Skip to content

Commit

Permalink
chore: Publish pr-feature-mfos-run-manage-discovery
Browse files Browse the repository at this point in the history
  • Loading branch information
Your Name committed Sep 18, 2024
1 parent 2ac8c3c commit 61f255c
Show file tree
Hide file tree
Showing 5 changed files with 87 additions and 263 deletions.
34 changes: 18 additions & 16 deletions apis/pr-feature-mfos-run-manage-discovery/core/Device/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -307,18 +307,18 @@ Capabilities:

#### Examples

Getting the supported HDCP versions
Getting the negotiated HDCP versions

JavaScript:

```javascript
import { Device } from '@firebolt-js/sdk'
let supportedHdcpVersions = await Device.hdcp()
console.log(supportedHdcpVersions)
let negotiatedHdcpVersions = await Device.hdcp()
console.log(negotiatedHdcpVersions)
```

Value of `supportedHdcpVersions`:
Value of `negotiatedHdcpVersions`:

```javascript
{
Expand Down Expand Up @@ -371,7 +371,7 @@ number
#### Examples
Getting the supported HDCP versions
Getting the negotiated HDCP versions
JavaScript:
Expand All @@ -384,7 +384,7 @@ let listenerId = await hdcp((value) => {
console.log(listenerId)
```

Value of `supportedHdcpVersions`:
Value of `negotiatedHdcpVersions`:

