 | ConnectionCreateChannel Method |
Create a new Channel
Namespace:
TeamSpeak.Sdk.Client
Assembly:
TeamSpeak.Sdk (in TeamSpeak.Sdk.dll) Version: 0.1.6124.20226 (0.1.0.0)
Syntaxpublic Task<Channel> CreateChannel(
string name,
Channel parent,
string topic = null,
string description = null,
string password = null,
Channel order = null,
Nullable<bool> isPermanent = null,
Nullable<bool> isSemiPermanent = null,
Nullable<CodecType> codec = null,
Nullable<int> codecQuality = null,
Nullable<bool> codecIsUnencrypted = null,
Nullable<int> codecLatencyFactor = null
)
Public Function CreateChannel (
name As String,
parent As Channel,
Optional topic As String = Nothing,
Optional description As String = Nothing,
Optional password As String = Nothing,
Optional order As Channel = Nothing,
Optional isPermanent As Nullable(Of Boolean) = Nothing,
Optional isSemiPermanent As Nullable(Of Boolean) = Nothing,
Optional codec As Nullable(Of CodecType) = Nothing,
Optional codecQuality As Nullable(Of Integer) = Nothing,
Optional codecIsUnencrypted As Nullable(Of Boolean) = Nothing,
Optional codecLatencyFactor As Nullable(Of Integer) = Nothing
) As Task(Of Channel)
public:
Task<Channel^>^ CreateChannel(
String^ name,
Channel^ parent,
String^ topic = nullptr,
String^ description = nullptr,
String^ password = nullptr,
Channel^ order = nullptr,
Nullable<bool> isPermanent = nullptr,
Nullable<bool> isSemiPermanent = nullptr,
Nullable<CodecType> codec = nullptr,
Nullable<int> codecQuality = nullptr,
Nullable<bool> codecIsUnencrypted = nullptr,
Nullable<int> codecLatencyFactor = nullptr
)
member CreateChannel :
name : string *
parent : Channel *
?topic : string *
?description : string *
?password : string *
?order : Channel *
?isPermanent : Nullable<bool> *
?isSemiPermanent : Nullable<bool> *
?codec : Nullable<CodecType> *
?codecQuality : Nullable<int> *
?codecIsUnencrypted : Nullable<bool> *
?codecLatencyFactor : Nullable<int>
(* Defaults:
let _topic = defaultArg topic null
let _description = defaultArg description null
let _password = defaultArg password null
let _order = defaultArg order null
let _isPermanent = defaultArg isPermanent null
let _isSemiPermanent = defaultArg isSemiPermanent null
let _codec = defaultArg codec null
let _codecQuality = defaultArg codecQuality null
let _codecIsUnencrypted = defaultArg codecIsUnencrypted null
let _codecLatencyFactor = defaultArg codecLatencyFactor null
*)
-> Task<Channel>
Parameters
- name
- Type: SystemString
Name of the channel - parent
- Type: TeamSpeak.Sdk.ClientChannel
The parent channel - topic (Optional)
- Type: SystemString
Single-line channel topic - description (Optional)
- Type: SystemString
Channel description. Can have multiple lines. - password (Optional)
- Type: SystemString
Password for password-protected channels. - order (Optional)
- Type: TeamSpeak.Sdk.ClientChannel
the Channel after which the new Channel is sorted. meaning its going to be the first Channel under parent. - isPermanent (Optional)
- Type: SystemNullableBoolean
Permanent channels will be restored when the server restarts. - isSemiPermanent (Optional)
- Type: SystemNullableBoolean
Semi-permanent channels are not automatically deleted when the last user left but will not be restored when the server restarts. - codec (Optional)
- Type: SystemNullableCodecType
Codec used for this channel - codecQuality (Optional)
- Type: SystemNullableInt32
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 - codecIsUnencrypted (Optional)
- Type: SystemNullableBoolean
If true, this channel is not using encrypted voice data. If false, voice data is encrypted for this channel. - codecLatencyFactor (Optional)
- Type: SystemNullableInt32
Latency of this channel.
Return Value
Type:
TaskChannelA task that represents the asynchronous creation of the channel.
See Also