Audio Devices

---

Classes

Types

Functions

Types Documentation

typedef vx_req_connector_mute_local_mic_t

typedef struct vx_req_connector_mute_local_mic vx_req_connector_mute_local_mic_t;

Mute or unmute the microphone. See: vx_resp_connector_mute_local_mic

typedef vx_req_connector_mute_local_speaker_t

typedef struct vx_req_connector_mute_local_speaker vx_req_connector_mute_local_speaker_t;

Mute or unmute the speaker (the render device of incoming audio). See: vx_resp_connector_mute_local_speaker Note: This setting applies universally to all connected audio sessions.

typedef vx_req_connector_get_local_audio_info_t

typedef struct vx_req_connector_get_local_audio_info vx_req_connector_get_local_audio_info_t;

Retrieve the current volume and mute status of the local render and capture devices. See: vx_resp_connector_get_local_audio_info

typedef vx_req_aux_get_render_devices_t

typedef struct vx_req_aux_get_render_devices vx_req_aux_get_render_devices_t;

Retrieve a list of audio render devices for the current computer. See: vx_resp_aux_get_render_devices Note: This list could be smaller than the list of all available render devices. Most machines have at least one audio render device. The application programmer can call this method without initializing the SDK or logging in (similar to the network connectivity methods).

typedef vx_req_aux_get_capture_devices_t

typedef struct vx_req_aux_get_capture_devices vx_req_aux_get_capture_devices_t;

Return a list of available audio capture devices. See: vx_resp_aux_get_capture_devices Note: This list could be smaller than the list of all available capture devices.

typedef vx_req_aux_set_render_device_t

typedef struct vx_req_aux_set_render_device vx_req_aux_set_render_device_t;

Instruct the Vivox SDK sound system to set the render device to a specific value. See: vx_resp_aux_set_render_device Note: On PlayStation 4, the render_device_specifier can be the string representation of the user ID. The "render device specifier" is a string that must match the device string of the vx_device_t structs that are returned from a "get render devices" call. This value is retained across various voice sessions.

typedef vx_req_aux_set_capture_device_t

typedef struct vx_req_aux_set_capture_device vx_req_aux_set_capture_device_t;

Instruct the Vivox SDK sound system to set the capture device to a specific value. See: vx_resp_aux_set_capture_device

typedef vx_req_aux_get_mic_level_t

typedef struct vx_req_aux_get_mic_level vx_req_aux_get_mic_level_t;

This method returns the master microphone (capture) level of the Vivox SDK sound system. See: vx_resp_aux_get_mic_level This is a non-negative integer value between 0 and 100 (inclusive). The scale is logarithmic, which means that a level increase of 6 represents a doubling in energy, and a level increase of 20 represents a ten-fold increase in energy. The default value is 50.

typedef vx_req_aux_get_speaker_level_t

typedef struct vx_req_aux_get_speaker_level vx_req_aux_get_speaker_level_t;

This method returns the master speaker (render) level of the Vivox SDK sound system. See: vx_resp_aux_get_speaker_level This is a non-negative integer value between 0 and 100 (inclusive). The scale is logarithmic, which means that a level increase of 6 represents a doubling in energy, and a level increase of 20 represents a ten-fold increase in energy. The default value is 50.

typedef vx_req_aux_set_mic_level_t

typedef struct vx_req_aux_set_mic_level vx_req_aux_set_mic_level_t;

Set the master microphone level of the Vivox SDK sound system. See: vx_resp_aux_set_mic_level Valid values are non-negative integers between 0 and 100 (inclusive). The default value is 50.

typedef vx_req_aux_set_speaker_level_t

typedef struct vx_req_aux_set_speaker_level vx_req_aux_set_speaker_level_t;

Set the master speaker level of the Vivox SDK sound system. See: vx_resp_aux_set_speaker_level Valid values are non-negative integers between 0 and 100 (inclusive). The default value is 50.

typedef vx_req_aux_render_audio_start_t

typedef struct vx_req_aux_render_audio_start vx_req_aux_render_audio_start_t;

Ensure that a specific selected render device is functioning properly. See: vx_resp_aux_render_audio_start The sound_file_path should point to a local directory path that contains a monaural .wav or .au sound file. If the loop value is set to 1, then the sound system plays the file in a continuous loop until the "render audio stop" method is called.

typedef vx_req_aux_get_vad_properties_t

typedef struct vx_req_aux_get_vad_properties vx_req_aux_get_vad_properties_t;

Get the connector VAD (Voice Activity Detector) properties. See: vx_req_aux_get_vad_properties

typedef vx_req_aux_set_vad_properties_t

typedef struct vx_req_aux_set_vad_properties vx_req_aux_set_vad_properties_t;

Set the connector VAD (Voice Activity Detector) properties. The following properties update when capture audio is active:

