Select AI Provider

Register the AI provider SDKs included by your app, then select the provider that AIBudsAISDK uses for subsequent AI operations.

Prerequisites

• The base AIBuds SDK is initialized.
• At least one provider SDK is installed and linked by the app.
• The selected provider is included in the array passed to AIBudsAISDK.initialize(_:).
• Device information is configured before provider authentication or device-dependent AI operations.

Implement with AI Assistance

Build with AI

Implement this workflow with AI

Use the official Select an AIBuds AI Provider skill to adapt this workflow to your app.

Read and follow https://docs-aibuds.github.io/skills/select-aibuds-ai-provider. Use it to implement Select an AIBuds AI Provider in this iOS project and verify the result.

View official skill↗

API Reference

Framework

AIBudsAI.xcframework

Provider implementations are distributed separately, including AIBudsStarBurst.xcframework and AIBudsMagicHelper.xcframework.

Import

Swift

Swift

import AIBudsAI
import AIBudsAIFoundation
import AIBudsStarBurst
import AIBudsMagicHelper

Objective-C

Objective-C

#import <AIBudsAI/AIBudsAI-Swift.h>
#import <AIBudsMagicHelper/AIBudsMagicHelper-Swift.h>
#import <AIBudsStarBurst/AIBudsStarBurst-Swift.h>

Declaration

The provider lifecycle is managed by AIBudsAISDK. Provider implementations conform to AIConnectSDK.

Swift

Swift

/// Initializes the SDK with the specified provider implementations.
/// - Parameter aiSDKs: The providers to register. Their order determines
///   recognition priority; a later provider using an already-registered
///   Bluetooth data protocol type is ignored.
/// - Returns: `true` when initialization succeeds; otherwise `false`.
public static func initialize( _ aiSDKs: [AIConnectSDK] ) -> Bool

/// The current AI service vendor.
static var aiServiceVendor: AIServiceVendor { get }

/// Sets the AI service vendor for the SDK.
/// - Parameter aiServiceVendor: The vendor used by subsequent AI services.
/// - Important: Call this method before using AI service-dependent functionality.
public static func setAIServiceVendor(_ aiServiceVendor: AIServiceVendor) -> Void

/// Returns all languages supported by the specified vendor.
/// - Parameter vendor: The vendor whose languages are requested.
/// - Returns: Supported languages, or an empty array when the vendor is `.none`
///   or its provider SDK is not registered.
public static func allSupportedLanguages(for vendor: AIServiceVendor) -> [AIServiceLanguage]

/// Returns the authentication initiation mode for the specified vendor.
/// - Parameter vendor: The vendor whose authentication mode is requested.
/// - Returns: The provider authentication mode.
public static func authenticationMode(for vendor: AIServiceVendor) -> AIAuthenticationMode

/// Indicates whether the device is authenticated for the specified vendor.
/// - Parameter vendor: The vendor whose authentication state is requested.
/// - Returns: `true` when the provider reports an authenticated device.
public static func isAuthenticated(for vendor: AIServiceVendor) -> Bool

Objective-C

Objective-C

/// Initializes the SDK with the specified provider implementations.
/// - Parameter aiSDKs: The providers to register. Their order determines
///   recognition priority; a later provider using an already-registered
///   Bluetooth data protocol type is ignored.
/// - Returns: `YES` when initialization succeeds; otherwise `NO`.
+ (BOOL)initWithAISDKs:(NSArray<id <AIBudsAIConnectSDK>> * _Nonnull)aiSDKs;

/// The current AI service vendor.
@property(nonatomic, class, readonly) AIBudsAIServiceVendor aiServiceVendor;

/// Sets the AI service vendor for the SDK.
/// - Parameter aiServiceVendor: The vendor used by subsequent AI services.
/// - Important: Call this method before using AI service-dependent functionality.
+ (void)setAIServiceVendor:(enum AIBudsAIServiceVendor)aiServiceVendor;

/// Returns all languages supported by the specified vendor.
/// - Parameter vendor: The vendor whose languages are requested.
/// - Returns: Supported languages, or an empty array when the vendor is
///   `AIBudsAIServiceVendorNone` or its provider SDK is not registered.
+ (NSArray<AIBudsAIServiceLanguage *> * _Nonnull)allSupportedLanguagesForVendor:(enum AIBudsAIServiceVendor)vendor;

