Skip to main content

Events

All events are being dispatched from Audio App Kit to the window object. In order to listen for events, an event listener needs to be created. Each event is of type CustomEvent and it contains the payload within event.detail property.

Importing Events

import { AudioAppKitEvents } from '@bragiai/audio-app-kit';
// Usage: AudioAppKitEvents.streaming.ON_PLAYLISTS;

List of Events

Configuration Availability Changed

Listen for events when the configuration availability changes:
window.addEventListener(AudioAppKitEvents.streaming.ON_CONFIG_AVAILABILITY_CHANGE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

Categories Received

Listen for events when the list of categories has been received.
window.addEventListener(AudioAppKitEvents.streaming.ON_CATEGORIES, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

Playlists Received

Listen for events when the list of playlists has been received.
window.addEventListener(AudioAppKitEvents.streaming.ON_PLAYLISTS, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

Equalizer Presets Received

Listen for events when the list of equalizer presets has been received.
window.addEventListener(AudioAppKitEvents.streaming.ON_EQUALIZER_PRESETS, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

User Profile Received

Listen for events when the user profile has been received.
window.addEventListener(AudioAppKitEvents.streaming.ON_USER_PROFILE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

Shortcut Config Received

Listen for events when the initial shortcut config is received.
window.addEventListener(AudioAppKitEvents.streaming.ON_SHORTCUT_CONFIG, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);
I