sharedSoundPlayers¶

Overview¶

This singleton is used to get instances of shared sound players. The most common use case for shared sound players is in common UI components that may have multiple instances within a sim, such as checkboxes and buttons. Sharing the sound players between these instances reduces memory consumption and load time versus creating separate instances. It also keeps the sound experience consistent.

These shared sound players are automatically added to the soundManager so there is no need for clients to do so.

Because these shared sound players are created on the first get for a particular one, instances should be gotten well before they need to be played, generally during construction of the view or model element that will need it. Waiting to get an instance until it needs to be played could result in a delayed or muffled first sound being produced.

@author John Blanco (PhET Interactive Simulations)

Type SharedSoundPlayerName¶

A list of all the available shared sound players as a string union type. Use these values to get a shared player.

import type { SharedSoundPlayerName } from 'scenerystack/tambo';

Source Code¶

See the source for sharedSoundPlayers.ts in the tambo repository.