Audio.xml 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624
  1. <Type Name="Audio" FullName="Urho.Audio.Audio">
  2. <TypeSignature Language="C#" Value="public class Audio : Urho.UrhoObject" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Audio extends Urho.UrhoObject" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.UrhoObject</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Audio subsystem, used to playback both regular audio and 3D sound.</summary>
  15. <remarks>
  16. <para>The Audio class represents the audio subsystem, which implements an audio output stream. It is the hub for audio operations in your application.  See the <see cref="N:Urho.Audio" /> documentation for more information.</para>
  17. <para>To hear pseudo-3D positional sounds, a <see cref="T:Urho.Audio.SoundListener" /> component must exist in a scene node and be assigned to the audio subsystem by setting the <see cref="P:Urho.Audio.Audio.Listener" /> property. </para>
  18. <para>The output is software mixed for an unlimited amount of simultaneous sounds. Ogg Vorbis sounds are decoded on the fly, and decoding them can be memory- and CPU-intensive, so WAV files are recommended when a large number of short sound effects need to be played.</para>
  19. <para>For purposes of volume control, each <see cref="T:Urho.Audio.SoundSource" /> can be classified into a user defined group which is multiplied with a master category and the individual <see cref="T:Urho.Audio.SoundSource" /> gain set using <see cref="P:Urho.Audio.SoundSource.Gain" /> for the final volume level.</para>
  20. <para>To control the category volumes, set the <see cref="M:Urho.Audio.Audio.SetMasterGain" />, which defines the category if it didn't already exist.</para>
  21. <para>It is possible to control the playback of a class of sounds identified by their type by using the <see cref="M:Urho.Audio.PauseSoundType" />, <see cref="M:Urho.Audio.ResumeSoundType" /> and <see cref="M:Urho.Audio.ResumeAll" /> methods.  You can probe whether a specific sound type is paused by calling the <see cref="M:Urho.Audio.IsSoundTypePaused" />.   The list of possible sound types are the strings “Master”, “Effect”, “Ambient”, “Voice” and “Music”.</para>
  22. <para></para>
  23. <para></para>
  24. </remarks>
  25. </Docs>
  26. <Members>
  27. <Member MemberName=".ctor">
  28. <MemberSignature Language="C#" Value="public Audio ();" />
  29. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  30. <MemberType>Constructor</MemberType>
  31. <AssemblyInfo>
  32. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  33. </AssemblyInfo>
  34. <Parameters />
  35. <Docs>
  36. <summary>
  37. <para>Constructs a new instance of Urho.Audio.Audio which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  38. </summary>
  39. <remarks></remarks>
  40. </Docs>
  41. </Member>
  42. <Member MemberName=".ctor">
  43. <MemberSignature Language="C#" Value="public Audio (IntPtr handle);" />
  44. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  45. <MemberType>Constructor</MemberType>
  46. <AssemblyInfo>
  47. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  48. </AssemblyInfo>
  49. <Parameters>
  50. <Parameter Name="handle" Type="System.IntPtr" />
  51. </Parameters>
  52. <Docs>
  53. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  54. <summary>Constructs a new instance of Urho.Audio.Audio, given a raw pointer to an unmanaged object</summary>
  55. <remarks>
  56. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  57. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  58. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  59. </remarks>
  60. </Docs>
  61. </Member>
  62. <Member MemberName=".ctor">
  63. <MemberSignature Language="C#" Value="public Audio (Urho.Context context);" />
  64. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  65. <MemberType>Constructor</MemberType>
  66. <AssemblyInfo>
  67. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  68. </AssemblyInfo>
  69. <Parameters>
  70. <Parameter Name="context" Type="Urho.Context" />
  71. </Parameters>
  72. <Docs>
  73. <param name="context">The context that this object will be attached to.</param>
  74. <summary>
  75. <para>Constructs a new instance of Urho.Audio.Audio linked to a specific <see cref="T:Urho.Context" />.</para>
  76. </summary>
  77. <remarks></remarks>
  78. </Docs>
  79. </Member>
  80. <Member MemberName=".ctor">
  81. <MemberSignature Language="C#" Value="protected Audio (Urho.UrhoObjectFlag emptyFlag);" />
  82. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  83. <MemberType>Constructor</MemberType>
  84. <AssemblyInfo>
  85. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  86. </AssemblyInfo>
  87. <Parameters>
  88. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  89. </Parameters>
  90. <Docs>
  91. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  92. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  93. <remarks>
  94. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  95. <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>
  96. <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>
  97. </remarks>
  98. </Docs>
  99. </Member>
  100. <Member MemberName="AddSoundSource">
  101. <MemberSignature Language="C#" Value="public void AddSoundSource (Urho.Audio.SoundSource soundSource);" />
  102. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddSoundSource(class Urho.Audio.SoundSource soundSource) cil managed" />
  103. <MemberType>Method</MemberType>
  104. <AssemblyInfo>
  105. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  106. </AssemblyInfo>
  107. <ReturnValue>
  108. <ReturnType>System.Void</ReturnType>
  109. </ReturnValue>
  110. <Parameters>
  111. <Parameter Name="soundSource" Type="Urho.Audio.SoundSource" />
  112. </Parameters>
  113. <Docs>
  114. <param name="soundSource">To be added.</param>
  115. <summary>
  116. Add a sound source to keep track of. Called by SoundSource.
  117. </summary>
  118. <remarks>To be added.</remarks>
  119. </Docs>
  120. </Member>
  121. <Member MemberName="GetMasterGain">
  122. <MemberSignature Language="C#" Value="public float GetMasterGain (string type);" />
  123. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetMasterGain(string type) cil managed" />
  124. <MemberType>Method</MemberType>
  125. <AssemblyInfo>
  126. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  127. </AssemblyInfo>
  128. <ReturnValue>
  129. <ReturnType>System.Single</ReturnType>
  130. </ReturnValue>
  131. <Parameters>
  132. <Parameter Name="type" Type="System.String" />
  133. </Parameters>
  134. <Docs>
  135. <param name="type">To be added.</param>
  136. <summary>
  137. Return master gain for a specific sound source type. Unknown sound types will return full gain (1).
  138. </summary>
  139. <returns>To be added.</returns>
  140. <remarks>To be added.</remarks>
  141. </Docs>
  142. </Member>
  143. <Member MemberName="GetSoundSourceMasterGain">
  144. <MemberSignature Language="C#" Value="public float GetSoundSourceMasterGain (Urho.StringHash typeHash);" />
  145. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetSoundSourceMasterGain(valuetype Urho.StringHash typeHash) cil managed" />
  146. <MemberType>Method</MemberType>
  147. <AssemblyInfo>
  148. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  149. </AssemblyInfo>
  150. <ReturnValue>
  151. <ReturnType>System.Single</ReturnType>
  152. </ReturnValue>
  153. <Parameters>
  154. <Parameter Name="typeHash" Type="Urho.StringHash" />
  155. </Parameters>
  156. <Docs>
  157. <param name="typeHash">To be added.</param>
  158. <summary>
  159. Return sound type specific gain multiplied by master gain.
  160. </summary>
  161. <returns>To be added.</returns>
  162. <remarks>To be added.</remarks>
  163. </Docs>
  164. </Member>
  165. <Member MemberName="HasMasterGain">
  166. <MemberSignature Language="C#" Value="public bool HasMasterGain (string type);" />
  167. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasMasterGain(string type) cil managed" />
  168. <MemberType>Method</MemberType>
  169. <AssemblyInfo>
  170. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  171. </AssemblyInfo>
  172. <ReturnValue>
  173. <ReturnType>System.Boolean</ReturnType>
  174. </ReturnValue>
  175. <Parameters>
  176. <Parameter Name="type" Type="System.String" />
  177. </Parameters>
  178. <Docs>
  179. <param name="type">To be added.</param>
  180. <summary>
  181. Return whether the specified master gain has been defined.
  182. </summary>
  183. <returns>To be added.</returns>
  184. <remarks>To be added.</remarks>
  185. </Docs>
  186. </Member>
  187. <Member MemberName="Initialized">
  188. <MemberSignature Language="C#" Value="public bool Initialized { get; }" />
  189. <MemberSignature Language="ILAsm" Value=".property instance bool Initialized" />
  190. <MemberType>Property</MemberType>
  191. <AssemblyInfo>
  192. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  193. </AssemblyInfo>
  194. <ReturnValue>
  195. <ReturnType>System.Boolean</ReturnType>
  196. </ReturnValue>
  197. <Docs>
  198. <summary>Return whether an audio stream has been reserved.</summary>
  199. <value>To be added.</value>
  200. <remarks>To be added.</remarks>
  201. </Docs>
  202. </Member>
  203. <Member MemberName="Interpolation">
  204. <MemberSignature Language="C#" Value="public bool Interpolation { get; }" />
  205. <MemberSignature Language="ILAsm" Value=".property instance bool Interpolation" />
  206. <MemberType>Property</MemberType>
  207. <AssemblyInfo>
  208. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  209. </AssemblyInfo>
  210. <ReturnValue>
  211. <ReturnType>System.Boolean</ReturnType>
  212. </ReturnValue>
  213. <Docs>
  214. <summary>
  215. Return whether output is interpolated.
  216. </summary>
  217. <value>To be added.</value>
  218. <remarks>To be added.</remarks>
  219. </Docs>
  220. </Member>
  221. <Member MemberName="IsSoundTypePaused">
  222. <MemberSignature Language="C#" Value="public bool IsSoundTypePaused (string type);" />
  223. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsSoundTypePaused(string type) cil managed" />
  224. <MemberType>Method</MemberType>
  225. <AssemblyInfo>
  226. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  227. </AssemblyInfo>
  228. <ReturnValue>
  229. <ReturnType>System.Boolean</ReturnType>
  230. </ReturnValue>
  231. <Parameters>
  232. <Parameter Name="type" Type="System.String" />
  233. </Parameters>
  234. <Docs>
  235. <param name="type">The type of the sound to probe, some possible value  “Master”, “Effect”, “Ambient”, “Voice” and “Music”.</param>
  236. <summary>Returns whether the specified sound type is currently paused.</summary>
  237. <returns>True if the sound for that sound type is paused, false otherwise.</returns>
  238. <remarks>
  239. <para></para>
  240. </remarks>
  241. </Docs>
  242. </Member>
  243. <Member MemberName="Listener">
  244. <MemberSignature Language="C#" Value="public Urho.Audio.SoundListener Listener { get; set; }" />
  245. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Audio.SoundListener Listener" />
  246. <MemberType>Property</MemberType>
  247. <AssemblyInfo>
  248. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  249. </AssemblyInfo>
  250. <ReturnValue>
  251. <ReturnType>Urho.Audio.SoundListener</ReturnType>
  252. </ReturnValue>
  253. <Docs>
  254. <summary>
  255. Return active sound listener.
  256. Or
  257. Set active sound listener for 3D sounds.
  258. </summary>
  259. <value>
  260. <para />
  261. </value>
  262. <remarks>Assign a SoundListener to this property.  The sound listener must be attached to a node in the scene for this to work.</remarks>
  263. </Docs>
  264. </Member>
  265. <Member MemberName="MixOutput">
  266. <MemberSignature Language="C#" Value="public void MixOutput (IntPtr dest, uint samples);" />
  267. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void MixOutput(native int dest, unsigned int32 samples) cil managed" />
  268. <MemberType>Method</MemberType>
  269. <AssemblyInfo>
  270. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  271. </AssemblyInfo>
  272. <ReturnValue>
  273. <ReturnType>System.Void</ReturnType>
  274. </ReturnValue>
  275. <Parameters>
  276. <Parameter Name="dest" Type="System.IntPtr" />
  277. <Parameter Name="samples" Type="System.UInt32" />
  278. </Parameters>
  279. <Docs>
  280. <param name="dest">To be added.</param>
  281. <param name="samples">To be added.</param>
  282. <summary>
  283. Mix sound sources into the buffer.
  284. </summary>
  285. <remarks>To be added.</remarks>
  286. </Docs>
  287. </Member>
  288. <Member MemberName="MixRate">
  289. <MemberSignature Language="C#" Value="public int MixRate { get; }" />
  290. <MemberSignature Language="ILAsm" Value=".property instance int32 MixRate" />
  291. <MemberType>Property</MemberType>
  292. <AssemblyInfo>
  293. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  294. </AssemblyInfo>
  295. <ReturnValue>
  296. <ReturnType>System.Int32</ReturnType>
  297. </ReturnValue>
  298. <Docs>
  299. <summary>
  300. Return mixing rate.
  301. </summary>
  302. <value>To be added.</value>
  303. <remarks>To be added.</remarks>
  304. </Docs>
  305. </Member>
  306. <Member MemberName="PauseSoundType">
  307. <MemberSignature Language="C#" Value="public void PauseSoundType (string type);" />
  308. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void PauseSoundType(string type) 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="type" Type="System.String" />
  318. </Parameters>
  319. <Docs>
  320. <param name="type">The list of possible sound types are the strings “Master”, “Effect”, “Ambient”, “Voice” and “Music”.</param>
  321. <summary>Pause playing back the sounds of the specific type.</summary>
  322. <remarks>To be added.</remarks>
  323. </Docs>
  324. </Member>
  325. <Member MemberName="Play">
  326. <MemberSignature Language="C#" Value="public bool Play ();" />
  327. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Play() cil managed" />
  328. <MemberType>Method</MemberType>
  329. <AssemblyInfo>
  330. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  331. </AssemblyInfo>
  332. <ReturnValue>
  333. <ReturnType>System.Boolean</ReturnType>
  334. </ReturnValue>
  335. <Parameters />
  336. <Docs>
  337. <summary>
  338. Restart sound output.
  339. </summary>
  340. <returns>To be added.</returns>
  341. <remarks>To be added.</remarks>
  342. </Docs>
  343. </Member>
  344. <Member MemberName="Playing">
  345. <MemberSignature Language="C#" Value="public bool Playing { get; }" />
  346. <MemberSignature Language="ILAsm" Value=".property instance bool Playing" />
  347. <MemberType>Property</MemberType>
  348. <AssemblyInfo>
  349. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  350. </AssemblyInfo>
  351. <ReturnValue>
  352. <ReturnType>System.Boolean</ReturnType>
  353. </ReturnValue>
  354. <Docs>
  355. <summary>Return whether audio is being output.</summary>
  356. <value>To be added.</value>
  357. <remarks>To be added.</remarks>
  358. </Docs>
  359. </Member>
  360. <Member MemberName="RemoveSoundSource">
  361. <MemberSignature Language="C#" Value="public void RemoveSoundSource (Urho.Audio.SoundSource soundSource);" />
  362. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveSoundSource(class Urho.Audio.SoundSource soundSource) cil managed" />
  363. <MemberType>Method</MemberType>
  364. <AssemblyInfo>
  365. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  366. </AssemblyInfo>
  367. <ReturnValue>
  368. <ReturnType>System.Void</ReturnType>
  369. </ReturnValue>
  370. <Parameters>
  371. <Parameter Name="soundSource" Type="Urho.Audio.SoundSource" />
  372. </Parameters>
  373. <Docs>
  374. <param name="soundSource">To be added.</param>
  375. <summary>
  376. Remove a sound source. Called by SoundSource.
  377. </summary>
  378. <remarks>To be added.</remarks>
  379. </Docs>
  380. </Member>
  381. <Member MemberName="ResumeAll">
  382. <MemberSignature Language="C#" Value="public void ResumeAll ();" />
  383. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResumeAll() cil managed" />
  384. <MemberType>Method</MemberType>
  385. <AssemblyInfo>
  386. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  387. </AssemblyInfo>
  388. <ReturnValue>
  389. <ReturnType>System.Void</ReturnType>
  390. </ReturnValue>
  391. <Parameters />
  392. <Docs>
  393. <summary>Resumes playback of all sound types.</summary>
  394. <remarks>This can be used to resume all sound type playback (some might have been paused by calling <see cref="M:Urho.Audio.PauseSoundType." /></remarks>
  395. </Docs>
  396. </Member>
  397. <Member MemberName="ResumeSoundType">
  398. <MemberSignature Language="C#" Value="public void ResumeSoundType (string type);" />
  399. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResumeSoundType(string type) cil managed" />
  400. <MemberType>Method</MemberType>
  401. <AssemblyInfo>
  402. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  403. </AssemblyInfo>
  404. <ReturnValue>
  405. <ReturnType>System.Void</ReturnType>
  406. </ReturnValue>
  407. <Parameters>
  408. <Parameter Name="type" Type="System.String" />
  409. </Parameters>
  410. <Docs>
  411. <param name="type">The list of possible sound types are the strings “Master”, “Effect”, “Ambient”, “Voice” and “Music”.</param>
  412. <summary>Resumes playing back the sounds of the specific type.</summary>
  413. <remarks>To be added.</remarks>
  414. </Docs>
  415. </Member>
  416. <Member MemberName="SampleSize">
  417. <MemberSignature Language="C#" Value="public uint SampleSize { get; }" />
  418. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 SampleSize" />
  419. <MemberType>Property</MemberType>
  420. <AssemblyInfo>
  421. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  422. </AssemblyInfo>
  423. <ReturnValue>
  424. <ReturnType>System.UInt32</ReturnType>
  425. </ReturnValue>
  426. <Docs>
  427. <summary>
  428. Return byte size of one sample.
  429. </summary>
  430. <value>To be added.</value>
  431. <remarks>To be added.</remarks>
  432. </Docs>
  433. </Member>
  434. <Member MemberName="SetMasterGain">
  435. <MemberSignature Language="C#" Value="public void SetMasterGain (string type, float gain);" />
  436. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetMasterGain(string type, float32 gain) cil managed" />
  437. <MemberType>Method</MemberType>
  438. <AssemblyInfo>
  439. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  440. </AssemblyInfo>
  441. <ReturnValue>
  442. <ReturnType>System.Void</ReturnType>
  443. </ReturnValue>
  444. <Parameters>
  445. <Parameter Name="type" Type="System.String" />
  446. <Parameter Name="gain" Type="System.Single" />
  447. </Parameters>
  448. <Docs>
  449. <param name="type">To be added.</param>
  450. <param name="gain">To be added.</param>
  451. <summary>
  452. Set master gain on a specific sound type such as sound effects, music or voice.
  453. </summary>
  454. <remarks>To be added.</remarks>
  455. </Docs>
  456. </Member>
  457. <Member MemberName="SetMode">
  458. <MemberSignature Language="C#" Value="public bool SetMode (int bufferLengthMSec, int mixRate, bool stereo, bool interpolation);" />
  459. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetMode(int32 bufferLengthMSec, int32 mixRate, bool stereo, bool interpolation) cil managed" />
  460. <MemberType>Method</MemberType>
  461. <AssemblyInfo>
  462. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  463. </AssemblyInfo>
  464. <ReturnValue>
  465. <ReturnType>System.Boolean</ReturnType>
  466. </ReturnValue>
  467. <Parameters>
  468. <Parameter Name="bufferLengthMSec" Type="System.Int32" />
  469. <Parameter Name="mixRate" Type="System.Int32" />
  470. <Parameter Name="stereo" Type="System.Boolean" />
  471. <Parameter Name="interpolation" Type="System.Boolean" />
  472. </Parameters>
  473. <Docs>
  474. <param name="bufferLengthMSec">To be added.</param>
  475. <param name="mixRate">To be added.</param>
  476. <param name="stereo">To be added.</param>
  477. <param name="interpolation">To be added.</param>
  478. <summary>
  479. Initialize sound output with specified buffer length and output mode.
  480. </summary>
  481. <returns>To be added.</returns>
  482. <remarks>To be added.</remarks>
  483. </Docs>
  484. </Member>
  485. <Member MemberName="Stereo">
  486. <MemberSignature Language="C#" Value="public bool Stereo { get; }" />
  487. <MemberSignature Language="ILAsm" Value=".property instance bool Stereo" />
  488. <MemberType>Property</MemberType>
  489. <AssemblyInfo>
  490. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  491. </AssemblyInfo>
  492. <ReturnValue>
  493. <ReturnType>System.Boolean</ReturnType>
  494. </ReturnValue>
  495. <Docs>
  496. <summary>Determines whether output is stereo.</summary>
  497. <value>To be added.</value>
  498. <remarks>To be added.</remarks>
  499. </Docs>
  500. </Member>
  501. <Member MemberName="Stop">
  502. <MemberSignature Language="C#" Value="public void Stop ();" />
  503. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Stop() cil managed" />
  504. <MemberType>Method</MemberType>
  505. <AssemblyInfo>
  506. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  507. </AssemblyInfo>
  508. <ReturnValue>
  509. <ReturnType>System.Void</ReturnType>
  510. </ReturnValue>
  511. <Parameters />
  512. <Docs>
  513. <summary>
  514. Suspend sound output.
  515. </summary>
  516. <remarks>To be added.</remarks>
  517. </Docs>
  518. </Member>
  519. <Member MemberName="StopSound">
  520. <MemberSignature Language="C#" Value="public void StopSound (Urho.Audio.Sound sound);" />
  521. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void StopSound(class Urho.Audio.Sound sound) cil managed" />
  522. <MemberType>Method</MemberType>
  523. <AssemblyInfo>
  524. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  525. </AssemblyInfo>
  526. <ReturnValue>
  527. <ReturnType>System.Void</ReturnType>
  528. </ReturnValue>
  529. <Parameters>
  530. <Parameter Name="sound" Type="Urho.Audio.Sound" />
  531. </Parameters>
  532. <Docs>
  533. <param name="sound">To be added.</param>
  534. <summary>
  535. Stop any sound source playing a certain sound clip.
  536. </summary>
  537. <remarks>To be added.</remarks>
  538. </Docs>
  539. </Member>
  540. <Member MemberName="Type">
  541. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  542. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  543. <MemberType>Property</MemberType>
  544. <AssemblyInfo>
  545. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  546. </AssemblyInfo>
  547. <ReturnValue>
  548. <ReturnType>Urho.StringHash</ReturnType>
  549. </ReturnValue>
  550. <Docs>
  551. <summary>Urho's type system type.</summary>
  552. <value>StringHash representing the type for this C# type.</value>
  553. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  554. </Docs>
  555. </Member>
  556. <Member MemberName="TypeName">
  557. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  558. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  559. <MemberType>Property</MemberType>
  560. <AssemblyInfo>
  561. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  562. </AssemblyInfo>
  563. <ReturnValue>
  564. <ReturnType>System.String</ReturnType>
  565. </ReturnValue>
  566. <Docs>
  567. <summary>Urho's low-level type name.</summary>
  568. <value>Stringified low-level type name.</value>
  569. <remarks></remarks>
  570. </Docs>
  571. </Member>
  572. <Member MemberName="TypeNameStatic">
  573. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  574. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  575. <MemberType>Property</MemberType>
  576. <AssemblyInfo>
  577. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  578. </AssemblyInfo>
  579. <ReturnValue>
  580. <ReturnType>System.String</ReturnType>
  581. </ReturnValue>
  582. <Docs>
  583. <summary>Urho's low-level type name, accessible as a static method.</summary>
  584. <value>Stringified low-level type name.</value>
  585. <remarks></remarks>
  586. </Docs>
  587. </Member>
  588. <Member MemberName="TypeStatic">
  589. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  590. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  591. <MemberType>Property</MemberType>
  592. <AssemblyInfo>
  593. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  594. </AssemblyInfo>
  595. <ReturnValue>
  596. <ReturnType>Urho.StringHash</ReturnType>
  597. </ReturnValue>
  598. <Docs>
  599. <summary>Urho's low-level type, accessible as a static method.</summary>
  600. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  601. <remarks></remarks>
  602. </Docs>
  603. </Member>
  604. <Member MemberName="Update">
  605. <MemberSignature Language="C#" Value="public void Update (float timeStep);" />
  606. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Update(float32 timeStep) cil managed" />
  607. <MemberType>Method</MemberType>
  608. <AssemblyInfo>
  609. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  610. </AssemblyInfo>
  611. <ReturnValue>
  612. <ReturnType>System.Void</ReturnType>
  613. </ReturnValue>
  614. <Parameters>
  615. <Parameter Name="timeStep" Type="System.Single" />
  616. </Parameters>
  617. <Docs>
  618. <param name="timeStep">To be added.</param>
  619. <summary>To be added.</summary>
  620. <remarks>To be added.</remarks>
  621. </Docs>
  622. </Member>
  623. </Members>
  624. </Type>