Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

SDLShowConstantTBT Class Reference

Section Contents

Overview

This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but also for the alert maneuver screen.

@since SmartDeviceLink 2.0

-initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:

Undocumented

Objective-C

- (instancetype)initWithNavigationText1:(nullable NSString *)navigationText1 navigationText2:(nullable NSString *)navigationText2 eta:(nullable NSString *)eta timeToDestination:(nullable NSString *)timeToDestination totalDistance:(nullable NSString *)totalDistance turnIcon:(nullable SDLImage *)turnIcon nextTurnIcon:(nullable SDLImage *)nextTurnIcon distanceToManeuver:(double)distanceToManeuver distanceToManeuverScale:(double)distanceToManeuverScale maneuverComplete:(BOOL)maneuverComplete softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons;

Swift

init(navigationText1: String?, navigationText2: String?, eta: String?, timeToDestination: String?, totalDistance: String?, turnIcon: SDLImage?, nextTurnIcon: SDLImage?, distanceToManeuver: Double, distanceToManeuverScale: Double, maneuverComplete: Bool, softButtons: [SDLSoftButton]?)

navigationText1

The first line of text in a multi-line overlay screen.

Optional, Max length 500 chars

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSString *navigationText1;

Swift

var navigationText1: String? { get set }

navigationText2

The second line of text in a multi-line overlay screen.

Optional, 1 - 500 chars

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSString *navigationText2;

Swift

var navigationText2: String? { get set }

eta

Estimated Time of Arrival time at final destination

Optional, 1 - 500 chars

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSString *eta;

Swift

var eta: String? { get set }

timeToDestination

The amount of time needed to reach the final destination

Optional, 1 - 500 chars

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSString *timeToDestination;

Swift

var timeToDestination: String? { get set }

totalDistance

The distance to the final destination

Optional, 1 - 500 chars

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSString *totalDistance;

Swift

var totalDistance: String? { get set }

turnIcon

An icon to show with the turn description

Optional

See

SDLImage

Objective-C

@property (readwrite, strong, nonatomic, nullable) SDLImage *turnIcon;

Swift

var turnIcon: SDLImage? { get set }

nextTurnIcon

An icon to show with the next turn description

Optional

See

SDLImage

Objective-C

@property (readwrite, strong, nonatomic, nullable) SDLImage *nextTurnIcon;

Swift

var nextTurnIcon: SDLImage? { get set }

distanceToManeuver

Fraction of distance till next maneuver (starting from when AlertManeuver is triggered). Used to calculate progress bar.

Optional, Float, 0 - 1,000,000,000

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLFloat> *distanceToManeuver;

Swift

var distanceToManeuver: (NSNumber & SDLFloat)? { get set }

distanceToManeuverScale

Distance till next maneuver (starting from) from previous maneuver. Used to calculate progress bar.

Optional, Float, 0 - 1,000,000,000

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLFloat> *distanceToManeuverScale;

Swift

var distanceToManeuverScale: (NSNumber & SDLFloat)? { get set }

maneuverComplete

If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE.

Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *maneuverComplete;

Swift

var maneuverComplete: (NSNumber & SDLBool)? { get set }

softButtons

Three dynamic SoftButtons available (first SoftButton is fixed to Turns). If omitted on supported displays, the currently displayed SoftButton values will not change.

Optional, Array length 0 - 3

See

SDLSoftButton

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLSoftButton *> *softButtons;

Swift

var softButtons: [SDLSoftButton]? { get set }
View on GitHub.com
Previous Section Next Section