Class DisTubeStream

Create a stream to play with DisTubeVoice

Hierarchy

TypedEmitter<
    {
        debug: (debug: string) => Awaitable;
        error: (error: Error) => Awaitable;
    },
>
- DisTubeStream

Constructors

constructor

new DisTubeStream(url: string, options: StreamOptions): DisTubeStream
Create a DisTubeStream to play with DisTubeVoice
Parameters
- url: string
  Stream URL
- options: StreamOptions
  Stream options
Returns DisTubeStream
Overrides TypedEmitter<{ debug: (debug: string) => Awaitable; error: (error: Error) => Awaitable; }>.constructor
- Defined in src/core/DisTubeStream.ts:76

Properties

audioResource

audioResource: AudioResource

`Optional`process

process?: ChildProcess

`Readonly`seekTime

seekTime: number

The seek time in seconds that this stream started from

stream

stream: VolumeTransformer

`Static`defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener<U extends "debug" | "error">(
event: U,
listener: { debug: (debug: string) => any; error: (error: Error) => any }[U],
): this
Type Parameters
- U extends "debug" | "error"
Parameters
- event: U
- listener: { debug: (debug: string) => any; error: (error: Error) => any }[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:11

emit

emit<U extends "debug" | "error">(
    event: U,
    ...args: Parameters<
        { debug: (debug: string) => any; error: (error: Error) => any }[U],
    >,
): boolean
Type Parameters
- U extends "debug" | "error"
Parameters
- event: U
- ...args: Parameters<{ debug: (debug: string) => any; error: (error: Error) => any }[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames<U extends "debug" | "error">(): U[]
Type Parameters
- U extends "debug" | "error"
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:20

getMaxListeners

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

kill

kill(): void
Returns void
- Defined in src/core/DisTubeStream.ts:175

listenerCount

listenerCount(type: "debug" | "error"): number
Parameters
- type: "debug" | "error"
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners<U extends "debug" | "error">(
type: U,
): { debug: (debug: string) => any; error: (error: Error) => any }[U][]
Type Parameters
- U extends "debug" | "error"
Parameters
- type: U
Returns { debug: (debug: string) => any; error: (error: Error) => any }[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:22

off

off<U extends "debug" | "error">(
event: U,
listener: { debug: (debug: string) => any; error: (error: Error) => any }[U],
): this
Type Parameters
- U extends "debug" | "error"
Parameters
- event: U
- listener: { debug: (debug: string) => any; error: (error: Error) => any }[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on<U extends "debug" | "error">(
event: U,
listener: { debug: (debug: string) => any; error: (error: Error) => any }[U],
): this
Type Parameters
- U extends "debug" | "error"
Parameters
- event: U
- listener: { debug: (debug: string) => any; error: (error: Error) => any }[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once<U extends "debug" | "error">(
event: U,
listener: { debug: (debug: string) => any; error: (error: Error) => any }[U],
): this
Type Parameters
- U extends "debug" | "error"
Parameters
- event: U
- listener: { debug: (debug: string) => any; error: (error: Error) => any }[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:16

prependListener

prependListener<U extends "debug" | "error">(
event: U,
listener: { debug: (debug: string) => any; error: (error: Error) => any }[U],
): this
Type Parameters
- U extends "debug" | "error"
Parameters
- event: U
- listener: { debug: (debug: string) => any; error: (error: Error) => any }[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener<U extends "debug" | "error">(
event: U,
listener: { debug: (debug: string) => any; error: (error: Error) => any }[U],
): this
Type Parameters
- U extends "debug" | "error"
Parameters
- event: U
- listener: { debug: (debug: string) => any; error: (error: Error) => any }[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners<U extends "debug" | "error">(
type: U,
): { debug: (debug: string) => any; error: (error: Error) => any }[U][]
Type Parameters
- U extends "debug" | "error"
Parameters
- type: U
Returns { debug: (debug: string) => any; error: (error: Error) => any }[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:23

removeAllListeners

removeAllListeners(event?: "debug" | "error"): this
Parameters
- Optionalevent: "debug" | "error"
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener<U extends "debug" | "error">(
event: U,
listener: { debug: (debug: string) => any; error: (error: Error) => any }[U],
): this
Type Parameters
- U extends "debug" | "error"
Parameters
- event: U
- listener: { debug: (debug: string) => any; error: (error: Error) => any }[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in 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/tiny-typed-emitter/lib/index.d.ts:25

setVolume

setVolume(volume: number): void
Parameters
- volume: number
Returns void
- Defined in src/core/DisTubeStream.ts:171

spawn

spawn(): void
Returns void
- Defined in src/core/DisTubeStream.ts:134