Class DisTubeVoice

Create a voice connection to the voice channel

Hierarchy

TypedEmitter<DisTubeVoiceEvents>
- DisTubeVoice

Constructors

constructor

new DisTubeVoice(voiceManager, channel): DisTubeVoice
Parameters
- voiceManager: DisTubeVoiceManager
- channel: VoiceBasedChannel
Returns DisTubeVoice
Overrides TypedEmitter<DisTubeVoiceEvents>.constructor
- Defined in src/core/DisTubeVoice.ts:31

Properties

`Private` #channel

#channel: VoiceBasedChannel

`Private` #volume

#volume: number = 100

`Readonly` audioPlayer

audioPlayer: AudioPlayer

`Optional` audioResource

audioResource?: AudioResource<unknown>

connection

connection: VoiceConnection

emittedError

emittedError: boolean

`Readonly` id

id: string

isDisconnected

isDisconnected: boolean = false

`Optional` stream

stream?: DisTubeStream

`Readonly` voices

voices: DisTubeVoiceManager

`Static` defaultMaxListeners

defaultMaxListeners: number

Accessors

channel

get channel(): VoiceBasedChannel
Returns VoiceBasedChannel
- Defined in src/core/DisTubeVoice.ts:98
set channel(channel): void
Parameters
- channel: VoiceBasedChannel
Returns void
- Defined in src/core/DisTubeVoice.ts:111

channelId

get channelId(): undefined | string
The voice channel id the bot is in

Returns undefined | string
- Defined in src/core/DisTubeVoice.ts:95

playbackDuration

get playbackDuration(): number
Playback duration of the audio resource in seconds

Returns number
- Defined in src/core/DisTubeVoice.ts:213

selfDeaf

get selfDeaf(): boolean
Whether the bot is self-deafened

Returns boolean
- Defined in src/core/DisTubeVoice.ts:228

selfMute

get selfMute(): boolean
Whether the bot is self-muted

Returns boolean
- Defined in src/core/DisTubeVoice.ts:234

voiceState

get voiceState(): undefined | VoiceState
The voice state of this connection

Returns undefined | VoiceState
- Defined in src/core/DisTubeVoice.ts:272

volume

get volume(): number
Returns number
- Defined in src/core/DisTubeVoice.ts:207
set volume(volume): void
Parameters
- volume: number
Returns void
- Defined in src/core/DisTubeVoice.ts:197

Methods

`Private` #br

#br(): void
Returns void
- Defined in src/core/DisTubeVoice.ts:89

`Private` #join

#join(channel): VoiceConnection
Parameters
- channel: VoiceBasedChannel
Returns VoiceConnection
- Defined in src/core/DisTubeVoice.ts:126

addListener

addListener(event, listener): this
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- event: U
- listener: DisTubeVoiceEvents[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:11

emit

emit(event, ...args): boolean
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- event: U
- Rest ...args: Parameters<DisTubeVoiceEvents[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames(): U[]
Type Parameters
- U extends keyof DisTubeVoiceEvents
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:20

getMaxListeners

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

join

join(channel?): Promise<DisTubeVoice>
Join a voice channel with this connection
Parameters
- Optional channel: VoiceBasedChannel
 A voice channel
Returns Promise<DisTubeVoice>
- Defined in src/core/DisTubeVoice.ts:139

leave

leave(error?): void
Leave the voice channel of this connection
Parameters
- Optional error: Error
  Optional, an error to emit with 'error' event.
Returns void
- Defined in src/core/DisTubeVoice.ts:157

listenerCount

listenerCount(type): number
Parameters
- type: keyof DisTubeVoiceEvents
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners(type): DisTubeVoiceEvents[U][]
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- type: U
Returns DisTubeVoiceEvents[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:22

off

off(event, listener): this
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- event: U
- listener: DisTubeVoiceEvents[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on(event, listener): this
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- event: U
- listener: DisTubeVoiceEvents[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once(event, listener): this
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- event: U
- listener: DisTubeVoiceEvents[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:16

pause

pause(): void
Returns void
- Defined in src/core/DisTubeVoice.ts:216

play

play(dtStream): void
Play a DisTubeStream
Parameters
- dtStream: DisTubeStream
  DisTubeStream
Returns void
- Defined in src/core/DisTubeVoice.ts:181

prependListener

prependListener(event, listener): this
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- event: U
- listener: DisTubeVoiceEvents[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener(event, listener): this
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- event: U
- listener: DisTubeVoiceEvents[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners(type): DisTubeVoiceEvents[U][]
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- type: U
Returns DisTubeVoiceEvents[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:23

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optional event: keyof DisTubeVoiceEvents
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener(event, listener): this
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- event: U
- listener: DisTubeVoiceEvents[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:14

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:25

setSelfDeaf

setSelfDeaf(selfDeaf): boolean
Self-deafens/undeafens the bot.
Parameters
- selfDeaf: boolean
  Whether or not the bot should be self-deafened
Returns boolean
true if the voice state was successfully updated, otherwise false
- Defined in src/core/DisTubeVoice.ts:244

setSelfMute

setSelfMute(selfMute): boolean
Self-mutes/unmutes the bot.
Parameters
- selfMute: boolean
  Whether or not the bot should be self-muted
Returns boolean
true if the voice state was successfully updated, otherwise false
- Defined in src/core/DisTubeVoice.ts:260

stop

stop(force?): void
Stop the playing stream
Parameters
- force: boolean = false
  If true, will force the DisTubeVoice#audioPlayer to enter the Idle state even if the DisTubeVoice#audioResource has silence padding frames.
Returns void
- Defined in src/core/DisTubeVoice.ts:172

unpause

unpause(): void
Returns void
- Defined in src/core/DisTubeVoice.ts:219

Class DisTubeVoice

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DisTubeVoice

Properties

Private #channel

Private #volume

Readonly audioPlayer

Optional audioResource

connection

emittedError

Readonly id

isDisconnected

Optional stream

Readonly voices

Static defaultMaxListeners

Accessors

channel

Returns VoiceBasedChannel

Parameters

Returns void

channelId

Returns undefined | string

playbackDuration

Returns number

selfDeaf

Returns boolean

selfMute

Returns boolean

voiceState

Returns undefined | VoiceState

volume

Returns number

Parameters

Returns void

Methods

Private #br

Returns void

Private #join

Parameters

Returns VoiceConnection

addListener

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns U[]

getMaxListeners

Returns number

join

Parameters

Returns Promise<DisTubeVoice>

leave

Parameters

Returns void

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns DisTubeVoiceEvents[U][]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

`Private` #channel

`Private` #volume

`Readonly` audioPlayer

`Optional` audioResource

`Readonly` id

`Optional` stream

`Readonly` voices

`Static` defaultMaxListeners

`Private` #br

`Private` #join