kord-voice/dev.kord.voice.gateway

Package-level declarations

Types

sealed class Close : VoiceEvent

Command

sealed class Command

DefaultVoiceGateway

@KordVoice

class DefaultVoiceGateway(data: DefaultVoiceGatewayData) : VoiceGateway

The default Voice Gateway implementation of Kord, using an HttpClient for the underlying websocket.

DefaultVoiceGatewayBuilder

@KordVoice

class DefaultVoiceGatewayBuilder(val selfId: Snowflake, val guildId: Snowflake, val sessionId: String)

DefaultVoiceGatewayData

@KordVoice

data class DefaultVoiceGatewayData(val selfId: Snowflake, val guildId: Snowflake, val sessionId: String, val client: HttpClient, val reconnectRetry: Retry, val eventFlow: MutableSharedFlow<VoiceEvent>)

Heartbeat

@Serializable

data class Heartbeat(val nonce: Long) : Command

HeartbeatAck

@Serializable(with = HeartbeatAck.Serializer::class)

data class HeartbeatAck(val nonce: Long) : VoiceEvent

Hello

@Serializable

data class Hello(val version: Short, val heartbeatInterval: Double) : VoiceEvent

Identify

@Serializable

data class Identify(val serverId: Snowflake, val userId: Snowflake, val sessionId: String, val token: String) : Command

OpCode

@Serializable(with = OpCode.Serializer::class)

enum OpCode : Enum<OpCode>

Ready

@Serializable

data class Ready(val ssrc: UInt, val ip: String, val port: Int, val modes: List<EncryptionMode>) : VoiceEvent

Resume

@Serializable

data class Resume(val serverId: Snowflake, val sessionId: String, val token: String) : Command

Resumed

object Resumed : VoiceEvent

SelectProtocol

@KordVoice

@Serializable

data class SelectProtocol(val protocol: String, val data: SelectProtocol.Data) : Command

SendSpeaking

@KordVoice

@Serializable

data class SendSpeaking(val speaking: SpeakingFlags, val delay: Int, val ssrc: UInt) : Command

SessionDescription

@Serializable

data class SessionDescription(val mode: EncryptionMode, val secretKey: List<UByte>) : VoiceEvent

Speaking

@Serializable

data class Speaking(val userId: Snowflake, val ssrc: UInt, val speaking: SpeakingFlags) : VoiceEvent

VoiceEvent

sealed class VoiceEvent

VoiceGateway

@KordVoice

interface VoiceGateway

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

VoiceGatewayCloseCode

sealed class VoiceGatewayCloseCode

Representation of Discord's Voice Gateway close codes.

VoiceGatewayConfiguration

@KordVoice

data class VoiceGatewayConfiguration(val token: String, val endpoint: String)

Functions

@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.