Click or drag to resize
Channel Class
Represents a Channel on a TeamSpeak-Server
Inheritance Hierarchy
SystemObject
  TeamSpeak.Sdk.ClientChannel

Namespace:  TeamSpeak.Sdk.Client
Assembly:  TeamSpeak.Sdk (in TeamSpeak.Sdk.dll) Version: 0.1.6124.20226 (0.1.0.0)
Syntax
public class Channel : IEquatable<Channel>

The Channel type exposes the following members.

Constructors
  NameDescription
Public methodChannel
Creates a new Channel-Object.
Top
Properties
  NameDescription
Public propertyChannelEmptyTime
Time since the last client has left a temporary channel
Public propertyChannels
List of all subchannels in the channel
Public propertyClients
List of all clients in the channel, if the channel is currently subscribed.
Public propertyCodec
Codec used for this channel
Public propertyCodecIsUnencrypted
If true, this channel is not using encrypted voice data. If false, voice data is encrypted for this channel.
Public propertyCodecLatencyFactor
Latency of this channel.
Public propertyCodecQuality
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
Public propertyConnection
Server Connection
Public propertyDeleteDelay
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.
Public propertyDescription
Optional channel description. Can have multiple lines. Needs to be request with GetChannelDescription.
Public propertyID
ID of the channel
Public propertyIsDefault
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.
Public propertyIsPasswordProtected
If set, channel is password protected. The password itself is stored in ChannelPassword
Public propertyIsPermanent
Permanent channels will be restored when the server restarts.
Public propertyIsSemiPermanent
Semi-permanent channels are not automatically deleted when the last user left but will not be restored when the server restarts.
Public propertyMaxClients
Number of maximum clients who can join this channel
Public propertyMaxFamilyClients
Number of maximum clients who can join this channel and all subchannels
Public propertyName
Name of the channel
Public propertyOrder
Order is the Channel after which this channel is sorted. meaning its going to be the first Channel under Parent
Public propertyParent
The parent channel
Public propertyPassword
Optional password for password-protected channels.
Public propertyTopic
Single-line channel topic
Top
Methods
  NameDescription
Public methodCreateDirectory
Create a directory.
Public methodDelete
Removes the channel from the server
Public methodDeleteFile(String, String)
Deleting a remote files on the server
Public methodDeleteFile(String, String)
Delete one or more remote files on the server.
Public methodEquals(Object)
Indicates whether this instance and a specified object are equal.
(Overrides ObjectEquals(Object).)
Public methodEquals(Channel)
Indicates whether this instance and a another instance are equal.
Protected methodFinalize (Inherited from Object.)
Public methodGetChannelDescription
Request updating the channel description
Public methodGetFileInfo
Query information of a specified file. The answer from the server will trigger FileInfoReceived with the requested information.
Public methodGetFileList
Query list of files in a directory.
Public methodGetHashCode
Returns the hash code for this instance.
(Overrides ObjectGetHashCode.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodMoveFile(String, String, String)
Moves or renames a file. If the source and target paths are the same, the file will simply be renamed.
Public methodMoveFile(String, Channel, String, String, String)
Moves or renames a file. If the source and target channels and paths are the same, the file will simply be renamed.
Public methodMoveTo
Move the channel to a new parent channel
Public methodRequestFile(String, String, Boolean, Boolean, String)
Download a file from the server.
Public methodRequestFile(String, String, Boolean, Boolean, String, String)
Request downloading a file from the server.
Public methodRequestFile(String, String, Boolean, Boolean, String, CancellationToken)
Download a file from the server.
Public methodSendFile(String, Boolean, Boolean, String)
Uploads a local file to the server
Public methodSendFile(String, String, Boolean, Boolean, String)
Uploads a local file to the server
Public methodSendFile(String, String, Boolean, Boolean, String, String)
Request uploading a local file to the server
Public methodSendFile(String, String, Boolean, Boolean, String, CancellationToken)
Uploads a local file to the server
Public methodSendTextMessage
Send a text message to the channel
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Top
Operators
  NameDescription
Public operatorStatic memberEquality
Compares two Channel for equality.
Public operatorStatic memberInequality
Compares two Channel for inequality.
Top
See Also