Class DisTubeVoice

Create a voice connection to the voice channel

Hierarchy

TypedEmitter<DisTubeVoiceEvents>
- DisTubeVoice

Constructors

constructor

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

Properties

`Readonly`audioPlayer

audioPlayer: AudioPlayer

connection

connection: VoiceConnection

emittedError

emittedError: boolean

`Readonly`id

id: string

isDisconnected

isDisconnected: boolean = false

`Optional`pausingStream

pausingStream?: DisTubeStream

`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:87
set channel(channel: VoiceBasedChannel): void
Parameters
- channel: VoiceBasedChannel
Returns void
- Defined in src/core/DisTubeVoice.ts:100

channelId

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

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

playbackDuration

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

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

selfDeaf

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

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

selfMute

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

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

voiceState

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

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

volume

get volume(): number
Get or set the volume percentage

Returns number
- Defined in src/core/DisTubeVoice.ts:198
set volume(volume: number): void
Parameters
- volume: number
Returns void
- Defined in src/core/DisTubeVoice.ts:185

Methods

addListener

addListener<U extends keyof DisTubeVoiceEvents>(
event: U,
listener: DisTubeVoiceEvents[U],
): 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<U extends keyof DisTubeVoiceEvents>(
event: U,
...args: Parameters<DisTubeVoiceEvents[U]>,
): boolean
Type Parameters
- U extends keyof DisTubeVoiceEvents
Parameters
- event: U
- ...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 extends keyof DisTubeVoiceEvents>(): 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?: VoiceBasedChannel): Promise<DisTubeVoice>
Join a voice channel with this connection
Parameters
- Optionalchannel: VoiceBasedChannel
  A voice channel
Returns Promise<DisTubeVoice>
- Defined in src/core/DisTubeVoice.ts:126

leave

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

listenerCount

listenerCount(type: keyof DisTubeVoiceEvents): 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<U extends keyof DisTubeVoiceEvents>(type: U): 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<U extends keyof DisTubeVoiceEvents>(
event: U,
listener: DisTubeVoiceEvents[U],
): 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<U extends keyof DisTubeVoiceEvents>(
event: U,
listener: DisTubeVoiceEvents[U],
): 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<U extends keyof DisTubeVoiceEvents>(
event: U,
listener: DisTubeVoiceEvents[U],
): 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:207

play

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

prependListener

prependListener<U extends keyof DisTubeVoiceEvents>(
event: U,
listener: DisTubeVoiceEvents[U],
): 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<U extends keyof DisTubeVoiceEvents>(
event: U,
listener: DisTubeVoiceEvents[U],
): 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<U extends keyof DisTubeVoiceEvents>(
type: U,
): 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?: keyof DisTubeVoiceEvents): this
Parameters
- Optionalevent: 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<U extends keyof DisTubeVoiceEvents>(
event: U,
listener: DisTubeVoiceEvents[U],
): 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: number): 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): 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:239

setSelfMute

setSelfMute(selfMute: boolean): 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:253

stop

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

unpause

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