kord-voice/dev.kord.voice.gateway/VoiceGateway

VoiceGateway

@KordVoice

interface VoiceGateway(source)

An implementation of the Discord Gateway (see gateway-only, not UDP connection in docs) and its lifecycle.

Allows consumers to receive VoiceEvents through events and send Commands through send.

Inheritors

DefaultVoiceGateway

Types

Companion

object Companion

Properties

events

abstract val events: SharedFlow<VoiceEvent>

The incoming VoiceEvents of the Gateway. Users should expect kotlinx.coroutines.flow.Flows to be hot and remain open for the entire lifecycle of the Gateway.

ping

abstract val ping: StateFlow<Duration?>

The Duration between the last Heartbeat and HeartbeatAck.

scope

abstract val scope: CoroutineScope

Functions

detach

abstract suspend fun detach()

@KordVoice

inline fun <T : VoiceEvent> VoiceGateway.on(scope: CoroutineScope = this.scope, crossinline consumer: suspend T.() -> Unit): Job

Convenience method that will invoke the consumer on every event T created by VoiceGateway.events.

send

abstract suspend fun send(command: Command)

Sends a Command to the gateway, suspending until the message has been sent.

start

abstract suspend fun start(configuration: VoiceGatewayConfiguration)

Starts a reconnection voice gateway connection with the given configuration. This function will suspend until the lifecycle of the gateway has ended.

stop

abstract suspend fun stop()

Close the Gateway and ends the current session, suspending until the underlying websocket is closed.