SoundSource.xml 27 KB

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