Interface IAudioChannel

Namespace

Kook

Assembly

Kook.Net.Core.dll

Represents a generic audio channel.

public interface IAudioChannel : IChannel, IEntity<ulong>

Inherited Members

IChannel.Name

IChannel.GetUsersAsync(CacheMode, RequestOptions)

IChannel.GetUserAsync(ulong, CacheMode, RequestOptions)

IEntity<ulong>.Id

Extension Methods

ChannelExtensions.GetChannelType(IChannel)

ChannelExtensions.GetJumpUrl(IChannel)

Properties

IsVoiceRegionOverwritten

Gets whether the voice region of this audio channel is overwritten.

bool? IsVoiceRegionOverwritten { get; }

Property Value

bool?

ServerUrl

Gets the server url that clients should connect to to join this voice channel.

string? ServerUrl { get; }

Property Value

string

A string representing the url that clients should connect to to join this voice channel.

VoiceRegion

Gets the voice region for this audio channel.

string? VoiceRegion { get; }

Property Value

string

Remarks

warning

This property may be empty if the voice channel is created before this feature was released.

Methods

ConnectAsync(bool, bool, string?)

Connects to this audio channel.

Task<IAudioClient?> ConnectAsync(bool external = false, bool disconnect = true, string? password = null)

Parameters

external bool

Determines whether the audio client is an external one or not.

disconnect bool

Determines whether the client should send a disconnect call before connecting to a new voice channel.

password string

The password to use when connecting to the audio channel.

Returns

Task<IAudioClient>

A task representing the asynchronous connection operation. The task result contains the IAudioClient responsible for the connection.

DisconnectAsync()

Disconnects from this audio channel.

Task DisconnectAsync()

Returns

Task

A task representing the asynchronous operation for disconnecting from the audio channel.