SDL_Android/SmartDeviceLinkAndroidProxy - added the correct version of the proxy
[profile/ivi/smartdevicelink.git] / SDL_Android / SmartDeviceLinkProxyAndroid / src / com / smartdevicelink / proxy / rpc / enums / AudioStreamingState.java
index 4c9d945..dea3504 100755 (executable)
@@ -1,13 +1,37 @@
-//
-// Copyright (c) 2013 Ford Motor Company
-//
-package com.smartdevicelink.proxy.rpc.enums;
-
-public enum AudioStreamingState {
-    AUDIBLE,
-    NOT_AUDIBLE;
-
-    public static AudioStreamingState valueForString(String value) {
-        return valueOf(value);
-    }
-}
+package com.smartdevicelink.proxy.rpc.enums;\r
+\r
+/**\r
+ * Describes whether or not streaming audio is currently audible to the user.\r
+ * Though provided in every OnHMIStatus notification, this information is only\r
+ * relevant for applications that declare themselves as media apps in\r
+ * RegisterAppInterface\r
+ * \r
+ * @since SmartDeviceLink 1.0\r
+ */\r
+public enum AudioStreamingState {\r
+       /**\r
+        * Currently streaming audio, if any, is audible to user.\r
+        * \r
+        * @since SmartDeviceLink 1.0\r
+        */\r
+       AUDIBLE,\r
+\r
+       /**\r
+        * Some kind of audio mixing is taking place. Currently streaming audio, if\r
+        * any, is audible to the user at a lowered volume.\r
+        * \r
+        * @since SmartDeviceLink 2.0\r
+        */\r
+       ATTENUATED,\r
+       /**\r
+        * Currently streaming audio, if any, is not audible to user. made via VR\r
+        * session.\r
+        * \r
+        * @since SmartDeviceLink 1.0\r
+        */\r
+       NOT_AUDIBLE;\r
+\r
+    public static AudioStreamingState valueForString(String value) {\r
+        return valueOf(value);\r
+    }\r
+}\r