Skip to main content
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.agent.ON_MESSAGE;

​
List of Events

​
Agent State Update

Listen for events when the agent state updates: 
window.addEventListener(AudioAppKitEvents.agent.ON_STATE_UPDATE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Mute State Update

Listen for events when the mute state updates: 
window.addEventListener(AudioAppKitEvents.agent.ON_MUTE_STATE_UPDATE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Chat Message Received

Listen for events when a chat message is received: 
window.addEventListener(AudioAppKitEvents.agent.ON_MESSAGE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Chat History Received

Listen for events when a chat history is received: 
window.addEventListener(AudioAppKitEvents.agent.ON_CHAT_HISTORY_UPDATE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Language Updated

Listen for events when the chat language is updated: 
window.addEventListener(AudioAppKitEvents.agent.ON_LANGUAGE_UPDATE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Available Languages Received

Listen for events when a list of available chat languages is received: 
window.addEventListener(AudioAppKitEvents.agent.ON_AVAILABLE_LANGUAGES, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Pad Volume Update

Listen for events when the pad volume is updated: 
window.addEventListener(AudioAppKitEvents.agent.ON_PAD_VOLUME_UPDATE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Voice Control Update

Listen for events when the voice control is updated: 
window.addEventListener(AudioAppKitEvents.agent.ON_VOICE_CONTROL_UPDATE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Wake Word Update

Listen for events when the wake word is updated: 
window.addEventListener(AudioAppKitEvents.agent.ON_WAKE_WORD_UPDATE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Notification Badge State Updated

Listen for events when a notification badge state updates: 
window.addEventListener(AudioAppKitEvents.agent.ON_NOTIFICATION_BADGE_STATE_UPDATE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);
Listen for events when a banner state updates: 
window.addEventListener(AudioAppKitEvents.agent.ON_BANNER_UPDATE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Debug Data

window.addEventListener(AudioAppKitEvents.agent.ON_DEBUG_DATA, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Available Language models

window.addEventListener(AudioAppKitEvents.agent.ON_AVAILABLE_LANGUAGE_MODELS, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Download Language Model Progress

window.addEventListener(AudioAppKitEvents.agent.ON_LANGUAGE_MODEL_DOWNLOAD_PROGRESS, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Download Language Model Error

window.addEventListener(AudioAppKitEvents.agent.ON_LANGUAGE_MODEL_DOWNLOAD_ERROR, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);

​
Placeholder Message Update

window.addEventListener(AudioAppKitEvents.agent.ON_PLACEHOLDER_MESSAGE_UPDATE, ((event: CustomEvent) => {
  // Handle event
}) as EventListener);
⌘I