TeamTalk 4 .NET DLL  Version 4.5A
BearWare.Channel Struct Reference

A struct containing the properties of a channel. More...

Public Attributes

int nParentID
 Parent channel ID. 0 means no parent channel, i.e. it's the root channel. More...
 
int nChannelID
 The channel's ID. A value from 1 - 65535. More...
 
string szName
 Name of the channel. More...
 
string szTopic
 Topic of the channel. More...
 
string szPassword
 Password to join the channel. When extracted through TeamTalk4.GetChannel() the password will only be set for users of user-type UserType USERTYPE_ADMIN. More...
 
bool bPassword
 Whether password is required to join channel. More...
 
ChannelType uChannelType
 A bitmask of the type of channel based on ChannelType. More...
 
long nDiskQuota
 Number of bytes available for file storage. More...
 
string szOpPassword
 Operator password, i.e. for use with '/opme' command. More...
 
int nMaxUsers
 Max number of users in channel. More...
 
AudioCodec codec
 The audio codec used by users in the channel. More...
 
AudioConfig audiocfg
 The audio configuration which users who join the channel should use. If the audio configuration forces some options, e.g. AGC and denoising then these options will automatically be enabled and override what is currently set by TeamTalk4.EnableDenoising() and TeamTalk4.EnableAGC(). More...
 
int[] voiceUsers
 The IDs of users who are allowed to transmit voice data to the channel. This setting only applies to channels of type ChannelType CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call BearWare.TeamTalk4.DoUpdateChannel() to update the list of users who are allowed to transmit data to the channel. More...
 
int[] videoUsers
 The IDs of users who are allowed to transmit video data to the channel. This setting only applies to channels of type ChannelType CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call BearWare.TeamTalk4.DoUpdateChannel() to update the list of users who are allowed to transmit data to the channel. More...
 
int[] desktopUsers
 The IDs of users who are allowed to share their desktop to the channel. This setting only applies to channels of type ChannelType CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call TeamTalk4.DoUpdateChannel() to update the list of users who are allowed to transmit data to the channel. More...
 

Detailed Description

A struct containing the properties of a channel.

See Also
TeamTalk4.GetChannel
ChannelType
AudioCodec

Member Data Documentation

int BearWare.Channel.nParentID

Parent channel ID. 0 means no parent channel, i.e. it's the root channel.

int BearWare.Channel.nChannelID

The channel's ID. A value from 1 - 65535.

string BearWare.Channel.szName

Name of the channel.

string BearWare.Channel.szTopic

Topic of the channel.

string BearWare.Channel.szPassword

Password to join the channel. When extracted through TeamTalk4.GetChannel() the password will only be set for users of user-type UserType USERTYPE_ADMIN.

bool BearWare.Channel.bPassword

Whether password is required to join channel.

ChannelType BearWare.Channel.uChannelType

A bitmask of the type of channel based on ChannelType.

long BearWare.Channel.nDiskQuota

Number of bytes available for file storage.

string BearWare.Channel.szOpPassword

Operator password, i.e. for use with '/opme' command.

See Also
UserRight USERRIGHT_CHANNEL_COMMANDS
int BearWare.Channel.nMaxUsers

Max number of users in channel.

AudioCodec BearWare.Channel.codec

The audio codec used by users in the channel.

AudioConfig BearWare.Channel.audiocfg

The audio configuration which users who join the channel should use. If the audio configuration forces some options, e.g. AGC and denoising then these options will automatically be enabled and override what is currently set by TeamTalk4.EnableDenoising() and TeamTalk4.EnableAGC().

Note
Requires server and client version 4.1.0.1127 or later.
int [] BearWare.Channel.voiceUsers

The IDs of users who are allowed to transmit voice data to the channel. This setting only applies to channels of type ChannelType CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call BearWare.TeamTalk4.DoUpdateChannel() to update the list of users who are allowed to transmit data to the channel.

Note
Requires server version 4.1.0.994 or later.
See Also
TeamTalk4.IsChannelOperator
TeamTalk4.DoChannelOp
TransmitType.TRANSMIT_AUDIO
TeamTalk.TT_CLASSROOM_FREEFORALL
int [] BearWare.Channel.videoUsers

The IDs of users who are allowed to transmit video data to the channel. This setting only applies to channels of type ChannelType CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call BearWare.TeamTalk4.DoUpdateChannel() to update the list of users who are allowed to transmit data to the channel.

Note
Requires server version 4.1.0.994 or later.
See Also
TeamTalk4.IsChannelOperator
TeamTalk4.DoChannelOp
TransmitType.TRANSMIT_VIDEO
TeamTalk.TT_CLASSROOM_FREEFORALL
int [] BearWare.Channel.desktopUsers

The IDs of users who are allowed to share their desktop to the channel. This setting only applies to channels of type ChannelType CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call TeamTalk4.DoUpdateChannel() to update the list of users who are allowed to transmit data to the channel.

Note
Requires server version 4.3.0.1490 or later.
See Also
TeamTalk4.IsChannelOperator
TeamTalk4.DoChannelOp
TeamTalk4.SendDesktopWindow()
TeamTalk.TT_CLASSROOM_FREEFORALL