kord-voice/dev.kord.voice

Package-level declarations

Types

AudioFrame

@KordVoice

@JvmInline

value class AudioFrame(val data: ByteArray)

A frame of 20ms Opus-encoded 48k stereo audio data.

AudioProvider

@KordVoice

fun interface AudioProvider

Implementations of AudioProvider should provide proper AudioFrames representing the audio which should be transmitted to Discord.

DefaultFrameInterceptor

@KordVoice

class DefaultFrameInterceptor(data: DefaultFrameInterceptorData = DefaultFrameInterceptorData()) : FrameInterceptor

The default implementation for FrameInterceptor. Any custom implementation should extend this and call the super intercept method, or else the speaking flags will not be sent!

DefaultFrameInterceptorData

@KordVoice

data class DefaultFrameInterceptorData(val speakingState: SpeakingFlags = SpeakingFlags { +SpeakingFlag.Microphone })

Data that is used to configure for the lifetime of a DefaultFrameInterceptor.

EncryptionMode

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

sealed class EncryptionMode

See EncryptionModes in the Discord Developer Documentation.

FrameInterceptor

@KordVoice

fun interface FrameInterceptor

An interceptor for audio frames before they are sent as packets.

FrameInterceptorConfiguration

@KordVoice

data class FrameInterceptorConfiguration(val gateway: Gateway, val voiceGateway: VoiceGateway, val ssrc: UInt)

SpeakingFlag

sealed class SpeakingFlag

See SpeakingFlags in the Discord Developer Documentation.

SpeakingFlags

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

class SpeakingFlags

A collection of multiple SpeakingFlags.

VoiceConnection

@KordVoice

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

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

VoiceConnectionBuilder

@KordVoice

class VoiceConnectionBuilder(var gateway: Gateway, var selfId: Snowflake, var channelId: Snowflake, var guildId: Snowflake)

VoiceConnectionData

data class VoiceConnectionData(val selfId: Snowflake, val guildId: Snowflake, val sessionId: String)

Data that represents a VoiceConnection, these will never change during the lifetime of a VoiceConnection.

Functions

SpeakingFlags

fun SpeakingFlags(vararg flags: SpeakingFlag): SpeakingFlags

fun SpeakingFlags(vararg flags: SpeakingFlags): SpeakingFlags

fun SpeakingFlags(flags: Iterable<SpeakingFlag>): SpeakingFlags

@JvmName(name = "SpeakingFlags0")

fun SpeakingFlags(flags: Iterable<SpeakingFlags>): SpeakingFlags

Returns an instance of SpeakingFlags that has all bits set that are set in any element of flags.

inline fun SpeakingFlags(builder: SpeakingFlags.Builder.() -> Unit = {}): SpeakingFlags

Returns an instance of SpeakingFlags built with SpeakingFlags.Builder.

VoiceConnection

@KordVoice

inline suspend fun VoiceConnection(gateway: Gateway, selfId: Snowflake, channelId: Snowflake, guildId: Snowflake, builder: VoiceConnectionBuilder.() -> Unit = {}): VoiceConnection

Builds a VoiceConnection configured by the builder.