Synced
IAudioDevice
Section titled “IAudioDevice”
- Owns one replaceable audio backend generation and all device-side audio objects.
Required contracts
Section titled “Required contracts”API: engine
Implements: System.IDisposable
Project: Inno.Audio
Declaration
Section titled “Declaration”public interface Inno.Audio.IAudioDevice : System.IDisposableMembers
Section titled “Members”| Kind | Element | Description |
|---|---|---|
| Methods | IAudioDevice.AddBusProcessor | Appends one backend-neutral processor configuration to a bus chain. |
| Methods | IAudioDevice.CreateBus | Creates one bus routed to a parent bus. |
| Methods | IAudioDevice.CreateClip | Starts preparation of one decoded or streamed clip from immutable encoded content. |
| Methods | IAudioDevice.CreateListener | Creates one backend spatial listener. |
| Methods | IAudioDevice.DestroyBus | Releases one graph-generation bus after dependent objects have been removed. |
| Methods | IAudioDevice.DestroyClip | Releases one clip after all voices using it have ended. |
| Methods | IAudioDevice.DestroyListener | Releases one backend spatial listener. |
| Methods | IAudioDevice.GetClipState | Queries asynchronous clip preparation without blocking the owner thread. |
| Methods | IAudioDevice.Pause | Pauses a live voice. |
| Methods | IAudioDevice.Play | Creates and starts or schedules one playback voice. |
| Methods | IAudioDevice.Resume | Resumes a paused voice. |
| Methods | IAudioDevice.Seek | Moves a live voice cursor to a clip-relative position. |
| Methods | IAudioDevice.SetBusMuted | Updates mute state for one bus. |
| Methods | IAudioDevice.SetBusPaused | Updates pause state for one bus and its routed voices. |
| Methods | IAudioDevice.SetBusVolume | Updates linear gain for one bus. |
| Methods | IAudioDevice.SetListener | Updates one backend spatial listener. |
| Methods | IAudioDevice.SetVoiceParameters | Replaces mutable parameters for a live voice. |
| Methods | IAudioDevice.Stop | Stops a voice and makes its handle terminal. |
| Methods | IAudioDevice.TryDequeueCompletion | Tries to consume one terminal voice transition recorded by the backend. |
| Methods | IAudioDevice.TryGetVoiceState | Queries the current playback state for a voice. |
| Methods | IAudioDevice.Update | Advances backend maintenance at a main-thread safety point. |
| Properties | IAudioDevice.capabilities | Gets immutable capabilities for the active device generation. |
| Properties | IAudioDevice.dspTime | Gets the monotonic backend audio clock in seconds. |
| Properties | IAudioDevice.generation | Gets the non-zero generation used to reject stale handles. |
| Properties | IAudioDevice.state | Gets the current output availability state. |
| Properties | IAudioDevice.statistics | Gets current backend resource statistics. |