Voice Assistant Overview

The on-device voice assistant runs supported wake-up and command handling on the wearable. Applications can read the device capability, inspect its current mode, and request a compatible mode through OnDeviceVoiceAssistantAPI.

Available Features

📄️Get On-Device Support

Read the connected device's on-device voice-assistant capability

📄️Get and Set On-Device Mode

Read and update the connected device's on-device voice-assistant mode

Implement with AI Assistance

Build with AI

Implement this workflow with AI

Use the official Manage AIBuds On-Device Voice Assistant skill to adapt this workflow to your app.

Read and follow https://docs-aibuds.github.io/skills/manage-aibuds-on-device-voice-assistant. Use it to implement Manage AIBuds On-Device Voice Assistant in this iOS project and verify the result.

View official skill

Capability and Mode

OnDeviceVoiceAssistantCapability describes what the device supports:

Capability	Supported behavior
`.none`	No on-device voice-command capability.
`.keywordWakeup`	Keyword wake-up only, such as “Hi Buds.”
`.common`	Common commands such as playback, track, and volume control.

OnDeviceVoiceAssistantMode describes the active behavior:

Mode	Behavior
`.unknown`	Current mode is unavailable. Do not set this value.
`.disabled`	On-device voice assistant is disabled.
`.basic`	Wake-up and basic voice commands.
`.advanced`	Basic behavior plus call-state voice control.

Capability determines which modes should be offered. The current Demo exposes disabled and basic for .keywordWakeup, and disabled, basic, and advanced for .common.

Integration Flow

Animated workflow

Voice assistant integration path

Prepare the SDK integration, confirm authorization and device capability, then expose only compatible assistant modes.

Host app

Initialize SDK

Install and initialize the base AIBuds SDK for the host application.

Host app

Install Integration

Add AIBudsVoiceAssistant when service authentication is required.

Service

Complete Authorization

Finish the required voice-assistant service authorization flow.

Device

Connect Device

Verify OnDeviceVoiceAssistantAPI conformance on the active device.

Device → app

Read Capability & Mode

Inspect supported behavior and the currently active assistant mode.

Host app → device

Apply Compatible Mode

Offer only valid modes, apply the selection, and update UI from completion or change callbacks.

Capability controls which modes the app should offer; never apply .unknown.

Prerequisites

The device is connected and ready.
Required service authentication is complete.
The device exposes OnDeviceVoiceAssistantAPI and a capability other than .none.

Available Features​