audio_module_input_device.h File Reference

Audio module input device. More...

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

Go to the source code of this file.

Typedefs
typedef struct otk_audio_module_input_device_enumerator	otc_audio_module_input_device_enumerator

Functions
otc_audio_module_input_device_enumerator *	otc_audio_module_input_device_enumerator_new ()
int	otc_audio_module_input_device_enumerator_size (otc_audio_module_input_device_enumerator *device_enumerator)
const char *	otc_audio_module_input_device_enumerator_get_device_id (otc_audio_module_input_device_enumerator *device_enumerator, int device_index)
const char *	otc_audio_module_input_device_enumerator_get_device_name (otc_audio_module_input_device_enumerator *device_enumerator, int device_index)
otc_status	otc_audio_module_input_device_enumerator_delete (otc_audio_module_input_device_enumerator *device_enumerator)
otc_status	otc_audio_module_input_device_select (const char *device_id)

Detailed Description

Audio module input device.

Typedef Documentation

otc_audio_module_input_device_enumerator

typedef struct otk_audio_module_input_device_enumerator otc_audio_module_input_device_enumerator

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

Function Documentation

otc_audio_module_input_device_enumerator_delete()

otc_status otc_audio_module_input_device_enumerator_delete

(

otc_audio_module_input_device_enumerator *

device_enumerator

)

Deletes an audio input device enumerator.

Parameters

device_enumerator

The audio input device enumerator.

Returns

The result of the operation. 0 if success.

otc_audio_module_input_device_enumerator_get_device_id()

const char* otc_audio_module_input_device_enumerator_get_device_id	(	otc_audio_module_input_device_enumerator *	device_enumerator,
		int	device_index
	)

Gets the ID of the specified audio input device from the audio input device enumerator.

Parameters

device_enumerator	The audio input device enumerator.
device_index	The index of the device in the enumeration.

Returns

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

otc_audio_module_input_device_enumerator_get_device_name()

const char* otc_audio_module_input_device_enumerator_get_device_name	(	otc_audio_module_input_device_enumerator *	device_enumerator,
		int	device_index
	)

Gets the name of the specified audio input device from audio input device enumerator.

Parameters

device_enumerator	The audio input device enumerator.
device_index	The index of the device in the enumeration.

Returns

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

otc_audio_module_input_device_enumerator_new()

otc_audio_module_input_device_enumerator* otc_audio_module_input_device_enumerator_new

(

)

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

Returns

The audio input device enumerator.

otc_audio_module_input_device_enumerator_size()

int otc_audio_module_input_device_enumerator_size

(

otc_audio_module_input_device_enumerator *

device_enumerator

)

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

Parameters

device_enumerator

The audio input device enumerator.

Returns

The number of audio input devices.

otc_audio_module_input_device_select()

otc_status otc_audio_module_input_device_select

(

const char *

device_id

)

Selects an audio input device in the default audio module.

Parameters

device_id

The ID of the audio input device.

Returns

The result of the operation. 0 if success.