ts3

package module

Go to main page

Versions in this module

v1

v1.3.0

Oct 26, 2026

Changes in this version

+ type DetailedOnlineClient struct

+ Away bool

+ AwayMessage string

+ Base64HashClientUID string

+ ChannelGroupID int

+ ChannelGroupInheritedChannelID int

+ ChannelID int

+ ConnectionBandwidthReceivedLastMinuteTotal uint64

+ ConnectionBandwidthReceivedLastSecondTotal uint64

+ ConnectionBandwidthSentLastMinuteTotal uint64

+ ConnectionBandwidthSentLastSecondTotal uint64

+ ConnectionBytesReceivedTotal uint64

+ ConnectionBytesSentTotal uint64

+ ConnectionClientIP string

+ ConnectionConnectedTime time.Duration

+ ConnectionFiletransferBandwidthReceived uint64

+ ConnectionFiletransferBandwidthSent uint64

+ ConnectionPacketsReceivedTotal uint64

+ ConnectionPacketsSentTotal uint64

+ Country string

+ Created time.Time

+ DatabaseID int

+ DefaultChannel string

+ DefaultToken string

+ Description string

+ FlagAvatar string

+ ID int

+ IconID uint32

+ IdleTime time.Duration

+ InputHardware bool

+ InputMuted bool

+ IsChannelCommander bool

+ IsPrioritySpeaker bool

+ IsRecording bool

+ IsTalker bool

+ LastConnected time.Time

+ LoginName string

+ MonthBytesDownloaded uint64

+ MonthBytesUploaded uint64

+ NeededServerQueryViewPower int

+ Nickname string

+ NicknamePhonetic string

+ OutputHardware bool

+ OutputMuted bool

+ OutputOnlyMuted bool

+ Platform string

+ SecurityHash string

+ ServerGroups []int

+ TalkPower int

+ TalkRequest time.Time

+ TalkRequestMsg string

+ TotalBytesDownloaded uint64

+ TotalBytesUploaded uint64

+ TotalConnections int

+ Type int

+ UniqueIdentifier string

+ Version string

+ VersionSign string

type ServerMethods

+ func (s *ServerMethods) ClientInfo(clientID int) (*DetailedOnlineClient, error)

v1.2.0

Feb 13, 2024

Changes in this version

+ const ClientAway

+ const ClientBadges

+ const ClientCountry

+ const ClientGroups

+ const ClientIP

+ const ClientIcon

+ const ClientInfo

+ const ClientListFull

+ const ClientTimes

+ const ClientUID

+ const ClientVoice

+ type OnlineClientExt struct

+ Badges *string

+ Country *string

+ IP *string

+ IconID *int

+ UniqueIdentifier *string

+ type OnlineClientGroups struct

+ ChannelGroupID *int

+ ChannelGroupInheritedChannelID *int

+ ServerGroups *[]int

+ type OnlineClientInfo struct

+ Platform *string

+ Version *string

+ type OnlineClientTimes struct

+ Created *int

+ IdleTime *int

+ LastConnected *int

+ type OnlineClientVoice struct

+ FlagTalking *bool

+ InputHardware *bool

+ InputMuted *bool

+ IsChannelCommander *bool

+ IsPrioritySpeaker *bool

+ IsRecording *bool

+ IsTalker *bool

+ OutputHardware *bool

+ OutputMuted *bool

+ TalkPower *int

v1.1.0

Jan 3, 2023

Changes in this version

+ const DefaultSSHPort

+ func SSH(config *ssh.ClientConfig) func(*Client) error

+ type Connection interface

+ Connect func(addr string, timeout time.Duration) error

v1.0.1

Oct 16, 2019

Changes in this version

+ const ClientDescription

+ const ClientIconID

+ const ClientIsChannelCommander

+ const ClientIsTalker

+ const ClientNickname

+ const DefaultConnectHeader

+ var DefaultKeepAlive = 200 * time.Second

+ var DefaultNotifyBufSize = 5

+ var ErrNotConnected = errors.New("not connected")

+ var ErrTimeout = errors.New("timeout")

+ func ConnectHeader(connectHeader string) func(*Client) error

+ func KeepAlive(keepAlive time.Duration) func(*Client) error

+ func NotificationBuffer(size int) func(*Client) error

type Client

+ func (c *Client) ClientUpdate(properties ...CmdArg) error

+ func (c *Client) IsConnected() bool

+ func (c *Client) Notifications() <-chan Notification

+ func (c *Client) Register(event NotifyCategory) error

+ func (c *Client) RegisterChannel(id uint) error

+ func (c *Client) SetChannelCommander(val bool) error

+ func (c *Client) SetDescription(description string) error

+ func (c *Client) SetIcon(id int) error

+ func (c *Client) SetNick(nick string) error

