Skip to content

DeviceDescription

struct DeviceDescription

The device description.

This stores the settings requested from the engine configuration and the actual settings provided by the device.

The device settings are filled after the Amplimix initialization, and are provided by the selected Driver.

Variables

Name Description
mDeviceName The device name.
mDeviceID The device ID.
mRequestedOutputFormat The requested device output format.
mDeviceOutputFormat The actual device format.
mRequestedOutputChannels The requested device output channel layout.
mDeviceOutputChannels The actual device channel layout.
mRequestedOutputSampleRate The requested device sample rate.
mDeviceOutputSampleRate The actual device sample rate.
mOutputBufferSize The device output buffer size.
mDeviceState The device state.

Variable Details

mDeviceID

AmObjectID mDeviceID

The device ID.

mDeviceName

AmString mDeviceName

The device name.

mDeviceOutputChannels

PlaybackOutputChannels mDeviceOutputChannels

The actual device channel layout.

mDeviceOutputFormat

PlaybackOutputFormat mDeviceOutputFormat

The actual device format.

mDeviceOutputSampleRate

AmUInt32 mDeviceOutputSampleRate

The actual device sample rate.

mDeviceState

DeviceState mDeviceState

The device state.

mOutputBufferSize

AmUInt32 mOutputBufferSize

The device output buffer size.

mRequestedOutputChannels

PlaybackOutputChannels mRequestedOutputChannels

The requested device output channel layout.

mRequestedOutputFormat

PlaybackOutputFormat mRequestedOutputFormat

The requested device output format.

mRequestedOutputSampleRate

AmUInt32 mRequestedOutputSampleRate

The requested device sample rate.