kord-voice/dev.kord.voice/VoiceConnectionBuilder

VoiceConnectionBuilder

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

Constructors

constructor(gateway: Gateway, selfId: Snowflake, channelId: Snowflake, guildId: Snowflake)

Properties

audioProvider

var audioProvider: AudioProvider?

The AudioProvider for this VoiceConnection. No audio will be provided when one is not set.

audioSender

var audioSender: AudioFrameSender?

The dev.kord.voice.udp.AudioFrameSender for this VoiceConnection. If null, dev.kord.voice.udp.DefaultAudioFrameSender will be used.

channelId

var channelId: Snowflake

connectionDetachDuration

var connectionDetachDuration: Duration

The amount of time the connection should wait before assuming the voice connection has been closed instead of moved.

frameInterceptor

var frameInterceptor: FrameInterceptor?

The FrameInterceptor for this VoiceConnection. If null, DefaultFrameInterceptor will be used.

gateway

var gateway: Gateway

guildId

var guildId: Snowflake

nonceStrategy

var nonceStrategy: NonceStrategy?

The nonce strategy to be used for the encryption of audio packets. If null, dev.kord.voice.encryption.strategies.LiteNonceStrategy will be used.

receiveVoice

var receiveVoice: Boolean

A flag to control the implementation of streams. Set to false by default. When set to false, a NOP implementation will be used. When set to true, a proper receiving implementation will be used.

selfDeaf

var selfDeaf: Boolean

A boolean indicating whether your voice state will be deafened.

selfId

var selfId: Snowflake

selfMute

var selfMute: Boolean

A boolean indicating whether your voice state will be muted.

streams

var streams: Streams?

A Streams implementation to be used. This will override the receiveVoice flag.

timeout

var timeout: Long

The amount in milliseconds to wait for the events required to create a VoiceConnection. Default is 5000, or 5 seconds.

udpSocket

var udpSocket: VoiceUdpSocket?

A dev.kord.voice.udp.VoiceUdpSocket implementation to be used. If null, a default will be used.

Functions

audioProvider

fun audioProvider(provider: AudioProvider)

build

suspend fun build(): VoiceConnection

frameInterceptor

fun frameInterceptor(frameInterceptor: FrameInterceptor)

voiceGateway

fun voiceGateway(builder: DefaultVoiceGatewayBuilder.() -> Unit)

A builder to customize the voice connection's underlying VoiceGateway.