+ func (c *Client) SetTalker(val bool) error

+ func (c *Client) Unregister() error

+ type Notification struct

+ Data map[string]string

+ Type string

+ type NotifyCategory string

+ const ChannelEvents

+ const ServerEvents

+ const TextChannelEvents

+ const TextPrivateEvents

+ const TextServerEvents

+ const TokenUsedEvents

type OnlineClient

+ ChannelID int

type ServerConnectionInfo

+ BytesReceivedControl uint64

+ BytesReceivedKeepalive uint64

+ BytesReceivedSpeech uint64

+ BytesSentControl uint64

+ BytesSentKeepalive uint64

+ BytesSentSpeech uint64

+ PacketsReceivedControl uint64

+ PacketsReceivedKeepalive uint64

+ PacketsReceivedSpeech uint64

+ PacketsSentControl uint64

+ PacketsSentKeepalive uint64

+ PacketsSentSpeech uint64

v1.0.0

Apr 3, 2018

Changes in this version

+ const DefaultPort

+ const ExtendedServerList

+ const MaxParseTokenSize

+ var DefaultTimeout = time.Second * 10

+ var ErrInvalidConnectHeader = errors.New("invalid connect header")

+ var ErrNilOption = errors.New("nil option")

+ func Buffer(buf []byte, max int) func(*Client) error

+ func Decode(str string) string

+ func DecodeResponse(lines []string, v interface{}) error

+ func ScanLines(data []byte, atEOF bool) (advance int, token []byte, err error)

+ func Timeout(timeout time.Duration) func(*Client) error

+ type Arg struct

+ func NewArg(key string, val interface{}) *Arg

+ func (a *Arg) ArgString() string

+ type ArgGroup struct

+ func NewArgGroup(args ...CmdArg) *ArgGroup

+ func (ag *ArgGroup) ArgString() string

+ type ArgSet struct

+ func NewArgSet(args ...CmdArg) *ArgSet

+ func (ag *ArgSet) ArgString() string

+ type Channel struct

+ ChannelName string

+ ChannelOrder int

+ ID int

+ NeededSubscribePower int

+ ParentID int

+ TotalClients int

+ type Client struct

+ Server *ServerMethods

+ func NewClient(addr string, options ...func(c *Client) error) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) Exec(cmd string) ([]string, error)

+ func (c *Client) ExecCmd(cmd *Cmd) ([]string, error)

+ func (c *Client) Login(user, passwd string) error

+ func (c *Client) Logout() error

+ func (c *Client) Use(id int) error

+ func (c *Client) UsePort(port int) error

+ func (c *Client) Version() (*Version, error)

+ func (c *Client) Whoami() (*ConnectionInfo, error)

+ type Cmd struct

+ func NewCmd(cmd string) *Cmd

+ func (c *Cmd) String() string

+ func (c *Cmd) WithArgs(args ...CmdArg) *Cmd

+ func (c *Cmd) WithOptions(options ...string) *Cmd

+ func (c *Cmd) WithResponse(r interface{}) *Cmd

+ type CmdArg interface

+ ArgString func() string

+ type ConnectionInfo struct

+ ClientChannelID int

+ ClientDatabaseID int

+ ClientID int

+ ClientLoginName string

+ ClientName string

+ ClientOriginServerID int

+ ClientUniqueIdentifier string

+ ServerID int

+ ServerPort int

+ ServerStatus string

+ ServerUniqueIdentifier string

+ type CreatedServer struct

+ ID int

+ Port uint16

+ Token string

+ type DBClient struct

+ Connections int

+ Created time.Time

+ ID int

+ LastConnected time.Time

+ Nickname string

+ UniqueIdentifier string

+ type Error struct

+ Details map[string]interface{}

+ ID int

+ Msg string

+ func NewError(matches []string) *Error

+ func (e *Error) Error() string

+ type Group struct

+ ID int

+ IconID int

+ MemberAddPower int

+ MemberRemovePower int

+ ModifyPower int

+ Name string

+ NameMode int

+ Saved bool

+ SortID int

+ Type int

+ type Instance struct

+ DatabaseVersion int

+ FileTransferPort int

+ GuestServerQueryGroup int

+ MaxTotalDownloadBandwidth uint64

+ MaxTotalUploadBandwidth uint64

+ PendingConnectionsPerIP int

+ PermissionsVersion int

+ ServerQueryBanTime int

+ ServerQueryFloodCommands int

+ ServerQueryFloodTime int

+ TemplateChannelAdminGroup int

+ TemplateChannelDefaultGroup int

+ TemplateServerAdminGroup int

+ TemplateServerDefaultGroup int

+ type InvalidResponseError struct

+ Data []string

+ Reason string

+ func NewInvalidResponseError(reason string, lines []string) *InvalidResponseError

+ func (e *InvalidResponseError) Error() string

