Class SharedStream

Hierarchy

EventEmitter
- SharedStream

Index

Constructors

constructor

Properties

Constructors

constructor

new SharedStream(options?: EventEmitterOptions): SharedStream

- Defined in node_modules/@types/node/events.d.ts:41
Parameters
- Optional options: EventEmitterOptions
Returns SharedStream

Properties

bitrate

bitrate: number

channels

channels: number

Optional current

current: undefined | VoiceStreamCurrent

ended

ended: boolean

frameDuration

frameDuration: number

on

on: StreamEvents<SharedStream>

piper

piper: Piper

playing

playing: boolean

samplingRate

samplingRate: number

speaking

speaking: boolean

voiceConnections

voiceConnections: Collection<VoiceConnection>

volume

volume: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

add

add(connection: VoiceConnection): void

- Defined in node_modules/eris/index.d.ts:2351
Parameters
- connection: VoiceConnection
Returns void

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): SharedStream

- Defined in node_modules/@types/node/globals.d.ts:547
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SharedStream

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/globals.d.ts:557
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/globals.d.ts:562
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/globals.d.ts:554
Returns number

listenerCount

listenerCount(type: string | symbol): number

- Defined in node_modules/@types/node/globals.d.ts:558
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/globals.d.ts:555
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): SharedStream

- Defined in node_modules/@types/node/globals.d.ts:551
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SharedStream

once

once(event: string | symbol, listener: (...args: any[]) => void): SharedStream

- Defined in node_modules/@types/node/globals.d.ts:549
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SharedStream

play

play(resource: string | Readable, options?: VoiceResourceOptions): void

- Defined in node_modules/eris/index.d.ts:2352
Parameters
- resource: string | Readable
- Optional options: VoiceResourceOptions
Returns void

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): SharedStream

- Defined in node_modules/@types/node/globals.d.ts:560
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SharedStream

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): SharedStream

- Defined in node_modules/@types/node/globals.d.ts:561
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SharedStream

rawListeners

rawListeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/globals.d.ts:556
Parameters
- event: string | symbol
Returns Function[]

remove

remove(connection: VoiceConnection): void

- Defined in node_modules/eris/index.d.ts:2353
Parameters
- connection: VoiceConnection
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): SharedStream

- Defined in node_modules/@types/node/globals.d.ts:552
Parameters
- Optional event: string | symbol
Returns SharedStream

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): SharedStream

- Defined in node_modules/@types/node/globals.d.ts:550
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SharedStream

setMaxListeners

setMaxListeners(n: number): SharedStream

- Defined in node_modules/@types/node/globals.d.ts:553
Parameters
- n: number
Returns SharedStream

setSpeaking

setSpeaking(value: boolean): void

- Defined in node_modules/eris/index.d.ts:2354
Parameters
- value: boolean
Returns void

setVolume

setVolume(volume: number): void

- Defined in node_modules/eris/index.d.ts:2355
Parameters
- volume: number
Returns void

stopPlaying

stopPlaying(): void

- Defined in node_modules/eris/index.d.ts:2356
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc