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
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaScript Suite Documentation
DeviceStatus

DeviceStatus Class Reference

Constructors

Instance Methods

Constructors

new DeviceStatus(parameters)

Initializes an instance of DeviceStatus.

Instance Methods

deviceStatus.getBattLevelStatus() ⇒ DeviceLevelStatus

Get the BattLevelStatus

Kind: Instance method of DeviceStatus
Returns: DeviceLevelStatus - the KEY_BATT_LEVEL_STATUS value

deviceStatus.getBtIconOn() ⇒ Boolean

Get the BtIconOn

Kind: Instance method of DeviceStatus
Returns: Boolean - the KEY_BT_ICON_ON value

deviceStatus.getCallActive() ⇒ Boolean

Get the CallActive

Kind: Instance method of DeviceStatus
Returns: Boolean - the KEY_CALL_ACTIVE value

deviceStatus.getECallEventActive() ⇒ Boolean

Get the ECallEventActive

Kind: Instance method of DeviceStatus
Returns: Boolean - the KEY_E_CALL_EVENT_ACTIVE value

deviceStatus.getMonoAudioOutputMuted() ⇒ Boolean

Get the MonoAudioOutputMuted

Kind: Instance method of DeviceStatus
Returns: Boolean - the KEY_MONO_AUDIO_OUTPUT_MUTED value

deviceStatus.getPhoneRoaming() ⇒ Boolean

Get the PhoneRoaming

Kind: Instance method of DeviceStatus
Returns: Boolean - the KEY_PHONE_ROAMING value

deviceStatus.getPrimaryAudioSource() ⇒ PrimaryAudioSource

Get the PrimaryAudioSource

Kind: Instance method of DeviceStatus
Returns: PrimaryAudioSource - the KEY_PRIMARY_AUDIO_SOURCE value

deviceStatus.getSignalLevelStatus() ⇒ DeviceLevelStatus

Get the SignalLevelStatus

Kind: Instance method of DeviceStatus
Returns: DeviceLevelStatus - the KEY_SIGNAL_LEVEL_STATUS value

deviceStatus.getStereoAudioOutputMuted() ⇒ Boolean

Get the StereoAudioOutputMuted

Kind: Instance method of DeviceStatus
Returns: Boolean - the KEY_STEREO_AUDIO_OUTPUT_MUTED value

deviceStatus.getTextMsgAvailable() ⇒ Boolean

Get the TextMsgAvailable

Kind: Instance method of DeviceStatus
Returns: Boolean - the KEY_TEXT_MSG_AVAILABLE value

deviceStatus.getVoiceRecOn() ⇒ Boolean

Get the VoiceRecOn

Kind: Instance method of DeviceStatus
Returns: Boolean - the KEY_VOICE_REC_ON value

deviceStatus.setBattLevelStatus(status) ⇒ DeviceStatus

Set the BattLevelStatus

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

ParamTypeDescription
status DeviceLevelStatus Device battery level status. References signal "CPM_Batt_Level_STAT". See DeviceLevelStatus. - The desired BattLevelStatus.

deviceStatus.setBtIconOn(on) ⇒ DeviceStatus

Set the BtIconOn

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

ParamTypeDescription
on Boolean References signal "BT_ICON". - The desired BtIconOn.

deviceStatus.setCallActive(active) ⇒ DeviceStatus

Set the CallActive

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

ParamTypeDescription
active Boolean References signal "CPM_Call_Active_STAT". - The desired CallActive.

deviceStatus.setECallEventActive(active) ⇒ DeviceStatus

Set the ECallEventActive

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

ParamTypeDescription
active Boolean References signal "eCall_Event". - The desired ECallEventActive.

deviceStatus.setMonoAudioOutputMuted(muted) ⇒ DeviceStatus

Set the MonoAudioOutputMuted

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

ParamTypeDescription
muted Boolean References signal "CPM_Mono_Audio_Output". - The desired MonoAudioOutputMuted.

deviceStatus.setPhoneRoaming(roaming) ⇒ DeviceStatus

Set the PhoneRoaming

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

ParamTypeDescription
roaming Boolean References signal "CPM_Phone_Roaming_STAT". - The desired PhoneRoaming.

deviceStatus.setPrimaryAudioSource(source) ⇒ DeviceStatus

Set the PrimaryAudioSource

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

ParamTypeDescription
source PrimaryAudioSource References signal "CPM_Stereo_PAS_Source". See PrimaryAudioSource. - The desired PrimaryAudioSource.

deviceStatus.setSignalLevelStatus(status) ⇒ DeviceStatus

Set the SignalLevelStatus

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

ParamTypeDescription
status DeviceLevelStatus Device signal level status. References signal "CPM_Signal_Strength_STAT". See DeviceLevelStatus. - The desired SignalLevelStatus.

deviceStatus.setStereoAudioOutputMuted(muted) ⇒ DeviceStatus

Set the StereoAudioOutputMuted

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

ParamTypeDescription
muted Boolean References signal "CPM_Stereo_Audio_Output". - The desired StereoAudioOutputMuted.

deviceStatus.setTextMsgAvailable(available) ⇒ DeviceStatus

Set the TextMsgAvailable

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

ParamTypeDescription
available Boolean References signal "CPM_TextMsg_AVAL". - The desired TextMsgAvailable.

deviceStatus.setVoiceRecOn(on) ⇒ DeviceStatus

Set the VoiceRecOn

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

ParamTypeDescription
on Boolean References signal "CPM_VoiceRec_STAT". - The desired VoiceRecOn.
View on GitHub.com
Previous Section Next Section