#include <audiodev.h>

Data Fields
pjmedia_dir	dir

pjmedia_aud_dev_index	rec_id

pjmedia_aud_dev_index	play_id

unsigned	clock_rate

unsigned	channel_count

unsigned	samples_per_frame

unsigned	bits_per_sample

unsigned	flags

pjmedia_format	ext_fmt

unsigned	input_latency_ms

unsigned	output_latency_ms

unsigned	input_vol

unsigned	output_vol

pjmedia_aud_dev_route	input_route

pjmedia_aud_dev_route	output_route

pj_bool_t	ec_enabled

unsigned	ec_tail_ms

pj_bool_t	plc_enabled

pj_bool_t	cng_enabled

pj_bool_t	vad_enabled

Detailed Description

This structure specifies the parameters to open the audio stream.

Field Documentation

◆ dir

pjmedia_dir pjmedia_aud_param::dir

The audio direction. This setting is mandatory.

◆ rec_id

pjmedia_aud_dev_index pjmedia_aud_param::rec_id

The audio recorder device ID. This setting is mandatory if the audio direction includes input/capture direction.

◆ play_id

pjmedia_aud_dev_index pjmedia_aud_param::play_id

The audio playback device ID. This setting is mandatory if the audio direction includes output/playback direction.

◆ clock_rate

unsigned pjmedia_aud_param::clock_rate

Clock rate/sampling rate. This setting is mandatory.

◆ channel_count

unsigned pjmedia_aud_param::channel_count

Number of channels. This setting is mandatory.

◆ samples_per_frame

unsigned pjmedia_aud_param::samples_per_frame

Number of samples per frame. This setting is mandatory.

◆ bits_per_sample

unsigned pjmedia_aud_param::bits_per_sample

Number of bits per sample. This setting is mandatory.

◆ flags

unsigned pjmedia_aud_param::flags

This flags specifies which of the optional settings are valid in this structure. The flags is bitmask combination of pjmedia_aud_dev_cap.

◆ ext_fmt

pjmedia_format pjmedia_aud_param::ext_fmt

Set the audio format. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_EXT_FORMAT is set in the flags.

◆ input_latency_ms

unsigned pjmedia_aud_param::input_latency_ms

Input latency, in milliseconds. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_INPUT_LATENCY is set in the flags.

◆ output_latency_ms

unsigned pjmedia_aud_param::output_latency_ms

Input latency, in milliseconds. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_OUTPUT_LATENCY is set in the flags.

◆ input_vol

unsigned pjmedia_aud_param::input_vol

Input volume setting, in percent. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_INPUT_VOLUME_SETTING is set in the flags.

◆ output_vol

unsigned pjmedia_aud_param::output_vol

Output volume setting, in percent. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_OUTPUT_VOLUME_SETTING is set in the flags.

◆ input_route

pjmedia_aud_dev_route pjmedia_aud_param::input_route

Set the audio input route/source. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_INPUT_ROUTE/ PJMEDIA_AUD_DEV_CAP_INPUT_SOURCE is set in the flags.

◆ output_route

pjmedia_aud_dev_route pjmedia_aud_param::output_route

Set the audio output route. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_OUTPUT_ROUTE is set in the flags.

◆ ec_enabled

pj_bool_t pjmedia_aud_param::ec_enabled

Enable/disable echo canceller, if the device supports it. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_EC is set in the flags.

◆ ec_tail_ms

unsigned pjmedia_aud_param::ec_tail_ms

Set echo canceller tail length in milliseconds, if the device supports it. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_EC_TAIL is set in the flags.

◆ plc_enabled

pj_bool_t pjmedia_aud_param::plc_enabled

Enable/disable PLC. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_PLC is set in the flags.

◆ cng_enabled

pj_bool_t pjmedia_aud_param::cng_enabled

Enable/disable CNG. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_CNG is set in the flags.

◆ vad_enabled

pj_bool_t pjmedia_aud_param::vad_enabled

Enable/disable VAD. This setting is optional, and will only be used if PJMEDIA_AUD_DEV_CAP_VAD is set in the flags.

The documentation for this struct was generated from the following file:

pjmedia/audiodev.h

Data Fields