• vad_hangover
• vad_sensitivity
• vad_auto The vad_noise_floor property requires capture audio restart to update (for example, the update occurs after rejoining a voice channel). vx_req_aux_set_vad_properties

typedef vx_req_aux_get_derumbler_properties_t

typedef struct vx_req_aux_get_derumbler_properties vx_req_aux_get_derumbler_properties_t;

Get the derumbler (high-pass filter) properties. See: vx_req_aux_get_derumbler_properties

typedef vx_req_aux_set_derumbler_properties_t

typedef struct vx_req_aux_set_derumbler_properties vx_req_aux_set_derumbler_properties_t;

Set the derumbler (high-pass filter) properties. See: vx_req_aux_set_derumbler_properties

typedef vx_req_aux_render_audio_stop_t

typedef struct vx_req_aux_render_audio_stop vx_req_aux_render_audio_stop_t;

Immediately stop audio render playback. See: vx_resp_aux_render_audio_stop If no audio files are being played back, then the method immediately returns.

typedef vx_req_aux_capture_audio_start_t

typedef struct vx_req_aux_capture_audio_start vx_req_aux_capture_audio_start_t;

Ensure that a specific selected capture device is functioning properly. See: vx_resp_aux_capture_audio_start This can only be successfully invoked if the capture device is not currently in use (such as if it is in a voice session). After the start audio capture method successfully completes, the Vivox SDK sound system starts sending VxAudioEvent_t events at one half the capture frame rate.

typedef vx_req_aux_capture_audio_stop_t

typedef struct vx_req_aux_capture_audio_stop vx_req_aux_capture_audio_stop_t;

Immediately stop audio capture. See: vx_resp_aux_capture_audio_stop If no audio files are being played back, then the method immediately returns.

typedef vx_req_aux_global_monitor_keyboard_mouse_t

typedef struct vx_req_aux_global_monitor_keyboard_mouse vx_req_aux_global_monitor_keyboard_mouse_t;

See: vx_resp_aux_global_monitor_keyboard_mouse Note: On OSX, to use this feature, "Enable Access for Assistive Devices" must be enabled. Attention: This is not supported on the iPhone platform.

typedef vx_req_aux_set_idle_timeout_t

typedef struct vx_req_aux_set_idle_timeout vx_req_aux_set_idle_timeout_t;

See: vx_resp_aux_set_idle_timeout Note: Mouse movement events do not trigger the exit from idle condition. Attention: This is not supported on the iPhone platform.

typedef vx_resp_connector_mute_local_mic_t

typedef struct vx_resp_connector_mute_local_mic vx_resp_connector_mute_local_mic_t;

The response for vx_req_connector_mute_local_mic. See: vx_req_connector_mute_local_mic

typedef vx_resp_connector_mute_local_speaker_t

typedef struct vx_resp_connector_mute_local_speaker vx_resp_connector_mute_local_speaker_t;

The response for vx_req_connector_mute_local_speaker. See: vx_req_connector_mute_local_speaker

typedef vx_resp_connector_get_local_audio_info_t

typedef struct vx_resp_connector_get_local_audio_info vx_resp_connector_get_local_audio_info_t;

The response for vx_req_connector_get_local_audio_info. See: vx_req_connector_get_local_audio_info

typedef vx_resp_aux_get_render_devices_t

typedef struct vx_resp_aux_get_render_devices vx_resp_aux_get_render_devices_t;

The response for vx_req_aux_get_render_devices. See: vx_req_aux_get_render_devices

typedef vx_resp_aux_get_capture_devices_t

typedef struct vx_resp_aux_get_capture_devices vx_resp_aux_get_capture_devices_t;

The response for vx_req_aux_get_capture_devices. See: vx_req_aux_get_capture_devices

typedef vx_resp_aux_set_render_device_t

typedef struct vx_resp_aux_set_render_device vx_resp_aux_set_render_device_t;

The response for vx_req_aux_set_render_device. See: vx_req_aux_set_render_device

typedef vx_resp_aux_set_capture_device_t

typedef struct vx_resp_aux_set_capture_device vx_resp_aux_set_capture_device_t;

The response for vx_req_aux_set_capture_device. See: vx_req_aux_set_capture_device

typedef vx_resp_aux_get_mic_level_t

typedef struct vx_resp_aux_get_mic_level vx_resp_aux_get_mic_level_t;

The response for vx_req_aux_get_mic_level. See: vx_req_aux_get_mic_level

typedef vx_resp_aux_get_speaker_level_t

typedef struct vx_resp_aux_get_speaker_level vx_resp_aux_get_speaker_level_t;

The response for vx_req_aux_get_speaker_level. See: vx_req_aux_get_speaker_level

typedef vx_resp_aux_set_mic_level_t

typedef struct vx_resp_aux_set_mic_level vx_resp_aux_set_mic_level_t;

