TeamTalk 5 C-API DLL: Channel Struct Reference

TeamTalk 5 C-API DLL Version 5.18A

Loading...
Searching...
No Matches
Public Attributes | List of all members
Channel Struct Reference
Channel Properties

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

`#include <TeamTalk.h>`

## 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 - TT_CHANNELID_MAX.
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.
TTBOOL | bPassword
| Whether password is required to join channel. Read-only property.
ChannelTypes | uChannelType
| A bitmask of the type of channel based on ChannelType.
INT32 | nUserData
| User specific data which will be stored on persistent storage on the server if the channel type is CHANNEL_PERMANENT.
INT64 | nDiskQuota
| Number of bytes available for file storage.
TTCHAR | szOpPassword [TT_STRLEN]
| Password to become channel operator.
INT32 | nMaxUsers
| Max number of users in channel.
AudioCodec | audiocodec
| The audio codec used by users in the channel.
AudioConfig | audiocfg
| The audio configuration which users who join the channel should use.
INT32 | transmitUsers [TT_TRANSMITUSERS_MAX][2]
| List of users who can transmit in a channel.
INT32 | transmitUsersQueue [TT_TRANSMITQUEUE_MAX]
| The users currently queued for voice or media file transmission.
INT32 | nTransmitUsersQueueDelayMSec
| Delay for switching to next active voice user in `transmitUsersQueue`.
INT32 | nTimeOutTimerVoiceMSec
| Time out timer for voice stream. The maximum time in miliseconds a user can transmit voice without changing stream ID.
INT32 | nTimeOutTimerMediaFileMSec
| Time out timer for media file stream. The maximum time in miliseconds a user can transmit a media file.

## Detailed Description

A struct containing the properties of a channel.

To change the properties of a channel call TT_DoUpdateChannel(). Note that audiocodec cannot be changed if the channel has users.

See also
  TT_GetChannel
  ChannelType
  AudioCodec

Definition at line 2470 of file TeamTalk.h.

## Member Data Documentation

## ◆ nParentID

INT32 Channel::nParentID

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

Definition at line 2474 of file TeamTalk.h.

## ◆ nChannelID

INT32 Channel::nChannelID

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

Definition at line 2476 of file TeamTalk.h.

## ◆ szName

TTCHAR Channel::szName[TT_STRLEN]

Name of the channel.

Definition at line 2478 of file TeamTalk.h.

## ◆ szTopic

TTCHAR Channel::szTopic[TT_STRLEN]

Topic of the channel.

Definition at line 2480 of file TeamTalk.h.

## ◆ szPassword

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.

Definition at line 2484 of file TeamTalk.h.

## ◆ bPassword

TTBOOL Channel::bPassword

Whether password is required to join channel. Read-only property.

Definition at line 2487 of file TeamTalk.h.

## ◆ uChannelType

ChannelTypes Channel::uChannelType

A bitmask of the type of channel based on ChannelType.

Definition at line 2489 of file TeamTalk.h.

## ◆ nUserData

INT32 Channel::nUserData

User specific data which will be stored on persistent storage on the server if the channel type is CHANNEL_PERMANENT.

Definition at line 2493 of file TeamTalk.h.

## ◆ nDiskQuota

INT64 Channel::nDiskQuota

Number of bytes available for file storage.

Definition at line 2495 of file TeamTalk.h.

## ◆ szOpPassword

TTCHAR Channel::szOpPassword[TT_STRLEN]

Password to become channel operator.

See also
  TT_DoChannelOpEx()

Definition at line 2498 of file TeamTalk.h.

## ◆ nMaxUsers

INT32 Channel::nMaxUsers

Max number of users in channel.

Definition at line 2500 of file TeamTalk.h.

## ◆ audiocodec

AudioCodec Channel::audiocodec

The audio codec used by users in the channel.

Definition at line 2502 of file TeamTalk.h.

## ◆ audiocfg

AudioConfig Channel::audiocfg

The audio configuration which users who join the channel should use.

See also
  TT_SetSoundInputPreprocess()

Definition at line 2505 of file TeamTalk.h.

## ◆ transmitUsers

INT32 Channel::transmitUsers[TT_TRANSMITUSERS_MAX][2]

List of users who can transmit in a channel.

`transmitUsers` is a 2-dimensional array which specifies who can transmit to the channel.

If `uChannelType` is set to CHANNEL_CLASSROOM then only the users in `transmitUsers` are allowed to transmit.

In TeamTalk v5.4 and onwards adding a user ID to `transmitUsers` will block the user from transmitting if the ChannelType is not CHANNEL_CLASSROOM. Basically the opposite effect of CHANNEL_CLASSROOM.

To specify user ID 46 can transmit voice to a CHANNEL_CLASSROOM channel is done by assigning the following:

    * transmitUsers[0][0] = 46;
    * transmitUsers[0][1] = STREAMTYPE_VOICE;
    *

To specify user ID 46 can transmit both voice and video capture to a CHANNEL_CLASSROOM channel is done by assigning the following:

    * transmitUsers[0][0] = 46;
    * transmitUsers[0][1] = STREAMTYPE_VOICE | STREAMTYPE_VIDEOCAPTURE;
    *

The transmission list is terminated by assigning user ID 0 to the end of the list, i.e.:

    * transmitUsers[0][0] = 0;
    * transmitUsers[0][1] = STREAMTYPE_NONE;
    *

To allow all users of a CHANNEL_CLASSROOM channel to transmit a specific StreamType is done like this:

    * transmitUsers[0][0] = TT_CLASSROOM_FREEFORALL;
    * transmitUsers[0][1] = STREAMTYPE_VOICE;
    *

Only channel operators 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.

See also
  TT_IsChannelOperator
  TT_DoChannelOp
  TT_CLASSROOM_FREEFORALL

Definition at line 2561 of file TeamTalk.h.

## ◆ transmitUsersQueue

INT32 Channel::transmitUsersQueue[TT_TRANSMITQUEUE_MAX]

The users currently queued for voice or media file transmission.

This property only applied when channel is configured with CHANNEL_SOLO_TRANSMIT. Read-only property.

Definition at line 2566 of file TeamTalk.h.

## ◆ nTransmitUsersQueueDelayMSec

INT32 Channel::nTransmitUsersQueueDelayMSec

Delay for switching to next active voice user in `transmitUsersQueue`.

In channels of type CHANNEL_SOLO_TRANSMIT only one user can transmit voice. When user has stopped transmitting this value specifies the delay before switching to next user in `transmitUsersQueue`. Default value is 500 msec.

Definition at line 2574 of file TeamTalk.h.

## ◆ nTimeOutTimerVoiceMSec

INT32 Channel::nTimeOutTimerVoiceMSec

Time out timer for voice stream. The maximum time in miliseconds a user can transmit voice without changing stream ID.

See also
  STREAMTYPE_VOICE

Definition at line 2578 of file TeamTalk.h.

## ◆ nTimeOutTimerMediaFileMSec

INT32 Channel::nTimeOutTimerMediaFileMSec

Time out timer for media file stream. The maximum time in miliseconds a user can transmit a media file.

See also
  STREAMTYPE_MEDIAFILE_AUDIO

Definition at line 2582 of file TeamTalk.h.