SDK Glossary

Concise definitions of terms used throughout the AIBuds SDK documentation. Feature guides explain how to use each capability; the Architecture page explains how the SDK pieces fit together.

Bluetooth & Connectivity

BLEBluetooth Low Energy

The radio path used to discover devices, establish the SDK control connection, and exchange device commands. The ABMate module supplies the supported device protocol implementation.

RSSIReceived Signal Strength Indicator

A signed dBm value describing the received strength of a BLE advertisement. It is a proximity hint, not a distance measurement or connection-quality guarantee.

Advertisement Data

The metadata included in a peripheral's BLE broadcast. A discovered-device handle exposes the advertisement snapshot alongside the peripheral and RSSI.

Core Bluetooth ObjectsCBCentralManager / CBPeripheral

Apple's central manager coordinates scanning and connections; a peripheral represents one remote BLE device. The SDK wraps these objects in its device abstractions.

Classic Bluetooth

A separate Bluetooth path commonly used for audio profiles. Its connection state is independent from the BLE control connection.

SCOSynchronous Connection-Oriented

A Classic Bluetooth voice link used for bidirectional call or voice audio on supported devices.

Beacon Data

Optional manufacturer data broadcast without an active device connection. Use it only when the discovered device exposes a beacon payload.

Device Concepts

Discovered DeviceFoundDeviceConvertible

A scan result represented by FoundDeviceConvertible. Convert it through the SDK before saving or connecting it.

Storable DeviceDeviceConvertible

The persistent DeviceConvertible handle used for identity, connection state, saving, commands, delegates, and capability checks.

StoredDevicesMgr

The process-wide manager for the app's persisted device list. Stored devices can participate in supported auto-reconnection behavior.

Device Ready

The lifecycle point reached after connection and the SDK's post-connect handshake. Wait for deviceDidReady or check isConnectedAndReady before issuing feature commands.

Capability Protocol

A small optional *API protocol implemented only when a device supports that feature. Cast the device to the protocol instead of assuming every model has every capability.

Device State

A device-reported working condition. It is distinct from Core Bluetooth's peripheral state, which only describes the BLE link.

Work Mode / Work State

Work mode is the device's configured operating mode; work state is its current reported activity. Treat both as device snapshots that may change through delegate events.

Wear Detection

A device capability that reports whether wear detection is supported, whether it is enabled, and the current wear status.

TWSTrue Wireless Stereo

Describes paired left/right wireless devices. The SDK separately exposes whether a device identifies as TWS and whether its sibling is currently connected.

Auto Reconnect

Per-device behavior controlling whether a persisted device should reconnect when rediscovered after app launch or a Bluetooth restart. Its initial value comes from SDK configuration.

Audio & Voice

VADVoice Activity Detection

Signal processing that distinguishes speech from silence or background noise. AI audio integrations may use it to segment or gate incoming audio.

Standard Recording

Device-side recording started and stopped through the device audio-recording capability. The command result does not itself return a local audio file.

AI Audio Recording

A coordinated device and AI-service workflow: the device supplies audio while the selected provider produces session events, transcript updates, and a final report.

Recording Scene

The device recording context passed when starting AI audio capture. The public values distinguish on-site and call recording scenes.

PCMPulse-Code Modulation

Uncompressed digital audio samples. PCM is easy to process but uses more bandwidth and storage than compressed audio.

Opus

A compressed, low-latency audio codec used in supported voice and streaming paths.

On-Device Voice Assistant

Wake-up and command processing exposed through OnDeviceVoiceAssistantAPI on supported wearable firmware. Authorization may still require the registered bridge plugin and its integration environment.

AI & Speech

ASRAutomatic Speech Recognition

Converts speech audio into text. The SDK exposes both session-based streaming recognition and service APIs for supported inputs.

Streaming ASR

Recognition that emits incremental transcript updates while audio is arriving instead of waiting for one final result.

TTSText to Speech

Converts text into an audio file. TTSResultModel supplies the relative audioFile, its audioFormat, and the resolved audioFilePath.

AI Summary

Produces a condensed result from source text or a transcript. Supported providers may deliver the result incrementally.

Text Translation

Translates supplied text between configured languages. It is separate from continuous speech-session workflows.

Simultaneous Interpretation

A live session combining incoming audio, streaming recognition, translation, and supported target-language audio output.

