Home

This Wiki is generated from the AIBuds SDK documentation. Do not edit generated pages by hand; update the documentation source and regenerate the Wiki instead.

Full documentation · API Reference

AIBuds SDK iOS

Welcome to the AIBuds SDK iOS documentation. The SDK helps iOS applications connect to supported AIBuds devices and integrate the product capabilities they need.

What is AIBuds SDK?

AIBuds SDK is a modular SDK for discovering, connecting, and interacting with supported AIBuds devices from an iOS application. Optional modules add AI services, an on-device voice assistant integration, media workflows, logging, crash reporting, and video stabilization.

Its CocoaPods subspecs let you install the complete SDK or select only the capabilities your product ships. Device features and provider availability still depend on the connected device, installed SDK modules, and configured services.

Key Features

• Core Connectivity - Device discovery, connection lifecycle management, persistent device records, and Bluetooth communication
• Device Features - Device information, physical operations, audio controls, recording, camera, media transfer, live streaming, and firmware updates
• AI Services - AI chat, AI recording, streaming speech recognition, text-to-speech, summaries, text translation, simultaneous interpretation, conversation translation, image generation, and asking services
• On-device Voice Assistant - Service authorization plus capability and mode management for wake-up and command handling performed by the wearable
• Comprehensive Logging - Configurable log levels and destinations, retained-log export, and cleanup

What's in This Document

• Getting Started — Install, configure, and quickly set up your first project with AIBuds SDK.
• Core Features — Use device information, controls, recording, camera, media, live streaming, and firmware update capabilities.
• Service Auth — Inspect supported device-service authorization, retry authorization, and report the host app's self-AI result.
• AI Services — Integrate provider-backed chat, recording, recognition, speech, summaries, text translation, simultaneous interpretation, conversation translation, image generation, and asking services.
• Voice Assistant — Authorize the on-device assistant, inspect device support, and manage compatible voice-assistant modes.
• Logging — Configure logging destinations and retention, then export or purge persisted logs.

Getting Started

To get started with AIBuds SDK iOS, follow these steps:

1. Installation - Install the SDK via CocoaPods
2. Quick Start - Set up your first project with AIBuds SDK
3. Configuration - Configure the SDK for your specific needs
4. Explore Features - Dive into the various modules and their capabilities

Check out the Getting Started section for detailed instructions.