String
DisplayType
Boolean
Array.<ImageField>
Array.<MediaClockFormat>
Number
ScreenParams
Array.<String>
Array.<TextField>
DisplayCapabilities
DisplayCapabilities
DisplayCapabilities
DisplayCapabilities
DisplayCapabilities
DisplayCapabilities
DisplayCapabilities
DisplayCapabilities
DisplayCapabilities
String
Get the DisplayName
Kind: Instance method of DisplayCapabilities
Returns: String
- the KEY_DISPLAY_NAME value
DisplayType
Get the DisplayType
Kind: Instance method of DisplayCapabilities
Returns: DisplayType
- the KEY_DISPLAY_TYPE value
Boolean
Get the GraphicSupported
Kind: Instance method of DisplayCapabilities
Returns: Boolean
- the KEY_GRAPHIC_SUPPORTED value
Array.<ImageField>
Get the ImageFields
Kind: Instance method of DisplayCapabilities
Returns: Array.<ImageField>
- the KEY_IMAGE_FIELDS value
Array.<MediaClockFormat>
Get the MediaClockFormats
Kind: Instance method of DisplayCapabilities
Returns: Array.<MediaClockFormat>
- the KEY_MEDIA_CLOCK_FORMATS value
Number
Get the NumCustomPresetsAvailable
Kind: Instance method of DisplayCapabilities
Returns: Number
- the KEY_NUM_CUSTOM_PRESETS_AVAILABLE value
ScreenParams
Get the ScreenParams
Kind: Instance method of DisplayCapabilities
Returns: ScreenParams
- the KEY_SCREEN_PARAMS value
Array.<String>
Get the TemplatesAvailable
Kind: Instance method of DisplayCapabilities
Returns: Array.<String>
- the KEY_TEMPLATES_AVAILABLE value
Array.<TextField>
Get the TextFields
Kind: Instance method of DisplayCapabilities
Returns: Array.<TextField>
- the KEY_TEXT_FIELDS value
DisplayCapabilities
Set the DisplayName
Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
name | String |
The name of the display the app is connected to. - The desired DisplayName. {'string_min_length': 1} |
DisplayCapabilities
Set the DisplayType
Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
type | DisplayType |
The type of the display. See DisplayType - The desired DisplayType. |
DisplayCapabilities
Set the GraphicSupported
Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
supported | Boolean |
The display's persistent screen supports referencing a static or dynamic image. - The desired GraphicSupported. |
DisplayCapabilities
Set the ImageFields
Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
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
Set the MediaClockFormats
Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
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
Set the NumCustomPresetsAvailable
Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
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
Set the ScreenParams
Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
params | ScreenParams |
A set of all parameters related to a prescribed screen area (e.g. for video / touch input). - The desired ScreenParams. |
DisplayCapabilities
Set the TemplatesAvailable
Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
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
Set the TextFields
Kind: Instance method of DisplayCapabilities
Returns: DisplayCapabilities
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
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} |