Table of Contents

Interface IAudioChannel

Namespace
Kook
Assembly
Kook.Net.Core.dll

表示一个通用的音频频道。

public interface IAudioChannel : IChannel, IEntity<ulong>
Inherited Members
Extension Methods

Properties

AudioClient

获取在此音频频道上建立的语音客户端。

IAudioClient? AudioClient { get; }

Property Value

IAudioClient

IsVoiceRegionOverwritten

获取此音频频道的语音区域设置是否覆写了服务器的语音区域设置。

bool? IsVoiceRegionOverwritten { get; }

Property Value

bool?

ServerUrl

获取语音客户端连接到此语音频道的语音服务器 URL。

string? ServerUrl { get; }

Property Value

string

VoiceRegion

获取此音频频道所设置的语音服务器区域。

string? VoiceRegion { get; }

Property Value

string

Remarks

warning

对于语音频道区域设置功能发布之前创建的语音频道,该属性可能为空。

See Also

Methods

ConnectAsync(bool, bool, string?)

连接到此音频频道。

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

Parameters

external bool

指定语音客户端是否是由外部管理的。当设置为 true 时,当前方法不会尝试连接到语音频道。

disconnect bool

指定语音客户端在连接到新的语音频道之前是否应调用断开连接。

password string

指定客户端连接到设置了密码的语音频道时所使用的密码。

Returns

Task<IAudioClient>

一个表示音频连接操作的异步任务。任务的结果是一个负责音频连接的 IAudioClient 实例;如果 externaltrue,则会返回 null

DisconnectAsync()

断开与此音频频道的连接。

Task DisconnectAsync()

Returns

Task

一个表示音频断开连接操作的异步任务。