diff --git a/src/openrpc/audio_output.json b/src/openrpc/audio_output.json index 4eb8bc665..874852984 100644 --- a/src/openrpc/audio_output.json +++ b/src/openrpc/audio_output.json @@ -1,14 +1,14 @@ { "openrpc": "1.2.4", "info": { - "title": "Display", - "description": "A module for query info about e current (or built in) display on a device", + "title": "Audio Output Properties", + "description": "A module for querying various aspects of the current (or built-in) audio output system of a device", "version": "0.0.0" }, "methods": [ { "name": "mode", - "summary": "Get the Audio mode supported by the platform.", + "summary": "Return the audio mode currently supported by the platform.", "tags": [ { "name": "capabilities", @@ -20,9 +20,9 @@ "params": [], "result": { "name": "audioMode", - "summary": "Get the Audio mode supported by the platform.", + "summary": "The audio mode supported by the platform.", "schema": { - "$ref": "#/components/schemas/AudioOutput" + "$ref": "#/components/schemas/AudioMode" } }, "examples": [ @@ -39,8 +39,8 @@ ], "components": { "schemas": { - "AudioOutput": { - "title": "AudioOutput", + "AudioMode": { + "title": "AudioMode", "type": "string", "enum": [ "Mono", @@ -52,8 +52,8 @@ "Unknown", "None" ], - "description": "The audio output supported by the platform" - } + "description": "The audio output mode supported by the platform" + } } } -} \ No newline at end of file +} diff --git a/src/openrpc/device.json b/src/openrpc/device.json index 9c50ee253..67ab25736 100644 --- a/src/openrpc/device.json +++ b/src/openrpc/device.json @@ -398,7 +398,7 @@ }, { "name": "hdr", - "summary": "Get the supported HDR profiles", + "summary": "Returns an array of valid HDR profiles that the device supports", "params": [], "tags": [ { @@ -413,14 +413,14 @@ ], "result": { "name": "supportedHdrProfiles", - "summary": "the supported HDR profiles", + "summary": "The supported HDR profiles", "schema": { "$ref": "https://meta.comcast.com/firebolt/types#/definitions/BooleanMap" } }, "examples": [ { - "name": "Getting the supported HDR profiles", + "name": "The supported HDR profiles", "params": [], "result": { "name": "Default Result", @@ -546,11 +546,11 @@ }, { "name": "videoFormatSupported", - "summary": "Get the supported video formats", + "summary": "Check whether content of a given a video format and resolution is supported by the device's current configuration. These values may change as different AV inputs are activated or connected.", "params": [ { "name": "format", - "summary": "Video Format to check if it is supported by platform", + "summary": "The video format used to check whether its supported by the device's current configuration.", "required": true, "schema": { "$ref": "#/components/schemas/VideoFormat" @@ -558,7 +558,7 @@ }, { "name": "resolution", - "summary": "Video Resolution to check if it is supported by platform", + "summary": "The video resolution used to check whether its supported by the device's current configuration.", "schema": { "$ref": "#/components/schemas/VideoFormatResolution" } @@ -577,14 +577,14 @@ ], "result": { "name": "videoFormatSupported", - "summary": "Video Format and Resolution support", + "summary": "Whether content of the provided video format and resolution are supported by the device's current configuration.", "schema": { "type": "boolean" } }, "examples": [ { - "name": "Getting the video format", + "name": "Specify the video format and resolution to check", "params": [ { "name": "format", @@ -604,11 +604,11 @@ }, { "name": "videoFormatPossible", - "summary": "Get the possible video formats", + "summary": "Check whether content of a given a video format and resolution is supported by the device regardless of its configuration. These values will never change without a restart of the device.", "params": [ { "name": "format", - "summary": "Video Format to check if it is possible by platform regardless of the configuration", + "summary": "The video format used to check whether its supported by the device.", "required": true, "schema": { "$ref": "#/components/schemas/VideoFormat" @@ -616,7 +616,7 @@ }, { "name": "resolution", - "summary": "Video Resolution to check if it is possible by platform", + "summary": "The video resolution used to check whether its supported by the device.", "schema": { "$ref": "#/components/schemas/VideoFormatResolution" } @@ -635,14 +635,14 @@ ], "result": { "name": "videoFormatPossible", - "summary": "Video Format and Resolution support", + "summary": "Whether content of the provided video format and resolution are supported by the device.", "schema": { "type": "boolean" } }, "examples": [ { - "name": "Getting the video format", + "name": "Specify the video format and resolution to check.", "params": [ { "name": "format", @@ -662,11 +662,11 @@ }, { "name": "audioFormatSupported", - "summary": "Check the supported audio formats", + "summary": "Check whether content of a given audio format and channel output is supported by the device's current configuration. These values may change as different AV inputs are activated or connected.", "params": [ { "name": "format", - "summary": "Audio Format to check if it is supported by platform", + "summary": "Audio format used to check whether its supported.", "required": true, "schema": { "$ref": "#/components/schemas/AudioFormat" @@ -674,7 +674,7 @@ }, { "name": "channels", - "summary": "Channels is the output medium for the Audio", + "summary": "An audio channels value used to check whether its supported.", "schema": { "$ref": "#/components/schemas/AudioChannels" } @@ -693,17 +693,17 @@ ], "result": { "name": "audioFormatSupported", - "summary": "Audio Format and Channel support", + "summary": "Whether content of the provided audio format and channels value are supported by the device's current configuration.", "schema": { "type": "boolean" } }, "examples": [ { - "name": "Getting the Audio format and channel format", + "name": "Specify the audio format and channel to check", "params": [ { - "name":"format", + "name": "format", "value": "AAC" }, { @@ -720,11 +720,11 @@ }, { "name": "audioFormatPossible", - "summary": "Check the possible video formats", + "summary": "Check whether content of a given audio format and channel output is supported by the device regardless of its configuration. These values will never change without a restart of the device.", "params": [ { "name": "format", - "summary": "Audio Format to check if it is possible irrespective of the configuration in the platform", + "summary": "Audio format used to check whether its supported.", "required": true, "schema": { "$ref": "#/components/schemas/AudioFormat" @@ -732,7 +732,7 @@ }, { "name": "channels", - "summary": "Channels is the output medium for the Audio", + "summary": "An audio channels value used to check whether its supported.", "schema": { "$ref": "#/components/schemas/AudioChannels" } @@ -751,25 +751,24 @@ ], "result": { "name": "audioFormatPossible", - "summary": "Audio Format and Channel support", + "summary": "Whether content of the provided audio format and channels value are supported by the device.", "schema": { "type": "boolean" } }, "examples": [ { - "name": "Getting the Audio format and channel format", + "name": "Specify the audio format and channel to check", "params": [ { "name": "format", "value": "aac" - }, + }, { "name": "channels", "value": "mono" } ], - "result": { "name": "Default Result", "value": true @@ -777,6 +776,50 @@ } ] }, + { + "name": "supportedResolutions", + "summary": "Returns an array of valid resolutions that the device supports, regardless of any connected display.", + "tags": [ + { + "name": "capabilities", + "x-uses": [ + "xrn:firebolt:capability:display:info" + ] + } + ], + "params": [], + "result": { + "name": "resolution", + "summary": "An array of valid resolutions that the device supports", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceResolution" + }, + "minItems": 1 + } + }, + "examples": [ + { + "name": "Default Example", + "params": [], + "result": { + "name": "Default Result", + "value": [ + "1080p24", + "1080i25", + "1080p30", + "1080i50", + "1080p50", + "1080p60", + "2160p30", + "2160p50", + "2160p60" + ] + } + } + ] + }, { "name": "name", "summary": "The human readable name of the device", @@ -1111,10 +1154,27 @@ "MONO", "STEREO", "SURROUND", + "SURROUND_5_1", "SURROUND_7_1" ], "description": "The audio channels supported by the platform" + }, + "DeviceResolution": { + "title": "DeviceResolution", + "type": "string", + "enum": [ + "1080p24", + "1080i25", + "1080p30", + "1080i50", + "1080p50", + "1080p60", + "2160p30", + "2160p50", + "2160p60" + ], + "description": "The list of resolutions supported by the device" } } } -} \ No newline at end of file +} diff --git a/src/openrpc/display.json b/src/openrpc/display.json index d907b9c71..71f4a3d6d 100644 --- a/src/openrpc/display.json +++ b/src/openrpc/display.json @@ -1,14 +1,14 @@ { "openrpc": "1.2.4", "info": { - "title": "Display", - "description": "A module for query info about e current (or built in) display on a device", + "title": "Display Properties", + "description": "A module for querying various aspects of the current (or built-in) display on a device", "version": "0.0.0" }, "methods": [ { "name": "width", - "summary": "Get the width of the display in centimeters.", + "summary": "Get the width of the display (in centimeters) from the HDMI EDID.", "tags": [ { "name": "capabilities", @@ -20,7 +20,7 @@ "params": [], "result": { "name": "width", - "summary": "Width of the display device in centimeters", + "summary": "Width of the display device", "schema": { "type": "number" } @@ -38,7 +38,7 @@ }, { "name": "height", - "summary": "Get the height of the display in centimeters.", + "summary": "Get the height of the display (in centimeters) from the HDMI EDID.", "tags": [ { "name": "capabilities", @@ -79,8 +79,8 @@ ], "params": [], "result": { - "name": "height", - "summary": "Height of the display device in centimeters", + "name": "resolution", + "summary": "The current resolution of the display device.", "schema": { "$ref": "#/components/schemas/DisplayResolution" } @@ -98,7 +98,7 @@ }, { "name": "optimalResolution", - "summary": "Get the optimal resolution of the display device.", + "summary": "Get the optimal resolution of the display device. This value is provided from the HDMI EDID.", "tags": [ { "name": "capabilities", @@ -110,7 +110,7 @@ "params": [], "result": { "name": "resolution", - "summary": "Height of the display device in centimeters", + "summary": "Optional resolution of the display device.", "schema": { "$ref": "#/components/schemas/DisplayResolution" } @@ -172,7 +172,7 @@ }, { "name": "hdr", - "summary": "Returns an array of valid HDR profiles that the display supports", + "summary": "Returns an array of valid HDR profiles that the display supports. ", "tags": [ { "name": "capabilities", @@ -184,15 +184,15 @@ "params": [ { "name": "resolution", - "summary": "Video Resolution include only HDR profiles that are supported by that resolution", + "summary": "The video resolution to check against HDR profiles supported by the display. When provided, the result includes only HDR profiles supported by this resolution.", "schema": { - "$ref": "#/components/schemas/VideoFormatResolution" + "$ref": "#/components/schemas/VideoFormatResolution" } } ], "result": { "name": "resolution", - "summary": "An array of valid HDR profiles that the display supports", + "summary": "An array of valid HDR profiles that the display supports.", "schema": { "type": "array", "items": { @@ -213,15 +213,11 @@ "result": { "name": "Default Result", "value": [ - "1080p24", - "1080i25", - "1080p30", - "1080i50", - "1080p50", - "1080p60", - "2160p30", - "2160p50", - "2160p60" + "DolbyVision", + "Hdr10", + "Hdr10Plus", + "St2084", + "hlg" ] } } @@ -229,7 +225,7 @@ }, { "name": "useSourceFrameRate", - "summary": "Get the hdmi output frame rate is set to follow video source frame rate.", + "summary": "Set the HDMI output frame rate to follow the video source frame rate.", "tags": [ { "name": "capabilities", @@ -241,7 +237,7 @@ "params": [], "result": { "name": "useSourceFrameRate", - "summary": "Get the hdmi output frame rate is set to follow video source frame rate", + "summary": "Whether the HDMI output frame rate was set to follow video source frame rate", "schema": { "type": "boolean" } @@ -260,34 +256,34 @@ ], "components": { "schemas": { - "DisplayResolution": { - "title": "DisplayResolution", - "type": "string", - "enum": [ - "1080p24", - "1080i25", - "1080p30", - "1080i50", - "1080p50", - "1080p60", - "2160p30", - "2160p50", - "2160p60" - ], - "description": "The list of resolutions supported by platform" - }, - "HdrProfile": { - "title": "HdrProfile", - "type": "string", - "enum": [ - "DolbyVision", - "Hdr10", - "Hdr10Plus", - "St2084", - "hlg" - ], - "description": "The list of HDR profiles supported by platform" - } + "DisplayResolution": { + "title": "DisplayResolution", + "type": "string", + "enum": [ + "1080p24", + "1080i25", + "1080p30", + "1080i50", + "1080p50", + "1080p60", + "2160p30", + "2160p50", + "2160p60" + ], + "description": "The list of resolutions supported by the display" + }, + "HdrProfile": { + "title": "HdrProfile", + "type": "string", + "enum": [ + "DolbyVision", + "Hdr10", + "Hdr10Plus", + "St2084", + "hlg" + ], + "description": "The list of HDR profiles supported by the display" + } } } -} \ No newline at end of file +}