Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VoiceConnection

Voice Connection

Hierarchy

  • EventSpewer
    • VoiceConnection

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

client

client: ShardClient

decodeAudio

decodeAudio: boolean

formats

formats: { audio: AudioFormat }

Type declaration

gateway

gateway: Socket

handler

handler: MediaHandler

opusDecoder

opusDecoder: null | OpusDecoderSettings

opusDecoders

opusDecoders: BaseCollection<string, AudioOpus>

opusEncoder

opusEncoder: null | AudioOpus

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

channel

channelId

  • get channelId(): string

guild

  • get guild(): null | Guild

guildId

  • get guildId(): null | string

killed

  • get killed(): boolean

member

serverId

  • get serverId(): string

user

  • get user(): null | User

userId

  • get userId(): string

voiceState

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): VoiceConnection

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns VoiceConnection

decode

  • decode(userId: string, data: Buffer, options?: DecodeSettings): Buffer

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

fetchOpusDecoder

  • fetchOpusDecoder(userId: string): AudioOpus

getMaxListeners

  • getMaxListeners(): number

  • Returns number

hasEventListener

  • hasEventListener(name: string | symbol): boolean

  • Parameters

    • name: string | symbol

    Returns boolean

kill

  • kill(): void

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): VoiceConnection

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns VoiceConnection

on

once

  • once(event: string | symbol, listener: (...args: any[]) => void): VoiceConnection

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns VoiceConnection

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): VoiceConnection

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns VoiceConnection

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): VoiceConnection

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns VoiceConnection

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional name: string | symbol

    Returns VoiceConnection

removeAllSubscriptions

  • Returns VoiceConnection

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): VoiceConnection

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns VoiceConnection

removeSubscription

  • removeSubscription(subscription: EventSubscription): void

  • Parameters

    • subscription: EventSubscription

    Returns void

sendAudio

sendAudioSilenceFrame

  • sendAudioSilenceFrame(): void

setDeaf

  • setDeaf(selfDeaf: boolean): Promise<void>

setDecodeAudio

  • setDecodeAudio(value: boolean): void

setMaxListeners

  • Parameters

    • n: number

    Returns VoiceConnection

setMute

  • setMute(selfMute: boolean): Promise<void>

setOpusDecoder

  • setOpusDecoder(options?: boolean | OpusOptions): void

setOpusEncoder

  • setOpusEncoder(options?: boolean | OpusOptions): void

setSpeaking

  • setSpeaking(options: { delay?: number; soundshare?: boolean; ssrc?: number; voice?: boolean }): Promise<void>

  • Parameters

    • options: { delay?: number; soundshare?: boolean; ssrc?: number; voice?: boolean }
      • Optional delay?: number
      • Optional soundshare?: boolean
      • Optional ssrc?: number
      • Optional voice?: boolean

    Returns Promise<void>

setState

  • setState(options: { selfDeaf?: boolean; selfMute?: boolean; selfVideo?: boolean }): Promise<void>

  • Parameters

    • options: { selfDeaf?: boolean; selfMute?: boolean; selfVideo?: boolean }
      • Optional selfDeaf?: boolean
      • Optional selfMute?: boolean
      • Optional selfVideo?: boolean

    Returns Promise<void>

setVideo

  • setVideo(selfVideo: boolean): Promise<void>

subscribe

  • subscribe(name: string | symbol, listener: (...args: any[]) => void): EventSubscription

  • Parameters

    • name: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventSubscription

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc