Welcome to AIBuds Docs

Hi everyone 👋 — welcome to the official AIBuds SDK documentation site!

If you've ever tried to build an iOS app that talks to smart glasses, earbuds, or any AI wearable over Bluetooth, you know how much plumbing is involved: BLE scanning, device pairing, audio routing, AI provider auth, offline voice commands, crash reporting… the list goes on. That's why we built AIBuds SDK — to wrap all that complexity into clean, modular APIs you can drop into your app in minutes.

Why We Built This Site

Good SDKs deserve good docs. Too often, getting started with a hardware SDK means flipping between scattered header files, outdated sample code, and a README that hasn't been touched in six months. We wanted AIBuds to be different.

This site is our commitment to that. Every subspec, every permission, every edge case you might hit when integrating is documented here — in both English and Chinese — with working Swift and Objective-C samples side by side.

What's Inside

If you're new, here's how to get the most out of these docs:

🚀 Getting Started

Start with Installation — we cover Full vs Custom installations, walk you through every CocoaPods subspec, and list the Info.plist permissions and entitlements you need for features like local Wi-Fi access and Bonjour discovery. Then move on to Quick Start — a step-by-step tour from SDK init → scan → add device → connect → send commands.

🔩 Core Features

Everything Bluetooth and device management lives here. Learn about pairing flows, connection state handling, ANC controls, file transfers over the device hotspot, and how to integrate the live RTSP streaming pipeline.

🤖 AI Capabilities

This is where things get fun. Chat, simultaneous interpretation, streaming ASR, TTS, conversation summarization — we support two AI providers today (StarBurst and MltCloud) and the modular plugin system means adding a third is just a subspec away.

🎙️ Voice Assistant & Logging

Offline voice command authentication, XLFacility log sinks, crash report collection — everything you need to ship production-ready features with confidence.

A Note on the Modular Design

One thing we're especially proud of: AIBuds SDK doesn't force a one-size-fits-all bundle on you. Every feature is a CocoaPods subspec. Building a lean companion app that only needs device connectivity? Just add AIBudsSDK/ABMate and you're done. Want all the AI bells and whistles? Use AIBudsSDK/AllInOne. Or anything in between.

The Core subspec is always pulled in automatically as a dependency, so the other modules have a stable foundation to build on.

Join the Community

These docs are open source, and we welcome contributions. Found a typo? A sample that's out of date? A feature you wish we covered? Open an issue or a pull request over at topstepsmart/AIBuds-SDK-iOS — we review everything.

If you build something with AIBuds, let us know! It's genuinely exciting every time we see a new app ship using the SDK.

Thanks for reading, and happy coding.
— the AIBuds team