Interface IAudioChannel

Represents a generic audio channel.

Inherited Members

IChannel.Name

IChannel.GetUsersAsync(CacheMode, RequestOptions)

IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

ISnowflakeEntity.CreatedAt

IEntity<UInt64>.Id

Namespace: Discord

Assembly: Discord.Net.Core.dll

Syntax

public interface IAudioChannel : IChannel, ISnowflakeEntity, IEntity<ulong>

Properties

RTCRegion

Gets the RTC region for this audio channel.

Declaration

string RTCRegion { get; }

Property Value

Type	Description
String

Remarks

This property can be null.

Methods

ConnectAsync(Boolean, Boolean, Boolean)

Connects to this audio channel.

Declaration

Task<IAudioClient> ConnectAsync(bool selfDeaf = false, bool selfMute = false, bool external = false)

Parameters

Type	Name	Description
Boolean	selfDeaf	Determines whether the client should deaf itself upon connection.
Boolean	selfMute	Determines whether the client should mute itself upon connection.
Boolean	external	Determines whether the audio client is an external one or not.

Returns

Type	Description
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.

Declaration

Task DisconnectAsync()

Returns

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

ModifyAsync(Action<AudioChannelProperties>, RequestOptions)

Modifies this audio channel.

Declaration

Task ModifyAsync(Action<AudioChannelProperties> func, RequestOptions options = null)

Parameters

Type	Name	Description
Action<AudioChannelProperties>	func	The properties to modify the channel with.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task	A task that represents the asynchronous modification operation.

See Also

AudioChannelProperties

Extension Methods

ChannelExtensions.GetChannelType(IChannel)