Class VoiceConnection

Hierarchy

EventEmitter
- VoiceConnection

Implements

SimpleJSON

Index

Constructors

constructor

Properties

Constructors

constructor

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

- Defined in node_modules/eris/index.d.ts:2463
Parameters
- id: string
- Optional options: { opusOnly?: undefined | boolean; shard?: undefined | Shard; shared?: undefined | boolean }
  - Optional opusOnly?: undefined | boolean
  - Optional shard?: undefined | Shard
  - Optional shared?: undefined | boolean
Returns VoiceConnection

Properties

channelID

channelID: string

connecting

connecting: boolean

Optional current

current: undefined | VoiceStreamCurrent

id

id: string

on

on: VoiceEvents<VoiceConnection>

paused

paused: boolean

playing

playing: boolean

ready

ready: boolean

volume

volume: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

- Defined in node_modules/@types/node/globals.d.ts:547
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:2465
Parameters
- data: VoiceConnectData
Returns void | Timer

disconnect

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

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

emit

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

- Defined in node_modules/@types/node/globals.d.ts:557
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/globals.d.ts:562
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/globals.d.ts:554
Returns number

heartbeat

heartbeat(): void

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

listenerCount

listenerCount(type: string | symbol): number

- Defined in node_modules/@types/node/globals.d.ts:558
Parameters
- type: string | symbol
Returns number

listeners

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

- Defined in node_modules/@types/node/globals.d.ts:555
Parameters
- event: string | symbol
Returns Function[]

off

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

- Defined in node_modules/@types/node/globals.d.ts:551
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns VoiceConnection

once

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

- Defined in node_modules/@types/node/globals.d.ts:549
Parameters
- event: string | symbol
- 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:2468
Returns void

play

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

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

prependListener

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

- Defined in node_modules/@types/node/globals.d.ts:560
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

- Defined in node_modules/@types/node/globals.d.ts:561
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[]

- Defined in node_modules/@types/node/globals.d.ts:556
Parameters
- event: string | symbol
Returns Function[]

receive

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

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

registerReceiveEventHandler

registerReceiveEventHandler(): void

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

removeAllListeners

removeAllListeners(event?: string | symbol): VoiceConnection

- Defined in node_modules/@types/node/globals.d.ts:552
Parameters
- Optional event: string | symbol
Returns VoiceConnection

removeListener

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

- Defined in node_modules/@types/node/globals.d.ts:550
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:2472
Returns void

sendWS

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

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

setMaxListeners

setMaxListeners(n: number): VoiceConnection

- Defined in node_modules/@types/node/globals.d.ts:553
Parameters
- n: number
Returns VoiceConnection

setSpeaking

setSpeaking(value: boolean): void

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

setVolume

setVolume(volume: number): void

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

stopPlaying

stopPlaying(): void

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

switchChannel

switchChannel(channelID: string): void

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

toJSON

toJSON(props?: string[]): JSONCache

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

updateVoiceState

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

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

Static listenerCount

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

- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

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

Generated using TypeDoc