Enum ChannelProperties

#[repr(C)]
pub enum ChannelProperties {
    Name = 0,
    Topic = 1,
    Description = 2,
    Password = 3,
    Codec = 4,
    CodecQuality = 5,
    MaxClients = 6,
    MaxFamilyClients = 7,
    Order = 8,
    FlagPermanent = 9,
    FlagSemiPermanent = 10,
    FlagDefault = 11,
    FlagPassword = 12,
    CodecLatencyFactor = 13,
    CodecIsUnencrypted = 14,
    SecuritySalt = 15,
    DeleteDelay = 16,
    UniqueIdentifier = 17,
    Dummy3 = 18,
    Dummy4 = 19,
    Dummy5 = 20,
    Dummy6 = 21,
    Dummy7 = 22,
    FlagMaxClientsUnlimited = 23,
    FlagMaxFamilyClientsUnlimited = 24,
    FlagMaxFamilyClientsInherited = 25,
    FlagAreSubscribed = 26,
    Filepath = 27,
    NeededTalkPower = 28,
    ForcedSilence = 29,
    NamePhonetic = 30,
    IconId = 31,
    BannerGfxUrl = 32,
    BannerMode = 33,
    PermissionHints = 34,
    StorageQuota = 35,
    Endmarker = 36,
    DeleteDelayDeadline = 127,
}

Variants

Name = 0

String. Read/Write. Name of the channel. Always available.

Topic = 1

String. Read/Write. Short single line text describing what the channel is about. Always available.

Description = 2

String. Read/Write. Arbitrary text (up to 8k bytes) with information about the channel. Must be requested (ts3client_requestChannelDescription)

Password = 3

String. Read/Write. Password of the channel. Read access is limited to the server. Clients will only ever see the last password they attempted to use when joining the channel. Always available.

Codec = 4

Integer. Read/Write. The codec this channel is using. One of the values from the CodecType enum. Always available.

CodecQuality = 5

Integer. Read/Write. The quality setting of the channel. Valid values are 0 to 10 inclusive. Higher value means better voice quality but also more bandwidth usage. Always available.

MaxClients = 6

Integer. Read/Write. The number of clients that can be in the channel simultaneously. Always available.

MaxFamilyClients = 7

Integer. Read/Write. The total number of clients that can be in this channel and all sub channels of this channel. Always available.

Order = 8

UInt64. Read/Write. The ID of the channel below which this channel should be displayed. If 0 the channel is sorted at the top of the current level. Always available.

FlagPermanent = 9

Integer. Read/Write. Boolean (1/0) indicating whether the channel remains when empty. Permanent channels are stored to the database and available after server restart. SDK users will need to take care of restoring channel at server start on their own. Mutually exclusive with CHANNEL_FLAG_SEMI_PERMANENT. Always available.

FlagSemiPermanent = 10

Integer. Read/Write. Boolean (1/0) indicating whether the channel remains when empty. Semi permanent channels are not stored to disk and gone after server restart but remain while empty. Mutually exclusive with `CHANNEL_FLAG_PERMANENT.`` Always available.

FlagDefault = 11

Integer. Read/Write. Boolean (1/0). The default channel is the channel that all clients are located in when they join the server, unless the client explicitly specified a different channel when connecting and is allowed to join their preferred channel. Only one channel on the server can have this flag set. The default channel must have CHANNEL_FLAG_PERMANENT set. Always available.

FlagPassword = 12

Integer. Read/Write. Boolean (1/0) indicating whether this channel is password protected. When removing or setting CHANNEL_PASSWORD you also need to adjust this flag.

CodecLatencyFactor = 13

(deprecated) Integer. Read/Write. Allows to increase packet size, reducing bandwith at the cost of higher latency of voice transmission. Valid values are 1-10 inclusive. 1 is the default and offers the lowest latency. Always available.

CodecIsUnencrypted = 14

Integer. Read/Write. Boolean (1/0). If 0 voice data is encrypted, if 1 the voice data is not encrypted. Only used if the server VIRTUALSERVER_CODEC_ENCRYPTION_MODE is set to CODEC_ENCRYPTION_PER_CHANNEL. Always available.

SecuritySalt = 15

String. Read/Write. SDK Only, not used by TeamSpeak. This channels security hash. When a client joins their CLIENT_SECURITY_HASH is compared to this value, to allow or deny the client access to the channel. Used to enforce clients joining the server with specific identity and CLIENT_META_DATA. See SDK Documentation about this feature for further details. Always available.

DeleteDelay = 16

UInt64. Read/Write. Number of seconds deletion of temporary channels is delayed after the last client leaves the channel. Channel is only deleted if empty when the delete delay expired. Always available.

UniqueIdentifier = 17

String. Read only. An identifier that uniquely identifies a channel. Available in Server >= 3.10.0

Dummy3 = 18

Rare properties

Dummy4 = 19

Dummy5 = 20

Dummy6 = 21

Dummy7 = 22

FlagMaxClientsUnlimited = 23

Available for all channels that are “in view”, always up-to-date

FlagMaxFamilyClientsUnlimited = 24

Available for all channels that are “in view”, always up-to-date

FlagMaxFamilyClientsInherited = 25

Available for all channels that are “in view”, always up-to-date

FlagAreSubscribed = 26

Only available client side, stores whether we are subscribed to this channel

Filepath = 27

Not available client side, the folder used for file-transfers for this channel

NeededTalkPower = 28

Available for all channels that are “in view”, always up-to-date

ForcedSilence = 29

Available for all channels that are “in view”, always up-to-date

NamePhonetic = 30

Available for all channels that are “in view”, always up-to-date

IconId = 31

Available for all channels that are “in view”, always up-to-date

BannerGfxUrl = 32

Available for all channels that are “in view”, always up-to-date

BannerMode = 33

Available for all channels that are “in view”, always up-to-date

PermissionHints = 34

StorageQuota = 35

Storage space that is allowed to be used by this channels files (in MiB)

Endmarker = 36

DeleteDelayDeadline = 127

(for clientlibv2) expected delete time in monotonic clock seconds or 0 if nothing is expected

Trait Implementations

impl Clone for ChannelProperties

fn clone(&self) -> ChannelProperties

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChannelProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ChannelProperties

fn eq(&self, other: &ChannelProperties) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ChannelProperties

impl Eq for ChannelProperties

impl StructuralPartialEq for ChannelProperties