The response for vx_req_aux_set_mic_level. See: vx_req_aux_set_mic_level

typedef vx_resp_aux_set_speaker_level_t

typedef struct vx_resp_aux_set_speaker_level vx_resp_aux_set_speaker_level_t;

The response for vx_req_aux_set_speaker_level. See: vx_req_aux_set_speaker_level_t

typedef vx_resp_aux_render_audio_start_t

typedef struct vx_resp_aux_render_audio_start vx_resp_aux_render_audio_start_t;

The response for vx_req_aux_render_audio_start. See: vx_req_aux_render_audio_start

typedef vx_resp_aux_get_vad_properties_t

typedef struct vx_resp_aux_get_vad_properties vx_resp_aux_get_vad_properties_t;

The response for vx_req_aux_get_vad_properties. See: vx_req_aux_set_vad_properties

typedef vx_resp_aux_set_vad_properties_t

typedef struct vx_resp_aux_set_vad_properties vx_resp_aux_set_vad_properties_t;

The response for vx_req_aux_set_vad_properties. See: vx_req_aux_set_vad_properties

typedef vx_resp_aux_get_derumbler_properties_t

typedef struct vx_resp_aux_get_derumbler_properties vx_resp_aux_get_derumbler_properties_t;

The response for vx_req_aux_get_derumbler_properties. See: vx_req_aux_set_derumbler_properties

typedef vx_resp_aux_set_derumbler_properties_t

typedef struct vx_resp_aux_set_derumbler_properties vx_resp_aux_set_derumbler_properties_t;

The response for vx_req_aux_set_derumbler_properties. See: vx_req_aux_set_derumbler_properties

typedef vx_resp_aux_render_audio_stop_t

typedef struct vx_resp_aux_render_audio_stop vx_resp_aux_render_audio_stop_t;

The response for vx_req_aux_render_audio_stop. See: vx_req_aux_render_audio_stop

typedef vx_resp_aux_capture_audio_start_t

typedef struct vx_resp_aux_capture_audio_start vx_resp_aux_capture_audio_start_t;

The response for vx_req_aux_capture_audio_start. See: vx_req_aux_capture_audio_start

typedef vx_resp_aux_capture_audio_stop_t

typedef struct vx_resp_aux_capture_audio_stop vx_resp_aux_capture_audio_stop_t;

The response for vx_req_aux_capture_audio_stop. See: vx_req_aux_capture_audio_stop

typedef vx_resp_aux_global_monitor_keyboard_mouse_t

typedef struct vx_resp_aux_global_monitor_keyboard_mouse vx_resp_aux_global_monitor_keyboard_mouse_t;

The response for vx_req_aux_global_monitor_keyboard_mouse. See: vx_req_aux_global_monitor_keyboard_mouse

typedef vx_resp_aux_set_idle_timeout_t

typedef struct vx_resp_aux_set_idle_timeout vx_resp_aux_set_idle_timeout_t;

The response for vx_req_aux_set_idle_timeout. See: vx_req_aux_set_idle_timeout

typedef vx_evt_aux_audio_properties_t

typedef struct vx_evt_aux_audio_properties vx_evt_aux_audio_properties_t;

Used by the SDK sound system to present audio information to the application, which can be used to create a visual representation of the speaker (for example, a "VU" meter). These events are presented at one half the rate of the audio capture rate.

typedef vx_evt_keyboard_mouse_t

typedef struct vx_evt_keyboard_mouse vx_evt_keyboard_mouse_t;

Raised to indicate to the application that a particular keyboard/mouse button combination has been pressed or cleared. Attention: Not supported on the iPhone platform.

typedef vx_evt_idle_state_changed_t

typedef struct vx_evt_idle_state_changed vx_evt_idle_state_changed_t;

Raised to indicate to the application that the user has transitioned between an idle and non-idle state (in either order). Attention: Not supported on the iPhone platform.

Functions Documentation

function vx_req_connector_mute_local_mic_create

VIVOXSDK_DLLEXPORT int vx_req_connector_mute_local_mic_create(    vx_req_connector_mute_local_mic_t ** req)

Allocate and initialize a vx_req_connector_mute_local_mic object.

function vx_req_connector_mute_local_speaker_create

VIVOXSDK_DLLEXPORT int vx_req_connector_mute_local_speaker_create(    vx_req_connector_mute_local_speaker_t ** req)

Allocate and initialize a vx_req_connector_mute_local_speaker object.

function vx_req_connector_get_local_audio_info_create

VIVOXSDK_DLLEXPORT int vx_req_connector_get_local_audio_info_create(    vx_req_connector_get_local_audio_info_t ** req)

Allocate and initialize a vx_req_connector_get_local_audio_info object.

function vx_req_aux_get_render_devices_create

