VoiceConnection

Hierarchy

EventEmitter
- VoiceConnection

Implements

SimpleJSON

Index

Constructors

constructor

Constructors

constructor

new VoiceConnection(id: string, options?: { opusOnly?: boolean; shard?: Shard; shared?: boolean }): VoiceConnection

Overrides EventEmitter.constructor
- Defined in node_modules/eris/index.d.ts:3663
Parameters
- id: string
- Optional options: { opusOnly?: boolean; shard?: Shard; shared?: boolean }
  - Optional opusOnly?: boolean
  - Optional shard?: Shard
  - Optional shared?: boolean
Returns VoiceConnection

Properties

bitrate

bitrate: number

channelID

channelID: null | string

channels

channels: number

connecting

connecting: boolean

connectionTimeout

connectionTimeout: null | Timeout

Optional current

current: null | VoiceStreamCurrent

Optional ended

ended: boolean

endpoint

endpoint: URL

frameDuration

frameDuration: number

frameSize

frameSize: number

heartbeatInterval

heartbeatInterval: null | Timeout

id

id: string

Optional mode

mode: string

Optional modes

modes: string

opus

opus: {}

Optional dependencies OpusScript (opusscript) or OpusEncoder (@discordjs/opus)

Type declaration

[userID: string]: unknown

opusOnly

opusOnly: boolean

paused

paused: boolean

pcmSize

pcmSize: number

piper

piper: Piper

playing

playing: boolean

ready

ready: boolean

Optional receiveStreamOpus

receiveStreamOpus: null | VoiceDataStream

Optional receiveStreamPCM

receiveStreamPCM: null | VoiceDataStream

reconnecting

reconnecting: boolean

samplingRate

samplingRate: number

secret

secret: Buffer

sendBuffer

sendBuffer: Buffer

sendNonce

sendNonce: Buffer

sequence

sequence: number

shard

shard: Shard | Record<string, never>

shared

shared: boolean

speaking

speaking: boolean

Optional ssrc

ssrc: number

ssrcUserMap

ssrcUserMap: {}

Type declaration

[s: number]: string

timestamp

timestamp: number

Optional udpIP

udpIP: string

Optional udpPort

udpPort: number

udpSocket

udpSocket: null | Socket

volume

volume: number

ws

ws: any

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.

Methods

addListener

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

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/ts4.8/events.d.ts:57
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns VoiceConnection

connect

connect(data: VoiceConnectData): void | Timer

- Defined in node_modules/eris/index.d.ts:3664
Parameters
- data: VoiceConnectData
Returns void | Timer

disconnect

disconnect(error?: Error, reconnecting?: boolean): void

- Defined in node_modules/eris/index.d.ts:3665
Parameters
- Optional error: Error
- Optional reconnecting: boolean
Returns void

emit

emit<K>(event: K, ...args: VoiceEvents[K]): boolean
emit(event: string, ...args: any[]): boolean

Overrides EventEmitter.emit
- Defined in node_modules/eris/index.d.ts:3666
Type parameters
- K: keyof VoiceEvents
Parameters
- event: K
- Rest ...args: VoiceEvents[K]
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/eris/index.d.ts:3667
Parameters
- event: string
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/ts4.8/events.d.ts:72
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:64
Returns number

heartbeat

heartbeat(): void

- Defined in node_modules/eris/index.d.ts:3668
Returns void

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/ts4.8/events.d.ts:68
Parameters
- event: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

off

off<K>(event: K, listener: (...args: VoiceEvents[K]) => void): VoiceConnection
off(event: string, listener: (...args: any[]) => void): VoiceConnection

Overrides EventEmitter.off
- Defined in node_modules/eris/index.d.ts:3669
Type parameters
- K: keyof VoiceEvents
Parameters
- event: K
- listener: (...args: VoiceEvents[K]) => void
  - - (...args: VoiceEvents[K]): void
    - Parameters
      - Rest ...args: VoiceEvents[K]
      Returns void
Returns VoiceConnection
Overrides EventEmitter.off
- Defined in node_modules/eris/index.d.ts:3670
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns VoiceConnection

on

on<K>(event: K, listener: (...args: VoiceEvents[K]) => void): VoiceConnection
on(event: string, listener: (...args: any[]) => void): VoiceConnection

Overrides EventEmitter.on
- Defined in node_modules/eris/index.d.ts:3686
Type parameters
- K: keyof VoiceEvents
Parameters
- event: K
- listener: (...args: VoiceEvents[K]) => void
  - - (...args: VoiceEvents[K]): void
    - Parameters
      - Rest ...args: VoiceEvents[K]
      Returns void
Returns VoiceConnection
Overrides EventEmitter.on
- Defined in node_modules/eris/index.d.ts:3687
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns VoiceConnection

