Audio.xml 28 KB

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