SoundSource.xml 28 KB

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