/// Returns the authentication initiation mode for the specified vendor.
/// - Parameter vendor: The vendor whose authentication mode is requested.
/// - Returns: The provider authentication mode.
+ (enum AIBudsAIAuthenticationMode)authenticationModeForVendor:(enum AIBudsAIServiceVendor)vendor;

/// Indicates whether the device is authenticated for the specified vendor.
/// - Parameter vendor: The vendor whose authentication state is requested.
/// - Returns: `YES` when the provider reports an authenticated device.
+ (BOOL)isAuthenticatedForVendor:(enum AIBudsAIServiceVendor)vendor;

Service Providers

Swift	Objective-C	Description
.none	AIBudsAIServiceVendorNone	No provider is selected. This is the default state.
.starBurst	AIBudsAIServiceVendorStarBurst	StarBurst AI (ByteDance).
.mltcloud	AIBudsAIServiceVendorMltcloud	MltCloud AI (Meilc).

See AIServiceVendor for the authoritative enumeration.

Usage Examples

Register Provider SDKs

Provider registration normally occurs once during application startup.

Swift

Swift

import AIBudsAI
import AIBudsStarBurst
import AIBudsMagicHelper

let initialized = AIBudsAISDK.initialize([
    StarBurstSDK.shared,
    MagicHelperSDK.shared,
])

guard initialized else {
    print("AIBudsAISDK initialization failed")
    return
}

Objective-C

Objective-C

#import <AIBudsAI/AIBudsAI-Swift.h>
#import <AIBudsMagicHelper/AIBudsMagicHelper-Swift.h>
#import <AIBudsStarBurst/AIBudsStarBurst-Swift.h>

BOOL initialized = [AIBudsAISDK initWithAISDKs:@[
    [AIBudsStarBurstSDK shared],
    [AIBudsMagicHelperSDK shared],
]];

if (!initialized) {
    NSLog(@"AIBudsAISDK initialization failed");
    return;
}

If your app uses AIBudsAllInOneSDK, its initialization can install the bundled AI providers. Do not initialize AIBudsAISDK a second time.

Select a Provider

Swift

Swift

let vendor: AIServiceVendor = .starBurst
AIBudsAISDK.setAIServiceVendor(vendor)

print("Selected provider: \(AIBudsAISDK.aiServiceVendor)")
print("Supported languages: \(AIBudsAISDK.allSupportedLanguages(for: vendor))")

Objective-C

Objective-C

AIBudsAIServiceVendor vendor = AIBudsAIServiceVendorStarBurst;
[AIBudsAISDK setAIServiceVendor:vendor];

NSLog(@"Selected provider: %ld", (long)AIBudsAISDK.aiServiceVendor);
NSLog(@"Supported languages: %@", [AIBudsAISDK allSupportedLanguagesForVendor:vendor]);

Check Authentication Requirements

After configuring the connected device's AI information, authenticate providers whose mode is app initiated.

Swift

Swift

let vendor = AIBudsAISDK.aiServiceVendor

if AIBudsAISDK.authenticationMode(for: vendor) == .appInitiated,
    !AIBudsAISDK.isAuthenticated(for: vendor)
{
    AIBudsAISDK.authenticateDevice(deviceInfo) { success, error in
        guard success else {
            print(error?.localizedDescription ?? "Authentication failed")
            return
        }
        print("AI provider authenticated")
    }
}

Objective-C

Objective-C

AIBudsAIServiceVendor vendor = AIBudsAISDK.aiServiceVendor;

if ([AIBudsAISDK authenticationModeForVendor:vendor] == AIBudsAIAuthenticationModeAppInitiated &&
    ![AIBudsAISDK isAuthenticatedForVendor:vendor]) {
    [AIBudsAISDK
        authenticateDevice:deviceInfo
                completion:^(BOOL success, NSError *error) {
                    if (!success) {
                        NSLog(@"%@", error.localizedDescription ?: @"Authentication failed");
                        return;
                    }
                    NSLog(@"AI provider authenticated");
                }];
}

Notes

• setAIServiceVendor(_:) does not register or install a provider SDK.
• Selecting .none leaves AI service-dependent operations without a usable provider.
• Calling initialize(_:) more than once returns false and keeps the existing initialization.
• If duplicate implementations declare the same provider enum value, the first registered implementation is retained.
• Supported features and languages can differ between providers.