SDLSetGlobalProperties Class Reference

-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:menuLayout:

Initialize SetGlobalProperties with all possible items

Objective-C

- (nonnull instancetype)
      initWithHelpText:(nullable NSString *)helpText
           timeoutText:(nullable NSString *)timeoutText
           vrHelpTitle:(nullable NSString *)vrHelpTitle
                vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp
             menuTitle:(nullable NSString *)menuTitle
              menuIcon:(nullable SDLImage *)menuIcon
    keyboardProperties:(nullable SDLKeyboardProperties *)keyboardProperties
            menuLayout:(nullable SDLMenuLayout)menuLayout;

Swift

init(helpText: String?, timeoutText: String?, vrHelpTitle: String?, vrHelp: [SDLVRHelpItem]?, menuTitle: String?, menuIcon: SDLImage?, keyboardProperties: SDLKeyboardProperties?, menuLayout: SDLMenuLayout?)

Parameters

helpText

A string that will be turned into TTS chunks for the help prompt

timeoutText

A string that will be turned into TTS chunks for the timeout prompt

vrHelpTitle

The title of the help interface prompt

vrHelp

The items of the help interface prompt

menuTitle

The title of the menu button

menuIcon

The icon on the menu button

keyboardProperties

The properties of a keyboard prompt

menuLayout

The layout of the top-level main menu

-initWithUserLocation:helpPrompt:timeoutPrompt:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:menuLayout:

Convenience init for setting all possible global properties

Objective-C

- (nonnull instancetype)
    initWithUserLocation:(nullable SDLSeatLocation *)userLocation
              helpPrompt:(nullable NSArray<SDLTTSChunk *> *)helpPrompt
           timeoutPrompt:(nullable NSArray<SDLTTSChunk *> *)timeoutPrompt
             vrHelpTitle:(nullable NSString *)vrHelpTitle
                  vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp
               menuTitle:(nullable NSString *)menuTitle
                menuIcon:(nullable SDLImage *)menuIcon
      keyboardProperties:(nullable SDLKeyboardProperties *)keyboardProperties
              menuLayout:(nullable SDLMenuLayout)menuLayout;

Swift

init(userLocation: SDLSeatLocation?, helpPrompt: [SDLTTSChunk]?, timeoutPrompt: [SDLTTSChunk]?, vrHelpTitle: String?, vrHelp: [SDLVRHelpItem]?, menuTitle: String?, menuIcon: SDLImage?, keyboardProperties: SDLKeyboardProperties?, menuLayout: SDLMenuLayout?)

Parameters

userLocation

- userLocation

helpPrompt

- helpPrompt

timeoutPrompt

- timeoutPrompt

vrHelpTitle

- vrHelpTitle

vrHelp

- vrHelp

menuTitle

- menuTitle

menuIcon

- menuIcon

keyboardProperties

- keyboardProperties

menuLayout

- menuLayout

helpPrompt

Help prompt for when the user asks for help with an interface prompt

Optional

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLTTSChunk *> *helpPrompt;

Swift

var helpPrompt: [SDLTTSChunk]? { get set }

timeoutPrompt

Help prompt for when an interface prompt times out

Optional, Array, at least 1 item

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLTTSChunk *> *timeoutPrompt;

Swift

var timeoutPrompt: [SDLTTSChunk]? { get set }

vrHelpTitle

Sets a voice recognition Help Title

Optional

Objective-C

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

Swift

var vrHelpTitle: String? { get set }

vrHelp

Sets the items listed in the VR help screen used in an interaction started by Push to Talk

@since SmartDeviceLink 2.0

Optional

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLVRHelpItem *> *vrHelp;

Swift

var vrHelp: [SDLVRHelpItem]? { get set }

menuTitle

Text for the menu button label

Optional

Objective-C

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

Swift

var menuTitle: String? { get set }

menuIcon

Icon for the menu button

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLImage *menuIcon;

Swift

var menuIcon: SDLImage? { get set }

keyboardProperties

On-screen keyboard (perform interaction) configuration

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLKeyboardProperties *keyboardProperties;

Swift

var keyboardProperties: SDLKeyboardProperties? { get set }

userLocation

Location of the user’s seat. Default is driver’s seat location if it is not set yet

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLSeatLocation *userLocation;

Swift

var userLocation: SDLSeatLocation? { get set }

menuLayout

The main menu layout. If this is sent while a menu is already on-screen, the head unit will change the display to the new layout type. See available menu layouts on DisplayCapabilities.menuLayoutsAvailable. Defaults to the head unit default.

Objective-C

@property (nonatomic, strong, nullable) SDLMenuLayout menuLayout;

Swift

var menuLayout: SDLMenuLayout? { get set }