omphalos.sound.set

function omphalos.sound.set(soundName, options);
function omphalos.sound.set(soundName, bundleName, options);

Adjust the per-sound options for the sound name provided, optionally in a bundle other than this assets current bundle. The sound name is the name given to the sound in the sound manifest for the given bundle.

Caution

When used in a panel or graphic, this API only allows for setting the playback settings for sounds in the current bundle. Attempting to alter data for sounds in other bundles will raise an error. Such operations need to be carried out in a server extension.

The passed options will be used to update the system mixer’s settings for this particular sound, for future use in calls to omphalos.sound.play().

The options provided should follows this structure:

{
  "volume": "number",  // Linear volume multiplier, 0.0 to 1.0 (100%)
  "pan": "number"      // Stereo panning -1.0 to 1.0, 0.0 is center
}