Skip to content

Commit

Permalink
minor corrections per requirements doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@alkalinecoffee
alkalinecoffee committed Apr 9, 2024
1 parent 08fcbbe commit 9dd77d2
Show file tree
Hide file tree
Showing 3 changed files with 146 additions and 90 deletions.
20 changes: 10 additions & 10 deletions src/openrpc/audio_output.json
View file
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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": [
Expand All @@ -39,8 +39,8 @@
],
"components": {
"schemas": {
"AudioOutput": {
"title": "AudioOutput",
"AudioMode": {
"title": "AudioMode",
"type": "string",
"enum": [
"Mono",
Expand All @@ -52,8 +52,8 @@
"Unknown",
"None"
],
"description": "The audio output supported by the platform"
}
"description": "The audio output mode supported by the platform"
}
}
}
}
}
114 changes: 87 additions & 27 deletions src/openrpc/device.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand All @@ -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",
Expand Down Expand Up @@ -546,19 +546,19 @@
},
{
"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"
}
},
{
"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"
}
Expand All @@ -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",
Expand All @@ -604,19 +604,19 @@
},
{
"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"
}
},
{
"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"
}
Expand All @@ -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",
Expand All @@ -662,19 +662,19 @@
},
{
"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"
}
},
{
"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"
}
Expand All @@ -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"
},
{
Expand All @@ -720,19 +720,19 @@
},
{
"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"
}
},
{
"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"
}
Expand All @@ -751,32 +751,75 @@
],
"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
}
}
]
},
{
"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",
Expand Down Expand Up @@ -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"
}
}
}
}
}
Loading

0 comments on commit 9dd77d2

Please sign in to comment.