Class DisPlayConnection

The voice connection class of discord-play. The bot joins the input voice state as soon as an instance is created.

Hierarchy

TypedEmitter<ConnectionEvents>
- DisPlayConnection

Index

Constructors

constructor

Properties

Accessors

player

Methods

Constructors

constructor

new DisPlayConnection(voice: VoiceState): DisPlayConnection

Overrides TypedEmitter<ConnectionEvents>.constructor
- Defined in src/classes/connection.ts:27
Joins the voice channel on instance creation.

Parameters
- voice: VoiceState
  
  The voice state of a member.
Returns DisPlayConnection

Properties

Readonly connection

connection: VoiceConnection

The {@link VoiceConnection} instance from @discordjs/voice.

Private oldVoiceID

oldVoiceID: null | string

Private readyLock

readyLock: boolean = false

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

player

get player(): undefined | AudioPlayer

- Defined in src/classes/connection.ts:77
The {@link AudioPlayer} attached to the voice connection (if any).

Returns undefined | AudioPlayer

Methods

addListener

addListener<U>(event: U, listener: ConnectionEvents[U]): DisPlayConnection

Inherited from TypedEmitter.addListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:11
Type parameters
- U: keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns DisPlayConnection

destroy

destroy(): void

- Defined in src/classes/connection.ts:108
Destroys the voice connection, making it unable to be reused again.

Returns void

emit

emit<U>(event: U, ...args: Parameters<ConnectionEvents[U]>): boolean

Inherited from TypedEmitter.emit
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:19
Type parameters
- U: keyof ConnectionEvents
Parameters
- event: U
- Rest ...args: Parameters<ConnectionEvents[U]>
Returns boolean

eventNames

eventNames<U>(): U[]

Inherited from TypedEmitter.eventNames
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:20
Type parameters
- U: keyof ConnectionEvents
Returns U[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:24
Returns number

listenerCount

listenerCount(type: keyof ConnectionEvents): number

Inherited from TypedEmitter.listenerCount
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:21
Parameters
- type: keyof ConnectionEvents
Returns number

listeners

listeners<U>(type: U): ConnectionEvents[U][]

Inherited from TypedEmitter.listeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:22
Type parameters
- U: keyof ConnectionEvents
Parameters
- type: U
Returns ConnectionEvents[U][]

off

off<U>(event: U, listener: ConnectionEvents[U]): DisPlayConnection

Inherited from TypedEmitter.off
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:18
Type parameters
- U: keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns DisPlayConnection

on

on<U>(event: U, listener: ConnectionEvents[U]): DisPlayConnection

Inherited from TypedEmitter.on
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:17
Type parameters
- U: keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns DisPlayConnection

once

once<U>(event: U, listener: ConnectionEvents[U]): DisPlayConnection

Inherited from TypedEmitter.once
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:16
Type parameters
- U: keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns DisPlayConnection

prependListener

prependListener<U>(event: U, listener: ConnectionEvents[U]): DisPlayConnection

Inherited from TypedEmitter.prependListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:12
Type parameters
- U: keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns DisPlayConnection

prependOnceListener

prependOnceListener<U>(event: U, listener: ConnectionEvents[U]): DisPlayConnection

Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:13
Type parameters
- U: keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns DisPlayConnection

rawListeners

rawListeners<U>(type: U): ConnectionEvents[U][]

Inherited from TypedEmitter.rawListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:23
Type parameters
- U: keyof ConnectionEvents
Parameters
- type: U
Returns ConnectionEvents[U][]

removeAllListeners

removeAllListeners(event?: keyof ConnectionEvents): DisPlayConnection

Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15
Parameters
- Optional event: keyof ConnectionEvents
Returns DisPlayConnection

removeListener

removeListener<U>(event: U, listener: ConnectionEvents[U]): DisPlayConnection

Inherited from TypedEmitter.removeListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:14
Type parameters
- U: keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns DisPlayConnection

setMaxListeners

setMaxListeners(n: number): DisPlayConnection

Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:25
Parameters
- n: number
Returns DisPlayConnection

toggleDeafen

toggleDeafen(): boolean

- Defined in src/classes/connection.ts:85
Toggle self-deafening of the bot.

Returns boolean
true if self-deafened, otherwise false i.e. self-undeafened.

toggleMute

toggleMute(): boolean

- Defined in src/classes/connection.ts:97
Toggle self-muting of the bot.

Returns boolean
true if self-muted, otherwise false i.e. self-unmuted.

Generated using TypeDoc