Skip to content

Improve script api documentation for AudioInjector #2029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zedwick wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improve script api documentation for AudioInjector #2029

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f359c48
Clarify that AudioInjector.setOptions replaces existing options in th…
zedwick Jan 14, 2026
ad11bd3
Do not use var in AudioInjector script examples
zedwick Jan 14, 2026
3cd6b16
Add script api example for AudioInjector.getOptions
zedwick Jan 14, 2026
75356d6
Fix syntax
zedwick Jan 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 46 additions & 9 deletions libraries/audio/src/ScriptAudioInjector.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ public slots:
* Stops audio playback.
* @function AudioInjector.stop
* @example <caption>Stop playing a sound before it finishes.</caption>
* var sound = SoundCache.getSound(Script.resourcesPath() + "sounds/sample.wav");
* var injector;
* var injectorOptions = {
* const sound = SoundCache.getSound(Script.resourcesPath() + "sounds/sample.wav");
* let injector;
* const injectorOptions = {
* position: MyAvatar.position
* };
*
Expand All @@ -85,13 +85,50 @@ public slots:
* Gets the current configuration of the audio injector.
* @function AudioInjector.getOptions
* @returns {AudioInjector.AudioInjectorOptions} Configuration of how the injector plays the audio.
* @example <caption>Prints injector options to log</caption>
* let sound = SoundCache.getSound(Script.resourcesPath() + "sounds/sample.wav");
* let injector;
* let injectorOptions = {
* position: MyAvatar.position,
* volume: 0.8,
* };
*
* Script.setTimeout(function () { // Give the sound time to load.
* injector = Audio.playSound(sound, injectorOptions);
* }, 1000);
*
* Script.setTimeout(function () {
* const options = injector.getOptions();
*
* print("Current AudioInjectorOptions: ",JSON.stringify(options)); // Print all options to log
*
* print("Volume is set to ", options.volume);
* }, 2000);
*/
AudioInjectorOptions getOptions() const { return DependencyManager::get<AudioInjectorManager>()->getOptions(_injector); }

/*@jsdoc
* Configures how the injector plays the audio.
* This will replace all current AudioInjectorOptions.
* @function AudioInjector.setOptions
* @param {AudioInjector.AudioInjectorOptions} options - Configuration of how the injector plays the audio.
* @example <caption>Reduce the volume of the sound without changing other existing options.</caption>
* const sound = SoundCache.getSound(Script.resourcesPath() + "sounds/sample.wav");
* let injector;
* const injectorOptions = {
* position: MyAvatar.position,
* volume: 1.0,
* };
*
* Script.setTimeout(function () { // Give the sound time to load.
* injector = Audio.playSound(sound, injectorOptions);
* }, 1000);
*
* Script.setTimeout(function () {
* const options = injector.getOptions();
* options.volume = 0.2 // Reduce volume
* injector.setOptions(options); // replace existing options
* }, 5000);
*/
void setOptions(const AudioInjectorOptions& options) { DependencyManager::get<AudioInjectorManager>()->setOptions(_injector, options); }

Expand All @@ -107,9 +144,9 @@ public slots:
* @function AudioInjector.isPlaying
* @returns {boolean} <code>true</code> if the audio is currently playing, otherwise <code>false</code>.
* @example <caption>See if a sound is playing.</caption>
* var sound = SoundCache.getSound(Script.resourcesPath() + "sounds/sample.wav");
* var injector;
* var injectorOptions = {
* const sound = SoundCache.getSound(Script.resourcesPath() + "sounds/sample.wav");
* let injector;
* const injectorOptions = {
* position: MyAvatar.position
* };
*
Expand All @@ -130,9 +167,9 @@ public slots:
* @function AudioInjector.finished
* @returns {Signal}
* @example <caption>Report when a sound has finished playing.</caption>
* var sound = SoundCache.getSound(Script.resourcesPath() + "sounds/sample.wav");
* var injector;
* var injectorOptions = {
* const sound = SoundCache.getSound(Script.resourcesPath() + "sounds/sample.wav");
* let injector;
* const injectorOptions = {
* position: MyAvatar.position
* };
*
Expand Down
Loading