com.smartdevicelink.proxy.rpc.enums

Enum AudioStreamingState

java.lang.Object

java.lang.Enum<AudioStreamingState>

com.smartdevicelink.proxy.rpc.enums.AudioStreamingState

All Implemented Interfaces:

Serializable, Comparable<AudioStreamingState>

public enum AudioStreamingState
extends Enum<AudioStreamingState>

Describes whether or not streaming audio is currently audible to the user. Though provided in every OnHMIStatus notification, this information is only relevant for applications that declare themselves as media apps in RegisterAppInterface

Since:

SmartDeviceLink 1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTENUATED Some kind of audio mixing is taking place.
AUDIBLE Currently streaming audio, if any, is audible to user.
NOT_AUDIBLE Currently streaming audio, if any, is not audible to user.

Method Summary

Modifier and Type	Method and Description
static AudioStreamingState	valueForString(String value) Convert String to AudioStreamingState
static AudioStreamingState	valueOf(String name) Returns the enum constant of this type with the specified name.
static AudioStreamingState[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUDIBLE

public static final AudioStreamingState AUDIBLE

Currently streaming audio, if any, is audible to user.

Since:

SmartDeviceLink 1.0

ATTENUATED

public static final AudioStreamingState ATTENUATED

Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume.

Since:

SmartDeviceLink 2.0

NOT_AUDIBLE

public static final AudioStreamingState NOT_AUDIBLE

Currently streaming audio, if any, is not audible to user. made via VR session.

Since:

SmartDeviceLink 1.0

Method Detail

values

public static AudioStreamingState[] 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 (AudioStreamingState c : AudioStreamingState.values())
    System.out.println(c);

Returns:

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

valueOf

public static AudioStreamingState 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

valueForString

public static AudioStreamingState valueForString(String value)

Convert String to AudioStreamingState

Parameters:

value - String

Returns:

AudioStreamingState