Class DisTubeStream

Create a stream to play with DisTubeVoice

Hierarchy

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

Index

Constructors

constructor

new DisTubeStream(url, options): 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:68

Properties

`Private` killed

killed: boolean = false

process

process: ChildProcess

stream

stream: PassThrough

type

type: StreamType

url

url: string

`Static` defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener<U>(event, listener): this
Type Parameters
- U extends "error" | "debug"
Parameters
- event: U
- listener: {
  debug: ((debug) => any);
  error: ((error) => any);
  }[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

`Private` debug

debug(debug): void
Parameters
- debug: string
Returns void
- Defined in src/core/DisTubeStream.ts:145

emit

emit<U>(event, ...args): boolean
Type Parameters
- U extends "error" | "debug"
Parameters
- event: U
- Rest ...args: Parameters<{
  debug: ((debug) => any);
  error: ((error) => any);
  }[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>(): U[]
Type Parameters
- U extends "error" | "debug"
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

kill

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

listenerCount

listenerCount(type): number
Parameters
- type: "error" | "debug"
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>(type): {
debug: ((debug) => any);
error: ((error) => any);
}[U][]
Type Parameters
- U extends "error" | "debug"
Parameters
- type: U
Returns {
debug: ((debug) => any);
error: ((error) => any);
}[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>(event, listener): this
Type Parameters
- U extends "error" | "debug"
Parameters
- event: U
- listener: {
  debug: ((debug) => any);
  error: ((error) => any);
  }[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>(event, listener): this
Type Parameters
- U extends "error" | "debug"
Parameters
- event: U
- listener: {
  debug: ((debug) => any);
  error: ((error) => any);
  }[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>(event, listener): this
Type Parameters
- U extends "error" | "debug"
Parameters
- event: U
- listener: {
  debug: ((debug) => any);
  error: ((error) => any);
  }[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

prependListener

prependListener<U>(event, listener): this
Type Parameters
- U extends "error" | "debug"
Parameters
- event: U
- listener: {
  debug: ((debug) => any);
  error: ((error) => any);
  }[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>(event, listener): this
Type Parameters
- U extends "error" | "debug"
Parameters
- event: U
- listener: {
  debug: ((debug) => any);
  error: ((error) => any);
  }[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>(type): {
debug: ((debug) => any);
error: ((error) => any);
}[U][]
Type Parameters
- U extends "error" | "debug"
Parameters
- type: U
Returns {
debug: ((debug) => any);
error: ((error) => any);
}[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: "error" | "debug"
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>(event, listener): this
Type Parameters
- U extends "error" | "debug"
Parameters
- event: U
- listener: {
  debug: ((debug) => any);
  error: ((error) => any);
  }[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

`Static` DirectLink

DirectLink(url, options): DisTubeStream
Create a stream from a stream url
Parameters
- url: string
  stream url
- options: StreamOptions
  options
Returns DisTubeStream
- Defined in src/core/DisTubeStream.ts:176

`Static` YouTube

YouTube(song, options): DisTubeStream
Create a stream from a YouTube Song
Parameters
- song: Song<unknown>
  A YouTube Song
- options: StreamOptions
  options
Returns DisTubeStream
- Defined in src/core/DisTubeStream.ts:160