Class TeamSpeak3

Namespace

OpenGSQ.Protocols

Assembly

OpenGSQ.dll

TeamSpeak 3 Protocol

public class TeamSpeak3 : ProtocolBase

Inheritance

object

ProtocolBase

TeamSpeak3

Inherited Members

ProtocolBase.Host

ProtocolBase.Port

ProtocolBase.Timeout

ProtocolBase.GetIPAddress()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TeamSpeak3(string, int, int, int)

Initializes a new instance of the TeamSpeak3 class.

public TeamSpeak3(string host, int port, int voicePort, int timeout = 5000)

Parameters

host string

The host.

port int

The port.

voicePort int

The voice port.

timeout int

The timeout. Default is 5000.

Properties

FullName

Gets the full name of the protocol.

public override string FullName { get; }

Property Value

string

Methods

GetChannels()

Gets the channel list asynchronously.

public Task<List<Dictionary<string, string>>> GetChannels()

Returns

Task<List<Dictionary<string, string>>>

A task that represents the asynchronous operation. The task result contains the channel list.

Exceptions

TimeoutException

Thrown when the operation times out.

GetClients()

Gets the client list asynchronously.

public Task<List<Dictionary<string, string>>> GetClients()

Returns

Task<List<Dictionary<string, string>>>

A task that represents the asynchronous operation. The task result contains the client list.

Exceptions

TimeoutException

Thrown when the operation times out.

GetInfo()

Gets the server information asynchronously.

public Task<Dictionary<string, string>> GetInfo()

Returns

Task<Dictionary<string, string>>

A task that represents the asynchronous operation. The task result contains the server information.

Exceptions

TimeoutException

Thrown when the operation times out.