CreateAudioResourceOptions
export interface CreateAudioResourceOptions<T>
export interface CreateAudioResourceOptions<T>
Options that are set when creating a new audio resource.
Name | Constraints | Optional | Default | Description |
---|---|---|---|---|
T | No | the type for the metadata (if any) of the audio resource |
Optional
inlineVolume?
:
boolean
Whether or not inline volume should be enabled. If enabled, you will be able to change the volume of the stream on-the-fly. However, this also increases the performance cost of playback. Defaults to
false
.Optional
The type of the input stream. Defaults to
StreamType.Arbitrary
.Optional
metadata?
:
T
Optional metadata that can be attached to the resource (e.g. track title, random id). This is useful for identification purposes when the resource is passed around in events. See metadata
Optional
silencePaddingFrames?
:
number
The number of silence frames to append to the end of the resource's audio stream, to prevent interpolation glitches. Defaults to 5.