Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_session_set_participant_volume_for_me

Reference the Vivox Core SDK API.
Read time 1 minuteLast updated 16 days ago

Module: Group Voice and Text Communications Set the volume for a participant in the current session. More...
#include <VxcRequests.h>

Public Attributes

Name

vx_req_base_tbase
The common properties for all requests.
VX_HANDLEsession_handle
The handle returned from a successful [vx_req_sessiongroup_add_session] request.
char *participant_uri
The fully specified URI of the participant.
intvolume
The volume level that has been set by the user, which should not often change.

Detailed Description

struct vx_req_session_set_participant_volume_for_me;
Set the volume for a participant in the current session. See: vx_resp_session_set_participant_volume_for_me This only affects the audio that is heard locally, and does not change the audio that is heard by any of the other participants. These changes are only valid for the current session; if the participant with the audio that is set leaves the session and rejoins, then the settings are lost.

Public Attributes Documentation

variable base

vx_req_base_t base;
The common properties for all requests.

variable session_handle

VX_HANDLE session_handle;
The handle returned from a successful [vx_req_sessiongroup_add_session] request.

variable participant_uri

char * participant_uri;
The fully specified URI of the participant.

variable volume

int volume;
The volume level that has been set by the user, which should not often change. This is a non-negative integer value between 0 and 100 (inclusive). The default value is 50.