Interface PlayOptions

Options for playing audio clips.

interface PlayOptions {
    group?: string;
    loop?: boolean;
    pan?: number;
    pitch?: number;
    tag?: string;
    volume?: number;
}

Index

Properties

group? loop? pan? pitch? tag? volume?

Properties

`Optional`group

group?: string

Audio group name.

`Optional`loop

loop?: boolean

Whether to loop the clip.

`Optional`pan

pan?: number

Stereo pan, -1 left to 1 right.

`Optional`pitch

pitch?: number

Pitch scaling factor.

`Optional`tag

tag?: string

Custom tag for identification.

`Optional`volume

volume?: number

Volume level, 0-1.