Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_aux_capture_audio_start

Learn about audio management.
Read time 1 minuteLast updated a day ago

Module: Audio Devices Ensure that a specific selected capture device is functioning properly. More...
#include <VxcRequests.h>

Public Attributes

Name

vx_req_base_tbase
The common properties for all requests.
intduration
intloop_to_render_device
Loop audio to the selected render device.
VX_HANDLEaccount_handle
An optional parameter that specifies the account handle of the user whose capture device will be used.

Detailed Description

struct vx_req_aux_capture_audio_start;
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.

Public Attributes Documentation

variable base

vx_req_base_t base;
The common properties for all requests.

variable duration

int duration;
Deprecated: This is deprecated and should not be used.

variable loop_to_render_device

int loop_to_render_device;
Loop audio to the selected render device. The default value is 0. To loop audio to a speaker, set this to 1.

variable account_handle

VX_HANDLE account_handle;
An optional parameter that specifies the account handle of the user whose capture device will be used. This must either be unset or the account_handle that was passed in to a vx_req_account_anonymous_login request that previously succeeded. If unset, the default account_handle is used.