com.smartdevicelink.proxy.rpc.enums

Enum HMILevel

java.lang.Object

java.lang.Enum<HMILevel>

com.smartdevicelink.proxy.rpc.enums.HMILevel

All Implemented Interfaces:

Serializable, Comparable<HMILevel>

public enum HMILevel
extends Enum<HMILevel>

Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing "focus" to other applications (e.g. phone, other mobile applications, etc.)

Since:

SmartDeviceLink 1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
HMI_BACKGROUND App cannot interact with user via TTS, VR, Display or Button Presses.
HMI_FULL The application has full use of the SDL HMI.
HMI_LIMITED This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen (Nav) system.
HMI_NONE Application has been discovered by SDL, but application cannot send any requests or receive any notifications An HMILevel of NONE can also mean that the user has exited the application by saying "exit appName" or selecting "exit" from the application's menu.

Method Summary

Modifier and Type	Method and Description
String	toString()
static HMILevel	valueForString(String value) Returns a HMILevel Status (FULL, LIMITED, BACKGROUND or NONE)
static HMILevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static HMILevel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HMI_FULL

public static final HMILevel HMI_FULL

The application has full use of the SDL HMI. The app may output via TTS, display, or streaming audio and may gather input via VR, Menu, and button presses

HMI_LIMITED

public static final HMILevel HMI_LIMITED

This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen (Nav) system. The application's Show text is displayed and it receives button presses from media-oriented buttons (SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN, PRESET_0-9)

HMI_BACKGROUND

public static final HMILevel HMI_BACKGROUND

App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:

• Operation AddCommand
• Operation DeleteCommand
• Operation AddSubMenu
• Operation DeleteSubMenu
• Operation CreateInteractionChoiceSet
• Operation DeleteInteractionChoiceSet
• Operation SubscribeButton
• Operation UnsubscribeButton
• Operation Show
• Operation UnregisterAppInterface
• Operation ResetGlobalProperties
• Operation SetGlobalProperties

HMI_NONE

public static final HMILevel HMI_NONE

Application has been discovered by SDL, but application cannot send any requests or receive any notifications An HMILevel of NONE can also mean that the user has exited the application by saying "exit appName" or selecting "exit" from the application's menu. When this happens, the application still has an active interface registration with SDL and all SDL resources the application has created (e.g. Choice Sets, subscriptions, etc.) still exist. But while the HMILevel is NONE, the application cannot send any messages to SDL, except UnregisterAppInterface

Method Detail

values

public static HMILevel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HMILevel c : HMILevel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HMILevel valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<HMILevel>

valueForString

public static HMILevel valueForString(String value)

Returns a HMILevel Status (FULL, LIMITED, BACKGROUND or NONE)

Parameters:

value - a String

Returns:

HMILevel -a String value (FULL, LIMITED, BACKGROUND or NONE)