Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_connector_mute_local_speaker

Learn how to mute local speakers.
Read time 1 minuteLast updated 8 days ago

Module: Audio Devices Mute or unmute the speaker (the render device of incoming audio). More...
#include <VxcRequests.h>

Public Attributes

Name

vx_req_base_tbase
The common properties for all requests.
VX_HANDLEconnector_handle
The handle returned from a successful vx_req_connector_create request.
intmute_level
VX_HANDLEaccount_handle
An optional parameter that specifies the account handle of the user whose speaker will be muted or unmuted.

Detailed Description

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

Public Attributes Documentation

variable base

vx_req_base_t base;
The common properties for all requests.

variable connector_handle

VX_HANDLE connector_handle;
The handle returned from a successful vx_req_connector_create request.

variable mute_level

int mute_level;
  • Set to 1 to mute.
  • Set to 0 to unmute.

variable account_handle

VX_HANDLE account_handle;
An optional parameter that specifies the account handle of the user whose speaker will be muted or unmuted. 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 this is unset, then the default account_handle is used.