vx_channel
Learn about voice channels in Vivox Core.
Read time 4 minutesLast updated a day ago
Channel struct.
#include <Vxc.h>Public Attributes
Name | |
|---|---|
| char * | channel_name The name of the channel. |
| char * | channel_desc The description of the channel. |
| char * | host Not currently implemented. |
| int | channel_id |
| int | limit The maximum number of participants allowed in the channel. |
| int | capacity |
| char * | modified The date and time that the channel was modified. |
| char * | owner The URI of the channel owner. |
| char * | owner_user_name The user name of the channel owner. |
| int | is_persistent A flag that indicates whether the channel is persistent. |
| int | is_protected A flag that indicates whether the channel is password protected. |
| int | size |
| int | type Identifies this as a channel (0) or as a positional (2). |
| vx_channel_mode | mode The mode of the channel: none (0), normal (1), presentation (2), lecture (3), or open (4). |
| char * | channel_uri The URI of the channel. |
| int | max_range The distance beyond which a participant is considered "out of range." When a participant crosses this threshold distance from a particular listening position in a positional channel, a participant update event is fired, which results in an entry being added (or removed) from the user's speakers list. |
| int | clamping_dist The distance from the listener below which the "gain rolloff" effects for a given audio rolloff model are not applied. |
| double | roll_off Indicates how sharp the audio attenuation will "rolloff" between the clamping and maximum distances. |
| double | max_gain The (render side) loudness for all speakers in this channel. |
| int | dist_model The distance model for the channel. |
| int | encrypt_audio Indicates whether audio is encrypted. |
| char * | owner_display_name The display name of the channel owner. |
| int | active_participants The number of participants in the channel. |
Public Attributes Documentation
variable channel_name
The name of the channel.char * channel_name;
variable channel_desc
The description of the channel.char * channel_desc;
variable host
Not currently implemented.char * host;
variable channel_id
Deprecated: This is deprecated and should not be used. The numeric identifier of the channel.int channel_id;
variable limit
The maximum number of participants allowed in the channel.int limit;
variable capacity
Deprecated: This is deprecated and should not be used. The forecasted number of participants in the channel.int capacity;
variable modified
The date and time that the channel was modified.char * modified;
variable owner
The URI of the channel owner.char * owner;
variable owner_user_name
The user name of the channel owner.char * owner_user_name;
variable is_persistent
A flag that indicates whether the channel is persistent. If the channel is not persistent, then it is deleted automatically after a certain period of inactivity.int is_persistent;
variable is_protected
A flag that indicates whether the channel is password protected.int is_protected;
variable size
Deprecated: This is deprecated and should not be used.int size;
variable type
Identifies this as a channel (0) or as a positional (2).int type;
variable mode
The mode of the channel: none (0), normal (1), presentation (2), lecture (3), or open (4).vx_channel_mode mode;
variable channel_uri
The URI of the channel. Join the channel and perform moderator actions against the channel.char * channel_uri;
variable max_range
The distance beyond which a participant is considered "out of range." When a participant crosses this threshold distance from a particular listening position in a positional channel, a participant update event is fired, which results in an entry being added (or removed) from the user's speakers list. No audio is received for participants beyond this range. The default value is 60. This uses server defaults on create, and leaves existing values unchanged on update.int max_range;
variable clamping_dist
The distance from the listener below which the "gain rolloff" effects for a given audio rolloff model are not applied. This is effectively the "audio plateau" distance: gain is constant up to this distance, and then falls off. The default value is 3. This uses server defaults on create, and leaves existing values unchanged on update.int clamping_dist;
variable roll_off
Indicates how sharp the audio attenuation will "rolloff" between the clamping and maximum distances. Larger values result in steeper rolloffs. The extent of rolloff depends on the selected distance model. The default value is 1.1. This uses server defaults on create, and leaves existing values unchanged on update.double roll_off;
variable max_gain
The (render side) loudness for all speakers in this channel. Note: This is a receive side value, and in practice, should not be raised above a value such as 2.5. The default value is 1.7. This uses server defaults on create, and leaves existing values unchanged on update.double max_gain;
variable dist_model
The distance model for the channel. Note: If channel_type == dir, this does not apply. This tells the server which algorithm to use when computing attenuation. The audio from speakers abruptly drops to 0 at the maximum distance. There are four possible values in this field:int dist_model;
- 0 - None:
- No distance-based attenuation is applied. All speakers are rendered as if they were in the same position as the listener.
- 1 - Inverse Distance Clamped:
- The attenuation increases in inverse proportion to the distance. The rolloff factor n is the inverse of the slope of the attenuation curve.
- 2 - Linear Distance Clamped:
- The attenuation increases in linear proportion to the distance. The rolloff factor is the negative slope of the attenuation curve.
- 3 - Exponent Distance Clamped:
- The attenuation increases in inverse proportion to the distance raised to the power of the rolloff factor. The default audio model is 1 - Inverse Distance Clamped. This uses server defaults on create, and leaves existing values unchanged on update.
variable encrypt_audio
Indicates whether audio is encrypted.int encrypt_audio;
variable owner_display_name
The display name of the channel owner.char * owner_display_name;
variable active_participants
The number of participants in the channel.int active_participants;