Synced
IAudioService
Section titled “IAudioService”
- Provides backend-neutral audio playback, caching, mixer, and device-state services.
Required contracts
Section titled “Required contracts”API: engine
Project: Inno.Audio
Declaration
Section titled “Declaration”public interface Inno.Audio.IAudioServiceMembers
Section titled “Members”| Kind | Element | Description |
|---|---|---|
| Methods | IAudioService.Pause | Pauses a live voice. |
| Methods | IAudioService.Play(Inno.Audio.AudioClipAsset) | Starts one clip using default playback parameters. |
| Methods | IAudioService.Play(Inno.Audio.AudioClipAsset,Inno.Audio.AudioPlayOptions) | Starts one clip using explicit playback parameters. |
| Methods | IAudioService.PlayScheduled | Schedules one clip against the monotonic audio clock. |
| Methods | IAudioService.PreloadAsync | Prepares a clip and retains it in the decoded or streamed cache. |
| Methods | IAudioService.ReleasePreload | Releases one explicit preload retention without interrupting active voices. |
| Methods | IAudioService.Resume | Resumes a paused voice. |
| Methods | IAudioService.Seek | Moves a live voice cursor to a clip-relative position. |
| Methods | IAudioService.SetBusMuted | Updates mute state for a semantic mixer bus. |
| Methods | IAudioService.SetBusPaused | Updates pause state for a semantic mixer bus. |
| Methods | IAudioService.SetBusVolume | Updates linear gain for a semantic mixer bus. |
| Methods | IAudioService.SetVoiceParameters | Replaces mutable parameters for a live voice. |
| Methods | IAudioService.Stop | Stops a live voice. |
| Methods | IAudioService.TryGetVoiceState | Queries the current state of a voice. |
| Properties | IAudioService.capabilities | Gets immutable capabilities for the current device generation. |
| Properties | IAudioService.deviceState | Gets the current audio output state. |
| Properties | IAudioService.dspTime | Gets the monotonic audio clock in seconds. |
| Properties | IAudioService.statistics | Gets current runtime and backend resource statistics. |