vx_req_aux_set_capture_device
Reference the Vivox Core SDK API.
Read time 1 minuteLast updated 8 months ago
Module: Audio Devices
Instruct the Vivox SDK sound system to set the capture device to a specific value. More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| char * | capture_device_specifier A string specifier that is returned by a "get capture devices" call. |
| VX_HANDLE | account_handle An optional parameter that specifies the account handle of the user whose capture device will be set. |
Detailed Description
struct vx_req_aux_set_capture_device;
Instruct the Vivox SDK sound system to set the capture device to a specific value.
Public Attributes Documentation
variable base
vx_req_base_t base;
The common properties for all requests.
variable capture_device_specifier
char * capture_device_specifier;
A string specifier that is returned by a "get capture devices" call.
Note:
- This string must be exactly the same value as the device string of a vx_device_t object. This value is retained across various voice sessions. If this value is a nullptr or an empty string, then the default capture device is used.
- On PlayStation 4, this value can be the string representation of the user ID.
variable account_handle
VX_HANDLE account_handle;
An optional parameter that specifies the account handle of the user whose capture device will be set.
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.