StreamOptions

typedef · Source

Options that can be passed to stream-playing methods: Type: Object

Properties

type

optional

type: StreamType

The type of stream.

Default: 'unknown'

seek

optional

seek: number

The time to seek to, will be ignored when playing ogg/opus or webm/opus streams

Default: 0

volume

optional

volume: number | boolean

The volume to play at. Set this to false to disable volume transforms for this stream to improve performance.

Default: 1

plp

optional

plp: number

Expected packet loss percentage

fec

optional

fec: boolean

Enabled forward error correction

bitrate

optional

bitrate: number | string

The bitrate (quality) of the audio in kbps. If set to 'auto', the voice channel's bitrate will be used

Default: 96

highWaterMark

optional

highWaterMark: number

The maximum number of opus packets to make and store before they are actually needed. See https://nodejs.org/en/docs/guides/backpressuring-in-streams/. Setting this value to 1 means that changes in volume will be more instant.

Default: 12