kord-voice/dev.kord.voice/VoiceConnection

VoiceConnection

A VoiceConnection is an adapter that forms the concept of a voice connection, or a connection between you and Discord voice servers.

Parameters

gateway

the Gateway that handles events for the guild this VoiceConnection represents.

voiceGateway

the underlying VoiceGateway for this voice connection.

data

the data representing this VoiceConnection.

voiceGatewayConfiguration

the configuration used on each new connect for the voiceGateway.

audioProvider

a AudioProvider that will provide AudioFrame when required.

frameInterceptor

a FrameInterceptor that will intercept all outgoing AudioFrames.

frameSender

the AudioFrameSender that will handle the sending of audio packets.

Constructors

VoiceConnection

constructor(data: VoiceConnectionData, gateway: Gateway, voiceGateway: VoiceGateway, socket: VoiceUdpSocket, voiceGatewayConfiguration: VoiceGatewayConfiguration, streams: Streams, audioProvider: AudioProvider, frameInterceptor: FrameInterceptor, frameSender: AudioFrameSender, nonceStrategy: NonceStrategy, connectionDetachDuration: Duration)

Properties

audioProvider

val audioProvider: AudioProvider

data

val data: VoiceConnectionData

frameInterceptor

val frameInterceptor: FrameInterceptor

frameSender

val frameSender: AudioFrameSender

gateway

val gateway: Gateway

nonceStrategy

val ~~nonceStrategy~~: NonceStrategy

scope

val scope: CoroutineScope

socket

val socket: VoiceUdpSocket

streams

val streams: Streams

voiceGateway

val voiceGateway: VoiceGateway

voiceGatewayConfiguration

var voiceGatewayConfiguration: VoiceGatewayConfiguration

Functions

connect

suspend fun connect(scope: CoroutineScope = this.scope)

Starts the VoiceGateway for this VoiceConnection. This will begin the process for audio transmission.

disconnect

suspend fun disconnect()

Disconnects from the voice servers, does not change the voice state.

leave

suspend fun leave()

Disconnects from Discord voice servers, and leaves the voice channel.

move

suspend fun move(channelId: Snowflake, selfMute: Boolean = false, selfDeaf: Boolean = false)

Sends a gateway command to update the connection in the current guild.

shutdown

suspend fun shutdown()

Releases all resources related to this VoiceConnection (except gateway) and then stops its CoroutineScope.