vx_channel#

Channel struct.

#include <Vxc.h>

Public Attributes#

Public Attributes Documentation#

variable channel_name#

char * channel_name;

The name of the channel.

variable channel_desc#

char * channel_desc;

The description of the channel.

variable host#

char * host;

Not currently implemented.

variable channel_id#

int channel_id;

Deprecated:

This is deprecated and should not be used. The numeric identifier of the channel.

variable limit#

int limit;

The maximum number of participants allowed in the channel.

variable capacity#

int capacity;

Deprecated:

This is deprecated and should not be used. The forecasted number of participants in the channel.

variable modified#

char * modified;

The date and time that the channel was modified.

variable owner#

char * owner;

The URI of the channel owner.

variable owner_user_name#

char * owner_user_name;

The user name of the channel owner.

variable is_persistent#

int 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.

variable is_protected#

int is_protected;

A flag that indicates whether the channel is password protected.

variable size#

int size;

Deprecated:

This is deprecated and should not be used.

variable type#

int type;

Identifies this as a channel (0) or as a positional (2).

variable mode#

vx_channel_mode mode;

The mode of the channel: none (0), normal (1), presentation (2), lecture (3), or open (4).

variable channel_uri#

char * channel_uri;

The URI of the channel.

Join the channel and perform moderator actions against the channel.

variable max_range#

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.

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.

variable clamping_dist#

int 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.

variable roll_off#

double 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.

variable max_gain#

double 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.

variable dist_model#

int 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:

• 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#

int encrypt_audio;

Indicates whether audio is encrypted.

variable owner_display_name#

char * owner_display_name;

The display name of the channel owner.

variable active_participants#

int active_participants;

The number of participants in the channel.