SoundSource.xml 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666
  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="Frequency">
  126. <MemberSignature Language="C#" Value="public float Frequency { get; set; }" />
  127. <MemberSignature Language="ILAsm" Value=".property instance float32 Frequency" />
  128. <MemberType>Property</MemberType>
  129. <AssemblyInfo>
  130. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  131. </AssemblyInfo>
  132. <ReturnValue>
  133. <ReturnType>System.Single</ReturnType>
  134. </ReturnValue>
  135. <Docs>
  136. <summary>
  137. Return frequency.
  138. Or
  139. Set frequency.
  140. </summary>
  141. <value>To be added.</value>
  142. <remarks>To be added.</remarks>
  143. </Docs>
  144. </Member>
  145. <Member MemberName="Gain">
  146. <MemberSignature Language="C#" Value="public float Gain { get; set; }" />
  147. <MemberSignature Language="ILAsm" Value=".property instance float32 Gain" />
  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 gain.
  158. Or
  159. Set gain. 0.0 is silence, 1.0 is full volume.
  160. </summary>
  161. <value>To be added.</value>
  162. <remarks>To be added.</remarks>
  163. </Docs>
  164. </Member>
  165. <Member MemberName="Mix">
  166. <MemberSignature Language="C#" Value="public void Mix (int* dest, uint samples, int mixRate, bool stereo, bool interpolation);" />
  167. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Mix(int32* dest, unsigned int32 samples, int32 mixRate, bool stereo, bool interpolation) cil managed" />
  168. <MemberType>Method</MemberType>
  169. <AssemblyInfo>
  170. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  171. </AssemblyInfo>
  172. <ReturnValue>
  173. <ReturnType>System.Void</ReturnType>
  174. </ReturnValue>
  175. <Parameters>
  176. <Parameter Name="dest" Type="System.Int32*" />
  177. <Parameter Name="samples" Type="System.UInt32" />
  178. <Parameter Name="mixRate" Type="System.Int32" />
  179. <Parameter Name="stereo" Type="System.Boolean" />
  180. <Parameter Name="interpolation" Type="System.Boolean" />
  181. </Parameters>
  182. <Docs>
  183. <param name="dest">To be added.</param>
  184. <param name="samples">To be added.</param>
  185. <param name="mixRate">To be added.</param>
  186. <param name="stereo">To be added.</param>
  187. <param name="interpolation">To be added.</param>
  188. <summary>
  189. Mix sound source output to a 32-bit clipping buffer. Called by Audio.
  190. </summary>
  191. <remarks>To be added.</remarks>
  192. </Docs>
  193. </Member>
  194. <Member MemberName="Panning">
  195. <MemberSignature Language="C#" Value="public float Panning { get; set; }" />
  196. <MemberSignature Language="ILAsm" Value=".property instance float32 Panning" />
  197. <MemberType>Property</MemberType>
  198. <AssemblyInfo>
  199. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  200. </AssemblyInfo>
  201. <ReturnValue>
  202. <ReturnType>System.Single</ReturnType>
  203. </ReturnValue>
  204. <Docs>
  205. <summary>
  206. Return stereo panning.
  207. Or
  208. Set stereo panning. -1.0 is full left and 1.0 is full right.
  209. </summary>
  210. <value>To be added.</value>
  211. <remarks>To be added.</remarks>
  212. </Docs>
  213. </Member>
  214. <Member MemberName="Play">
  215. <MemberSignature Language="C#" Value="public void Play (Urho.Audio.Sound sound);" />
  216. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Play(class Urho.Audio.Sound sound) cil managed" />
  217. <MemberType>Method</MemberType>
  218. <AssemblyInfo>
  219. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  220. </AssemblyInfo>
  221. <ReturnValue>
  222. <ReturnType>System.Void</ReturnType>
  223. </ReturnValue>
  224. <Parameters>
  225. <Parameter Name="sound" Type="Urho.Audio.Sound" />
  226. </Parameters>
  227. <Docs>
  228. <param name="sound">To be added.</param>
  229. <summary>
  230. Play a sound.
  231. </summary>
  232. <remarks>To be added.</remarks>
  233. </Docs>
  234. </Member>
  235. <Member MemberName="Play">
  236. <MemberSignature Language="C#" Value="public void Play (Urho.Audio.SoundStream stream);" />
  237. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Play(class Urho.Audio.SoundStream stream) cil managed" />
  238. <MemberType>Method</MemberType>
  239. <AssemblyInfo>
  240. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  241. </AssemblyInfo>
  242. <ReturnValue>
  243. <ReturnType>System.Void</ReturnType>
  244. </ReturnValue>
  245. <Parameters>
  246. <Parameter Name="stream" Type="Urho.Audio.SoundStream" />
  247. </Parameters>
  248. <Docs>
  249. <param name="stream">To be added.</param>
  250. <summary>
  251. Start playing a sound stream.
  252. </summary>
  253. <remarks>To be added.</remarks>
  254. </Docs>
  255. </Member>
  256. <Member MemberName="Play">
  257. <MemberSignature Language="C#" Value="public void Play (Urho.Audio.Sound sound, float frequency);" />
  258. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Play(class Urho.Audio.Sound sound, float32 frequency) cil managed" />
  259. <MemberType>Method</MemberType>
  260. <AssemblyInfo>
  261. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  262. </AssemblyInfo>
  263. <ReturnValue>
  264. <ReturnType>System.Void</ReturnType>
  265. </ReturnValue>
  266. <Parameters>
  267. <Parameter Name="sound" Type="Urho.Audio.Sound" />
  268. <Parameter Name="frequency" Type="System.Single" />
  269. </Parameters>
  270. <Docs>
  271. <param name="sound">To be added.</param>
  272. <param name="frequency">To be added.</param>
  273. <summary>
  274. Play a sound with specified frequency.
  275. </summary>
  276. <remarks>To be added.</remarks>
  277. </Docs>
  278. </Member>
  279. <Member MemberName="Play">
  280. <MemberSignature Language="C#" Value="public void Play (Urho.Audio.Sound sound, float frequency, float gain);" />
  281. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Play(class Urho.Audio.Sound sound, float32 frequency, float32 gain) cil managed" />
  282. <MemberType>Method</MemberType>
  283. <AssemblyInfo>
  284. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  285. </AssemblyInfo>
  286. <ReturnValue>
  287. <ReturnType>System.Void</ReturnType>
  288. </ReturnValue>
  289. <Parameters>
  290. <Parameter Name="sound" Type="Urho.Audio.Sound" />
  291. <Parameter Name="frequency" Type="System.Single" />
  292. <Parameter Name="gain" Type="System.Single" />
  293. </Parameters>
  294. <Docs>
  295. <param name="sound">To be added.</param>
  296. <param name="frequency">To be added.</param>
  297. <param name="gain">To be added.</param>
  298. <summary>
  299. Play a sound with specified frequency and gain.
  300. </summary>
  301. <remarks>To be added.</remarks>
  302. </Docs>
  303. </Member>
  304. <Member MemberName="Play">
  305. <MemberSignature Language="C#" Value="public void Play (Urho.Audio.Sound sound, float frequency, float gain, float panning);" />
  306. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Play(class Urho.Audio.Sound sound, float32 frequency, float32 gain, float32 panning) cil managed" />
  307. <MemberType>Method</MemberType>
  308. <AssemblyInfo>
  309. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  310. </AssemblyInfo>
  311. <ReturnValue>
  312. <ReturnType>System.Void</ReturnType>
  313. </ReturnValue>
  314. <Parameters>
  315. <Parameter Name="sound" Type="Urho.Audio.Sound" />
  316. <Parameter Name="frequency" Type="System.Single" />
  317. <Parameter Name="gain" Type="System.Single" />
  318. <Parameter Name="panning" Type="System.Single" />
  319. </Parameters>
  320. <Docs>
  321. <param name="sound">To be added.</param>
  322. <param name="frequency">To be added.</param>
  323. <param name="gain">To be added.</param>
  324. <param name="panning">To be added.</param>
  325. <summary>
  326. Play a sound with specified frequency, gain and panning.
  327. </summary>
  328. <remarks>To be added.</remarks>
  329. </Docs>
  330. </Member>
  331. <Member MemberName="Playing">
  332. <MemberSignature Language="C#" Value="public bool Playing { get; }" />
  333. <MemberSignature Language="ILAsm" Value=".property instance bool Playing" />
  334. <MemberType>Property</MemberType>
  335. <AssemblyInfo>
  336. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  337. </AssemblyInfo>
  338. <ReturnValue>
  339. <ReturnType>System.Boolean</ReturnType>
  340. </ReturnValue>
  341. <Docs>
  342. <summary>Return whether is playing.</summary>
  343. <value>To be added.</value>
  344. <remarks>To be added.</remarks>
  345. </Docs>
  346. </Member>
  347. <Member MemberName="PlayPosition">
  348. <MemberSignature Language="C#" Value="public sbyte* PlayPosition { get; }" />
  349. <MemberSignature Language="ILAsm" Value=".property instance int8* PlayPosition" />
  350. <MemberType>Property</MemberType>
  351. <AssemblyInfo>
  352. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  353. </AssemblyInfo>
  354. <ReturnValue>
  355. <ReturnType>System.SByte*</ReturnType>
  356. </ReturnValue>
  357. <Docs>
  358. <summary>
  359. Return playback position.
  360. </summary>
  361. <value>To be added.</value>
  362. <remarks>To be added.</remarks>
  363. </Docs>
  364. </Member>
  365. <Member MemberName="PositionAttr">
  366. <MemberSignature Language="C#" Value="public int PositionAttr { get; set; }" />
  367. <MemberSignature Language="ILAsm" Value=".property instance int32 PositionAttr" />
  368. <MemberType>Property</MemberType>
  369. <AssemblyInfo>
  370. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  371. </AssemblyInfo>
  372. <ReturnValue>
  373. <ReturnType>System.Int32</ReturnType>
  374. </ReturnValue>
  375. <Docs>
  376. <summary>
  377. Return sound position attribute.
  378. Or
  379. Set sound position attribute.
  380. </summary>
  381. <value>To be added.</value>
  382. <remarks>To be added.</remarks>
  383. </Docs>
  384. </Member>
  385. <Member MemberName="RegisterObject">
  386. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  387. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  388. <MemberType>Method</MemberType>
  389. <AssemblyInfo>
  390. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  391. </AssemblyInfo>
  392. <ReturnValue>
  393. <ReturnType>System.Void</ReturnType>
  394. </ReturnValue>
  395. <Parameters>
  396. <Parameter Name="context" Type="Urho.Context" />
  397. </Parameters>
  398. <Docs>
  399. <param name="context">To be added.</param>
  400. <summary>
  401. Register object factory.
  402. </summary>
  403. <remarks>To be added.</remarks>
  404. </Docs>
  405. </Member>
  406. <Member MemberName="SetPlayingAttr">
  407. <MemberSignature Language="C#" Value="public void SetPlayingAttr (bool value);" />
  408. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPlayingAttr(bool value) cil managed" />
  409. <MemberType>Method</MemberType>
  410. <AssemblyInfo>
  411. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  412. </AssemblyInfo>
  413. <ReturnValue>
  414. <ReturnType>System.Void</ReturnType>
  415. </ReturnValue>
  416. <Parameters>
  417. <Parameter Name="value" Type="System.Boolean" />
  418. </Parameters>
  419. <Docs>
  420. <param name="value">To be added.</param>
  421. <summary>
  422. Set sound playing attribute
  423. </summary>
  424. <remarks>To be added.</remarks>
  425. </Docs>
  426. </Member>
  427. <Member MemberName="SetPlayPosition">
  428. <MemberSignature Language="C#" Value="public void SetPlayPosition (sbyte* pos);" />
  429. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPlayPosition(int8* pos) cil managed" />
  430. <MemberType>Method</MemberType>
  431. <AssemblyInfo>
  432. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  433. </AssemblyInfo>
  434. <ReturnValue>
  435. <ReturnType>System.Void</ReturnType>
  436. </ReturnValue>
  437. <Parameters>
  438. <Parameter Name="pos" Type="System.SByte*" />
  439. </Parameters>
  440. <Docs>
  441. <param name="pos">To be added.</param>
  442. <summary>
  443. Set new playback position.
  444. </summary>
  445. <remarks>To be added.</remarks>
  446. </Docs>
  447. </Member>
  448. <Member MemberName="SetSoundType">
  449. <MemberSignature Language="C#" Value="public void SetSoundType (string type);" />
  450. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetSoundType(string type) cil managed" />
  451. <MemberType>Method</MemberType>
  452. <AssemblyInfo>
  453. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  454. </AssemblyInfo>
  455. <ReturnValue>
  456. <ReturnType>System.Void</ReturnType>
  457. </ReturnValue>
  458. <Parameters>
  459. <Parameter Name="type" Type="System.String" />
  460. </Parameters>
  461. <Docs>
  462. <param name="type">To be added.</param>
  463. <summary>
  464. Set sound type, determines the master gain group.
  465. </summary>
  466. <remarks>To be added.</remarks>
  467. </Docs>
  468. </Member>
  469. <Member MemberName="Sound">
  470. <MemberSignature Language="C#" Value="public Urho.Audio.Sound Sound { get; }" />
  471. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Audio.Sound Sound" />
  472. <MemberType>Property</MemberType>
  473. <AssemblyInfo>
  474. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  475. </AssemblyInfo>
  476. <ReturnValue>
  477. <ReturnType>Urho.Audio.Sound</ReturnType>
  478. </ReturnValue>
  479. <Docs>
  480. <summary>
  481. Return sound.
  482. </summary>
  483. <value>To be added.</value>
  484. <remarks>To be added.</remarks>
  485. </Docs>
  486. </Member>
  487. <Member MemberName="SoundAttr">
  488. <MemberSignature Language="C#" Value="public Urho.ResourceRef SoundAttr { get; }" />
  489. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.ResourceRef SoundAttr" />
  490. <MemberType>Property</MemberType>
  491. <AssemblyInfo>
  492. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  493. </AssemblyInfo>
  494. <ReturnValue>
  495. <ReturnType>Urho.ResourceRef</ReturnType>
  496. </ReturnValue>
  497. <Docs>
  498. <summary>
  499. Return sound attribute.
  500. </summary>
  501. <value>To be added.</value>
  502. <remarks>To be added.</remarks>
  503. </Docs>
  504. </Member>
  505. <Member MemberName="SoundType">
  506. <MemberSignature Language="C#" Value="public string SoundType { get; }" />
  507. <MemberSignature Language="ILAsm" Value=".property instance string SoundType" />
  508. <MemberType>Property</MemberType>
  509. <AssemblyInfo>
  510. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  511. </AssemblyInfo>
  512. <ReturnValue>
  513. <ReturnType>System.String</ReturnType>
  514. </ReturnValue>
  515. <Docs>
  516. <summary>
  517. Return sound type, determines the master gain group.
  518. </summary>
  519. <value>To be added.</value>
  520. <remarks>To be added.</remarks>
  521. </Docs>
  522. </Member>
  523. <Member MemberName="Stop">
  524. <MemberSignature Language="C#" Value="public void Stop ();" />
  525. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Stop() cil managed" />
  526. <MemberType>Method</MemberType>
  527. <AssemblyInfo>
  528. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  529. </AssemblyInfo>
  530. <ReturnValue>
  531. <ReturnType>System.Void</ReturnType>
  532. </ReturnValue>
  533. <Parameters />
  534. <Docs>
  535. <summary>
  536. Stop playback.
  537. </summary>
  538. <remarks>To be added.</remarks>
  539. </Docs>
  540. </Member>
  541. <Member MemberName="TimePosition">
  542. <MemberSignature Language="C#" Value="public float TimePosition { get; }" />
  543. <MemberSignature Language="ILAsm" Value=".property instance float32 TimePosition" />
  544. <MemberType>Property</MemberType>
  545. <AssemblyInfo>
  546. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  547. </AssemblyInfo>
  548. <ReturnValue>
  549. <ReturnType>System.Single</ReturnType>
  550. </ReturnValue>
  551. <Docs>
  552. <summary>
  553. Return playback time position.
  554. </summary>
  555. <value>To be added.</value>
  556. <remarks>To be added.</remarks>
  557. </Docs>
  558. </Member>
  559. <Member MemberName="Type">
  560. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  561. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  562. <MemberType>Property</MemberType>
  563. <AssemblyInfo>
  564. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  565. </AssemblyInfo>
  566. <ReturnValue>
  567. <ReturnType>Urho.StringHash</ReturnType>
  568. </ReturnValue>
  569. <Docs>
  570. <summary>Urho's type system type.</summary>
  571. <value>StringHash representing the type for this C# type.</value>
  572. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  573. </Docs>
  574. </Member>
  575. <Member MemberName="TypeName">
  576. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  577. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  578. <MemberType>Property</MemberType>
  579. <AssemblyInfo>
  580. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  581. </AssemblyInfo>
  582. <ReturnValue>
  583. <ReturnType>System.String</ReturnType>
  584. </ReturnValue>
  585. <Docs>
  586. <summary>Urho's low-level type name.</summary>
  587. <value>Stringified low-level type name.</value>
  588. <remarks>
  589. </remarks>
  590. </Docs>
  591. </Member>
  592. <Member MemberName="TypeNameStatic">
  593. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  594. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  595. <MemberType>Property</MemberType>
  596. <AssemblyInfo>
  597. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  598. </AssemblyInfo>
  599. <ReturnValue>
  600. <ReturnType>System.String</ReturnType>
  601. </ReturnValue>
  602. <Docs>
  603. <summary>Urho's low-level type name, accessible as a static method.</summary>
  604. <value>Stringified low-level type name.</value>
  605. <remarks>
  606. </remarks>
  607. </Docs>
  608. </Member>
  609. <Member MemberName="TypeStatic">
  610. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  611. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  612. <MemberType>Property</MemberType>
  613. <AssemblyInfo>
  614. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  615. </AssemblyInfo>
  616. <ReturnValue>
  617. <ReturnType>Urho.StringHash</ReturnType>
  618. </ReturnValue>
  619. <Docs>
  620. <summary>Urho's low-level type, accessible as a static method.</summary>
  621. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  622. <remarks>
  623. </remarks>
  624. </Docs>
  625. </Member>
  626. <Member MemberName="Update">
  627. <MemberSignature Language="C#" Value="public virtual void Update (float timeStep);" />
  628. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Update(float32 timeStep) cil managed" />
  629. <MemberType>Method</MemberType>
  630. <AssemblyInfo>
  631. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  632. </AssemblyInfo>
  633. <ReturnValue>
  634. <ReturnType>System.Void</ReturnType>
  635. </ReturnValue>
  636. <Parameters>
  637. <Parameter Name="timeStep" Type="System.Single" />
  638. </Parameters>
  639. <Docs>
  640. <param name="timeStep">To be added.</param>
  641. <summary>
  642. Update the sound source. Perform subclass specific operations. Called by Audio.
  643. </summary>
  644. <remarks>To be added.</remarks>
  645. </Docs>
  646. </Member>
  647. <Member MemberName="UpdateMasterGain">
  648. <MemberSignature Language="C#" Value="public void UpdateMasterGain ();" />
  649. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UpdateMasterGain() cil managed" />
  650. <MemberType>Method</MemberType>
  651. <AssemblyInfo>
  652. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  653. </AssemblyInfo>
  654. <ReturnValue>
  655. <ReturnType>System.Void</ReturnType>
  656. </ReturnValue>
  657. <Parameters />
  658. <Docs>
  659. <summary>
  660. Update the effective master gain. Called internally and by Audio when the master gain changes.
  661. </summary>
  662. <remarks>To be added.</remarks>
  663. </Docs>
  664. </Member>
  665. </Members>
  666. </Type>