Skip to content

Commit

Permalink
chore: Publish pr-feature-media-info
Browse files Browse the repository at this point in the history
  • Loading branch information
Your Name committed Oct 2, 2024
1 parent f47677e commit 428c487
Show file tree
Hide file tree
Showing 8 changed files with 2,399 additions and 1,338 deletions.
426 changes: 426 additions & 0 deletions apis/pr-feature-media-info/core/AudioOutput/index.md

Large diffs are not rendered by default.

258 changes: 2 additions & 256 deletions apis/pr-feature-media-info/core/Display/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,8 @@ Version Display 1.2.0-feature-media-info.5
- [Usage](#usage)
- [Overview](#overview)
- [Methods](#methods)
- [colorDepth](#colordepth)
- [colorimetry](#colorimetry)
- [hdrProfiles](#hdrprofiles)
- [nativeRefreshRate](#nativerefreshrate)
- [nativeResolution](#nativeresolution)
- [nativeResolutionName](#nativeresolutionname)
- [size](#size)
- [videoModes](#videomodes)
- [Types](#types)
Expand All @@ -38,72 +34,10 @@ import { Display } from '@firebolt-js/sdk'

## Overview

A module for querying various aspects of the currently connected display (connected or built-in).
A module for querying various aspects of the currently connected (or built-in) display.

## Methods

### colorDepth

The color depth supported by the display.

```typescript
function colorDepth(): Promise<number>
```

Promise resolution:

Capabilities:

| Role | Capability |
| ---- | ------------------------------------ |
| uses | xrn:firebolt:capability:display:info |

#### Examples

Default Example

JavaScript:

```javascript
import { Display } from '@firebolt-js/sdk'
let colorDepth = await Display.colorDepth()
console.log(colorDepth)
```

Value of `colorDepth`:

```javascript
10
```

<details markdown="1" >
<summary>JSON-RPC:</summary>
Request:

```json
{
"jsonrpc": "2.0",
"id": 1,
"method": "Display.colorDepth",
"params": {}
}
```

Response:

```json
{
"jsonrpc": "2.0",
"id": 1,
"result": 10
}
```

</details>

---

### colorimetry

The colorimetry values supported by the display.
Expand Down Expand Up @@ -166,133 +100,9 @@ Response:

---

### hdrProfiles

The display's supported HDR profiles.

```typescript
function hdrProfiles(): Promise<HDRProfile[]>
```

Promise resolution:

Capabilities:

| Role | Capability |
| ---- | ------------------------------------ |
| uses | xrn:firebolt:capability:display:info |

#### Examples

Default Example

JavaScript:

```javascript
import { Display } from '@firebolt-js/sdk'
let hdrProfiles = await Display.hdrProfiles()
console.log(hdrProfiles)
```

Value of `hdrProfiles`:

```javascript
;['dolbyVision', 'hdr10', 'hdr10plus', 'hlg']
```

<details markdown="1" >
<summary>JSON-RPC:</summary>
Request:

```json
{
"jsonrpc": "2.0",
"id": 1,
"method": "Display.hdrProfiles",
"params": {}
}
```

Response:

```json
{
"jsonrpc": "2.0",
"id": 1,
"result": ["dolbyVision", "hdr10", "hdr10plus", "hlg"]
}
```

</details>

---

### nativeRefreshRate

The native refresh rate of the display device.

```typescript
function nativeRefreshRate(): Promise<number>
```

Promise resolution:

Capabilities:

| Role | Capability |
| ---- | ------------------------------------ |
| uses | xrn:firebolt:capability:display:info |

#### Examples

Default Example

JavaScript:

```javascript
import { Display } from '@firebolt-js/sdk'
let nativeRefreshRate = await Display.nativeRefreshRate()
console.log(nativeRefreshRate)
```

Value of `nativeRefreshRate`:

```javascript
60
```

<details markdown="1" >
<summary>JSON-RPC:</summary>
Request:

```json
{
"jsonrpc": "2.0",
"id": 1,
"method": "Display.nativeRefreshRate",
"params": {}
}
```

Response:

```json
{
"jsonrpc": "2.0",
"id": 1,
"result": 60
}
```

</details>

---

### nativeResolution

The native resolution of the display device in pixels. Returns a zero value for width and height if no display is present.
The native resolution of the display device in pixels.

```typescript
function nativeResolution(): Promise<Dimensions>
Expand Down Expand Up @@ -360,70 +170,6 @@ Response:

---

### nativeResolutionName

The user-friendly representation of the display's native resolution.

```typescript
function nativeResolutionName(): Promise<ResolutionName>
```

Promise resolution:

[ResolutionName](../Media/schemas/#ResolutionName)

Capabilities:

| Role | Capability |
| ---- | ------------------------------------ |
| uses | xrn:firebolt:capability:display:info |

#### Examples

Default Example

JavaScript:

```javascript
import { Display } from '@firebolt-js/sdk'
let nativeResolutionName = await Display.nativeResolutionName()
console.log(nativeResolutionName)
```

Value of `nativeResolutionName`:

```javascript
'uhd'
```

<details markdown="1" >
<summary>JSON-RPC:</summary>
Request:

```json
{
"jsonrpc": "2.0",
"id": 1,
"method": "Display.nativeResolutionName",
"params": {}
}
```

Response:

```json
{
"jsonrpc": "2.0",
"id": 1,
"result": "uhd"
}
```

</details>

---

### size

The physical width and height of the display panel (in centimeters).
Expand Down
Loading

0 comments on commit 428c487

Please sign in to comment.