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:1232
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 | { options: VoiceResourceOptions; pausedTime?: undefined | number; pausedTimestamp?: undefined | number; playTime: number; startTime: number }

id

id: string

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

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

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

on

on(event: "warn" | "debug", listener: (message: string) => void): VoiceConnection
on(event: "disconnect" | "error", listener: (err: Error) => void): VoiceConnection
on(event: "pong", listener: (latency: number) => void): VoiceConnection
on(event: "speakingStart", listener: (userID: string) => void): VoiceConnection
on(event: "speakingStop", listener: (userID: string) => void): VoiceConnection
on(event: "end", listener: () => void): VoiceConnection
on(event: "userDisconnect", listener: (userID: string) => void): VoiceConnection

- Defined in node_modules/eris/index.d.ts:1242
Parameters
- event: "warn" | "debug"
- listener: (message: string) => void
  - - (message: string): void
    - Parameters
      - message: string
      Returns void
Returns VoiceConnection
- Defined in node_modules/eris/index.d.ts:1243
Parameters
- event: "disconnect" | "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns VoiceConnection
- Defined in node_modules/eris/index.d.ts:1244
Parameters
- event: "pong"
- listener: (latency: number) => void
  - - (latency: number): void
    - Parameters
      - latency: number
      Returns void
Returns VoiceConnection
- Defined in node_modules/eris/index.d.ts:1245
Parameters
- event: "speakingStart"
- listener: (userID: string) => void
  - - (userID: string): void
    - Parameters
      - userID: string
      Returns void
Returns VoiceConnection
- Defined in node_modules/eris/index.d.ts:1246
Parameters
- event: "speakingStop"
- listener: (userID: string) => void
  - - (userID: string): void
    - Parameters
      - userID: string
      Returns void
Returns VoiceConnection
- Defined in node_modules/eris/index.d.ts:1247
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns VoiceConnection
- Defined in node_modules/eris/index.d.ts:1248
Parameters
- event: "userDisconnect"
- listener: (userID: string) => void
  - - (userID: string): void
    - Parameters
      - userID: string
      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:1234
Returns void

play

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

- Defined in node_modules/eris/index.d.ts:1235
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: string): VoiceDataStream

- Defined in node_modules/eris/index.d.ts:1236
Parameters
- type: string
Returns VoiceDataStream

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:1237
Returns void

setMaxListeners

setMaxListeners(n: number): VoiceConnection

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

setVolume

setVolume(volume: number): void

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

stopPlaying

stopPlaying(): void

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

switchChannel

switchChannel(channelID: string): void

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

toJSON

toJSON(props?: string[]): JSONCache

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

toString

toString(): string

- Defined in node_modules/eris/index.d.ts:1249
Returns string

updateVoiceState

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

- Defined in node_modules/eris/index.d.ts:1241
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

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

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

connecting

Optional current

id

paused

playing

ready

volume

Static defaultMaxListeners

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns VoiceConnection

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns VoiceConnection

on

Parameters

event: "warn" | "debug"

listener: (message: string) => void

Parameters

message: string

Returns void

Returns VoiceConnection

Parameters

event: "disconnect" | "error"

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns VoiceConnection

Parameters

event: "pong"

listener: (latency: number) => void

Parameters

latency: number

Returns void