From 0f0dcc86630f59fcef6d9fb82508f3ecc7904896 Mon Sep 17 00:00:00 2001 From: Joe Martin Date: Tue, 23 Jul 2024 12:06:57 -0400 Subject: [PATCH] fix: Update docs --- requirements/specifications/media/media-capabilities.md | 6 ------ src/openrpc/display.json | 4 ++-- src/openrpc/video_output.json | 4 ++-- 3 files changed, 4 insertions(+), 10 deletions(-) diff --git a/requirements/specifications/media/media-capabilities.md b/requirements/specifications/media/media-capabilities.md index 5066ca209..ebab71f5d 100644 --- a/requirements/specifications/media/media-capabilities.md +++ b/requirements/specifications/media/media-capabilities.md @@ -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 @@ -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. @@ -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. diff --git a/src/openrpc/display.json b/src/openrpc/display.json index b3ce2b06e..3d2da4969 100644 --- a/src/openrpc/display.json +++ b/src/openrpc/display.json @@ -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" } diff --git a/src/openrpc/video_output.json b/src/openrpc/video_output.json index eeada9fde..4b4f83e9c 100644 --- a/src/openrpc/video_output.json +++ b/src/openrpc/video_output.json @@ -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" @@ -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"