SoundSource.xml 26 KB

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