audio_module_output_device.h

Audio module output device.

Includes: stdlib.h, config.h, base.h

typedef otc_audio_module_output_device_enumerator

Represents an audio output device enumerator, listing the output devices detected by the default audio module.

typedef struct otc_audio_module_output_device_enumerator otc_audio_module_output_device_enumerator;

Functions

Name Description
otc_audio_module_output_device_enumerator_new() → {otc_audio_module_output_device_enumerator *} Creates an audio output device enumerator, listing the output devices detected by the default audio module.
otc_audio_module_output_device_enumerator_size(device_enumerator) → {int} Gets the number of audio output devices in an audio output device enumerator.
otc_audio_module_output_device_enumerator_get_device_id(device_enumerator, device_index) → {const char *} Gets the ID of the specified audio output device in an audio output device enumerator.
otc_audio_module_output_device_enumerator_get_device_name(device_enumerator, device_index) → {const char *} Gets the name of the specified audio output device in an audio output device enumerator.
otc_audio_module_output_device_enumerator_delete(device_enumerator) → {otc_status} Deletes an audio output device enumerator.
otc_audio_module_output_device_select(device_id) → {otc_status} Selects an audio output device in the default audio module.

otc_audio_module_output_device_enumerator_new() → {otc_audio_module_output_device_enumerator *}

Creates an audio output device enumerator, listing the output devices detected by the default audio module.

Returns:

The audio output device enumerator.

otc_audio_module_output_device_enumerator_size(device_enumerator) → {int}

Gets the number of audio output devices in an audio output device enumerator.

Parameters:
Name Type Description
device_enumerator otc_audio_module_output_device_enumerator * The audio output device enumerator.
Returns:

The number of audio output devices.

otc_audio_module_output_device_enumerator_get_device_id(device_enumerator, device_index) → {const char *}

Gets the ID of the specified audio output device in an audio output device enumerator.

Parameters:
Name Type Description
device_enumerator otc_audio_module_output_device_enumerator * The audio output device enumerator.
device_index int The index of the device in the enumeration.
Returns:

The ID of the device at selected index, or nullptr if the index is out of range.

otc_audio_module_output_device_enumerator_get_device_name(device_enumerator, device_index) → {const char *}

Gets the name of the specified audio output device in an audio output device enumerator.

Parameters:
Name Type Description
device_enumerator otc_audio_module_output_device_enumerator * The audio output device enumerator.
device_index int The index of the device in the enumeration.
Returns:

The name of the device at selected index, or nullptr if the index is out of range.

otc_audio_module_output_device_enumerator_delete(device_enumerator) → {otc_status}

Deletes an audio output device enumerator.

Parameters:
Name Type Description
device_enumerator otc_audio_module_output_device_enumerator * The audio output device enumerator.
Returns:

The result of the operation. 0 if success.

otc_audio_module_output_device_select(device_id) → {otc_status}

Selects an audio output device in the default audio module.

Parameters:
Name Type Description
device_id const char * The ID of the audio output device.
Returns:

The result of the operation. 0 if success.