vx_req_channel_mute_all_users
Learn about voice channels in Vivox Core.
Read time 1 minuteLast updated a day ago
Mute or unmute all current users in a channel. More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| VX_HANDLE | account_handle The handle returned from a successful vx_req_account_anonymous_login request. |
| char * | channel_name |
| char * | channel_uri The URI of the channel. |
| int | set_muted Set to 1 to mute. |
| vx_mute_scope | scope The scope of the mute command. |
| char * | access_token A Vivox Access Token to authorize the operation. |
Detailed Description
Mute or unmute all current users in a channel. See: vx_resp_channel_mute_all_users Note: New users who join the channel are not muted.struct vx_req_channel_mute_all_users;
Public Attributes Documentation
variable base
The common properties for all requests.vx_req_base_t base;
variable account_handle
The handle returned from a successful vx_req_account_anonymous_login request.VX_HANDLE account_handle;
variable channel_name
Deprecated: This field is ignored. The name of the channel.char * channel_name;
variable channel_uri
The URI of the channel.char * channel_uri;
variable set_muted
Set to 1 to mute. Set to 0 to unmute. The default value is 0.int set_muted;
variable scope
The scope of the mute command. The default setting is mute_scope_all.vx_mute_scope scope;
variable access_token
A Vivox Access Token to authorize the operation.char * access_token;