Передача навигационных данных
Создайте NavigationInfoModel для текущего этапа маршрута и передайте его устройству.
Предварительные условия
- Устройство подключено и поддерживает
TurnByTurnNavigationAPI. - Размер каждого из полей
instructionиroadNameне превышает 128 байт. - Расстояния и время указаны в единицах, описанных моделью.
Справочник API
Фреймворк
AIBuds.xcframework
Протокол
- Swift
- Objective-C
/// Turn by turn navigation API
protocol TurnByTurnNavigationAPI: DeviceAPI {
/// Send navigation info
/// - Parameters:
/// - info: Navigation info
/// - completion: A closure that is called when the operation completes.
/// - success: `true` if the operation was successful; otherwise `false`.
/// - statusCode: The status code returned by the device. `nil` if the operation failed.
/// - error: An `NSError` object that describes the error that occurred, or `nil` if the operation was successful.
func sendNavigationInfo(
_ info: NavigationInfoModel,
completion: AIBudsStatusCodeCompletionHandler?
)
}/// Turn by turn navigation API
@protocol AIBudsTurnByTurnNavigationAPI <AIBudsDeviceAPI>
/// Send navigation info
/// - Parameters:
/// - info: Navigation info
/// - completion: Reports success, device status code, and an optional error.
- (void)sendNavigationInfo:(AIBudsNavigationInfoModel *_Nonnull)info
completion:(AIBudsStatusCodeCompletionHandler _Nullable)completion;
@endСм. sendNavigationInfo в справочнике API.
Модель навигации
| Свойство | Назначение |
|---|---|
nextStepDistanceText | Готовый к отображению текст, например 300m или 1.5km. |
maneuver | Исходное значение из раздела Навигационные манёвры. |
instruction | Текст указания размером до 128 байт. |
roadName | Название дороги размером до 128 байт. |
alertInfo | Необязательная модель NavigationAlertInfoModel; значения и правила параметров приведены в разделе Навигационные предупреждения. |
mapProvider | Исходное значение из NavigationMapProvider. |
transportMode | Исходное значение из NavigationTransportMode. |
remainingTime | Оставшееся время в секундах. |
remainingDistance | Оставшееся расстояние в метрах. |
Примеры использования
- Swift
- Objective-C
guard let device = device as? TurnByTurnNavigationAPI else { return }
let info = NavigationInfoModel()
info.nextStepDistanceText = "300m"
info.maneuver = NSNumber(value: NavigationManeuver.right.rawValue)
info.instruction = "Turn right"
info.roadName = "Market Street"
info.remainingTime = 420
info.remainingDistance = 1800
device.sendNavigationInfo(info) { success, statusCode, error in
guard success else {
print(error?.localizedDescription ?? "Navigation update failed")
return
}
print("Navigation sent: \(statusCode?.stringValue ?? "Unavailable")")
}id<AIBudsTurnByTurnNavigationAPI> device = (id<AIBudsTurnByTurnNavigationAPI>)self.device;
if (![device conformsToProtocol:@protocol(AIBudsTurnByTurnNavigationAPI)])
return;
AIBudsNavigationInfoModel *info = [[AIBudsNavigationInfoModel alloc] init];
info.nextStepDistanceText = @"300m";
info.maneuver = @(AIBudsNavigationManeuverRight);
info.instruction = @"Turn right";
info.roadName = @"Market Street";
info.remainingTime = @420;
info.remainingDistance = @1800;
[device
sendNavigationInfo:info
completion:^(BOOL success, NSNumber *_Nullable statusCode, NSError *_Nullable error) {
if (!success)
NSLog(@"Navigation update failed: %@", error.localizedDescription);
}];Обработка ошибок
Перед отправкой проверяйте ограничения по размеру. Основным результатом считайте success и сохраняйте statusCode устройства; значения отдельных кодов состояния в открытом SDK пока не описаны.