Class Piper

Hierarchy

EventEmitter
- Piper

Index

Constructors

constructor

Properties

Constructors

constructor

new Piper(converterCommand: string, opusFactory: OpusScript): Piper

- Defined in node_modules/eris/index.d.ts:2185
Parameters
- converterCommand: string
- opusFactory: OpusScript
Returns Piper

Properties

converterCommand

converterCommand: ConverterCommand

dataPacketCount

dataPacketCount: number

encoding

encoding: boolean

libopus

libopus: boolean

opus

opus: null | OpusScript

opusFactory

opusFactory: () => OpusScript

Type declaration

- (): OpusScript
- Returns OpusScript

volumeLevel

volumeLevel: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addDataPacket

addDataPacket(packet: unknown): void

- Defined in node_modules/eris/index.d.ts:2187
Parameters
- packet: unknown
Returns void

addListener

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

- 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 Piper

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

encode

encode(source: string | Stream, options: VoiceResourceOptions): boolean

- Defined in node_modules/eris/index.d.ts:2188
Parameters
- source: string | Stream
- options: VoiceResourceOptions
Returns boolean

eventNames

eventNames(): (string | symbol)[]

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

getDataPacket

getDataPacket(): Buffer

- Defined in node_modules/eris/index.d.ts:2189
Returns Buffer

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): Piper

- 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 Piper

on

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

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

once

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

- 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 Piper

prependListener

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

- 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 Piper

prependOnceListener

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

- 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 Piper

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): Piper

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

removeListener

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

- 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 Piper

reset

reset(): void

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

resetPackets

resetPackets(): void

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

setMaxListeners

setMaxListeners(n: number): Piper

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

setVolume

setVolume(volume: number): void

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

stop

stop(e: Error, source: Duplex): void

- Defined in node_modules/eris/index.d.ts:2193
Parameters
- e: Error
- source: Duplex
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