Enum ts3plugin_sys::public_definitions::ClientProperties

#[repr(C)]
pub enum ClientProperties {
    UniqueIdentifier,
    Nickname,
    Version,
    Platform,
    FlagTalking,
    InputMuted,
    OutputMuted,
    OutputOnlyMuted,
    InputHardware,
    OutputHardware,
    InputDeactivated,
    IdleTime,
    DefaultChannel,
    DefaultChannelPassword,
    ServerPassword,
    MetaData,
    IsMuted,
    IsRecording,
    VolumeModificator,
    VersionSign,
    SecurityHash,
    Dummy3,
    Dummy4,
    Dummy5,
    Dummy6,
    Dummy7,
    Dummy8,
    Dummy9,
    KeyOffset,
    LastVarRequest,
    LoginName,
    LoginPassword,
    DatabaseId,
    ChannelGroupId,
    Servergroups,
    Created,
    Lastconnected,
    Totalconnections,
    Away,
    AwayMessage,
    Type,
    FlagAvatar,
    TalkPower,
    TalkRequest,
    TalkRequestMsg,
    Description,
    IsTalker,
    MonthBytesUploaded,
    MonthBytesDownloaded,
    TotalBytesUploaded,
    TotalBytesDownloaded,
    IsPrioritySpeaker,
    UnreadMessages,
    NicknamePhonetic,
    NeededServerqueryViewPower,
    DefaultToken,
    IconId,
    IsChannelCommander,
    Country,
    ChannelGroupInheritedChannelId,
    Badges,
    Endmarker,
}

Variants

UniqueIdentifier

Automatically up-to-date for any client "in view", can be used to identify this particular client installation

Nickname

Automatically up-to-date for any client "in view"

Version

For other clients than ourself, this needs to be requested (=> requestClientVariables)

Platform

For other clients than ourself, this needs to be requested (=> requestClientVariables)

FlagTalking

Automatically up-to-date for any client that can be heard (in room / whisper)

InputMuted

Automatically up-to-date for any client "in view", this clients microphone mute status

OutputMuted

Automatically up-to-date for any client "in view", this clients headphones/speakers/mic combined mute status

OutputOnlyMuted

Automatically up-to-date for any client "in view", this clients headphones/speakers only mute status

InputHardware

Automatically up-to-date for any client "in view", this clients microphone hardware status (is the capture device opened?)

OutputHardware

Automatically up-to-date for any client "in view", this clients headphone/speakers hardware status (is the playback device opened?)

InputDeactivated

Only usable for ourself, not propagated to the network

IdleTime

Internal use

DefaultChannel

Only usable for ourself, the default channel we used to connect on our last connection attempt

DefaultChannelPassword

Internal use

ServerPassword

Internal use

MetaData

Automatically up-to-date for any client "in view", not used by TeamSpeak, free storage for sdk users

IsMuted

Only make sense on the client side locally, "1" if this client is currently muted by us, "0" if he is not

IsRecording

Automatically up-to-date for any client "in view"

VolumeModificator

Internal use

VersionSign

Sign

SecurityHash

SDK use, not used by teamspeak. Hash is provided by an outside source. A channel will use the security salt + other client data to calculate a hash, which must be the same as the one provided here.

Dummy3

Rare properties

Dummy4Dummy5Dummy6Dummy7Dummy8Dummy9KeyOffset

Internal use

LastVarRequest

Internal use

LoginName

Used for serverquery clients, makes no sense on normal clients currently

LoginPassword

Used for serverquery clients, makes no sense on normal clients currently

DatabaseId

Automatically up-to-date for any client "in view", only valid with PERMISSION feature, holds database client id

ChannelGroupId

Automatically up-to-date for any client "in view", only valid with PERMISSION feature, holds database client id

Servergroups

Automatically up-to-date for any client "in view", only valid with PERMISSION feature, holds all servergroups client belongs too

Created

This needs to be requested (=> requestClientVariables), first time this client connected to this server

Lastconnected

This needs to be requested (=> requestClientVariables), last time this client connected to this server

Totalconnections

This needs to be requested (=> requestClientVariables), how many times this client connected to this server

Away

Automatically up-to-date for any client "in view", this clients away status

AwayMessage

Automatically up-to-date for any client "in view", this clients away status

Type

Automatically up-to-date for any client "in view", determines if this is a real client or a server-query connection

FlagAvatar

Automatically up-to-date for any client "in view", this client got an avatar

TalkPower

Automatically up-to-date for any client "in view", only valid with PERMISSION feature, holds database client id

TalkRequest

Automatically up-to-date for any client "in view", only valid with PERMISSION feature, holds timestamp where client requested to talk

TalkRequestMsg

Automatically up-to-date for any client "in view", only valid with PERMISSION feature, holds matter for the request

Description

Automatically up-to-date for any client "in view"

IsTalker

Automatically up-to-date for any client "in view"

MonthBytesUploaded

This needs to be requested (=> requestClientVariables)

MonthBytesDownloaded

This needs to be requested (=> requestClientVariables)

TotalBytesUploaded

This needs to be requested (=> requestClientVariables)

TotalBytesDownloaded

This needs to be requested (=> requestClientVariables)

IsPrioritySpeaker

Automatically up-to-date for any client "in view"

UnreadMessages

Automatically up-to-date for any client "in view"

NicknamePhonetic

Automatically up-to-date for any client "in view"

NeededServerqueryViewPower

Automatically up-to-date for any client "in view"

DefaultToken

Only usable for ourself, the default token we used to connect on our last connection attempt

IconId

Automatically up-to-date for any client "in view"

IsChannelCommander

Automatically up-to-date for any client "in view"

Country

Automatically up-to-date for any client "in view"

ChannelGroupInheritedChannelId

Automatically up-to-date for any client "in view", only valid with PERMISSION feature, contains channel_id where the channel_group_id is set from

Badges

Automatically up-to-date for any client "in view", stores icons for partner badges

Endmarker

Trait Implementations

impl Debug for ClientProperties

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for ClientProperties

fn eq(&self, __arg_0: &ClientProperties) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for ClientProperties

impl Clone for ClientProperties

fn clone(&self) -> ClientProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ClientProperties