Skip to content

Commit

Permalink
fix: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alkalinecoffee committed Jul 23, 2024
1 parent 9c63ec2 commit 0f0dcc8
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 10 deletions.
6 changes: 0 additions & 6 deletions requirements/specifications/media/media-capabilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,8 +338,6 @@ MediaCapabilities.colorDepth()

The `MediaCapabilities` module **MUST** have an `hdrProfiles` method that returns an array of `Media.HDRProfile` values describing the HDR capabilities commonly supported across all relevant peripherals in the user's AV chain.

If no display is present, an empty array **MUST** be returned.

Access to this method **MUST** require the `use` role of the `xrn:firebolt:capability:media-capabilities:info` capability.

```javascript
Expand Down Expand Up @@ -497,8 +495,6 @@ These APIs will be surfaced in the `VideoOutput` module.

The `VideoOutput` module **MUST** have a `mode` property that returns a `Media.VideoMode` value describing the currently set video output mode.

If no display is present, a value of `unknown` is returned.

This method **MUST** have a corresponding `onModeWillChange` event to notify listeners when a change to this property has been made but before that change has taken effect.

This method **MUST** have a corresponding `onModeChanged` event to notify listeners after a change to this property has been made and that change has taken effect.
Expand All @@ -514,8 +510,6 @@ VideoOutput.mode()

The `VideoOutput` module **MUST** have a `resolution` method that returns a `Types.Dimensions` object describing the current video output resolution, in pixels.

If no display is present, the height and width values **MUST** both be zero.

This method **MUST** have a corresponding `onResolutionChanged` event to notify listeners after a change to the device's `videoMode` property has been made and that change has taken effect.

Access to these methods **MUST** require the `use` role of the `xrn:firebolt:capability:video-output:mode` capability.
Expand Down
4 changes: 2 additions & 2 deletions src/openrpc/display.json
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@
],
"params": [],
"result": {
"name": "refreshRate",
"summary": "The refresh rate of the display device.",
"name": "nativeRefreshRate",
"summary": "The native refresh rate of the display device.",
"schema": {
"type": "number"
}
Expand Down
4 changes: 2 additions & 2 deletions src/openrpc/video_output.json
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@
},
{
"name": "mode",
"summary": "The current video output mode of the device.",
"summary": "The current video output mode setting of the device.",
"tags": [
{
"name": "property:readonly"
Expand Down Expand Up @@ -304,7 +304,7 @@
},
{
"name": "resolution",
"summary": "The width and height of the current video output, in pixels.",
"summary": "The width and height of the current video mode setting, in pixels.",
"tags": [
{
"name": "property:readonly"
Expand Down

0 comments on commit 0f0dcc8

Please sign in to comment.