Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
iOS Documentation
SDLSetDisplayLayout

SDLSetDisplayLayout Class Reference

Section Contents

Overview

Used to set an alternate display layout. If not sent, default screen for given platform will be shown

Since SmartDeviceLink 2.0

-initWithPredefinedLayout:

Convenience init to set a display layout

Objective-C

- (nonnull instancetype)initWithPredefinedLayout:
    (nonnull SDLPredefinedLayout)predefinedLayout;

Swift

init(predefinedLayout: SDLPredefinedLayout)

Parameters

predefinedLayout

A template layout an app uses to display information

Return Value

An SDLSetDisplayLayout object

-initWithLayout:

Convenience init to set a display layout

Objective-C

- (nonnull instancetype)initWithLayout:(nonnull NSString *)displayLayout;

Swift

init(layout displayLayout: String)

Parameters

displayLayout

A display layout name

Return Value

An SDLSetDisplayLayout object

-initWithPredefinedLayout:dayColorScheme:nightColorScheme:

Convenience init to set a display layout

Objective-C

- (nonnull instancetype)
    initWithPredefinedLayout:(nonnull SDLPredefinedLayout)predefinedLayout
              dayColorScheme:(nonnull SDLTemplateColorScheme *)dayColorScheme
            nightColorScheme:(nonnull SDLTemplateColorScheme *)nightColorScheme;

Swift

init(predefinedLayout: SDLPredefinedLayout, dayColorScheme: SDLTemplateColorScheme, nightColorScheme: SDLTemplateColorScheme)

Parameters

predefinedLayout

A display layout. Predefined or dynamically created screen layout

dayColorScheme

The color scheme to be used on a head unit using a “light” or “day” color scheme

nightColorScheme

The color scheme to be used on a head unit using a “dark” or “night” color scheme

Return Value

An SDLSetDisplayLayout object

-initWithLayout:dayColorScheme:nightColorScheme:

Convenience init to set a display layout

Objective-C

- (nonnull instancetype)
      initWithLayout:(nonnull NSString *)displayLayout
      dayColorScheme:(nonnull SDLTemplateColorScheme *)dayColorScheme
    nightColorScheme:(nonnull SDLTemplateColorScheme *)nightColorScheme;

Swift

init(layout displayLayout: String, dayColorScheme: SDLTemplateColorScheme, nightColorScheme: SDLTemplateColorScheme)

Parameters

displayLayout

A display layout name

dayColorScheme

The color scheme to be used on a head unit using a “light” or “day” color scheme

nightColorScheme

The color scheme to be used on a head unit using a “dark” or “night” color scheme

Return Value

An SDLSetDisplayLayout object

displayLayout

A display layout. Predefined or dynamically created screen layout. Currently only predefined screen layouts are defined. Predefined layouts include: “ONSCREEN_PRESETS” Custom screen containing app-defined onscreen presets. Currently defined for GEN2

Objective-C

@property (nonatomic, strong) NSString *_Nonnull displayLayout;

Swift

var displayLayout: String { get set }

dayColorScheme

The color scheme to be used on a head unit using a “light” or “day” color scheme. The OEM may only support this theme if their head unit only has a light color scheme.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLTemplateColorScheme *dayColorScheme;

Swift

var dayColorScheme: SDLTemplateColorScheme? { get set }

nightColorScheme

The color scheme to be used on a head unit using a “dark” or “night” color scheme. The OEM may only support this theme if their head unit only has a dark color scheme.

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLTemplateColorScheme *nightColorScheme;

Swift

var nightColorScheme: SDLTemplateColorScheme? { get set }
View on GitHub.com
Previous Section Next Section