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
Documentation
DisplayCapabilities

DisplayCapabilities Class Reference

Constructors

Instance Methods

Constructors

new DisplayCapabilities(parameters)

Initalizes an instance of DisplayCapabilities.

Instance Methods

displayCapabilities.getDisplayName() ⇒ String

Get the DisplayName

Kind: Instance method of DisplayCapabilities
Returns: String - the KEY_DISPLAY_NAME value

displayCapabilities.getDisplayType() ⇒ DisplayType

Get the DisplayType

Kind: Instance method of DisplayCapabilities
Returns: DisplayType - the KEY_DISPLAY_TYPE value

displayCapabilities.getGraphicSupported() ⇒ Boolean

Get the GraphicSupported

Kind: Instance method of DisplayCapabilities
Returns: Boolean - the KEY_GRAPHIC_SUPPORTED value

displayCapabilities.getImageFields() ⇒ Array.<ImageField>

Get the ImageFields

Kind: Instance method of DisplayCapabilities
Returns: Array.<ImageField> - the KEY_IMAGE_FIELDS value

displayCapabilities.getMediaClockFormats() ⇒ Array.<MediaClockFormat>

Get the MediaClockFormats

Kind: Instance method of DisplayCapabilities
Returns: Array.<MediaClockFormat> - the KEY_MEDIA_CLOCK_FORMATS value

displayCapabilities.getNumCustomPresetsAvailable() ⇒ Number

Get the NumCustomPresetsAvailable

Kind: Instance method of DisplayCapabilities
Returns: Number - the KEY_NUM_CUSTOM_PRESETS_AVAILABLE value

displayCapabilities.getScreenParams() ⇒ ScreenParams

Get the ScreenParams

Kind: Instance method of DisplayCapabilities
Returns: ScreenParams - the KEY_SCREEN_PARAMS value

displayCapabilities.getTemplatesAvailable() ⇒ Array.<String>

Get the TemplatesAvailable

Kind: Instance method of DisplayCapabilities
Returns: Array.<String> - the KEY_TEMPLATES_AVAILABLE value

displayCapabilities.getTextFields() ⇒ Array.<TextField>

Get the TextFields

Kind: Instance method of DisplayCapabilities
Returns: Array.<TextField> - the KEY_TEXT_FIELDS value

displayCapabilities.setDisplayName(name) ⇒ DisplayCapabilities

Set the DisplayName

Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities - The class instance for method chaining.

ParamTypeDescription
name String The name of the display the app is connected to. - The desired DisplayName. {'string_min_length': 1}

displayCapabilities.setDisplayType(type) ⇒ DisplayCapabilities

Set the DisplayType

Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities - The class instance for method chaining.

ParamTypeDescription
type DisplayType The type of the display. See DisplayType - The desired DisplayType.

displayCapabilities.setGraphicSupported(supported) ⇒ DisplayCapabilities

Set the GraphicSupported

Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities - The class instance for method chaining.

ParamTypeDescription
supported Boolean The display's persistent screen supports referencing a static or dynamic image. - The desired GraphicSupported.

displayCapabilities.setImageFields(fields) ⇒ DisplayCapabilities

Set the ImageFields

Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities - The class instance for method chaining.

ParamTypeDescription
fields Array.<ImageField> A set of all fields that support images. See ImageField - The desired ImageFields. {'array_min_size': 1, 'array_max_size': 100}

displayCapabilities.setMediaClockFormats(formats) ⇒ DisplayCapabilities

Set the MediaClockFormats

Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities - The class instance for method chaining.

ParamTypeDescription
formats Array.<MediaClockFormat> A set of all supported formats of the media clock. See MediaClockFormat - The desired MediaClockFormats. {'array_min_size': 0, 'array_max_size': 100}

displayCapabilities.setNumCustomPresetsAvailable(available) ⇒ DisplayCapabilities

Set the NumCustomPresetsAvailable

Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities - The class instance for method chaining.

ParamTypeDescription
available Number The number of on-screen custom presets available (if any); otherwise omitted. - The desired NumCustomPresetsAvailable. {'num_min_value': 1, 'num_max_value': 100}

displayCapabilities.setScreenParams(params) ⇒ DisplayCapabilities

Set the ScreenParams

Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities - The class instance for method chaining.

ParamTypeDescription
params ScreenParams A set of all parameters related to a prescribed screen area (e.g. for video / touch input). - The desired ScreenParams.

displayCapabilities.setTemplatesAvailable(available) ⇒ DisplayCapabilities

Set the TemplatesAvailable

Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities - The class instance for method chaining.

ParamTypeDescription
available Array.<String> A set of all predefined persistent display templates available on headunit. To be referenced in SetDisplayLayout. - The desired TemplatesAvailable. {'array_min_size': 0, 'array_max_size': 100, 'string_min_length': 1, 'string_max_length': 100}

displayCapabilities.setTextFields(fields) ⇒ DisplayCapabilities

Set the TextFields

Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities - The class instance for method chaining.

ParamTypeDescription
fields Array.<TextField> A set of all fields that support text data. See TextField - The desired TextFields. {'array_min_size': 1, 'array_max_size': 100}
View on GitHub.com
Previous Section Next Section