Get On-Device Support

Read the connected device's voice-assistant capability before displaying mode controls.

Prerequisites

• The device is connected and ready.
• The device conforms to OnDeviceVoiceAssistantAPI.

API Reference

Framework

AIBuds.xcframework

Import

Swift

Swift

import AIBuds
import AIBudsFoundation

Objective-C

Objective-C

#import <AIBuds/AIBuds-Swift.h>

Declaration

Swift

Swift

/// The protocol for the on-device voice assistant API.
protocol OnDeviceVoiceAssistantAPI: DeviceAPI {
    /// The capability of the on-device voice assistant.
    var onDeviceVoiceAssistantCapability: OnDeviceVoiceAssistantCapability { get }
}

Objective-C

Objective-C

/// The protocol for the on-device voice assistant API.
@protocol AIBudsOnDeviceVoiceAssistantAPI <AIBudsDeviceAPI>
/// The capability of the on-device voice assistant.
@property(nonatomic, readonly)
    AIBudsOnDeviceVoiceAssistantCapability onDeviceVoiceAssistantCapability;
@end

See onDeviceVoiceAssistantCapability and OnDeviceVoiceAssistantCapability.

Usage Examples

Swift

Swift

guard let voiceAssistant = device as? OnDeviceVoiceAssistantAPI else {
    supportLabel.text = "Not supported"
    return
}

switch voiceAssistant.onDeviceVoiceAssistantCapability {
case .none:
    supportLabel.text = "No voice-command capability"
case .keywordWakeup:
    supportLabel.text = "Keyword wake-up"
case .common:
    supportLabel.text = "Common voice commands"
}

Objective-C

Objective-C

id<AIBudsOnDeviceVoiceAssistantAPI> voiceAssistant =
    (id<AIBudsOnDeviceVoiceAssistantAPI>)self.device;

if (![voiceAssistant conformsToProtocol:@protocol(AIBudsOnDeviceVoiceAssistantAPI)]) {
    self.supportLabel.text = @"Not supported";
    return;
}

switch (voiceAssistant.onDeviceVoiceAssistantCapability) {
case AIBudsOnDeviceVoiceAssistantCapabilityNone:
    self.supportLabel.text = @"No voice-command capability";
    break;
case AIBudsOnDeviceVoiceAssistantCapabilityKeywordWakeup:
    self.supportLabel.text = @"Keyword wake-up";
    break;
case AIBudsOnDeviceVoiceAssistantCapabilityCommon:
    self.supportLabel.text = @"Common voice commands";
    break;
}

Notes

• Protocol conformance and capability are separate checks. A conforming device can still report .none.
• Capability is a property, not an asynchronous query.
• Use capability to restrict the modes presented by the UI.