forked from foundryvtt/pf2e
-
Notifications
You must be signed in to change notification settings - Fork 0
/
playlist-sound.d.ts
36 lines (30 loc) · 1.5 KB
/
playlist-sound.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
import type { ClientBasePlaylistSound } from "./client-base-mixes.d.ts";
declare global {
/**
* The PlaylistSound embedded document within a Playlist document which extends the BasePlaylist abstraction.
* Each PlaylistSound belongs to the results collection of a Playlist entity.
* Each PlaylistSound contains a PlaylistSoundData object which provides its source data.
*
* @see {@link data.PlaylistSoundData} The PlaylistSound data schema
* @see {@link documents.Playlist} The Playlist document which contains PlaylistSound embedded documents
* @see {@link Sound} The Sound API which manages web audio playback
*/
class PlaylistSound<TParent extends Playlist | null> extends ClientBasePlaylistSound<TParent> {
constructor(
data: PreCreate<foundry.documents.PlaylistSoundSource>,
context?: DocumentConstructionContext<TParent>
);
/** The Sound which manages playback for this playlist sound */
sound: Sound | null;
/**
* A debounced function, accepting a single volume parameter to adjust the volume of this sound
* @param volume The desired volume level
*/
debounceVolume: (volume: number) => unknown;
/** The debounce tolerance for processing rapid volume changes into database updates in milliseconds */
static VOLUME_DEBOUNCE_MS: number;
/** @todo fill the rest of this in */
}
/** @todo: fill in */
class Sound {}
}