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

Class DeviceStatus

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.

Parameter List

Name Type Description SmartDeviceLink Ver. Available
voiceRecOn Boolean Voice recognition is on SmartDeviceLink 2.0
btIconOn Boolean Bluetooth connection established SmartDeviceLink 2.0
callActive Boolean A call is being active SmartDeviceLink 2.0
phoneRoaming Boolean The phone is in roaming mode SmartDeviceLink 2.0
textMsgAvailable Boolean A textmessage is available SmartDeviceLink 2.0
battLevelStatus DeviceLevelStatus Battery level status SmartDeviceLink 2.0
stereoAudioOutputMuted Boolean Status of the stereo audio output channel SmartDeviceLink 2.0
monoAudioOutputMuted Boolean Status of the mono audio output channel SmartDeviceLink 2.0
signalLevelStatus DeviceLevelStatus Signal level status SmartDeviceLink 2.0
primaryAudioSource PrimaryAudioSource Reflects the current primary audio source of SDL (if selected). SmartDeviceLink 2.0
eCallEventActive Boolean Reflects, if an eCall event is active SmartDeviceLink 2.0

Fields

KEY_VOICE_REC_ON

public static final java.lang.String KEY_VOICE_REC_ON
Constant Value
"voiceRecOn"

KEY_BT_ICON_ON

public static final java.lang.String KEY_BT_ICON_ON
Constant Value
"btIconOn"

KEY_CALL_ACTIVE

public static final java.lang.String KEY_CALL_ACTIVE
Constant Value
"callActive"

KEY_PHONE_ROAMING

public static final java.lang.String KEY_PHONE_ROAMING
Constant Value
"phoneRoaming"

KEY_TEXT_MSG_AVAILABLE

public static final java.lang.String KEY_TEXT_MSG_AVAILABLE
Constant Value
"textMsgAvailable"

KEY_BATT_LEVEL_STATUS

public static final java.lang.String KEY_BATT_LEVEL_STATUS
Constant Value
"battLevelStatus"

KEY_STEREO_AUDIO_OUTPUT_MUTED

public static final java.lang.String KEY_STEREO_AUDIO_OUTPUT_MUTED
Constant Value
"stereoAudioOutputMuted"

KEY_MONO_AUDIO_OUTPUT_MUTED

public static final java.lang.String KEY_MONO_AUDIO_OUTPUT_MUTED
Constant Value
"monoAudioOutputMuted"

KEY_SIGNAL_LEVEL_STATUS

public static final java.lang.String KEY_SIGNAL_LEVEL_STATUS
Constant Value
"signalLevelStatus"

KEY_PRIMARY_AUDIO_SOURCE

public static final java.lang.String KEY_PRIMARY_AUDIO_SOURCE
Constant Value
"primaryAudioSource"

KEY_E_CALL_EVENT_ACTIVE

public static final java.lang.String KEY_E_CALL_EVENT_ACTIVE
Constant Value
"eCallEventActive"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

DeviceStatus()

Constructs a newly allocated DeviceStatus object

public DeviceStatus()

