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.agent.ON_MESSAGE;

const { AudioAppKit } from '@bragiai/audio-app-kit';
// Usage: AudioAppKit.events.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);

window.addEventListener(AudioAppKit.events.agent.ON_STATE_UPDATE, event => {
  // Handle event
});

{
  "state": 1 // agentNotify.StatePayload_State.INITIAL
}

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);

window.addEventListener(AudioAppKit.events.agent.ON_MUTE_STATE_UPDATE, event => {
  // Handle event
});

{
  "state": 0 // agentShared.StatePayload_State.OFF
}

Chat Message Received

Listen for events when a chat message is received:

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

window.addEventListener(AudioAppKit.events.agent.ON_MESSAGE, event => {
  // Handle event
});

{
  "text": "What is superconductivity?",
  "uuid": "43fed0f0-4e6c-496e-8d2e-3b0c633dab0c",
  "createdAt": "2025-04-14T12:51:37.747Z",
  "sender": 1 // agentNotify.ChatMessagePayload_MessageSender.USER
}

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);

window.addEventListener(AudioAppKit.events.agent.ON_CHAT_HISTORY_UPDATE, event => {
  // Handle event
});

{
  "messages": [
    {
      "text": "What is superconductivity?",
      "uuid": "43fed0f0-4e6c-496e-8d2e-3b0c633dab0c",
      "createdAt": "2025-04-14T12:51:37.747Z",
      "sender": 1 // agentNotify.ChatMessagePayload_MessageSender.USER
    },
    // ...
  ]
}

Language Updated

Listen for events when the chat language is updated:

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

window.addEventListener(AudioAppKit.events.agent.ON_LANGUAGE_UPDATE, event => {
  // Handle event
});

{
  "language": "en"
}

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);

window.addEventListener(AudioAppKit.events.agent.ON_AVAILABLE_LANGUAGES, event => {
  // Handle event
});

[
  {
    "label": "English",
    "code": "en"
  },
  {
    "label": "Spanish",
    "code": "es"
  },
  // ...
]

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);

window.addEventListener(AudioAppKit.events.agent.ON_PAD_VOLUME_UPDATE, event => {
  // Handle event
});

{
  "value": 50
}

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);

window.addEventListener(AudioAppKit.events.agent.ON_VOICE_CONTROL_UPDATE, event => {
  // Handle event
});

{
  "state": 1 // agentShared.StatePayload.ON
}

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);

window.addEventListener(AudioAppKit.events.agent.ON_WAKE_WORD_UPDATE, event => {
  // Handle event
});

{
  "isAvailable": true,
  "title": "Hey, Chat AI"
}

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);

window.addEventListener(AudioAppKit.events.agent.ON_NOTIFICATION_BADGE_STATE_UPDATE, event => {
  // Handle event
});

{
  isActive: true, // Boolean - whether the notification badge is active
  type: 0 // agentShared.NotificationBadgePayload_Type.SETTINGS_BUTTON
}

Listen for events when a banner state updates:

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

window.addEventListener(AudioAppKit.events.agent.ON_BANNER_UPDATE, event => {
  // Handle event
});

{
  isAvailable: true, // Boolean - whether the banner is available
  title: "✨ Bonus: for a limited time try our UHD AI models"
}

Debug Data

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

window.addEventListener(AudioAppKit.events.agent.ON_DEBUG_DATA, event => {
  // Handle event
});

{
  lastSessionId: "123123";
  cloudVersion: "1.0.0";
  serviceId: "chatai";
}

Available Language models

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

window.addEventListener(AudioAppKit.events.agent.ON_AVAILABLE_LANGUAGE_MODELS, event => {
  // Handle event
});

{
  models: [
    {
      label: "English", // The language label of the model
      code: "en", // The language code of the model
      downloaded: true, // Whether the model is downloaded
      fileSize: 83886080, // File size in bytes
      estimatedDownloadTime: 120, // Estimated download time in seconds
      newVersionAvailable: false, // Whether a new version of the model is available
      newVersionBannerContent: '✨ New English AI voice is out', // The banner content for the new version of the model
    },
    // ...
  ],
}

Download Language Model Progress

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

window.addEventListener(AudioAppKit.events.agent.ON_LANGUAGE_MODEL_DOWNLOAD_PROGRESS, event => {
  // Handle event
});

{
  languageCode: 'en', // The language code of the model
  progress: 42, // Progress in percent
}

Download Language Model Error

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

window.addEventListener(AudioAppKit.events.agent.ON_LANGUAGE_MODEL_DOWNLOAD_ERROR, event => {
  // Handle event
});

{
  languageCode: 'en', // The language code of the model
  errorType: agentNotify.LanguageModelDownloadErrorPayload_ErrorType.STORAGE_FULL, // Storage full error
}

Placeholder Message Update

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

window.addEventListener(AudioAppKit.events.agent.ON_PLACEHOLDER_MESSAGE_UPDATE, event => {
  // Handle event
});

{
  message: '🎉 Download abgeschlossen – Sie können jetzt mit ChatAI sprechen und ChatAI wird auf Deutsch antworten.',
}

Get Started

Audio Apps

Importing Events

List of Events

Agent State Update

Mute State Update

Chat Message Received

Chat History Received

Language Updated

Available Languages Received

Pad Volume Update

Voice Control Update

Wake Word Update

Notification Badge State Updated

Banner State Updated

Debug Data

Available Language models

Download Language Model Progress

Download Language Model Error

Placeholder Message Update

​Importing Events

​List of Events

​Agent State Update

​Mute State Update

​Chat Message Received

​Chat History Received

​Language Updated

​Available Languages Received

​Pad Volume Update

​Voice Control Update

​Wake Word Update

​Notification Badge State Updated

​Banner State Updated

​Debug Data

​Available Language models

​Download Language Model Progress

​Download Language Model Error

​Placeholder Message Update

Importing Events

List of Events

Agent State Update

Mute State Update

Chat Message Received

Chat History Received

Language Updated

Available Languages Received

Pad Volume Update

Voice Control Update

Wake Word Update

Notification Badge State Updated

Banner State Updated

Debug Data

Available Language models

Download Language Model Progress

Download Language Model Error

Placeholder Message Update