```javascript
{
Expand Down Expand Up @@ -427,7 +427,9 @@ Response:

### hdr

Get the negotiated HDR formats for the connected display and device
Get the negotiated HDR formats for the connected display and device.

For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles.

To get the value of `hdr` call the method like this:

Expand All @@ -447,18 +449,18 @@ Capabilities:

#### Examples

Getting the supported HDR formats
Getting the negotiated HDR formats

JavaScript:

```javascript
import { Device } from '@firebolt-js/sdk'
let supportedHdrFormats = await Device.hdr()
console.log(supportedHdrFormats)
let negotiatedHdrFormats = await Device.hdr()
console.log(negotiatedHdrFormats)
```

Value of `supportedHdrFormats`:
Value of `negotiatedHdrFormats`:

```javascript
{
Expand Down Expand Up @@ -515,7 +517,7 @@ number
#### Examples
Getting the supported HDR formats
Getting the negotiated HDR formats
JavaScript:
Expand All @@ -528,7 +530,7 @@ let listenerId = await hdr((value) => {
console.log(listenerId)
```

Value of `supportedHdrFormats`:
Value of `negotiatedHdrFormats`:

```javascript
{
Expand Down Expand Up @@ -1231,7 +1233,7 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio

### platform

Get a transient platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms.
Get a platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms.

To get the value of `platform` call the method like this:

Expand Down Expand Up @@ -2011,7 +2013,7 @@ NetworkType: {

### HDRFormatMap

The type of HDR format that is supported
The type of HDR format

```typescript
type HDRFormatMap = {
Expand Down Expand Up @@ -2101,7 +2103,7 @@ See also:

### HDCPVersionMap

The type of HDCP versions that is supported
The type of HDCP versions

```typescript
type HDCPVersionMap = {
Expand Down
85 changes: 0 additions & 85 deletions apis/pr-feature-mfos-run-manage-discovery/core/Discovery/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2501,91 +2501,6 @@ Response:

</details>

Launch the Aggregated Experience to it's search screen.

JavaScript:

```javascript
import { Discovery } from '@firebolt-js/sdk'
let success = await Discovery.launch('xrn:firebolt:application-type:main', {
action: 'search',
data: {
query: 'a cool show',
suggestions: [
{
entityType: 'program',
programType: 'movie',
entityId: 'xyz',
},
{
entityType: 'music',
musicType: 'song',
entityId: 'abc',
},
],
},
context: {
source: 'voice',
},
})
console.log(success)
```

Value of `success`:

```javascript
true
```

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

```json
{
"jsonrpc": "2.0",
"id": 1,
"method": "Discovery.launch",
"params": {
"appId": "xrn:firebolt:application-type:main",
"intent": {
"action": "search",
"data": {
"query": "a cool show",
"suggestions": [
{
"entityType": "program",
"programType": "movie",
"entityId": "xyz"
},
{
"entityType": "music",
"musicType": "song",
"entityId": "abc"
}
]
},
"context": {
"source": "voice"
}
}
}
}
```

Response:

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

</details>

---

### listen
Expand Down
77 changes: 23 additions & 54 deletions requirements/pr-feature-mfos-run-manage-discovery/specifications/firebolt-core-open-rpc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2033,7 +2033,7 @@
},
{
"name": "Device.platform",
"summary": "Get a transient platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms.",
"summary": "Get a platform identifier for the device. This API should be used to correlate metrics on the device only and cannot be guaranteed to have consistent responses across platforms.",
"params": [],
"tags": [
{
Expand Down Expand Up @@ -2307,15 +2307,15 @@
}
],
"result": {
"name": "supportedHdcpVersions",
"summary": "the supported HDCP versions",
"name": "negotiatedHdcpVersions",
"summary": "the negotiated HDCP versions",
"schema": {
"$ref": "#/components/schemas/HDCPVersionMap"
}
},
"examples": [
{
"name": "Getting the supported HDCP versions",
"name": "Getting the negotiated HDCP versions",
"params": [],
"result": {
"name": "Default Result",
Expand All @@ -2329,7 +2329,7 @@
},
{
"name": "Device.hdr",
"summary": "Get the negotiated HDR formats for the connected display and device",
"summary": "Get the negotiated HDR formats for the connected display and device. \n\n For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles.",
"params": [],
"tags": [
{
Expand All @@ -2343,15 +2343,15 @@
}
],
"result": {
"name": "supportedHdrFormats",
"summary": "the supported HDR formats",
"name": "negotiatedHdrFormats",
"summary": "the negotiated HDR formats",
"schema": {
"$ref": "#/components/schemas/HDRFormatMap"
}
},
"examples": [
{
"name": "Getting the supported HDR formats",
"name": "Getting the negotiated HDR formats",
"params": [],
"result": {
"name": "Default Result",
Expand Down Expand Up @@ -2416,6 +2416,9 @@
"x-uses": [
"xrn:firebolt:capability:device:info"
]
},
{
"name": "deprecated"
}
],
"result": {
Expand Down Expand Up @@ -2710,8 +2713,8 @@
}
],
"result": {
"name": "supportedHdcpVersions",
"summary": "the supported HDCP versions",
"name": "negotiatedHdcpVersions",
"summary": "the negotiated HDCP versions",
"schema": {
"anyOf": [
{
Expand All @@ -2725,7 +2728,7 @@
},
"examples": [
{
"name": "Getting the supported HDCP versions",
"name": "Getting the negotiated HDCP versions",
"params": [
{
"name": "listen",
Expand All @@ -2744,7 +2747,7 @@
},
{
"name": "Device.onHdrChanged",
"summary": "Get the negotiated HDR formats for the connected display and device",
"summary": "Get the negotiated HDR formats for the connected display and device. \n\n For devices that do not require additional connections (e.g. panels), `true` will be returned for all profiles.",
"params": [
{
"name": "listen",
Expand All @@ -2771,8 +2774,8 @@
}
],
"result": {
"name": "supportedHdrFormats",
"summary": "the supported HDR formats",
"name": "negotiatedHdrFormats",
"summary": "the negotiated HDR formats",
"schema": {
"anyOf": [
{
Expand All @@ -2786,7 +2789,7 @@
},
"examples": [
{
"name": "Getting the supported HDR formats",
"name": "Getting the negotiated HDR formats",
"params": [
{
"name": "listen",
Expand Down Expand Up @@ -2894,6 +2897,9 @@
"x-uses": [
"xrn:firebolt:capability:device:info"
]
},
{
"name": "deprecated"
}
],
"result": {
Expand Down Expand Up @@ -4295,43 +4301,6 @@
"name": "success",
"value": true
}
},
{
"name": "Launch the Aggregated Experience to it's search screen.",
"params": [
{
"name": "appId",
"value": "xrn:firebolt:application-type:main"
},
{
"name": "intent",
"value": {
"action": "search",
"data": {
"query": "a cool show",
"suggestions": [
{
"entityType": "program",
"programType": "movie",
"entityId": "xyz"
},
{
"entityType": "music",
"musicType": "song",
"entityId": "abc"
}
]
},
"context": {
"source": "voice"
}
}
}
],
"result": {
"name": "success",
"value": true
}
}
]
},
Expand Down Expand Up @@ -8650,7 +8619,7 @@
"dolbyVision",
"hlg"
],
"description": "The type of HDR format that is supported"
"description": "The type of HDR format"
},
"HDCPVersionMap": {
"title": "HDCPVersionMap",
Expand All @@ -8667,7 +8636,7 @@
"hdcp1.4",
"hdcp2.2"
],
"description": "The type of HDCP versions that is supported"
"description": "The type of HDCP versions"
},
"DeviceVersion": {
"title": "DeviceVersion",
Expand Down
Loading

0 comments on commit 61f255c

Please sign in to comment.