TeamTalk 4 C-API DLL  Version 4.5A
Channel Struct Reference

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

#include <TeamTalk4.h>

Public Attributes

INT32 nParentID
 Parent channel ID. 0 means no parent channel, i.e. it's the root channel. More...
 
INT32 nChannelID
 The channel's ID. A value from 1 - 65535. More...
 
TTCHAR szName [TT_STRLEN]
 Name of the channel. More...
 
TTCHAR szTopic [TT_STRLEN]
 Topic of the channel. More...
 
TTCHAR szPassword [TT_STRLEN]
 Password to join the channel. When extracted through TT_GetChannel the password will only be set for users of user-type USERTYPE_ADMIN. More...
 
BOOL bPassword
 Whether password is required to join channel. More...
 
ChannelTypes uChannelType
 A bitmask of the type of channel based on ChannelType. More...
 
INT64 nDiskQuota
 Number of bytes available for file storage. More...
 
TTCHAR szOpPassword [TT_STRLEN]
 Operator password, i.e. for use with '/opme' command. More...
 
INT32 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 TT_EnableDenoising() and TT_EnableAGC(). More...
 
INT32 voiceUsers [TT_VOICEUSERS_MAX]
 The IDs of users who are allowed to transmit voice data to the channel. This setting only applies to channels of type CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call TT_DoUpdateChannel to update the list of users who are allowed to transmit data to the channel. More...
 
INT32 videoUsers [TT_VIDEOUSERS_MAX]
 The IDs of users who are allowed to transmit video data to the channel. This setting only applies to channels of type CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call TT_DoUpdateChannel to update the list of users who are allowed to transmit data to the channel. More...
 
INT32 desktopUsers [TT_DESKTOPUSERS_MAX]
 The IDs of users who are allowed to share their desktop to the channel. This setting only applies to channels of type CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call TT_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
TT_GetChannel
ChannelType
AudioCodec

Member Data Documentation

INT32 Channel::nParentID

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

INT32 Channel::nChannelID

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

TTCHAR Channel::szName[TT_STRLEN]

Name of the channel.

TTCHAR Channel::szTopic[TT_STRLEN]

Topic of the channel.

TTCHAR Channel::szPassword[TT_STRLEN]

Password to join the channel. When extracted through TT_GetChannel the password will only be set for users of user-type USERTYPE_ADMIN.

BOOL Channel::bPassword

Whether password is required to join channel.

ChannelTypes Channel::uChannelType

A bitmask of the type of channel based on ChannelType.

INT64 Channel::nDiskQuota

Number of bytes available for file storage.

TTCHAR Channel::szOpPassword[TT_STRLEN]

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

See Also
USERRIGHT_CHANNEL_COMMANDS
INT32 Channel::nMaxUsers

Max number of users in channel.

AudioCodec Channel::codec

The audio codec used by users in the channel.

AudioConfig 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 TT_EnableDenoising() and TT_EnableAGC().

Note
Requires server and client version 4.1.0.1127 or later.
INT32 Channel::voiceUsers[TT_VOICEUSERS_MAX]

The IDs of users who are allowed to transmit voice data to the channel. This setting only applies to channels of type CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call TT_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
TT_IsChannelOperator
TT_DoChannelOp
TRANSMIT_AUDIO
TT_CLASSROOM_FREEFORALL
INT32 Channel::videoUsers[TT_VIDEOUSERS_MAX]

The IDs of users who are allowed to transmit video data to the channel. This setting only applies to channels of type CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call TT_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
TT_IsChannelOperator
TT_DoChannelOp
TRANSMIT_VIDEO
TT_CLASSROOM_FREEFORALL
INT32 Channel::desktopUsers[TT_DESKTOPUSERS_MAX]

The IDs of users who are allowed to share their desktop to the channel. This setting only applies to channels of type CHANNEL_CLASSROOM. Only channel operators and administrators are allowed to change the users who are allowed to transmit data to a channel. Call TT_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
TT_IsChannelOperator()
TT_DoChannelOp()
TT_SendDesktopWindow()
TT_CLASSROOM_FREEFORALL