Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SharedStream

Hierarchy

  • EventEmitter
    • SharedStream

Index

Constructors

Properties

Methods

Constructors

constructor

  • new SharedStream(options?: EventEmitterOptions): SharedStream

  • Parameters

    • Optional options: EventEmitterOptions

    Returns SharedStream

Properties

bitrate

bitrate: number

channels

channels: number

Optional current

current: 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 Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

add

  • Parameters

    Returns void

addListener

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

  • 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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

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

  • 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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SharedStream

play

  • Parameters

    Returns void

prependListener

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

  • 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

  • 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[]

  • Parameters

    • event: string | symbol

    Returns Function[]

remove

  • Parameters

    Returns void

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns SharedStream

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SharedStream

setMaxListeners

  • Parameters

    • n: number

    Returns SharedStream

setSpeaking

  • setSpeaking(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

setVolume

  • setVolume(volume: number): void

  • Parameters

    • volume: number

    Returns void

stopPlaying

  • stopPlaying(): void

  • Returns void

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc