omni::audio::experimental

namespace experimental

The omni::audio namespace is part of an audio refresh that is still in the experimental stages.

This currently only contains the IAudioCapture interface, which was created to address a number of defects in carb::audio::IAudioCapture. IAudioCapture is currently in beta stage; the interface is complete and unlikely to change substantially but it has not been tested heavily in a real-world use case yet. The ABI of IAudioCapture and ICaptureStream are stable and will not be broken without a deprecation warning given in advance.

Classes

• omni::audio::experimental::IAudioCapture: Low-Level Audio Capture Plugin Interface.

• omni::audio::experimental::ICaptureStream: An individual audio capture stream.

• omni::audio::experimental::ICaptureStream_abi: An individual audio capture stream.

Enumerations

• omni::audio::experimental::CaptureInfoType: The reason that a CaptureInfoCallback was called.

Structs

• omni::audio::experimental::CaptureDeviceDesc: The parameters to use when opening a capture device.

• omni::audio::experimental::CaptureStreamDesc: The descriptor used to create a new ICaptureStream .

• omni::audio::experimental::Format: The minimal format needed to interpret an PCM audio stream.

Typedefs

• omni::audio::experimental::AudioResult: possible return values from various audio APIs.

• omni::audio::experimental::CaptureDataCallback: A callback that's used to receive audio data from an audio capture stream.

• omni::audio::experimental::CaptureDeviceFlags: Flags to indicate some additional behaviour of the device.

• omni::audio::experimental::CaptureInfoCallback: A callback that's used to signal capture stream events.

• omni::audio::experimental::CaptureStreamFlags: Flags to indicate some additional behaviour of the stream.

• omni::audio::experimental::CaptureStreamStartFlags: Flags that alter the behavior of ICaptureStream_abi::start_abi() .

• omni::audio::experimental::CaptureStreamStopFlags: Flags that alter the behavior of ICaptureStream_abi::stop_abi() .

• omni::audio::experimental::SampleFormat: the data type for a single sample of raw audio data.

• omni::audio::experimental::SoundFormat: provides information about the format of a sound.

• omni::audio::experimental::SpeakerMode: the base type for a set of speaker flag masks.

Unions

• omni::audio::experimental::CaptureInfoData: Extra data for CaptureInfoCallback .

Variables

• omni::audio::experimental::fCaptureStreamFlagLowLatency: Bypass the stream's capture buffer entirely to minimize audio capture latency as much as possible.

• omni::audio::experimental::fCaptureStreamStartFlagOneShot: This will cause recording to be stopped once the full buffer has been recorded.

• omni::audio::experimental::fCaptureStreamStopFlagSync: If this flag is passed, the call to ICaptureStream_abi::stop_abi() will block until the capture thread has stopped.