Class RoomAudioDecodeCache

A bounded, promise-sharing LRU of decoded PCM.

Index

Constructors

Accessors

Methods

Clear GetOrLoad

Constructors

constructor

new RoomAudioDecodeCache(
maxEntries?: number,
maxSamples?: number,
): RoomAudioDecodeCache
Parameters
- maxEntries: number = DEFAULT_DECODE_CACHE_ENTRIES
  Maximum number of cached sources.
- maxSamples: number = DEFAULT_DECODE_CACHE_MAX_SAMPLES
  Maximum total samples held across all resolved entries.
Returns RoomAudioDecodeCache
- Defined in LiveKitRoomServer/src/room-audio/room-audio-decode-cache.ts:31

Accessors

Size

get Size(): number
How many sources are cached (or loading).

Returns number
- Defined in LiveKitRoomServer/src/room-audio/room-audio-decode-cache.ts:37

Methods

Clear

Clear(): void
Empties the cache.

Returns void
- Defined in LiveKitRoomServer/src/room-audio/room-audio-decode-cache.ts:70

GetOrLoad

GetOrLoad(
key: string,
load: () => Promise<Int16Array<ArrayBufferLike>>,
): Promise<Int16Array<ArrayBufferLike>>
Returns the cached PCM for key, or runs load once and caches its result. Concurrent callers for the same key share one load. A rejected load is removed so the next call retries.
Parameters
- key: string
- load: () => Promise<Int16Array<ArrayBufferLike>>
Returns Promise<Int16Array<ArrayBufferLike>>
- Defined in LiveKitRoomServer/src/room-audio/room-audio-decode-cache.ts:45