This repository has been archived by the owner on Jan 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAudioSource_8hpp_source.html
131 lines (129 loc) · 12.1 KB
/
AudioSource_8hpp_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPICPRJ Engine: includes/spic-api-headers/AudioSource.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SPICPRJ Engine
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_09e761304027c904456130627fd4dcf5.html">includes</a></li><li class="navelem"><a class="el" href="dir_d14ad54c13021448a5a21de847e61ce8.html">spic-api-headers</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">AudioSource.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="AudioSource_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef AUDIOSOURCE_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define AUDIOSOURCE_H_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="Component_8hpp.html">Component.hpp</a>"</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#if __has_include("AudioSource_includes.hpp"</span>)</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "AudioSource_includes.hpp"</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span><a class="code" href="namespacespic.html">spic</a> {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classspic_1_1AudioSource.html"> 17</a></span>  <span class="keyword">class </span><a class="code" href="classspic_1_1AudioSource.html">AudioSource</a> : <span class="keyword">public</span> <a class="code" href="classspic_1_1Component.html">Component</a> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="classspic_1_1AudioSource.html#a4ae180a58117fce615d7759e1923173f">AudioSource</a>(<span class="keyword">const</span> std::string& audioClip, <span class="keywordtype">bool</span> playOnAwake, <span class="keywordtype">bool</span> looping, <span class="keywordtype">double</span> volume);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">void</span> <a class="code" href="classspic_1_1AudioSource.html#afc2ea09b57477c34083d937f50e83166">Play</a>(<span class="keywordtype">bool</span> looping);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">void</span> <a class="code" href="classspic_1_1AudioSource.html#afcfa9a28255f0aac30aa218d4e293123">Stop</a>();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">double</span> <a class="code" href="classspic_1_1AudioSource.html#a2bffcc5f63b4f9fcc0cc6154af6489aa">Volume</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> <a class="code" href="classspic_1_1AudioSource.html#a2bffcc5f63b4f9fcc0cc6154af6489aa">Volume</a>(<span class="keywordtype">double</span> newVolume);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#if __has_include("AudioSource_public.hpp"</span>)</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#include "<a class="code" href="AudioSource__public_8hpp.html">AudioSource_public.hpp</a>"</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  std::string audioClip;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">bool</span> playOnAwake;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">bool</span> loop;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">double</span> volume;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#if __has_include("AudioSource_private.hpp"</span>)</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#include "AudioSource_private.hpp"</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  };</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#endif </span><span class="comment">// AUDIOSOURCE_H_</span></div>
<div class="ttc" id="aAudioSource__public_8hpp_html"><div class="ttname"><a href="AudioSource__public_8hpp.html">AudioSource_public.hpp</a></div></div>
<div class="ttc" id="aComponent_8hpp_html"><div class="ttname"><a href="Component_8hpp.html">Component.hpp</a></div></div>
<div class="ttc" id="aclassspic_1_1AudioSource_html"><div class="ttname"><a href="classspic_1_1AudioSource.html">spic::AudioSource</a></div><div class="ttdoc">Component which can play audio. @spicapi.</div><div class="ttdef"><b>Definition:</b> AudioSource.hpp:17</div></div>
<div class="ttc" id="aclassspic_1_1AudioSource_html_a2bffcc5f63b4f9fcc0cc6154af6489aa"><div class="ttname"><a href="classspic_1_1AudioSource.html#a2bffcc5f63b4f9fcc0cc6154af6489aa">spic::AudioSource::Volume</a></div><div class="ttdeci">double Volume() const</div><div class="ttdoc">Get the volume of the AudioSource.</div><div class="ttdef"><b>Definition:</b> AudioSource.cpp:31</div></div>
<div class="ttc" id="aclassspic_1_1AudioSource_html_a4ae180a58117fce615d7759e1923173f"><div class="ttname"><a href="classspic_1_1AudioSource.html#a4ae180a58117fce615d7759e1923173f">spic::AudioSource::AudioSource</a></div><div class="ttdeci">AudioSource(const std::string &audioClip, bool playOnAwake, bool looping, double volume)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> AudioSource.cpp:7</div></div>
<div class="ttc" id="aclassspic_1_1AudioSource_html_afc2ea09b57477c34083d937f50e83166"><div class="ttname"><a href="classspic_1_1AudioSource.html#afc2ea09b57477c34083d937f50e83166">spic::AudioSource::Play</a></div><div class="ttdeci">void Play(bool looping)</div><div class="ttdoc">Call this method to start playing audio.</div><div class="ttdef"><b>Definition:</b> AudioSource.cpp:15</div></div>
<div class="ttc" id="aclassspic_1_1AudioSource_html_afcfa9a28255f0aac30aa218d4e293123"><div class="ttname"><a href="classspic_1_1AudioSource.html#afcfa9a28255f0aac30aa218d4e293123">spic::AudioSource::Stop</a></div><div class="ttdeci">void Stop()</div><div class="ttdoc">Call this method to stop playing audio. @spicapi.</div><div class="ttdef"><b>Definition:</b> AudioSource.cpp:23</div></div>
<div class="ttc" id="aclassspic_1_1Component_html"><div class="ttname"><a href="classspic_1_1Component.html">spic::Component</a></div><div class="ttdoc">Base class for all components. @spicapi.</div><div class="ttdef"><b>Definition:</b> Component.hpp:18</div></div>
<div class="ttc" id="anamespacespic_html"><div class="ttname"><a href="namespacespic.html">spic</a></div><div class="ttdef"><b>Definition:</b> Animator.hpp:13</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>