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 typeCustomEvent and it contains the payload within event.detail property.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
CustomEvent and it contains the payload within event.detail property.
import { AudioAppKitEvents } from '@bragiai/audio-app-kit';
// Usage: AudioAppKitEvents.streaming.ON_PLAYLISTS;
const { AudioAppKit } = require('@bragiai/audio-app-kit');
// Usage: AudioAppKit.events.streaming.ON_PLAYLISTS;
import { AudioAppKit } from '@bragiai/audio-app-kit';
// Usage: AudioAppKit.events.streaming.ON_PLAYLISTS;
window.addEventListener(AudioAppKitEvents.streaming.ON_CONFIG_AVAILABILITY_CHANGE, ((event: CustomEvent) => {
// Handle event
}) as EventListener);
window.addEventListener(AudioAppKit.events.streaming.ON_CONFIG_AVAILABILITY_CHANGE, event => {
// Handle event
});
{
isANCAvailable: true;
isTransparencyAvailable: false;
isEqualizerAvailable: true;
isShuffleAvailable: true;
isRepeatAvailable: true;
}
window.addEventListener(AudioAppKitEvents.streaming.ON_CATEGORIES, ((event: CustomEvent) => {
// Handle event
}) as EventListener);
window.addEventListener(AudioAppKit.events.streaming.ON_CATEGORIES, event => {
// Handle event
});
{
categories: [
{
id: 'music';
title: 'Music';
},
{
id: 'podcasts';
title: 'Podcasts';
}
]
}
window.addEventListener(AudioAppKitEvents.streaming.ON_PLAYLISTS, ((event: CustomEvent) => {
// Handle event
}) as EventListener);
window.addEventListener(AudioAppKit.events.streaming.ON_PLAYLISTS, event => {
// Handle event
});
{
playlists: [
{
id: 'b8b2790d-02b7-48c0-b50d-f5de63715887';
title: 'Gravity';
imageUrl: 'https://example.com/playlist.png';
}
]
}
window.addEventListener(AudioAppKitEvents.streaming.ON_EQUALIZER_PRESETS, ((event: CustomEvent) => {
// Handle event
}) as EventListener);
window.addEventListener(AudioAppKit.events.streaming.ON_EQUALIZER_PRESETS, event => {
// Handle event
});
{
presets: ['flat', 'treble', 'bass', 'bassBoost', 'vocal', 'podcast', 'rock', 'movie', 'music', 'custom']
}
window.addEventListener(AudioAppKitEvents.streaming.ON_USER_PROFILE, ((event: CustomEvent) => {
// Handle event
}) as EventListener);
window.addEventListener(AudioAppKit.events.streaming.ON_USER_PROFILE, event => {
// Handle event
});
{
imageUrl: 'https://example.com/user.png',
isPremium: true
}
window.addEventListener(AudioAppKitEvents.streaming.ON_SHORTCUT_CONFIG, ((event: CustomEvent) => {
// Handle event
}) as EventListener);
window.addEventListener(AudioAppKit.events.streaming.ON_SHORTCUT_CONFIG, event => {
// Handle event
});
{
playlistId: '81755f03-9a82-47f6-be0c-d7fa986e4352',
isTransparencyEnabled: false,
isAncEnabled: true,
isShuffleEnabled: true,
isRepeatEnabled: true,
equalizerType: 'flat'
}