+ type OnlineClient struct

+ Away bool

+ AwayMessage string

+ DatabaseID int

+ ID int

+ Nickname string

+ Type int

+ type PrivilegeKey struct

+ Created int

+ Description string

+ ID1 int

+ ID2 int

+ Token string

+ Type int

+ type Server struct

+ AntiFloodPointsNeededCommandBlock int

+ AntiFloodPointsNeededIPBlock int

+ AntiFloodPointsTickReduce int

+ AskForPrivilegeKey bool

+ AutoStart bool

+ BandwidthReceivedLastMinuteTotal int

+ BandwidthReceivedLastSecondTotal int

+ BandwidthSentLastMinuteTotal int

+ BandwidthSentLastSecondTotal int

+ ChannelTempDeleteDelayDefault int

+ ChannelsOnline int

+ ClientsOnline int

+ CodecEncryptionMode int

+ ComplainAutoBanCount int

+ ComplainAutoBanTime int

+ ComplainRemoveTime int

+ Created int

+ DefaultChannelAdminGroup int

+ DefaultChannelGroup int

+ DefaultServerGroup int

+ FileBase string

+ FlagPassword bool

+ HostBannerGFXInterval int

+ HostBannerGFXURL string

+ HostBannerMode int

+ HostBannerURL string

+ HostButtonGFXURL string

+ HostButtonToolTip string

+ HostButtonURL string

+ HostMessage string

+ HostMessageMode int

+ ID int

+ IconID int

+ LogChannel bool

+ LogClient bool

+ LogFileTransfer bool

+ LogPermissions bool

+ LogQuery bool

+ LogServer bool

+ MachineID string

+ MaxClients int

+ MaxDownloadTotalBandwidth uint64

+ MaxUploadTotalBandwidth uint64

+ MinAndroidVersion int

+ MinClientVersion int

+ MinClientsInChannelBeforeForcedSilence int

+ MiniOSVersion int

+ MonthBytesDownloaded int64

+ MonthBytesUploaded int64

+ Name string

+ NamePhonetic string

+ NeededIdentitySecurityLevel int

+ Password string

+ Platform string

+ Port int

+ PrioritySpeakerDimmModificator float32

+ QueryClientsOnline int

+ ReservedSlots int

+ Status string

+ TotalBytesDownloaded int64

+ TotalBytesUploaded int64

+ TotalPacketLossControl float64

+ TotalPacketLossKeepalive float64

+ TotalPacketLossSpeech float64

+ TotalPacketLossTotal float64

+ TotalPing float32

+ UniqueIdentifier string

+ Uptime int

+ Version string

+ VirtualServerDownloadQuota uint64

+ VirtualServerUploadQuota uint64

+ WebListEnabled bool

+ WelcomeMessage string

+ type ServerConnectionInfo struct

+ BandwidthReceivedLastMinute uint64

+ BandwidthReceivedLastSecond uint64

+ BandwidthSentLastMinute uint64

+ BandwidthSentLastSecond uint64

+ BytesReceivedTotal uint64

+ BytesSentTotal uint64

+ ConnectedTime uint32

+ FileTransferBandwidthReceived uint64

+ FileTransferBandwidthSent uint64

+ FileTransferTotalReceived uint64

+ FileTransferTotalSent uint64

+ PacketLossTotalAvg float32

+ PacketsReceivedTotal uint64

+ PacketsSentTotal uint64

+ PingTotalAvg float32

+ type ServerMethods struct

+ func (s *ServerMethods) ChannelList() ([]*Channel, error)

+ func (s *ServerMethods) ClientDBList() ([]*DBClient, error)

+ func (s *ServerMethods) ClientList() ([]*OnlineClient, error)

+ func (s *ServerMethods) Create(name string, args ...CmdArg) (*CreatedServer, error)

+ func (s *ServerMethods) Delete(id int) error

+ func (s *ServerMethods) Edit(args ...CmdArg) error

+ func (s *ServerMethods) GroupList() ([]*Group, error)

+ func (s *ServerMethods) IDGetByPort(port uint16) (int, error)

+ func (s *ServerMethods) Info() (*Server, error)

+ func (s *ServerMethods) InstanceInfo() (*Instance, error)

+ func (s *ServerMethods) List(options ...string) (servers []*Server, err error)

+ func (s *ServerMethods) PrivilegeKeyAdd(ttype, id1, id2 int, options ...CmdArg) (string, error)

+ func (s *ServerMethods) PrivilegeKeyList() ([]*PrivilegeKey, error)

+ func (s *ServerMethods) ServerConnectionInfo() (*ServerConnectionInfo, error)

+ func (s *ServerMethods) Start(id int) error

+ func (s *ServerMethods) Stop(id int) error

+ type Version struct

+ Build int

+ Platform string

+ Version string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL