Назначение функций

Назначьте DeviceFunction поддерживаемому DeviceOperation.

Предварительные условия

• Устройство подключено и готово к работе
• Устройство поддерживает DevicePhysicalOperationsAPI
• Действие присутствует в physicalOperationsMapping

Справочник API

Фреймворк

AIBuds.xcframework

Импорт

Swift

Swift

import AIBuds

Objective-C

Objective-C

#import <AIBuds/AIBuds-Swift.h>
#import <AIBuds/AIBuds.h>

Протокол

Swift

Swift

/// The protocol for device physical operations API.
protocol DevicePhysicalOperationsAPI: DeviceAPI {
    /// Assign a device function to a specific operation.
    ///
    /// - Parameters:
    ///   - function: The ``DeviceFunction`` to be assigned.
    ///   - operation: The ``DeviceOperation`` that will trigger the function.
    ///   - completion: An optional callback invoked when the assignment completes.
    ///     - success: `true` if the assignment succeeded; `false` otherwise.
    ///     - error: An error object explaining the failure, or `nil` on success.
    func assignFunction(
        _ function: DeviceFunction,
        forPhysicalOperation operation: DeviceOperation,
        completion: AIBudsCompletionHandler?
    )
}

Objective-C

Objective-C

/// The protocol for device physical operations API.
@protocol AIBudsDevicePhysicalOperationsAPI <AIBudsDeviceAPI>
/// Assign a device function to a specific operation.
///
/// - Parameters:
///   - function: The ``DeviceFunction`` to be assigned.
///   - operation: The ``DeviceOperation`` that will trigger the function.
///   - completion: An optional callback invoked when the assignment completes.
///     - success: `true` if the assignment succeeded; `false` otherwise.
///     - error: An error object explaining the failure, or `nil` on success.
- (void)assignFunction:(enum AIBudsDeviceFunction)function
    forPhysicalOperation:(enum AIBudsDeviceOperation)operation
              completion:(AIBudsCompletionHandler _Nullable)completion;
@end

Метод экземпляра

Назначает функцию физическому действию.

Swift

Swift

/// Assign a device function to a specific operation.
///
/// - Parameters:
///   - function: The ``DeviceFunction`` to be assigned.
///   - operation: The ``DeviceOperation`` that will trigger the function.
///   - completion: An optional callback invoked when the assignment completes.
///     - success: `true` if the assignment succeeded; `false` otherwise.
///     - error: An error object explaining the failure, or `nil` on success.
func assignFunction(
    _ function: DeviceFunction,
    forPhysicalOperation operation: DeviceOperation,
    completion: AIBudsCompletionHandler?
)

Objective-C

Objective-C

/// Assign a device function to a specific operation.
///
/// - Parameters:
///   - function: The ``DeviceFunction`` to be assigned.
///   - operation: The ``DeviceOperation`` that will trigger the function.
///   - completion: An optional callback invoked when the assignment completes.
///     - success: `true` if the assignment succeeded; `false` otherwise.
///     - error: An error object explaining the failure, or `nil` on success.
- (void)assignFunction:(enum AIBudsDeviceFunction)function
    forPhysicalOperation:(enum AIBudsDeviceOperation)operation
              completion:(AIBudsCompletionHandler _Nullable)completion;

Параметры

Параметр	Тип	Описание
function	DeviceFunction	Назначаемая функция.
operation	DeviceOperation	Физическое действие, запускающее функцию.
completion	AIBudsCompletionHandler?	Необязательный обработчик завершения.

Параметры обработчика:

Имя	Тип	Описание
success	Bool / BOOL	Успешно ли выполнено назначение.
error	NSError?	Сведения об ошибке или nil при успехе.

Возвращаемое значение

Метод не возвращает значение напрямую.

Примеры использования

Swift

Swift

import AIBuds

guard let device = device as? DevicePhysicalOperationsAPI else {
    print("Device does not support physical-operation mapping")
    return
}

device.assignFunction(
    .playPause,
    forPhysicalOperation: .rightDoubleClick
) { success, error in
    guard success else {
        print("Assignment failed: \(error?.localizedDescription ?? "Unknown error")")
        return
    }
    print("Function assigned")
}

Objective-C

Objective-C

#import <AIBuds/AIBuds-Swift.h>
#import <AIBuds/AIBuds.h>

id<AIBudsDevicePhysicalOperationsAPI> device = (id<AIBudsDevicePhysicalOperationsAPI>)self.device;

if ([device conformsToProtocol:@protocol(AIBudsDevicePhysicalOperationsAPI)]) {
    [device assignFunction:AIBudsDeviceFunctionPlayPause
        forPhysicalOperation:AIBudsDeviceOperationRightDoubleClick
                  completion:^(BOOL success, NSError *_Nullable error) {
                      if (!success) {
                          NSLog(@"Assignment failed: %@", error.localizedDescription);
                          return;
                      }
                      NSLog(@"Function assigned");
                  }];
}

Обработка ошибок

Проверяйте success, а сведения об ошибке берите из error. Не обновляйте локальное соответствие до успешного завершения операции.

Рекомендации

1. Опирайтесь на опубликованное соответствие: предлагайте только действия из physicalOperationsMapping.
2. Используйте перечисления SDK: передавайте DeviceOperation и DeviceFunction, а не произвольные числа.
3. Обновляйте после успеха: перед показом применённой конфигурации снова прочитайте соответствие.

Примечания

• За один вызов API назначает одну функцию одному действию.
• В SDK нет модели KeyMapping или метода customizeKeyMapping.