Basic Features Overview
Welcome to the Basic Features documentation for the AIBuds SDK. This section covers fundamental operations you can perform with your AIBuds device.
Available Features
Factory Reset
Restore device to factory settings, erasing all user data and custom configurations
Format Media Storage
Delete all media files from a connected AIBuds device
Power Off
Power off the device programmatically
Unpair Device
Unpair the device from the connected device
Getting Started
To get started with the AIBuds SDK, follow these steps:
- Install the SDK - Integrate
AIBuds.xcframeworkinto your iOS project - Initialize the SDK - Set up the SDK with your API credentials
- Connect to Device - Establish a connection with your AIBuds device
- Explore Features - Use the APIs documented in this section to interact with your device
Key Concepts
Device Management
- Power Management: Control device power state with
power-off - Pairing Management: Manage device pairing relationships with
unpair-device - Factory Reset: Reset device to factory settings with
factory-reset - Media Storage: Use
formatStorageto delete all device media after explicit user confirmation; the API delegates to the existing delete-all-media operation rather than issuing a separate filesystem-format command
Error Handling
All operations include comprehensive error handling. Refer to each API's documentation for specific error codes and recovery suggestions.
Platform Considerations
Be aware of platform-specific limitations, such as iOS Bluetooth unpairing restrictions. Each feature documentation includes platform-specific notes where applicable.