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

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:

Convenience init to create navigation directions

Objective-C

- (nonnull 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]?)

Parameters

navigationText1

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

navigationText2

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

eta

Estimated Time of Arrival time at final destination

timeToDestination

The amount of time needed to reach the final destination

totalDistance

The distance to the final destination

turnIcon

An icon to show with the turn description

nextTurnIcon

An icon to show with the next turn description

distanceToManeuver

Fraction of distance till next maneuver

distanceToManeuverScale

Distance till next maneuver

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

softButtons

Three dynamic SoftButtons available (first SoftButton is fixed to “Turns”)

Return Value

An SDLShowConstantTBT object

navigationText1

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

Optional, Max length 500 chars

Objective-C

@property (nonatomic, strong, 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 (nonatomic, strong, 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 (nonatomic, strong, 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 (nonatomic, strong, nullable) NSString *timeToDestination;

Swift

var timeToDestination: String? { get set }

totalDistance

The distance to the final destination

Optional, 1 - 500 chars

Objective-C

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

Swift

var totalDistance: String? { get set }

turnIcon

An icon to show with the turn description

Optional

See

SDLImage

Objective-C

@property (nonatomic, strong, 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 (nonatomic, strong, 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 (nonatomic, strong, 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 (nonatomic, strong, 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 (nonatomic, strong, 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 (nonatomic, strong, nullable) NSArray<SDLSoftButton *> *softButtons;

Swift

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