Channel Struct Reference
[Channel Properties]

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

#include <TeamTalk4.h>

List of all members.

Public Attributes

INT32 nParentID
 Parent channel ID. 0 means no parent channel, i.e. it's the root channel.
INT32 nChannelID
 The channel's ID. A value from 1 - 65535.
TTCHAR szName [TT_STRLEN]
 Name of the channel.
TTCHAR szTopic [TT_STRLEN]
 Topic of the channel.
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.
BOOL bPassword
 Whether password is required to join channel.
ChannelTypes uChannelType
 A bitmask of the type of channel based on ChannelType.
INT64 nDiskQuota
 Number of bytes available for file storage.
TTCHAR szOpPassword [TT_STRLEN]
 Operator password, i.e. for use with '/opme' command.
INT32 nMaxUsers
 Max number of users in channel.
AudioCodec codec
 The audio codec used by users in the channel.
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().
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.
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.
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.

Detailed Description

A struct containing the properties of a channel.

See also:
TT_GetChannel
ChannelType
AudioCodec

Member Data Documentation

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

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

TTCHAR Channel::szName[TT_STRLEN]

Name of the channel.

Topic of the channel.

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

Whether password is required to join channel.

A bitmask of the type of channel based on ChannelType.

Number of bytes available for file storage.

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

See also:
USERRIGHT_CHANNEL_COMMANDS

Max number of users in channel.

The audio codec used by users in the channel.

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
Generated on Sun Mar 18 17:18:33 2012 for TeamTalk 4 C-API DLL by  doxygen 1.6.3