feat: Audio Description and Preferred Audio Languages Settings (#45)

* Adding Audio Description Settings property * Adding Preferred Audio Languages --------- Co-authored-by: Clay Simmons <[email protected]>
rdkcentral · Jul 31, 2023 · 58f6ea1 · 58f6ea1
1 parent 1ec847e
commit 58f6ea1
Show file tree

Hide file tree

Showing 5 changed files with 161 additions and 3 deletions.
diff --git a/src/openrpc/accessibility.json b/src/openrpc/accessibility.json
@@ -179,9 +179,56 @@
           }
         }
       ]
-    }
+    },
+    {
+      "name": "audioDescriptionSettings",
+      "summary": "Get the user's preferred audio description settings",
+      "params": [],
+      "tags": [
+        {
+          "name": "property:readonly"
+        },
+        {
+          "name": "capabilities",
+          "x-uses": [
+            "xrn:firebolt:capability:accessibility:audiodescriptions"
+          ]
+        }
+      ],
+      "result": {
+        "name": "settings",
+        "summary": "the audio description settings",
+        "schema": {
+          "$ref": "#/components/schemas/AudioDescriptionSettings"
+        }
+      },
+      "examples": [
+        {
+          "name": "Getting the audio description settings",
+          "params": [],
+          "result": {
+            "name": "Default Result",
+            "value": {
+              "enabled": true
+            }
+          }
+        }
+      ]
+    }    
   ],
   "components": {
-    "schemas": {}
+    "schemas": {
+      "AudioDescriptionSettings": {
+        "title": "AudioDescriptionSettings",
+        "type": "object",
+        "required": ["enabled"],
+        "properties": {
+          "enabled": {
+            "type": "boolean",
+            "description": "Whether or not audio descriptions should be enabled by default"
+          }
+        }
+      }      
+    }
   }
 }
diff --git a/src/openrpc/audio_descriptions.json b/src/openrpc/audio_descriptions.json
@@ -0,0 +1,57 @@
+{
+    "openrpc": "1.2.4",
+    "info": {
+        "title": "AudioDescriptions",
+        "description": "A module for managing audio-description Settings.",
+        "version": "0.0.0"
+    },
+    "methods": [
+        {
+            "name": "enabled",
+            "tags": [
+                {
+                    "name": "property"
+                },
+                {
+                    "name": "capabilities",
+                    "x-uses": [
+                        "xrn:firebolt:capability:accessibility:audiodescriptions"
+                    ]
+                }
+            ],
+            "summary": "Whether or not audio-descriptions are enabled.",
+            "params": [
+            ],
+            "result": {
+                "name": "enabled",
+                "schema": {
+                    "type": "boolean"
+                }
+            },
+            "examples": [
+                {
+                    "name": "Default example #1",
+                    "params": [
+                    ],
+                    "result": {
+                        "name": "enabled",
+                        "value": true
+                    }
+                },
+                {
+                    "name": "Default example #2",
+                    "params": [
+                    ],
+                    "result": {
+                        "name": "enabled",
+                        "value": false
+                    }
+                }
+            ]
+        }
+   ],
+    "components": {
+        "schemas": {
+        }
+    }
+}
diff --git a/src/openrpc/localization.json b/src/openrpc/localization.json
@@ -168,6 +168,50 @@
         }            
       ]
     },
+    {
+      "name": "preferredAudioLanguages",
+      "summary": "A prioritized list of ISO 639 1/2 codes for the preferred audio languages on this device.",
+      "params": [],
+      "tags": [
+        {
+          "name": "property"
+        },
+        {
+          "name": "capabilities",
+          "x-uses": [
+            "xrn:firebolt:capability:localization:language"
+          ]
+        }
+      ],
+      "result": {
+        "name": "languages",
+        "summary": "the preferred audio languages",
+        "schema": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "examples": [
+        {
+          "name": "Default Example",
+          "params": [],
+          "result": {
+            "name": "Default Result",
+            "value": ["es", "en"]
+          }
+        }, 
+        {
+          "name": "Default Example #2",
+          "params": [],
+          "result": {
+            "name": "Default Result",
+            "value": ["en", "es"]
+          }
+        }             
+      ]
+    },
     {
       "name": "locale",
       "tags": [

diff --git a/src/sdks/core/sdk.config.json b/src/sdks/core/sdk.config.json
@@ -7,7 +7,8 @@
             "module": "Accessibility",
             "use": [
                 "xrn:firebolt:capability:accessibility:closedcaptions",
-                "xrn:firebolt:capability:accessibility:voiceguidance"
+                "xrn:firebolt:capability:accessibility:voiceguidance",
+                "xrn:firebolt:capability:accessibility:audiodescriptions"
             ]
         },
         {

diff --git a/src/sdks/manage/sdk.config.json b/src/sdks/manage/sdk.config.json
@@ -48,6 +48,15 @@
                 "xrn:firebolt:capability:accessibility:closedcaptions"
             ]
         },
+        {
+            "module": "AudioDescriptions",
+            "use": [
+                "xrn:firebolt:capability:accessibility:audiodescriptions"
+            ],
+            "manage": [
+                "xrn:firebolt:capability:accessibility:audiodescriptions"
+            ]
+        },
         {
             "module": "VoiceGuidance",
             "use": [