Skip to content

@nhtio/common-vue/sounds

A module that provides sound-related utilities for web applications

Other

NameDescription
SoundManager-
DemoSoundPlayerA type representing the public instance of the DemoSoundPlayer component.
NotificationA type representing the list of available notification sounds.
SoundManagerConstructorEventSubscriptionA type representing an event subscription for the SoundManager which is passed to the constructor so that they are subscribed on creation. Formats include: - A callback function - A tuple containing a callback function as the first element - A tuple containing a callback function as the first element and a boolean once flag as the second element which indicates if the subscription should be removed after the first invocation.
SoundManagerConstructorSignalSubscriptionA type representing a signal subscription for the SoundManager which is passed to the constructor so that they are subscribed on creation. Formats include: - A callback function - A tuple containing a callback function as the first element - A tuple containing a callback function as the first element and a boolean once flag as the second element which indicates if the subscription should be removed after the first invocation.
SoundManagerEventsA map of publically subscribable events emitted by the SoundManager.
SoundManagerInternalBusEventMapA map of events used internally by the SoundManager.
SoundManagerOptionsOptions for configuring the SoundManager.
DemoSoundPlayerA Vue component that provides a demo sound player interface.
NotificationA list of available notification sounds.
SoundUrlsA readonly map of notification sound names to their corresponding audio file URLs.

Utilities

FunctionDescription
isHTMLAudioElementType guard that checks if a value is an HTMLAudioElement. Safe to use in SSR environments.