SDLDisplayCapabilities Class Reference

displayType

The type of display

Required

Objective-C

@property (nonatomic, strong) __deprecated_msg("See `displayName` instead") SDLDisplayType displayType;

Swift

var displayType: SDLDisplayType { get set }

displayName

The name of the connected display

Optional

Objective-C

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

Swift

var displayName: String? { get set }

textFields

An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as SDLShow, SDLSetMediaClockTimer, etc.

@discussion This array of SDLTextField structures identify all the text fields to which the application can write on the current display (identified by SDLDisplayType).

Required, Array of SDLTextField, 1 - 100 objects

Objective-C

@property (nonatomic, strong) NSArray<SDLTextField *> *_Nonnull textFields;

Swift

var textFields: [SDLTextField] { get set }

imageFields

An array of SDLImageField elements

@discussion A set of all fields that support images.

Optional, Array of SDLImageField, 1 - 100 objects

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLImageField *> *imageFields;

Swift

var imageFields: [SDLImageField]? { get set }

mediaClockFormats

An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field

Required, Array of SDLMediaClockFormats, 0 - 100 objects

Objective-C

@property (nonatomic, strong) NSArray<SDLMediaClockFormat> *_Nonnull mediaClockFormats;

Swift

var mediaClockFormats: [SDLMediaClockFormat] { get set }

graphicSupported

The display’s persistent screen supports.

@since SDL 2.0

Required, Boolean

Objective-C

@property (nonatomic, strong) NSNumber<SDLBool> *_Nonnull graphicSupported;

Swift

var graphicSupported: NSNumber & SDLBool { get set }

templatesAvailable

An array of all predefined persistent display templates available on the head unit.

Optional, Array of String, max string size 100, 0 - 100 objects, since SDL 3.0

See SDLPredefinedLayout

Objective-C

@property (nonatomic, strong, nullable) NSArray<NSString *> *templatesAvailable;

Swift

var templatesAvailable: [String]? { get set }

screenParams

A set of all parameters related to a prescribed screen area (e.g. for video / touch input)

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLScreenParams *screenParams;

Swift

var screenParams: SDLScreenParams? { get set }

numCustomPresetsAvailable

The number of on-screen custom presets available (if any); otherwise omitted

Optional, Integer 1 - 100

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLInt> *numCustomPresetsAvailable;

Swift

var numCustomPresetsAvailable: (NSNumber & SDLInt)? { get set }