vx_req_session_set_participant_mute_for_me
Learn how to mute individual participants.
Read time 1 minuteLast updated 14 days ago
Module: Group Voice and Text Communications Mute a participant in the current session. More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| VX_HANDLE | session_handle The handle returned from a successful [vx_req_sessiongroup_add_session] request. |
| char * | participant_uri The fully specified URI of the participant. |
| int | mute Indicate whether to mute or unmute the specified participant. |
| vx_mute_scope | scope The scope of the mute command. |
Detailed Description
Mute a participant in the current session. See: vx_resp_session_set_participant_mute_for_me Note: This command only applies to channels (3D and static), and is not applicable for person-to-person calls. 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.struct vx_req_session_set_participant_mute_for_me;
Public Attributes Documentation
variable base
The common properties for all requests.vx_req_base_t base;
variable session_handle
The handle returned from a successful [vx_req_sessiongroup_add_session] request.VX_HANDLE session_handle;
variable participant_uri
The fully specified URI of the participant.char * participant_uri;
variable mute
Indicate whether to mute or unmute the specified participant.int mute;
- 1 to mute
- 0 to unmute The default value is 0.
variable scope
The scope of the mute command. The default setting is mute_scope_all.vx_mute_scope scope;