Class PlayerVoice

Hierarchy

TypedEmitter<PlayerVoiceEvents>
- PlayerVoice

Constructors

constructor

new PlayerVoice(player): PlayerVoice
Parameters
- player: Player<Node>
Returns PlayerVoice
Overrides TypedEmitter.constructor

Methods

addListener

addListener<U>(event, listener): PlayerVoice
Type Parameters
- U extends keyof PlayerVoiceEvents
Parameters
- event: U
- listener: PlayerVoiceEvents[U]
Returns PlayerVoice
Inherited from TypedEmitter.addListener

connect

connect(channel, options?): PlayerVoice
Parameters
- channel: string | DiscordResource
- Optional options: ConnectOptions
Returns PlayerVoice

disconnect

disconnect(): PlayerVoice
Returns PlayerVoice

emit

emit<U>(event, ...args): boolean
Type Parameters
- U extends keyof PlayerVoiceEvents
Parameters
- event: U
- Rest ...args: Parameters<PlayerVoiceEvents[U]>
Returns boolean
Inherited from TypedEmitter.emit

eventNames

eventNames<U>(): U[]
Type Parameters
- U extends keyof PlayerVoiceEvents
Returns U[]
Inherited from TypedEmitter.eventNames

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners

handleVoiceUpdate

handleVoiceUpdate(update): Promise<boolean>
Parameters
- update: VoiceStateUpdate | VoiceServerUpdate
Returns Promise<boolean>

listenerCount

listenerCount(type): number
Parameters
- type: keyof PlayerVoiceEvents
Returns number
Inherited from TypedEmitter.listenerCount

listeners

listeners<U>(type): PlayerVoiceEvents[U][]
Type Parameters
- U extends keyof PlayerVoiceEvents
Parameters
- type: U
Returns PlayerVoiceEvents[U][]
Inherited from TypedEmitter.listeners

off

off<U>(event, listener): PlayerVoice
Type Parameters
- U extends keyof PlayerVoiceEvents
Parameters
- event: U
- listener: PlayerVoiceEvents[U]
Returns PlayerVoice
Inherited from TypedEmitter.off

on

on<U>(event, listener): PlayerVoice
Type Parameters
- U extends keyof PlayerVoiceEvents
Parameters
- event: U
- listener: PlayerVoiceEvents[U]
Returns PlayerVoice
Inherited from TypedEmitter.on

once

once<U>(event, listener): PlayerVoice
Type Parameters
- U extends keyof PlayerVoiceEvents
Parameters
- event: U
- listener: PlayerVoiceEvents[U]
Returns PlayerVoice
Inherited from TypedEmitter.once

prependListener

prependListener<U>(event, listener): PlayerVoice
Type Parameters
- U extends keyof PlayerVoiceEvents
Parameters
- event: U
- listener: PlayerVoiceEvents[U]
Returns PlayerVoice
Inherited from TypedEmitter.prependListener

prependOnceListener

prependOnceListener<U>(event, listener): PlayerVoice
Type Parameters
- U extends keyof PlayerVoiceEvents
Parameters
- event: U
- listener: PlayerVoiceEvents[U]
Returns PlayerVoice
Inherited from TypedEmitter.prependOnceListener

rawListeners

rawListeners<U>(type): PlayerVoiceEvents[U][]
Type Parameters
- U extends keyof PlayerVoiceEvents
Parameters
- type: U
Returns PlayerVoiceEvents[U][]
Inherited from TypedEmitter.rawListeners

removeAllListeners

removeAllListeners(event?): PlayerVoice
Parameters
- Optional event: keyof PlayerVoiceEvents
Returns PlayerVoice
Inherited from TypedEmitter.removeAllListeners

removeListener

removeListener<U>(event, listener): PlayerVoice
Type Parameters
- U extends keyof PlayerVoiceEvents
Parameters
- event: U
- listener: PlayerVoiceEvents[U]
Returns PlayerVoice
Inherited from TypedEmitter.removeListener

setMaxListeners

setMaxListeners(n): PlayerVoice
Parameters
- n: number
Returns PlayerVoice
Inherited from TypedEmitter.setMaxListeners

Properties

channelId

channelId: string

connected

connected: boolean

latency

latency: number

`Readonly` player

player: Player<Node>

server

server: {
    endpoint: string;
    sessionId: string;
    token: string;
}

Type declaration

Readonly endpoint: string
Readonly sessionId: string
Readonly token: string

`Private` voiceUpdate

voiceUpdate: any

`Static` defaultMaxListeners

defaultMaxListeners: number