SoundSource.xml 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686
  1. <Type Name="SoundSource" FullName="Urho.Audio.SoundSource">
  2. <TypeSignature Language="C#" Value="public class SoundSource : Urho.Component" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SoundSource extends Urho.Component" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Component</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>Sound source component with stereo position.
  14. </summary>
  15. <remarks>
  16. <para>Provides support for playing back <see cref="T:Urho.Audio.Sound" />.</para>
  17. <para>
  18. </para>
  19. <para>
  20. </para>
  21. <format type="text/html" />
  22. <para>
  23. </para>
  24. <para>The <see cref="T:Urho.Audio.SoundSource" /> components support automatic removal from the node they belong to, once playback is finished. To use, set the <see cref="P:Urho.Audio.SoundSource.AutoRemove property" /> on them. This may be useful when a game object plays several "fire and forget" sound effects.</para>
  25. <para>
  26. </para>
  27. </remarks>
  28. </Docs>
  29. <Members>
  30. <Member MemberName=".ctor">
  31. <MemberSignature Language="C#" Value="public SoundSource ();" />
  32. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  33. <MemberType>Constructor</MemberType>
  34. <AssemblyInfo>
  35. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  36. </AssemblyInfo>
  37. <Parameters />
  38. <Docs>
  39. <summary>
  40. <para>Constructs a new instance of Urho.Audio.SoundSource which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  41. </summary>
  42. <remarks>
  43. </remarks>
  44. </Docs>
  45. </Member>
  46. <Member MemberName=".ctor">
  47. <MemberSignature Language="C#" Value="public SoundSource (IntPtr handle);" />
  48. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  49. <MemberType>Constructor</MemberType>
  50. <AssemblyInfo>
  51. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  52. </AssemblyInfo>
  53. <Parameters>
  54. <Parameter Name="handle" Type="System.IntPtr" />
  55. </Parameters>
  56. <Docs>
  57. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  58. <summary>Constructs a new instance of Urho.Audio.SoundSource, given a raw pointer to an unmanaged object</summary>
  59. <remarks>
  60. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  61. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  62. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  63. </remarks>
  64. </Docs>
  65. </Member>
  66. <Member MemberName=".ctor">
  67. <MemberSignature Language="C#" Value="public SoundSource (Urho.Context context);" />
  68. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  69. <MemberType>Constructor</MemberType>
  70. <AssemblyInfo>
  71. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  72. </AssemblyInfo>
  73. <Parameters>
  74. <Parameter Name="context" Type="Urho.Context" />
  75. </Parameters>
  76. <Docs>
  77. <param name="context">The context that this object will be attached to.</param>
  78. <summary>
  79. <para>Constructs a new instance of Urho.Audio.SoundSource linked to a specific <see cref="T:Urho.Context" />.</para>
  80. </summary>
  81. <remarks>
  82. </remarks>
  83. </Docs>
  84. </Member>
  85. <Member MemberName=".ctor">
  86. <MemberSignature Language="C#" Value="protected SoundSource (Urho.UrhoObjectFlag emptyFlag);" />
  87. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  88. <MemberType>Constructor</MemberType>
  89. <AssemblyInfo>
  90. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  91. </AssemblyInfo>
  92. <Parameters>
  93. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  94. </Parameters>
  95. <Docs>
  96. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  97. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  98. <remarks>
  99. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  100. <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
  101. <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
  102. </remarks>
  103. </Docs>
  104. </Member>
  105. <Member MemberName="Attenuation">
  106. <MemberSignature Language="C#" Value="public float Attenuation { get; set; }" />
  107. <MemberSignature Language="ILAsm" Value=".property instance float32 Attenuation" />
  108. <MemberType>Property</MemberType>
  109. <AssemblyInfo>
  110. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  111. </AssemblyInfo>
  112. <ReturnValue>
  113. <ReturnType>System.Single</ReturnType>
  114. </ReturnValue>
  115. <Docs>
  116. <summary>
  117. Return attenuation.
  118. Or
  119. Set attenuation. 1.0 is unaltered. Used for distance attenuated playback.
  120. </summary>
  121. <value>To be added.</value>
  122. <remarks>To be added.</remarks>
  123. </Docs>
  124. </Member>
  125. <Member MemberName="AutoRemove">
  126. <MemberSignature Language="C#" Value="public bool AutoRemove { get; set; }" />
  127. <MemberSignature Language="ILAsm" Value=".property instance bool AutoRemove" />
  128. <MemberType>Property</MemberType>
  129. <AssemblyInfo>
  130. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  131. </AssemblyInfo>
  132. <ReturnValue>
  133. <ReturnType>System.Boolean</ReturnType>
  134. </ReturnValue>
  135. <Docs>
  136. <summary>
  137. Return autoremove mode.
  138. Or
  139. Set whether sound source will be automatically removed from the scene node when playback stops.
  140. </summary>
  141. <value>To be added.</value>
  142. <remarks>To be added.</remarks>
  143. </Docs>
  144. </Member>
  145. <Member MemberName="Frequency">
  146. <MemberSignature Language="C#" Value="public float Frequency { get; set; }" />
  147. <MemberSignature Language="ILAsm" Value=".property instance float32 Frequency" />
  148. <MemberType>Property</MemberType>
  149. <AssemblyInfo>
  150. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  151. </AssemblyInfo>
  152. <ReturnValue>
  153. <ReturnType>System.Single</ReturnType>
  154. </ReturnValue>
  155. <Docs>
  156. <summary>
  157. Return frequency.
  158. Or
  159. Set frequency.
  160. </summary>
  161. <value>To be added.</value>
  162. <remarks>To be added.</remarks>
  163. </Docs>
  164. </Member>
  165. <Member MemberName="Gain">
  166. <MemberSignature Language="C#" Value="public float Gain { get; set; }" />
  167. <MemberSignature Language="ILAsm" Value=".property instance float32 Gain" />
  168. <MemberType>Property</MemberType>
  169. <AssemblyInfo>
  170. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  171. </AssemblyInfo>
  172. <ReturnValue>
  173. <ReturnType>System.Single</ReturnType>
  174. </ReturnValue>
  175. <Docs>
  176. <summary>
  177. Return gain.
  178. Or
  179. Set gain. 0.0 is silence, 1.0 is full volume.
  180. </summary>
  181. <value>To be added.</value>
  182. <remarks>To be added.</remarks>
  183. </Docs>
  184. </Member>
  185. <Member MemberName="Mix">
  186. <MemberSignature Language="C#" Value="public void Mix (int* dest, uint samples, int mixRate, bool stereo, bool interpolation);" />
  187. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Mix(int32* dest, unsigned int32 samples, int32 mixRate, bool stereo, bool interpolation) cil managed" />
  188. <MemberType>Method</MemberType>
  189. <AssemblyInfo>
  190. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  191. </AssemblyInfo>
  192. <ReturnValue>
  193. <ReturnType>System.Void</ReturnType>
  194. </ReturnValue>
  195. <Parameters>
  196. <Parameter Name="dest" Type="System.Int32*" />
  197. <Parameter Name="samples" Type="System.UInt32" />
  198. <Parameter Name="mixRate" Type="System.Int32" />
  199. <Parameter Name="stereo" Type="System.Boolean" />
  200. <Parameter Name="interpolation" Type="System.Boolean" />
  201. </Parameters>
  202. <Docs>
  203. <param name="dest">To be added.</param>
  204. <param name="samples">To be added.</param>
  205. <param name="mixRate">To be added.</param>
  206. <param name="stereo">To be added.</param>
  207. <param name="interpolation">To be added.</param>
  208. <summary>
  209. Mix sound source output to a 32-bit clipping buffer. Called by Audio.
  210. </summary>
  211. <remarks>To be added.</remarks>
  212. </Docs>
  213. </Member>
  214. <Member MemberName="Panning">
  215. <MemberSignature Language="C#" Value="public float Panning { get; set; }" />
  216. <MemberSignature Language="ILAsm" Value=".property instance float32 Panning" />
  217. <MemberType>Property</MemberType>
  218. <AssemblyInfo>
  219. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  220. </AssemblyInfo>
  221. <ReturnValue>
  222. <ReturnType>System.Single</ReturnType>
  223. </ReturnValue>
  224. <Docs>
  225. <summary>
  226. Return stereo panning.
  227. Or
  228. Set stereo panning. -1.0 is full left and 1.0 is full right.
  229. </summary>
  230. <value>To be added.</value>
  231. <remarks>To be added.</remarks>
  232. </Docs>
  233. </Member>
  234. <Member MemberName="Play">
  235. <MemberSignature Language="C#" Value="public void Play (Urho.Audio.Sound sound);" />
  236. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Play(class Urho.Audio.Sound sound) cil managed" />
  237. <MemberType>Method</MemberType>
  238. <AssemblyInfo>
  239. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  240. </AssemblyInfo>
  241. <ReturnValue>
  242. <ReturnType>System.Void</ReturnType>
  243. </ReturnValue>
  244. <Parameters>
  245. <Parameter Name="sound" Type="Urho.Audio.Sound" />
  246. </Parameters>
  247. <Docs>
  248. <param name="sound">To be added.</param>
  249. <summary>
  250. Play a sound.
  251. </summary>
  252. <remarks>To be added.</remarks>
  253. </Docs>
  254. </Member>
  255. <Member MemberName="Play">
  256. <MemberSignature Language="C#" Value="public void Play (Urho.Audio.SoundStream stream);" />
  257. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Play(class Urho.Audio.SoundStream stream) cil managed" />
  258. <MemberType>Method</MemberType>
  259. <AssemblyInfo>
  260. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  261. </AssemblyInfo>
  262. <ReturnValue>
  263. <ReturnType>System.Void</ReturnType>
  264. </ReturnValue>
  265. <Parameters>
  266. <Parameter Name="stream" Type="Urho.Audio.SoundStream" />
  267. </Parameters>
  268. <Docs>
  269. <param name="stream">To be added.</param>
  270. <summary>
  271. Start playing a sound stream.
  272. </summary>
  273. <remarks>To be added.</remarks>
  274. </Docs>
  275. </Member>
  276. <Member MemberName="Play">
  277. <MemberSignature Language="C#" Value="public void Play (Urho.Audio.Sound sound, float frequency);" />
  278. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Play(class Urho.Audio.Sound sound, float32 frequency) cil managed" />
  279. <MemberType>Method</MemberType>
  280. <AssemblyInfo>
  281. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  282. </AssemblyInfo>
  283. <ReturnValue>
  284. <ReturnType>System.Void</ReturnType>
  285. </ReturnValue>
  286. <Parameters>
  287. <Parameter Name="sound" Type="Urho.Audio.Sound" />
  288. <Parameter Name="frequency" Type="System.Single" />
  289. </Parameters>
  290. <Docs>
  291. <param name="sound">To be added.</param>
  292. <param name="frequency">To be added.</param>
  293. <summary>
  294. Play a sound with specified frequency.
  295. </summary>
  296. <remarks>To be added.</remarks>
  297. </Docs>
  298. </Member>
  299. <Member MemberName="Play">
  300. <MemberSignature Language="C#" Value="public void Play (Urho.Audio.Sound sound, float frequency, float gain);" />
  301. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Play(class Urho.Audio.Sound sound, float32 frequency, float32 gain) cil managed" />
  302. <MemberType>Method</MemberType>
  303. <AssemblyInfo>
  304. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  305. </AssemblyInfo>
  306. <ReturnValue>
  307. <ReturnType>System.Void</ReturnType>
  308. </ReturnValue>
  309. <Parameters>
  310. <Parameter Name="sound" Type="Urho.Audio.Sound" />
  311. <Parameter Name="frequency" Type="System.Single" />
  312. <Parameter Name="gain" Type="System.Single" />
  313. </Parameters>
  314. <Docs>
  315. <param name="sound">To be added.</param>
  316. <param name="frequency">To be added.</param>
  317. <param name="gain">To be added.</param>
  318. <summary>
  319. Play a sound with specified frequency and gain.
  320. </summary>
  321. <remarks>To be added.</remarks>
  322. </Docs>
  323. </Member>
  324. <Member MemberName="Play">
  325. <MemberSignature Language="C#" Value="public void Play (Urho.Audio.Sound sound, float frequency, float gain, float panning);" />
  326. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Play(class Urho.Audio.Sound sound, float32 frequency, float32 gain, float32 panning) cil managed" />
  327. <MemberType>Method</MemberType>
  328. <AssemblyInfo>
  329. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  330. </AssemblyInfo>
  331. <ReturnValue>
  332. <ReturnType>System.Void</ReturnType>
  333. </ReturnValue>
  334. <Parameters>
  335. <Parameter Name="sound" Type="Urho.Audio.Sound" />
  336. <Parameter Name="frequency" Type="System.Single" />
  337. <Parameter Name="gain" Type="System.Single" />
  338. <Parameter Name="panning" Type="System.Single" />
  339. </Parameters>
  340. <Docs>
  341. <param name="sound">To be added.</param>
  342. <param name="frequency">To be added.</param>
  343. <param name="gain">To be added.</param>
  344. <param name="panning">To be added.</param>
  345. <summary>
  346. Play a sound with specified frequency, gain and panning.
  347. </summary>
  348. <remarks>To be added.</remarks>
  349. </Docs>
  350. </Member>
  351. <Member MemberName="Playing">
  352. <MemberSignature Language="C#" Value="public bool Playing { get; }" />
  353. <MemberSignature Language="ILAsm" Value=".property instance bool Playing" />
  354. <MemberType>Property</MemberType>
  355. <AssemblyInfo>
  356. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  357. </AssemblyInfo>
  358. <ReturnValue>
  359. <ReturnType>System.Boolean</ReturnType>
  360. </ReturnValue>
  361. <Docs>
  362. <summary>Return whether is playing.</summary>
  363. <value>To be added.</value>
  364. <remarks>To be added.</remarks>
  365. </Docs>
  366. </Member>
  367. <Member MemberName="PlayPosition">
  368. <MemberSignature Language="C#" Value="public sbyte* PlayPosition { get; }" />
  369. <MemberSignature Language="ILAsm" Value=".property instance int8* PlayPosition" />
  370. <MemberType>Property</MemberType>
  371. <AssemblyInfo>
  372. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  373. </AssemblyInfo>
  374. <ReturnValue>
  375. <ReturnType>System.SByte*</ReturnType>
  376. </ReturnValue>
  377. <Docs>
  378. <summary>
  379. Return playback position.
  380. </summary>
  381. <value>To be added.</value>
  382. <remarks>To be added.</remarks>
  383. </Docs>
  384. </Member>
  385. <Member MemberName="PositionAttr">
  386. <MemberSignature Language="C#" Value="public int PositionAttr { get; set; }" />
  387. <MemberSignature Language="ILAsm" Value=".property instance int32 PositionAttr" />
  388. <MemberType>Property</MemberType>
  389. <AssemblyInfo>
  390. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  391. </AssemblyInfo>
  392. <ReturnValue>
  393. <ReturnType>System.Int32</ReturnType>
  394. </ReturnValue>
  395. <Docs>
  396. <summary>
  397. Return sound position attribute.
  398. Or
  399. Set sound position attribute.
  400. </summary>
  401. <value>To be added.</value>
  402. <remarks>To be added.</remarks>
  403. </Docs>
  404. </Member>
  405. <Member MemberName="RegisterObject">
  406. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  407. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  408. <MemberType>Method</MemberType>
  409. <AssemblyInfo>
  410. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  411. </AssemblyInfo>
  412. <ReturnValue>
  413. <ReturnType>System.Void</ReturnType>
  414. </ReturnValue>
  415. <Parameters>
  416. <Parameter Name="context" Type="Urho.Context" />
  417. </Parameters>
  418. <Docs>
  419. <param name="context">To be added.</param>
  420. <summary>
  421. Register object factory.
  422. </summary>
  423. <remarks>To be added.</remarks>
  424. </Docs>
  425. </Member>
  426. <Member MemberName="SetPlayingAttr">
  427. <MemberSignature Language="C#" Value="public void SetPlayingAttr (bool value);" />
  428. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPlayingAttr(bool value) cil managed" />
  429. <MemberType>Method</MemberType>
  430. <AssemblyInfo>
  431. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  432. </AssemblyInfo>
  433. <ReturnValue>
  434. <ReturnType>System.Void</ReturnType>
  435. </ReturnValue>
  436. <Parameters>
  437. <Parameter Name="value" Type="System.Boolean" />
  438. </Parameters>
  439. <Docs>
  440. <param name="value">To be added.</param>
  441. <summary>
  442. Set sound playing attribute
  443. </summary>
  444. <remarks>To be added.</remarks>
  445. </Docs>
  446. </Member>
  447. <Member MemberName="SetPlayPosition">
  448. <MemberSignature Language="C#" Value="public void SetPlayPosition (sbyte* pos);" />
  449. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPlayPosition(int8* pos) cil managed" />
  450. <MemberType>Method</MemberType>
  451. <AssemblyInfo>
  452. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  453. </AssemblyInfo>
  454. <ReturnValue>
  455. <ReturnType>System.Void</ReturnType>
  456. </ReturnValue>
  457. <Parameters>
  458. <Parameter Name="pos" Type="System.SByte*" />
  459. </Parameters>
  460. <Docs>
  461. <param name="pos">To be added.</param>
  462. <summary>
  463. Set new playback position.
  464. </summary>
  465. <remarks>To be added.</remarks>
  466. </Docs>
  467. </Member>
  468. <Member MemberName="SetSoundType">
  469. <MemberSignature Language="C#" Value="public void SetSoundType (string type);" />
  470. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetSoundType(string type) cil managed" />
  471. <MemberType>Method</MemberType>
  472. <AssemblyInfo>
  473. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  474. </AssemblyInfo>
  475. <ReturnValue>
  476. <ReturnType>System.Void</ReturnType>
  477. </ReturnValue>
  478. <Parameters>
  479. <Parameter Name="type" Type="System.String" />
  480. </Parameters>
  481. <Docs>
  482. <param name="type">To be added.</param>
  483. <summary>
  484. Set sound type, determines the master gain group.
  485. </summary>
  486. <remarks>To be added.</remarks>
  487. </Docs>
  488. </Member>
  489. <Member MemberName="Sound">
  490. <MemberSignature Language="C#" Value="public Urho.Audio.Sound Sound { get; }" />
  491. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Audio.Sound Sound" />
  492. <MemberType>Property</MemberType>
  493. <AssemblyInfo>
  494. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  495. </AssemblyInfo>
  496. <ReturnValue>
  497. <ReturnType>Urho.Audio.Sound</ReturnType>
  498. </ReturnValue>
  499. <Docs>
  500. <summary>
  501. Return sound.
  502. </summary>
  503. <value>To be added.</value>
  504. <remarks>To be added.</remarks>
  505. </Docs>
  506. </Member>
  507. <Member MemberName="SoundAttr">
  508. <MemberSignature Language="C#" Value="public Urho.ResourceRef SoundAttr { get; }" />
  509. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.ResourceRef SoundAttr" />
  510. <MemberType>Property</MemberType>
  511. <AssemblyInfo>
  512. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  513. </AssemblyInfo>
  514. <ReturnValue>
  515. <ReturnType>Urho.ResourceRef</ReturnType>
  516. </ReturnValue>
  517. <Docs>
  518. <summary>
  519. Return sound attribute.
  520. </summary>
  521. <value>To be added.</value>
  522. <remarks>To be added.</remarks>
  523. </Docs>
  524. </Member>
  525. <Member MemberName="SoundType">
  526. <MemberSignature Language="C#" Value="public string SoundType { get; }" />
  527. <MemberSignature Language="ILAsm" Value=".property instance string SoundType" />
  528. <MemberType>Property</MemberType>
  529. <AssemblyInfo>
  530. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  531. </AssemblyInfo>
  532. <ReturnValue>
  533. <ReturnType>System.String</ReturnType>
  534. </ReturnValue>
  535. <Docs>
  536. <summary>
  537. Return sound type, determines the master gain group.
  538. </summary>
  539. <value>To be added.</value>
  540. <remarks>To be added.</remarks>
  541. </Docs>
  542. </Member>
  543. <Member MemberName="Stop">
  544. <MemberSignature Language="C#" Value="public void Stop ();" />
  545. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Stop() cil managed" />
  546. <MemberType>Method</MemberType>
  547. <AssemblyInfo>
  548. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  549. </AssemblyInfo>
  550. <ReturnValue>
  551. <ReturnType>System.Void</ReturnType>
  552. </ReturnValue>
  553. <Parameters />
  554. <Docs>
  555. <summary>
  556. Stop playback.
  557. </summary>
  558. <remarks>To be added.</remarks>
  559. </Docs>
  560. </Member>
  561. <Member MemberName="TimePosition">
  562. <MemberSignature Language="C#" Value="public float TimePosition { get; }" />
  563. <MemberSignature Language="ILAsm" Value=".property instance float32 TimePosition" />
  564. <MemberType>Property</MemberType>
  565. <AssemblyInfo>
  566. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  567. </AssemblyInfo>
  568. <ReturnValue>
  569. <ReturnType>System.Single</ReturnType>
  570. </ReturnValue>
  571. <Docs>
  572. <summary>
  573. Return playback time position.
  574. </summary>
  575. <value>To be added.</value>
  576. <remarks>To be added.</remarks>
  577. </Docs>
  578. </Member>
  579. <Member MemberName="Type">
  580. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  581. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  582. <MemberType>Property</MemberType>
  583. <AssemblyInfo>
  584. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  585. </AssemblyInfo>
  586. <ReturnValue>
  587. <ReturnType>Urho.StringHash</ReturnType>
  588. </ReturnValue>
  589. <Docs>
  590. <summary>Urho's type system type.</summary>
  591. <value>StringHash representing the type for this C# type.</value>
  592. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  593. </Docs>
  594. </Member>
  595. <Member MemberName="TypeName">
  596. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  597. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  598. <MemberType>Property</MemberType>
  599. <AssemblyInfo>
  600. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  601. </AssemblyInfo>
  602. <ReturnValue>
  603. <ReturnType>System.String</ReturnType>
  604. </ReturnValue>
  605. <Docs>
  606. <summary>Urho's low-level type name.</summary>
  607. <value>Stringified low-level type name.</value>
  608. <remarks>
  609. </remarks>
  610. </Docs>
  611. </Member>
  612. <Member MemberName="TypeNameStatic">
  613. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  614. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  615. <MemberType>Property</MemberType>
  616. <AssemblyInfo>
  617. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  618. </AssemblyInfo>
  619. <ReturnValue>
  620. <ReturnType>System.String</ReturnType>
  621. </ReturnValue>
  622. <Docs>
  623. <summary>Urho's low-level type name, accessible as a static method.</summary>
  624. <value>Stringified low-level type name.</value>
  625. <remarks>
  626. </remarks>
  627. </Docs>
  628. </Member>
  629. <Member MemberName="TypeStatic">
  630. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  631. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  632. <MemberType>Property</MemberType>
  633. <AssemblyInfo>
  634. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  635. </AssemblyInfo>
  636. <ReturnValue>
  637. <ReturnType>Urho.StringHash</ReturnType>
  638. </ReturnValue>
  639. <Docs>
  640. <summary>Urho's low-level type, accessible as a static method.</summary>
  641. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  642. <remarks>
  643. </remarks>
  644. </Docs>
  645. </Member>
  646. <Member MemberName="Update">
  647. <MemberSignature Language="C#" Value="public virtual void Update (float timeStep);" />
  648. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Update(float32 timeStep) cil managed" />
  649. <MemberType>Method</MemberType>
  650. <AssemblyInfo>
  651. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  652. </AssemblyInfo>
  653. <ReturnValue>
  654. <ReturnType>System.Void</ReturnType>
  655. </ReturnValue>
  656. <Parameters>
  657. <Parameter Name="timeStep" Type="System.Single" />
  658. </Parameters>
  659. <Docs>
  660. <param name="timeStep">To be added.</param>
  661. <summary>
  662. Update the sound source. Perform subclass specific operations. Called by Audio.
  663. </summary>
  664. <remarks>To be added.</remarks>
  665. </Docs>
  666. </Member>
  667. <Member MemberName="UpdateMasterGain">
  668. <MemberSignature Language="C#" Value="public void UpdateMasterGain ();" />
  669. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UpdateMasterGain() cil managed" />
  670. <MemberType>Method</MemberType>
  671. <AssemblyInfo>
  672. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  673. </AssemblyInfo>
  674. <ReturnValue>
  675. <ReturnType>System.Void</ReturnType>
  676. </ReturnValue>
  677. <Parameters />
  678. <Docs>
  679. <summary>
  680. Update the effective master gain. Called internally and by Audio when the master gain changes.
  681. </summary>
  682. <remarks>To be added.</remarks>
  683. </Docs>
  684. </Member>
  685. </Members>
  686. </Type>