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

SDLDisplayCapabilities Class Reference

Section Contents

Overview

Contains information about the display for the SDL system to which the application is currently connected.

@since SDL 1.0

displayType

The type of display

Required

Objective-C

@property (readwrite, strong, nonatomic) SDLDisplayType _Nonnull displayType;

Swift

var displayType: SDLDisplayType { get set }

displayName

The name of the connected display

Optional

Objective-C

@property (readwrite, strong, nonatomic, 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).

See

SDLTextField

Required, Array of SDLTextField, 1 - 100 objects

Objective-C

@property (readwrite, strong, nonatomic)
    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.

See

SDLImageField

Optional, Array of SDLImageField, 1 - 100 objects

Objective-C

@property (readwrite, strong, nonatomic, 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

See

SDLMediaClockFormat

Required, Array of SDLMediaClockFormats, 0 - 100 objects

Objective-C

@property (readwrite, strong, nonatomic)
    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 (readwrite, strong, nonatomic)
    NSNumber<SDLBool> *_Nonnull graphicSupported;

Swift

var graphicSupported: NSNumber & SDLBool { get set }

templatesAvailable

Number of presets the screen supports

@discussion The number of on-screen custom presets available (if any)

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

Objective-C

@property (readwrite, strong, nonatomic, 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 (readwrite, strong, nonatomic, 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 (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLInt> *numCustomPresetsAvailable;

Swift

var numCustomPresetsAvailable: (NSNumber & SDLInt)? { get set }
View on GitHub.com
Previous Section Next Section