![]() | Channel Properties |
The Channel type exposes the following members.
Name | Description | |
---|---|---|
![]() | ChannelEmptyTime |
Time since the last client has left a temporary channel
|
![]() | Channels |
List of all subchannels in the channel
|
![]() | Clients |
List of all clients in the channel, if the channel is currently subscribed.
|
![]() | Codec |
Codec used for this channel
|
![]() | CodecIsUnencrypted |
If true, this channel is not using encrypted voice data. If false, voice data is encrypted for this channel.
|
![]() | CodecLatencyFactor |
Latency of this channel.
|
![]() | CodecQuality |
Quality of channel codec of this channel. Valid values range from 0 to 10, default is 7. Higher values result in better speech quality but more bandwidth usage
|
![]() | Connection |
Server Connection
|
![]() | DeleteDelay |
This parameter defines how many seconds the server waits until a temporary channel is deleted when empty.
When a temporary channel is created, a timer is started. If a user joins the channel before the countdown is finished, the channel is not deleted. After the last person has left the channel, the countdown starts again. DeleteDelay defines the length of this countdown in seconds.
The time since the last client has left the temporary channel can be queried with ts3client_getChannelEmptySecs.
|
![]() | Description |
Optional channel description. Can have multiple lines. Needs to be request with GetChannelDescription.
|
![]() | ID |
ID of the channel
|
![]() | IsDefault |
Channel is the default channel. There can only be one default channel per server. New users who did not configure a channel to join on login in ts3client_startConnection will automatically join the default channel.
|
![]() | IsPasswordProtected |
If set, channel is password protected. The password itself is stored in ChannelPassword
|
![]() | IsPermanent |
Permanent channels will be restored when the server restarts.
|
![]() | IsSemiPermanent |
Semi-permanent channels are not automatically deleted when the last user left but will not be restored when the server restarts.
|
![]() | MaxClients |
Number of maximum clients who can join this channel
|
![]() | MaxFamilyClients |
Number of maximum clients who can join this channel and all subchannels
|
![]() | Name |
Name of the channel
|
![]() | Order | |
![]() | Parent |
The parent channel
|
![]() | Password |
Optional password for password-protected channels.
|
![]() | Topic |
Single-line channel topic
|