com.smartdevicelink.proxy.rpc

Class DeviceStatus

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.DeviceStatus

All Implemented Interfaces:

Cloneable

public class DeviceStatus
extends RPCStruct

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 text message 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

Since:

SmartDeviceLink 2.0

See Also:

DeviceLevelStatus, GetVehicleData, OnVehicleData

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_BATT_LEVEL_STATUS
static String	KEY_BT_ICON_ON
static String	KEY_CALL_ACTIVE
static String	KEY_E_CALL_EVENT_ACTIVE
static String	KEY_MONO_AUDIO_OUTPUT_MUTED
static String	KEY_PHONE_ROAMING
static String	KEY_PRIMARY_AUDIO_SOURCE
static String	KEY_SIGNAL_LEVEL_STATUS
static String	KEY_STEREO_AUDIO_OUTPUT_MUTED
static String	KEY_TEXT_MSG_AVAILABLE
static String	KEY_VOICE_REC_ON

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
DeviceStatus() Constructs a newly allocated DeviceStatus object
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
DeviceStatus(Hashtable<String,Object> hash) Constructs a newly allocated DeviceStatus object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
DeviceLevelStatus	getBattLevelStatus() get battery level status
Boolean	getBtIconOn() get the bluetooth connection established
Boolean	getCallActive() get a call is being active
Boolean	getECallEventActive()
Boolean	getMonoAudioOutputMuted() get the status of the mono audio output channel
Boolean	getPhoneRoaming() get the phone is in roaming mode
PrimaryAudioSource	getPrimaryAudioSource() get the current primary audio source of SDL (if selected).
DeviceLevelStatus	getSignalLevelStatus() get signal level status
Boolean	getStereoAudioOutputMuted() get the status of the stereo audio output channel
Boolean	getTextMsgAvailable() get a text message is available
Boolean	getVoiceRecOn() get whether the voice recognition is on
DeviceStatus	setBattLevelStatus(DeviceLevelStatus battLevelStatus) set battery level status
DeviceStatus	setBtIconOn(Boolean btIconOn) set the bluetooth connection established
DeviceStatus	setCallActive(Boolean callActive) set a call is being active
DeviceStatus	setECallEventActive(Boolean eCallEventActive)
DeviceStatus	setMonoAudioOutputMuted(Boolean monoAudioOutputMuted) set the status of the mono audio output channel
DeviceStatus	setPhoneRoaming(Boolean phoneRoaming) set the phone is in roaming mode
DeviceStatus	setPrimaryAudioSource(PrimaryAudioSource primaryAudioSource) set the current primary audio source of SDL (if selected).
DeviceStatus	setSignalLevelStatus(DeviceLevelStatus signalLevelStatus) set signal level status
DeviceStatus	setStereoAudioOutputMuted(Boolean stereoAudioOutputMuted) set the status of the stereo audio output channel
DeviceStatus	setTextMsgAvailable(Boolean textMsgAvailable)
DeviceStatus	setVoiceRecOn(Boolean voiceRecOn) set the voice recognition on or off

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_VOICE_REC_ON

public static final String KEY_VOICE_REC_ON

See Also:

Constant Field Values

KEY_BT_ICON_ON

public static final String KEY_BT_ICON_ON

See Also:

Constant Field Values

KEY_CALL_ACTIVE

public static final String KEY_CALL_ACTIVE

See Also:

Constant Field Values

KEY_PHONE_ROAMING

public static final String KEY_PHONE_ROAMING

See Also:

Constant Field Values

KEY_TEXT_MSG_AVAILABLE

public static final String KEY_TEXT_MSG_AVAILABLE

See Also:

Constant Field Values

KEY_BATT_LEVEL_STATUS

public static final String KEY_BATT_LEVEL_STATUS

See Also:

Constant Field Values

KEY_STEREO_AUDIO_OUTPUT_MUTED

public static final String KEY_STEREO_AUDIO_OUTPUT_MUTED

See Also:

Constant Field Values

KEY_MONO_AUDIO_OUTPUT_MUTED

public static final String KEY_MONO_AUDIO_OUTPUT_MUTED

See Also:

Constant Field Values

KEY_SIGNAL_LEVEL_STATUS

public static final String KEY_SIGNAL_LEVEL_STATUS

See Also:

Constant Field Values