AI Chat

A provider-backed conversational session that can emit transcript, chat, intent, voice, lifecycle, error, and final-report events.

AI Intent

Structured action data extracted from a chat interaction. It is separate from free-form text and only has meaning when the selected provider emits it.

AI Service ProviderAIServiceVendor / AIBudsAIServiceVendor

The registered provider selected for AI service calls. The public enum retains Vendor in its API name, while developer-facing documentation uses “service provider.” Installing a provider module, registering it, initializing it, and selecting it are separate steps.

StarBurst AI.starBurst / AIBudsAIServiceVendorStarBurst

The ByteDance-backed AI provider known in Chinese as “星芒 AI.” Apps register it through the AIBudsStarBurst module's StarBurstSDK before selecting it for AI service calls.

MltCloud AI.mltcloud / AIBudsAIServiceVendorMltcloud

The Meilc AI provider known in Chinese as “骆方案 AI.” Apps register it through the AIBudsMagicHelper module's MagicHelperSDK before selecting it for AI service calls.

Authorized Services

A device-reported bitmask describing which supported services completed their authorization handshake. It is not a general list of every installed AI module.

AI Dashboard

An optional local diagnostic interface for inspecting AI sessions, events, reports, and errors during controlled development or troubleshooting.

Sound Tuning

EQEqualizer

A device setting that applies frequency-band gains. Prefer settings reported by the device because custom EQ constraints are not currently a complete public contract.

Preset EQ

A device-provided equalizer setting such as a factory tuning profile. Available presets vary by device and firmware.

ANCActive Noise Cancellation

Device processing that reduces ambient sound. The public mode also distinguishes normal and transparency behavior.

Transparency Mode

An ANC mode that passes environmental sound through the wearable instead of suppressing it.

ANC Fade

A supported transition setting for changing ANC behavior gradually. Its audible effect remains device-defined.

Volume Domains

Independent device volume values for system prompts, media, calls, and readable local playback state. Check device capability before exposing a writable control.

VolumeSetCapability

A bitmask describing which volume-setting operations the current device supports.

Imaging, Streaming & Storage

Remote Shutter

A device-originated request for the host app to enter, capture with, or exit its camera. The app owns camera execution and reports the resulting state to the device.

Capture Mode

CaptureMode uses .camera to store a high-resolution photo on the device and .ai to push a 320×240 JPEG to the app.

RTSPReal-Time Streaming Protocol

The session URL used to play a supported device's live camera stream after the hotspot and streaming workflow succeeds.

JPEG Live Streaming

A callback-based stream of complete compressed JPEG images. Each callback delivers an image, not an undecoded raw video frame.

RTMPReal-Time Messaging Protocol

An optional publishing path used to relay a live stream to a compatible endpoint. Its lifecycle is separate from the device session and local player.

Media File Import

A device-to-app hotspot workflow exposed by DeviceMediaFileImportAPI. It fetches metadata, downloads selected files, and can optionally run local video stabilization.

MediaCountInfoModel

The current device-reported counts for supported media categories after a successful refresh request.

StorageInfoModel

The current device-reported used and free storage values, expressed in megabytes by the public model.

Over-the-Air Updates

OTAOver-the-Air Update

Updates the device's main firmware from a compatible local firmware package supplied by the host app.

Camera OTA

A separate firmware workflow for a supported camera module, including hotspot connection, local HTTP delivery, transfer, flashing, and final completion.

OTA Battery Limit

The minimum device battery percentage required before the main firmware update can start. A reported value of 0 means no battery threshold.

SDK Architecture

SDKDelegate / DeviceDelegate

SDKDelegate receives SDK-wide scanning and device events. DeviceDelegate receives events associated with one device.

All-in-One

The aggregate installation and convenience initializer for the complete supported SDK suite. Modular integration gives the host app finer dependency and plugin control.

Bridge Plugin

An optional adapter that connects provider-specific authentication or services to the core SDK through a public plugin boundary.

ConnectParams

Per-connection values such as user identity, pairing data, Classic Bluetooth preference, and optional AI authorization parameters.

LogService

The active process-wide LogService backend. One configured destination handles output; supported persisted destinations also provide export and cleanup.

SDKConfiguration

Initialization-time defaults for confirmed SDK behavior such as log level, scan timeout, auto reconnect, and known-device discovery filtering.