Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

audio_module_output_device.h File Reference

Audio module output device. More...

#include <stdlib.h>
#include "config.h"
#include "base.h"

Typedefs

typedef struct otk_audio_module_output_device_enumerator otc_audio_module_output_device_enumerator

Functions

otc_audio_module_output_device_enumerator * otc_audio_module_output_device_enumerator_new ()
int otc_audio_module_output_device_enumerator_size (otc_audio_module_output_device_enumerator *device_enumerator)
const char * otc_audio_module_output_device_enumerator_get_device_id (otc_audio_module_output_device_enumerator *device_enumerator, int device_index)
const char * otc_audio_module_output_device_enumerator_get_device_name (otc_audio_module_output_device_enumerator *device_enumerator, int device_index)
otc_status otc_audio_module_output_device_enumerator_delete (otc_audio_module_output_device_enumerator *device_enumerator)
otc_status otc_audio_module_output_device_select (const char *device_id)

Detailed Description

Audio module output device.

Typedef Documentation

◆ otc_audio_module_output_device_enumerator

typedef struct otk_audio_module_output_device_enumerator otc_audio_module_output_device_enumerator

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

Function Documentation

◆ otc_audio_module_output_device_enumerator_delete()

otc_status otc_audio_module_output_device_enumerator_delete ( otc_audio_module_output_device_enumerator *  device_enumerator)

Deletes an audio output device enumerator.

Parameters
device_enumeratorThe audio output device enumerator.
Returns
The result of the operation. 0 if success.

◆ otc_audio_module_output_device_enumerator_get_device_id()

const char* otc_audio_module_output_device_enumerator_get_device_id ( otc_audio_module_output_device_enumerator *  device_enumerator,
int  device_index 
)

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

Parameters
device_enumeratorThe audio output device enumerator.
device_indexThe 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()

const char* otc_audio_module_output_device_enumerator_get_device_name ( otc_audio_module_output_device_enumerator *  device_enumerator,
int  device_index 
)

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

Parameters
device_enumeratorThe audio output device enumerator.
device_indexThe 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_new()

otc_audio_module_output_device_enumerator* otc_audio_module_output_device_enumerator_new ( )

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()

int otc_audio_module_output_device_enumerator_size ( otc_audio_module_output_device_enumerator *  device_enumerator)

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

Parameters
device_enumeratorThe audio output device enumerator.
Returns
The number of audio output devices.

◆ otc_audio_module_output_device_select()

otc_status otc_audio_module_output_device_select ( const char *  device_id)

Selects an audio output device in the default audio module.

Parameters
device_idThe ID of the audio output device.
Returns
The result of the operation. 0 if success.