AudioResource
Represents an audio resource that can be played by an audio player.
| Name | Constraints | Optional | Default | Description |
|---|---|---|---|---|
| T | Yes | unknown | the type for the metadata (if any) of the audio resource |
constructor(edges, streams, metadata, silencePaddingFrames)
Constructs a new instance of the
AudioResource class| Name | Type | Optional | Description |
|---|---|---|---|
| edges | readonly Edge[] | No | None |
| streams | readonly Readable[] | No | None |
| metadata | T | No | None |
| silencePaddingFrames | number | No | None |
The audio player that the resource is subscribed to, if any.
Readonly
The pipeline used to convert the input stream into a playable format. For example, this may contain an FFmpeg component for arbitrary inputs, and it may contain a VolumeTransformer component for resources with inline volume transformation enabled.
Readonly
If using an Opus encoder to create this audio resource, then this will be a prism-media opus.Encoder. You can use this to control settings such as bitrate, FEC, PLP.
An object-mode Readable stream that emits Opus packets. This is what is played by audio players.
Whether this resource is readable. If the underlying resource is no longer readable, this will still return true while there are silence padding frames left to play.
The number of silence frames to append to the end of the resource's audio stream, to prevent interpolation glitches.
The number of remaining silence frames to play. If -1, the frames have not yet started playing.
Readonly
If the resource was created with inline volume transformation enabled, then this will be a prism-media VolumeTransformer. You can use this to alter the volume of the stream.