Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_aux_set_render_device

Reference the Vivox Core SDK API.
Read time 1 minuteLast updated 20 hours ago

Module: Audio Devices Instruct the Vivox SDK sound system to set the render device to a specific value. More...
#include <VxcRequests.h>

Public Attributes

Name

vx_req_base_tbase
The common properties for all requests.
char *render_device_specifier
A string specifier that is returned by a Get Render Devices call.
VX_HANDLEaccount_handle
An optional parameter that specifies the account handle of the user whose render device will be set.

Detailed Description

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

Public Attributes Documentation

variable base

vx_req_base_t base;
The common properties for all requests.

variable render_device_specifier

char * render_device_specifier;
A string specifier that is returned by a Get Render Devices call. Note:
  • This must be exactly the same as the device string of a vx_device_t object.
  • On PlayStation 4, this can be the string representation of the user ID. For example, "1", "2", "3", and so on.

variable account_handle

VX_HANDLE account_handle;
An optional parameter that specifies the account handle of the user whose render 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.