KEY_PRIMARY_AUDIO_SOURCE

public static final String KEY_PRIMARY_AUDIO_SOURCE

See Also:

Constant Field Values

KEY_E_CALL_EVENT_ACTIVE

public static final String KEY_E_CALL_EVENT_ACTIVE

See Also:

Constant Field Values

Constructor Detail

DeviceStatus

public DeviceStatus()

Constructs a newly allocated DeviceStatus object

DeviceStatus

public DeviceStatus(Hashtable<String,Object> hash)

Constructs a newly allocated DeviceStatus object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

DeviceStatus

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

Constructs a newly allocated DeviceStatus object

Parameters:

voiceRecOn -

btIconOn - the bluetooth connection established

callActive - a call is being active

phoneRoaming - the phone is in roaming mode

textMsgAvailable - a text message 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 -

Method Detail

setVoiceRecOn

public DeviceStatus setVoiceRecOn(@NonNull
                                  Boolean voiceRecOn)

set the voice recognition on or off

Parameters:

voiceRecOn -

getVoiceRecOn

public Boolean getVoiceRecOn()

get whether the voice recognition is on

Returns:

whether the voice recognition is on

setBtIconOn

public DeviceStatus setBtIconOn(@NonNull
                                Boolean btIconOn)

set the bluetooth connection established

Parameters:

btIconOn - the bluetooth connection established

getBtIconOn

public Boolean getBtIconOn()

get the bluetooth connection established

Returns:

the bluetooth connection established

setCallActive

public DeviceStatus setCallActive(@NonNull
                                  Boolean callActive)

set a call is being active

Parameters:

callActive - a call is being active

getCallActive

public Boolean getCallActive()

get a call is being active

Returns:

a call is being active

setPhoneRoaming

public DeviceStatus setPhoneRoaming(@NonNull
                                    Boolean phoneRoaming)

set the phone is in roaming mode

Parameters:

phoneRoaming - the phone is in roaming mode

getPhoneRoaming

public Boolean getPhoneRoaming()

get the phone is in roaming mode

Returns:

the phone is in roaming mode

setTextMsgAvailable

public DeviceStatus setTextMsgAvailable(@NonNull
                                        Boolean textMsgAvailable)

getTextMsgAvailable

public Boolean getTextMsgAvailable()

get a text message is available

Returns:

a text message is available

setBattLevelStatus

public DeviceStatus setBattLevelStatus(@NonNull
                                       DeviceLevelStatus battLevelStatus)

set battery level status

Parameters:

battLevelStatus - battery level status

getBattLevelStatus

public DeviceLevelStatus getBattLevelStatus()

get battery level status

Returns:

battery level status

setStereoAudioOutputMuted

public DeviceStatus setStereoAudioOutputMuted(@NonNull
                                              Boolean stereoAudioOutputMuted)

set the status of the stereo audio output channel

Parameters:

stereoAudioOutputMuted - the status of the stereo audio output channel

getStereoAudioOutputMuted

public Boolean getStereoAudioOutputMuted()

get the status of the stereo audio output channel

Returns:

the status of the stereo audio output channel

setMonoAudioOutputMuted

public DeviceStatus setMonoAudioOutputMuted(@NonNull
                                            Boolean monoAudioOutputMuted)

set the status of the mono audio output channel

Parameters:

monoAudioOutputMuted - the status of the mono audio output channel

getMonoAudioOutputMuted

public Boolean getMonoAudioOutputMuted()

get the status of the mono audio output channel

Returns:

the status of the mono audio output channel

setSignalLevelStatus

public DeviceStatus setSignalLevelStatus(@NonNull
                                         DeviceLevelStatus signalLevelStatus)

set signal level status

Parameters:

signalLevelStatus - signal level status

getSignalLevelStatus

public DeviceLevelStatus getSignalLevelStatus()

get signal level status

Returns:

signal level status

setPrimaryAudioSource

public DeviceStatus setPrimaryAudioSource(@NonNull
                                          PrimaryAudioSource primaryAudioSource)

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

Parameters:

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

getPrimaryAudioSource

public PrimaryAudioSource getPrimaryAudioSource()

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

Returns:

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

setECallEventActive

public DeviceStatus setECallEventActive(@NonNull
                                        Boolean eCallEventActive)

getECallEventActive

public Boolean getECallEventActive()