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
SystemCapabilityManager

SystemCapabilityManager Class Reference

Constructors

Instance Methods

Constructors

new SystemCapabilityManager(lifecycleManager)

Initializes an instance of SystemCapabilityManager

Instance Methods

systemCapabilityManager.addOnSystemCapabilityListener(systemCapabilityType, listener)

Add an OnSystemCapabilityListener function.

Kind: Instance method of SystemCapabilityManager

ParamTypeDescription
systemCapabilityType SystemCapabilityType A SystemCapabilityType enum value.
listener function The function to invoke when the event is triggered.

systemCapabilityManager.getAudioPassThruCapabilities() ⇒ [Array.<AudioPassThruCapabilities>, null]

Gets the audio pass thru capabilities

Kind: Instance method of SystemCapabilityManager
Returns: [Array.<AudioPassThruCapabilities>, null] - An array of AudioPassThruCapabilities structs, or null.

systemCapabilityManager.getCapability(systemCapabilityType) ⇒ [Object, null]

Tries to find a capability in the cache

Kind: Instance method of SystemCapabilityManager
Returns: [Object, null] - returns null if a capability can't be returned

ParamTypeDescription
systemCapabilityType SystemCapabilityType A SystemCapabilityType enum value.

systemCapabilityManager.getDefaultMainWindowCapability() ⇒ [WindowCapability, null]

Returns the default main window capability

Kind: Instance method of SystemCapabilityManager
Returns: [WindowCapability, null] - A WindowCapability struct, or null.

systemCapabilityManager.getDisplayCapabilities() ⇒ [DisplayCapabilities, null]

Gets the display capabilities

Kind: Instance method of SystemCapabilityManager
Returns: [DisplayCapabilities, null] - A DisplayCapabilities struct, or null.

systemCapabilityManager.getDriverDistractionCapabilities() ⇒ [DriverDistractionCapability, null]

Gets the DriverDistraction capabilities

Kind: Instance method of SystemCapabilityManager
Returns: [DriverDistractionCapability, null] - A HMICapabilities struct, or null.

systemCapabilityManager.getHmiCapabilities() ⇒ [HMICapabilities, null]

Gets the HMI capabilities

Kind: Instance method of SystemCapabilityManager
Returns: [HMICapabilities, null] - A HMICapabilities struct, or null.

systemCapabilityManager.getHmiZoneCapabilities() ⇒ [Array.<HmiZoneCapabilities>, null]

Gets the HMI zone capabilities

Kind: Instance method of SystemCapabilityManager
Returns: [Array.<HmiZoneCapabilities>, null] - An array of HmiZoneCapabilities enums, or null.

systemCapabilityManager.getPcmStreamCapabilities() ⇒ [AudioPassThruCapabilities, null]

Gets the PCM stream capabilities

Kind: Instance method of SystemCapabilityManager
Returns: [AudioPassThruCapabilities, null] - A AudioPassThruCapabilities struct, or null.

systemCapabilityManager.getPrerecordedSpeechCapabilities() ⇒ [Array.<PrerecordedSpeech>, null]

Gets the prerecorded speech capabilities

Kind: Instance method of SystemCapabilityManager
Returns: [Array.<PrerecordedSpeech>, null] - An array of PrerecordedSpeech enums, or null.

systemCapabilityManager.getPresetBankCapabilities() ⇒ [PresetBankCapabilities, null]

Gets the preset bank capabilities

Kind: Instance method of SystemCapabilityManager
Returns: [PresetBankCapabilities, null] - A PresetBankCapabilities struct, or null.

systemCapabilityManager.getSpeechCapabilities() ⇒ [Array.<SpeechCapabilities>, null]

Gets the speech capabilities

Kind: Instance method of SystemCapabilityManager
Returns: [Array.<SpeechCapabilities>, null] - An array of SpeechCapabilities enums, or null.

systemCapabilityManager.getVrCapabilities() ⇒ [Array.<VrCapabilities>, null]

Gets the VR capabilities

Kind: Instance method of SystemCapabilityManager
Returns: [Array.<VrCapabilities>, null] - An array of VrCapabilities enums, or null.

systemCapabilityManager.getWindowCapability(windowId) ⇒ [WindowCapability, null]

Gets the window capability given a window id

Kind: Instance method of SystemCapabilityManager
Returns: [WindowCapability, null] - A WindowCapability struct, or null.

ParamTypeDescription
windowId Number The numeric window ID.

systemCapabilityManager.isCapabilitySupported(type) ⇒ Boolean

Ability to see if the connected module supports the given capability. Useful to check before attempting to query for capabilities that require asynchronous calls to initialize.

Kind: Instance method of SystemCapabilityManager
Returns: Boolean - if that capability is supported with the current, connected module

ParamTypeDescription
type SystemCapabilityType the SystemCapabilityType that is to be checked

systemCapabilityManager.removeOnSystemCapabilityListener(systemCapabilityType, listener) ⇒ Boolean

Remove an OnSystemCapabilityListener function.

Kind: Instance method of SystemCapabilityManager
Returns: Boolean - Whether or not the listener was removed.

ParamTypeDescription
systemCapabilityType SystemCapabilityType A SystemCapabilityType enum value.
listener function The function to invoke when the event is triggered.

systemCapabilityManager.updateCapability(systemCapabilityType) ⇒ Promise

Sends a request to core for the capability, instead of checking cached capabilities

Kind: Instance method of SystemCapabilityManager
Returns: Promise - Promise returning either the capability Object or null if not found

ParamTypeDescription
systemCapabilityType SystemCapabilityType A SystemCapabilityType enum value.
View on GitHub.com
Previous Section Next Section