once

once<K>(event: K, listener: (...args: VoiceEvents[K]) => void): VoiceConnection
once(event: string, listener: (...args: any[]) => void): VoiceConnection

Overrides EventEmitter.once
- Defined in node_modules/eris/index.d.ts:3671
Type parameters
- K: keyof VoiceEvents
Parameters
- event: K
- listener: (...args: VoiceEvents[K]) => void
  - - (...args: VoiceEvents[K]): void
    - Parameters
      - Rest ...args: VoiceEvents[K]
      Returns void
Returns VoiceConnection
Overrides EventEmitter.once
- Defined in node_modules/eris/index.d.ts:3672
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns VoiceConnection

pause

pause(): void

- Defined in node_modules/eris/index.d.ts:3673
Returns void

play

play(resource: string | Readable, options?: VoiceResourceOptions): void

- Defined in node_modules/eris/index.d.ts:3674
Parameters
- resource: string | Readable
- Optional options: VoiceResourceOptions
Returns void

prependListener

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

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/ts4.8/events.d.ts:70
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

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/ts4.8/events.d.ts:71
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[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:66
Parameters
- event: string | symbol
Returns Function[]

receive

receive(type: "opus" | "pcm"): VoiceDataStream

- Defined in node_modules/eris/index.d.ts:3675
Parameters
- type: "opus" | "pcm"
Returns VoiceDataStream

registerReceiveEventHandler

registerReceiveEventHandler(): void

- Defined in node_modules/eris/index.d.ts:3676
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): VoiceConnection

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:62
Parameters
- Optional event: string | symbol
Returns VoiceConnection

removeListener

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

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/ts4.8/events.d.ts:60
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns VoiceConnection

resume

resume(): void

- Defined in node_modules/eris/index.d.ts:3677
Returns void

sendAudioFrame

sendAudioFrame(frame: Buffer): void

- Defined in node_modules/eris/index.d.ts:3678
Parameters
- frame: Buffer
Returns void

sendUDPPacket

sendUDPPacket(packet: Buffer): void

- Defined in node_modules/eris/index.d.ts:3679
Parameters
- packet: Buffer
Returns void

sendWS

sendWS(op: number, data: Record<string, unknown>): void

- Defined in node_modules/eris/index.d.ts:3680
Parameters
- op: number
- data: Record<string, unknown>
Returns void

setMaxListeners

setMaxListeners(n: number): VoiceConnection

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:63
Parameters
- n: number
Returns VoiceConnection

setSpeaking

setSpeaking(value: boolean): void

- Defined in node_modules/eris/index.d.ts:3681
Parameters
- value: boolean
Returns void

setVolume

setVolume(volume: number): void

- Defined in node_modules/eris/index.d.ts:3682
Parameters
- volume: number
Returns void

stopPlaying

stopPlaying(): void

- Defined in node_modules/eris/index.d.ts:3683
Returns void

switchChannel

switchChannel(channelID: string): void

- Defined in node_modules/eris/index.d.ts:3684
Parameters
- channelID: string
Returns void

toJSON

toJSON(props?: string[]): JSONCache

Implementation of SimpleJSON.toJSON
- Defined in node_modules/eris/index.d.ts:3688
Parameters
- Optional props: string[]
Returns JSONCache

updateVoiceState

updateVoiceState(selfMute: boolean, selfDeaf: boolean): void

- Defined in node_modules/eris/index.d.ts:3685
Parameters
- selfMute: boolean
- selfDeaf: boolean
Returns void

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/ts4.8/events.d.ts:26
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

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

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/ts4.8/events.d.ts:23
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[]>

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/ts4.8/events.d.ts:21
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/ts4.8/events.d.ts:22
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

id: string

Optional options: { opusOnly?: boolean; shard?: Shard; shared?: boolean }

Optional opusOnly?: boolean

Optional shard?: Shard

Optional shared?: boolean

Returns VoiceConnection

Properties

bitrate

channelID

channels

connecting

connectionTimeout

Optional current

Optional ended

endpoint

frameDuration

frameSize

heartbeatInterval

id

Optional mode

Optional modes

opus

Type declaration

[userID: string]: unknown

opusOnly

paused

pcmSize

piper

playing

ready

Optional receiveStreamOpus

Optional receiveStreamPCM

reconnecting

samplingRate

secret

sendBuffer

sendNonce

sequence

shard

shared

speaking

Optional ssrc

ssrcUserMap

Type declaration

[s: number]: string

timestamp

Optional udpIP

Optional udpPort

udpSocket

volume

ws

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns VoiceConnection

connect

Parameters

data: VoiceConnectData

Returns void | Timer

disconnect

Parameters

Optional error: Error