Audio.xml 28 KB

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