vx_req_channel_mute_user
Learn about voice channels in Vivox Core.
読み終わるまでの所要時間 2 分最終更新 8ヶ月前
Mute or unmute a participant in a specific 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 where the muting occurs. |
| char * | participant_uri The URI of the participant to mute or unmute. |
| int | set_muted Set to 1 to mute the user. |
| vx_mute_scope | scope The scope of the mute command. |
| char * | access_token A Vivox Access Token to authorize the operation. |
Detailed Description
struct vx_req_channel_mute_user;
Mute or unmute a participant in a specific channel.
Note: This request is only valid if the account making the request has moderator privileges on the target channel.
This request mutes or unmutes the user for all users in the channel.
Public Attributes Documentation
variable base
vx_req_base_t base;
The common properties for all requests.
variable account_handle
VX_HANDLE account_handle;
The handle returned from a successful vx_req_account_anonymous_login request.
variable channel_name
char * channel_name;
Deprecated:
This field is ignored. The name of the channel.
variable channel_uri
char * channel_uri;
The URI of the channel where the muting occurs.
variable participant_uri
char * participant_uri;
The URI of the participant to mute or unmute.
variable set_muted
int set_muted;
Set to 1 to mute the user.
Set to 0 to unmute the user. The default value is 0.
variable scope
vx_mute_scope scope;
The scope of the mute command.
The default setting is mute_scope_all.
variable access_token
char * access_token;
A Vivox Access Token to authorize the operation.