ProtectedconstructorBaseSingleton requires a protected constructor.
StaticInstanceThe process-wide player.
Forgets every cached decode (e.g. after a hold file is replaced under the same id).
The live playbacks in a room (room names compare case-insensitively).
The Global Object Store is a place to store global objects that need to be shared across the application. Depending on the execution environment, this could be the window object in a browser, or the global object in a node environment, or something else in other contexts. The key here is that in some cases static variables are not truly shared because it is possible that a given class might have copies of its code in multiple paths in a deployed application. This approach ensures that no matter how many code copies might exist, there is only one instance of the object in question by using the Global Object Store.
Overrides the native room-module loader (tests inject a fake module).
Overrides the native room-module specifier; undefined returns to LIVEKIT_NATIVE_MODULE / the default.
Installs the text-to-speech used by RoomAudioHandle.Announce with { Text } — e.g. an
MJRoomSpeechSynthesizer. None is installed by default (a voice is vendor-specific); without one a text
announcement returns false and the player logs the omission once.
The synthesizer, or undefined to remove it.
Overrides where bot tokens come from (tests; a host with its own credentials).
Starts playing params.Source into params.RoomName: loads and decodes it (cached by source), joins the room as
a publish-only bot, and paces the audio in.
The live playback.
Stops every playback in a room. Never throws.
How many playbacks were stopped.
Protected StaticgetReturns the singleton instance of the class. If the instance does not exist, it is created and stored in the Global Object Store. If className is provided it will be used as part of the key in the Global Object Store, otherwise the actual class name will be used. NOTE: the class name used by default is the lowest level of the object hierarchy, so if you have a class that extends another class, the lowest level class name will be used.
OptionalclassName: string
Plays audio into LiveKit rooms. A process-wide singleton so the playback registry (and the
room_finishedcleanup that reads it) is shared by every caller.