VIVOXSDK_DLLEXPORT int vx_req_aux_get_render_devices_create(    vx_req_aux_get_render_devices_t ** req)

Allocate and initialize a vx_req_aux_get_render_devices object.

function vx_req_aux_get_capture_devices_create

VIVOXSDK_DLLEXPORT int vx_req_aux_get_capture_devices_create(    vx_req_aux_get_capture_devices_t ** req)

Allocate and initialize a vx_req_aux_get_render_devices object.

function vx_req_aux_set_render_device_create

VIVOXSDK_DLLEXPORT int vx_req_aux_set_render_device_create(    vx_req_aux_set_render_device_t ** req)

Allocate and initialize a vx_req_aux_set_render_device object.

function vx_req_aux_set_capture_device_create

VIVOXSDK_DLLEXPORT int vx_req_aux_set_capture_device_create(    vx_req_aux_set_capture_device_t ** req)

Allocate and initialize a vx_req_aux_set_capture_device object.

function vx_req_aux_get_mic_level_create

VIVOXSDK_DLLEXPORT int vx_req_aux_get_mic_level_create(    vx_req_aux_get_mic_level_t ** req)

Allocate and initialize a vx_req_aux_get_mic_level object.

function vx_req_aux_get_speaker_level_create

VIVOXSDK_DLLEXPORT int vx_req_aux_get_speaker_level_create(    vx_req_aux_get_speaker_level_t ** req)

Allocate and initialize a vx_req_aux_get_speaker_level object.

function vx_req_aux_set_mic_level_create

VIVOXSDK_DLLEXPORT int vx_req_aux_set_mic_level_create(    vx_req_aux_set_mic_level_t ** req)

Allocate and initialize a vx_req_aux_set_mic_level object.

function vx_req_aux_set_speaker_level_create

VIVOXSDK_DLLEXPORT int vx_req_aux_set_speaker_level_create(    vx_req_aux_set_speaker_level_t ** req)

Allocate and initialize a vx_req_aux_set_speaker_level object.

function vx_req_aux_render_audio_start_create

VIVOXSDK_DLLEXPORT int vx_req_aux_render_audio_start_create(    vx_req_aux_render_audio_start_t ** req)

Allocate and initialize a vx_req_aux_render_audio_start object.

function vx_req_aux_get_vad_properties_create

VIVOXSDK_DLLEXPORT int vx_req_aux_get_vad_properties_create(    vx_req_aux_get_vad_properties_t ** req)

Allocate and initialize a vx_req_aux_get_vad_properties object.

function vx_req_aux_set_vad_properties_create

VIVOXSDK_DLLEXPORT int vx_req_aux_set_vad_properties_create(    vx_req_aux_set_vad_properties_t ** req)

Allocate and initialize a vx_req_aux_set_vad_properties object.

function vx_req_aux_get_derumbler_properties_create

VIVOXSDK_DLLEXPORT int vx_req_aux_get_derumbler_properties_create(    vx_req_aux_get_derumbler_properties_t ** req)

Allocate and initialize a vx_req_aux_get_derumbler_properties object.

function vx_req_aux_set_derumbler_properties_create

VIVOXSDK_DLLEXPORT int vx_req_aux_set_derumbler_properties_create(    vx_req_aux_set_derumbler_properties_t ** req)

Allocate and initialize a vx_req_aux_set_derumbler_properties object.

function vx_req_aux_render_audio_stop_create

VIVOXSDK_DLLEXPORT int vx_req_aux_render_audio_stop_create(    vx_req_aux_render_audio_stop_t ** req)

Allocate and initialize a vx_req_aux_render_audio_stop object.

function vx_req_aux_capture_audio_start_create

VIVOXSDK_DLLEXPORT int vx_req_aux_capture_audio_start_create(    vx_req_aux_capture_audio_start_t ** req)

Allocate and initialize a vx_req_aux_capture_audio_start object.

function vx_req_aux_capture_audio_stop_create

VIVOXSDK_DLLEXPORT int vx_req_aux_capture_audio_stop_create(    vx_req_aux_capture_audio_stop_t ** req)

Allocate and initialize a vx_req_aux_capture_audio_stop object.

function vx_req_aux_global_monitor_keyboard_mouse_create

VIVOXSDK_DLLEXPORT int vx_req_aux_global_monitor_keyboard_mouse_create(    vx_req_aux_global_monitor_keyboard_mouse_t ** req)

Allocate and initialize a vx_req_aux_global_monitor_keyboard_mouse object. Attention: This is not supported on the iPhone platform.

function vx_req_aux_set_idle_timeout_create

VIVOXSDK_DLLEXPORT int vx_req_aux_set_idle_timeout_create(    vx_req_aux_set_idle_timeout_t ** req)

Allocate and initialize a vx_req_aux_set_idle_timeout object. Attention: This is not supported on the iPhone platform.