chore: Publish pr-feature-and-fixes-1-3-1

rdkcentral · Aug 14, 2024 · bd9830f · bd9830f
1 parent 76e1309
commit bd9830f
Show file tree

Hide file tree

Showing 4 changed files with 82 additions and 39 deletions.
diff --git a/apis/pr-feature-and-fixes-1-3-1/core/Advertising/index.md b/apis/pr-feature-and-fixes-1-3-1/core/Advertising/index.md
@@ -780,8 +780,8 @@ type AdvertisingIdOptions = {
 ```typescript
 type AdvertisingIdResult = {
   ifa: string // UUID conforming to IAB standard
-  ifa_type?: string // source of the IFA as defined by IAB
-  lmt?: string // boolean that if set to 1, user has requested ad tracking and measurement is disabled
+  ifa_type: string // source of the IFA as defined by IAB
+  lmt: '0' | '1' // boolean that if set to 1, user has requested ad tracking and measurement is disabled
 }
 ```
 

diff --git a/apis/pr-feature-and-fixes-1-3-1/core/Device/index.md b/apis/pr-feature-and-fixes-1-3-1/core/Device/index.md
@@ -48,11 +48,12 @@ Version Device 1.3.1-feature-and-fixes-1-3-1.0
 - [Types](#types)
   - [NetworkState](#networkstate)
   - [NetworkType](#networktype)
-  - [HDRType](#hdrtype)
+  - [HDRFormat](#hdrformat)
+  - [AudioProfiles](#audioprofiles)
   - [Resolution](#resolution)
   - [NetworkInfoResult](#networkinforesult)
   - [DeviceVersion](#deviceversion)
-  - [HDCPType](#hdcptype)
+  - [HDCPVersion](#hdcpversion)
 
 ## Usage
 
@@ -79,11 +80,13 @@ It is not recommended to use this API for visual badging on content within your
 To get the value of `audio` call the method like this:
 
 ```typescript
-function audio(): Promise<string>
+function audio(): Promise<AudioProfiles>
 ```
 
 Promise resolution:
 
+[AudioProfiles](#audioprofiles)
+
 Capabilities:
 
 | Role | Capability                          |
@@ -149,7 +152,7 @@ Response:
 To subscribe to notifications when the value changes, call the method like this:
 
 ```typescript
-function audio(callback: (value) => string): Promise<number>
+function audio(callback: (value) => AudioProfiles): Promise<number>
 ```
 
 Promise resolution:
@@ -289,12 +292,12 @@ Get the supported HDCP profiles
 To get the value of `hdcp` call the method like this:
 
 ```typescript
-function hdcp(): Promise<HDCPType>
+function hdcp(): Promise<HDCPVersion>
 ```
 
 Promise resolution:
 
-[HDCPType](#hdcptype)
+[HDCPVersion](#hdcpversion)
 
 Capabilities:
 
@@ -357,7 +360,7 @@ Response:
 To subscribe to notifications when the value changes, call the method like this:
 
 ```typescript
-function hdcp(callback: (value) => HDCPType): Promise<number>
+function hdcp(callback: (value) => HDCPVersion): Promise<number>
 ```
 
 Promise resolution:
@@ -429,12 +432,12 @@ Get the supported HDR profiles
 To get the value of `hdr` call the method like this:
 
 ```typescript
-function hdr(): Promise<HDRType>
+function hdr(): Promise<HDRFormat>
 ```
 
 Promise resolution:
 
-[HDRType](#hdrtype)
+[HDRFormat](#hdrformat)
 
 Capabilities:
 
@@ -501,7 +504,7 @@ Response:
 To subscribe to notifications when the value changes, call the method like this:
 
 ```typescript
-function hdr(callback: (value) => HDRType): Promise<number>
+function hdr(callback: (value) => HDRFormat): Promise<number>
 ```
 
 Promise resolution:
@@ -2010,12 +2013,12 @@ NetworkType: {
 
 ---
 
-### HDRType
+### HDRFormat
 
 The type of HDR that is supported
 
 ```typescript
-type HDRType = {
+type HDRFormat = {
   hdr10: boolean
   hdr10Plus: boolean
   dolbyVision: boolean
@@ -2025,6 +2028,20 @@ type HDRType = {
 
 ---
 
+### AudioProfiles
+
+```typescript
+type AudioProfiles = {
+    stereo: boolean
+    dolbyDigital5.1: boolean
+    dolbyDigital5.1+: boolean
+    dolbyAtmos: boolean
+}
+
+```
+
+---
+
 ### Resolution
 
 ```typescript
@@ -2074,7 +2091,7 @@ See also:
 ```typescript
 type DeviceVersion = {
   sdk?: SemanticVersion // The Firebolt SDK version
-  api: SemanticVersion // The lateset Firebolt API version supported by the curent device.
+  api: SemanticVersion // The latest Firebolt API version supported by the current device.
   firmware: SemanticVersion // The device firmware version.
   os: SemanticVersion // **Deprecated** Use `firmware`, instead.
   debug?: string // Detail version as a string, for debugging purposes
@@ -2087,12 +2104,12 @@ See also:
 
 ---
 
-### HDCPType
+### HDCPVersion
 
 The type of HDCP that is supported
 
 ```typescript
-type HDCPType = {
+type HDCPVersion = {
     hdcp1.4: boolean
     hdcp2.2: boolean
 }

diff --git a/requirements/pr-feature-and-fixes-1-3-1/specifications/firebolt-open-rpc.json b/requirements/pr-feature-and-fixes-1-3-1/specifications/firebolt-open-rpc.json
@@ -6092,7 +6092,7 @@
 				"name": "supportedHdcpProfiles",
 				"summary": "the supported HDCP profiles",
 				"schema": {
-					"$ref": "#/components/schemas/HDCPType"
+					"$ref": "#/components/schemas/HDCPVersion"
 				}
 			},
 			"examples": [
@@ -6128,7 +6128,7 @@
 				"name": "supportedHdrProfiles",
 				"summary": "the supported HDR profiles",
 				"schema": {
-					"$ref": "#/components/schemas/HDRType"
+					"$ref": "#/components/schemas/HDRFormat"
 				}
 			},
 			"examples": [
@@ -6585,7 +6585,7 @@
 							"$ref": "#/x-schemas/Types/ListenResponse"
 						},
 						{
-							"$ref": "#/components/schemas/HDCPType"
+							"$ref": "#/components/schemas/HDCPVersion"
 						}
 					]
 				}
@@ -6646,7 +6646,7 @@
 							"$ref": "#/x-schemas/Types/ListenResponse"
 						},
 						{
-							"$ref": "#/components/schemas/HDRType"
+							"$ref": "#/components/schemas/HDRFormat"
 						}
 					]
 				}
@@ -18562,11 +18562,17 @@
 					},
 					"lmt": {
 						"type": "string",
+						"enum": [
+							"0",
+							"1"
+						],
 						"description": "boolean that if set to 1, user has requested ad tracking and measurement is disabled"
 					}
 				},
 				"required": [
-					"ifa"
+					"ifa",
+					"ifa_type",
+					"lmt"
 				]
 			},
 			"TokenType": {
@@ -18784,6 +18790,7 @@
 			},
 			"AudioProfiles": {
 				"title": "AudioProfiles",
+				"type": "object",
 				"properties": {
 					"stereo": {
 						"type": "boolean"
@@ -18797,10 +18804,16 @@
 					"dolbyAtmos": {
 						"type": "boolean"
 					}
-				}
+				},
+				"required": [
+					"stereo",
+					"dolbyDigital5.1",
+					"dolbyDigital5.1+",
+					"dolbyAtmos"
+				]
 			},
-			"HDRType": {
-				"title": "HDRType",
+			"HDRFormat": {
+				"title": "HDRFormat",
 				"type": "object",
 				"properties": {
 					"hdr10": {
@@ -18824,8 +18837,8 @@
 				],
 				"description": "The type of HDR that is supported"
 			},
-			"HDCPType": {
-				"title": "HDCPType",
+			"HDCPVersion": {
+				"title": "HDCPVersion",
 				"type": "object",
 				"properties": {
 					"hdcp1.4": {
@@ -18851,7 +18864,7 @@
 					},
 					"api": {
 						"$ref": "#/x-schemas/Types/SemanticVersion",
-						"description": "The lateset Firebolt API version supported by the curent device."
+						"description": "The latest Firebolt API version supported by the current device."
 					},
 					"firmware": {
 						"$ref": "#/x-schemas/Types/SemanticVersion",

diff --git a/requirements/pr-feature-and-fixes-1-3-1/specifications/firebolt-specification.json b/requirements/pr-feature-and-fixes-1-3-1/specifications/firebolt-specification.json
@@ -7017,7 +7017,7 @@
 						"name": "supportedHdcpProfiles",
 						"summary": "the supported HDCP profiles",
 						"schema": {
-							"$ref": "#/components/schemas/HDCPType"
+							"$ref": "#/components/schemas/HDCPVersion"
 						}
 					},
 					"examples": [
@@ -7053,7 +7053,7 @@
 						"name": "supportedHdrProfiles",
 						"summary": "the supported HDR profiles",
 						"schema": {
-							"$ref": "#/components/schemas/HDRType"
+							"$ref": "#/components/schemas/HDRFormat"
 						}
 					},
 					"examples": [
@@ -7510,7 +7510,7 @@
 									"$ref": "#/x-schemas/Types/ListenResponse"
 								},
 								{
-									"$ref": "#/components/schemas/HDCPType"
+									"$ref": "#/components/schemas/HDCPVersion"
 								}
 							]
 						}
@@ -7571,7 +7571,7 @@
 									"$ref": "#/x-schemas/Types/ListenResponse"
 								},
 								{
-									"$ref": "#/components/schemas/HDRType"
+									"$ref": "#/components/schemas/HDRFormat"
 								}
 							]
 						}
@@ -19487,11 +19487,17 @@
 							},
 							"lmt": {
 								"type": "string",
+								"enum": [
+									"0",
+									"1"
+								],
 								"description": "boolean that if set to 1, user has requested ad tracking and measurement is disabled"
 							}
 						},
 						"required": [
-							"ifa"
+							"ifa",
+							"ifa_type",
+							"lmt"
 						]
 					},
 					"TokenType": {
@@ -19709,6 +19715,7 @@
 					},
 					"AudioProfiles": {
 						"title": "AudioProfiles",
+						"type": "object",
 						"properties": {
 							"stereo": {
 								"type": "boolean"
@@ -19722,10 +19729,16 @@
 							"dolbyAtmos": {
 								"type": "boolean"
 							}
-						}
+						},
+						"required": [
+							"stereo",
+							"dolbyDigital5.1",
+							"dolbyDigital5.1+",
+							"dolbyAtmos"
+						]
 					},
-					"HDRType": {
-						"title": "HDRType",
+					"HDRFormat": {
+						"title": "HDRFormat",
 						"type": "object",
 						"properties": {
 							"hdr10": {
@@ -19749,8 +19762,8 @@
 						],
 						"description": "The type of HDR that is supported"
 					},
-					"HDCPType": {
-						"title": "HDCPType",
+					"HDCPVersion": {
+						"title": "HDCPVersion",
 						"type": "object",
 						"properties": {
 							"hdcp1.4": {
@@ -19776,7 +19789,7 @@
 							},
 							"api": {
 								"$ref": "#/x-schemas/Types/SemanticVersion",
-								"description": "The lateset Firebolt API version supported by the curent device."
+								"description": "The latest Firebolt API version supported by the current device."
 							},
 							"firmware": {
 								"$ref": "#/x-schemas/Types/SemanticVersion",