DeviceStatus( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a newly allocated DeviceStatus object indicated by the Hashtable parameter

public DeviceStatus(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash
The Hashtable to use

DeviceStatus( Boolean voiceRecOn, Boolean btIconOn, Boolean callActive, Boolean phoneRoaming, Boolean textMsgAvailable, DeviceLevelStatus battLevelStatus, Boolean stereoAudioOutputMuted, Boolean monoAudioOutputMuted, DeviceLevelStatus signalLevelStatus, PrimaryAudioSource primaryAudioSource, Boolean eCallEventActive )

Constructs a newly allocated DeviceStatus object

public DeviceStatus(Boolean voiceRecOn,Boolean btIconOn,Boolean callActive,Boolean phoneRoaming,Boolean textMsgAvailable,DeviceLevelStatus battLevelStatus,Boolean stereoAudioOutputMuted,Boolean monoAudioOutputMuted,DeviceLevelStatus signalLevelStatus,PrimaryAudioSource primaryAudioSource,Boolean eCallEventActive)

Parameters

voiceRecOn
btIconOn
the bluetooth connection established
callActive
a call is being active
phoneRoaming
the phone is in roaming mode
textMsgAvailable
a textmessage is available
battLevelStatus
battery level status
stereoAudioOutputMuted
the status of the stereo audio output channel
monoAudioOutputMuted
the status of the mono audio output channel
signalLevelStatus
signal level status
primaryAudioSource
the current primary audio source of SDL (if selected
eCallEventActive

Methods

setVoiceRecOn( Boolean voiceRecOn )

set the voice recognition on or off

public void setVoiceRecOn(Boolean voiceRecOn)

Parameters

voiceRecOn

getVoiceRecOn()

get whether the voice recognition is on

public java.lang.Boolean getVoiceRecOn()

setBtIconOn( Boolean btIconOn )

set the bluetooth connection established

public void setBtIconOn(Boolean btIconOn)

Parameters

btIconOn
the bluetooth connection established

getBtIconOn()

get the bluetooth connection established

public java.lang.Boolean getBtIconOn()

setCallActive( Boolean callActive )

set a call is being active

public void setCallActive(Boolean callActive)

Parameters

callActive
a call is being active

getCallActive()

get a call is being active

public java.lang.Boolean getCallActive()

setPhoneRoaming( Boolean phoneRoaming )

set the phone is in roaming mode

public void setPhoneRoaming(Boolean phoneRoaming)

Parameters

phoneRoaming
the phone is in roaming mode

getPhoneRoaming()

get the phone is in roaming mode

public java.lang.Boolean getPhoneRoaming()

setTextMsgAvailable( Boolean textMsgAvailable )

public void setTextMsgAvailable(Boolean textMsgAvailable)

Parameters

textMsgAvailable

getTextMsgAvailable()

get a textmessage is available

public java.lang.Boolean getTextMsgAvailable()

setBattLevelStatus( DeviceLevelStatus battLevelStatus )

set battery level status

public void setBattLevelStatus(DeviceLevelStatus battLevelStatus)

Parameters

battLevelStatus
battery level status

getBattLevelStatus()

get battery level status

public com.smartdevicelink.proxy.rpc.enums.DeviceLevelStatus getBattLevelStatus()

setStereoAudioOutputMuted( Boolean stereoAudioOutputMuted )

set the status of the stereo audio output channel

public void setStereoAudioOutputMuted(Boolean stereoAudioOutputMuted)

Parameters

stereoAudioOutputMuted
the status of the stereo audio output channel

getStereoAudioOutputMuted()

get the status of the stereo audio output channel

public java.lang.Boolean getStereoAudioOutputMuted()

setMonoAudioOutputMuted( Boolean monoAudioOutputMuted )

set the status of the mono audio output channel

public void setMonoAudioOutputMuted(Boolean monoAudioOutputMuted)

Parameters

monoAudioOutputMuted
the status of the mono audio output channel

getMonoAudioOutputMuted()

get the status of the mono audio output channel

public java.lang.Boolean getMonoAudioOutputMuted()

setSignalLevelStatus( DeviceLevelStatus signalLevelStatus )

set signal level status

public void setSignalLevelStatus(DeviceLevelStatus signalLevelStatus)

Parameters

signalLevelStatus
signal level status

getSignalLevelStatus()

get signal level status

public com.smartdevicelink.proxy.rpc.enums.DeviceLevelStatus getSignalLevelStatus()

setPrimaryAudioSource( PrimaryAudioSource primaryAudioSource )

set the current primary audio source of SDL (if selected).

public void setPrimaryAudioSource(PrimaryAudioSource primaryAudioSource)

Parameters

primaryAudioSource
the current primary audio source of SDL (if selected).

getPrimaryAudioSource()

get the current primary audio source of SDL (if selected).

public com.smartdevicelink.proxy.rpc.enums.PrimaryAudioSource getPrimaryAudioSource()

setECallEventActive( Boolean eCallEventActive )

public void setECallEventActive(Boolean eCallEventActive)

Parameters

eCallEventActive

getECallEventActive()

public java.lang.Boolean getECallEventActive()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section