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 index 935e7b5e..e2d89fee 100644 --- 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,10 +48,11 @@ Version Device 1.3.1-feature-and-fixes-1-3-1.0 - [Types](#types) - [NetworkState](#networkstate) - [NetworkType](#networktype) + - [HDRType](#hdrtype) - [Resolution](#resolution) - [NetworkInfoResult](#networkinforesult) + - [DeviceVersion](#deviceversion) - [HDCPType](#hdcptype) - - [HDRType](#hdrtype) ## Usage @@ -1291,7 +1292,7 @@ Response: ### screenResolution -Get the maximum supported video resolution for the graphical surface of the app. +Get the maximum supported screen resolution for the graphical surface of the app. The pairs returned will be of a [width, height] format and will correspond to the following values: @@ -1630,12 +1631,12 @@ Get the SDK, OS and other version info To get the value of `version` call the method like this: ```typescript -function version(): Promise +function version(): Promise ``` Promise resolution: -[HDCPType](#hdcptype) +[DeviceVersion](#deviceversion) Capabilities: @@ -2009,6 +2010,21 @@ NetworkType: { --- +### HDRType + +The type of HDR that is supported + +```typescript +type HDRType = { + hdr10: boolean + hdr10Plus: boolean + dolbyVision: boolean + hlg: boolean +} +``` + +--- + ### Resolution ```typescript @@ -2053,31 +2069,34 @@ See also: --- -### HDCPType - -The type of HDCP that is supported +### DeviceVersion ```typescript -type HDCPType = { - hdcp1.4?: boolean - hdcp2.2?: boolean +type DeviceVersion = { + sdk?: SemanticVersion // The Firebolt SDK version + api: SemanticVersion // The lateset Firebolt API version supported by the curent device. + firmware: SemanticVersion // The device firmware version. + os: SemanticVersion // **Deprecated** Use `firmware`, instead. + debug?: string // Detail version as a string, for debugging purposes } - ``` +See also: + +[SemanticVersion](../Types/schemas/#SemanticVersion) + --- -### HDRType +### HDCPType -The type of HDR that is supported +The type of HDCP that is supported ```typescript -type HDRType = { - hdr10?: boolean - hdr10plus?: boolean - dolbyVision?: boolean - hlg?: boolean +type HDCPType = { + 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 index c78145a1..0656a55e 100644 --- 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 @@ -6033,7 +6033,7 @@ "name": "versions", "summary": "the versions", "schema": { - "$ref": "#/components/schemas/HDCPType" + "$ref": "#/components/schemas/DeviceVersion" } }, "examples": [ @@ -6187,7 +6187,7 @@ }, { "name": "Device.screenResolution", - "summary": "Get the maximum supported video resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", + "summary": "Get the maximum supported screen resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", "params": [], "tags": [ { @@ -6737,7 +6737,7 @@ }, { "name": "Device.onScreenResolutionChanged", - "summary": "Get the maximum supported video resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", + "summary": "Get the maximum supported screen resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", "params": [ { "name": "listen", @@ -18806,7 +18806,7 @@ "hdr10": { "type": "boolean" }, - "hdr10plus": { + "hdr10Plus": { "type": "boolean" }, "dolbyVision": { @@ -18816,6 +18816,12 @@ "type": "boolean" } }, + "required": [ + "hdr10", + "hdr10Plus", + "dolbyVision", + "hlg" + ], "description": "The type of HDR that is supported" }, "HDCPType": { @@ -18829,6 +18835,10 @@ "type": "boolean" } }, + "required": [ + "hdcp1.4", + "hdcp2.2" + ], "description": "The type of HDCP that is supported" }, "DeviceVersion": { 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 index f563cf72..3f175cf8 100644 --- 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 @@ -6958,7 +6958,7 @@ "name": "versions", "summary": "the versions", "schema": { - "$ref": "#/components/schemas/HDCPType" + "$ref": "#/components/schemas/DeviceVersion" } }, "examples": [ @@ -7112,7 +7112,7 @@ }, { "name": "Device.screenResolution", - "summary": "Get the maximum supported video resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", + "summary": "Get the maximum supported screen resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", "params": [], "tags": [ { @@ -7662,7 +7662,7 @@ }, { "name": "Device.onScreenResolutionChanged", - "summary": "Get the maximum supported video resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", + "summary": "Get the maximum supported screen resolution for the graphical surface of the app. \n\nThe pairs returned will be of a [width, height] format and will correspond to the following values: \n\nNTSC Standard Definition (SD): [720, 480] \n\nPAL Standard Definition (SD): [720, 576] \n\nHigh Definition (HD): [1280, 720] \n\nFull HD (FHD): [1920, 1080]\n\n4K Ultra High Definition (UHD): [1920, 1080] \n\n**Note:** This method will be deprecated with a future Firebolt release", "params": [ { "name": "listen", @@ -19731,7 +19731,7 @@ "hdr10": { "type": "boolean" }, - "hdr10plus": { + "hdr10Plus": { "type": "boolean" }, "dolbyVision": { @@ -19741,6 +19741,12 @@ "type": "boolean" } }, + "required": [ + "hdr10", + "hdr10Plus", + "dolbyVision", + "hlg" + ], "description": "The type of HDR that is supported" }, "HDCPType": { @@ -19754,6 +19760,10 @@ "type": "boolean" } }, + "required": [ + "hdcp1.4", + "hdcp2.2" + ], "description": "The type of HDCP that is supported" }, "DeviceVersion": {