Skip to content

Commit

Permalink
fix: remove Hdmi Preview support
Browse files Browse the repository at this point in the history
  • Loading branch information
satlead committed Nov 14, 2023
1 parent 86a759c commit 5828f21
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 135 deletions.
15 changes: 1 addition & 14 deletions requirements/specifications/hardware/hdmi-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,17 +310,4 @@ Below is an example of stopping an existing HDMI Port selection
HDMIInput.select('HDMI1','stop').then(() => {
console.log("Successfully un selected HDMI1 port");
})
```


### 9.2 HDMI Select Preview Mode

Most of the modern system ui applications support showcasing the preview of the HDMI player within the tile. To support such feature we need the platform to create a `Hole Punch` around the Hdmi Video playback. To support this feature `HDMInput.select` api offers a `HDMIPreviewOptions` schema structure.

The `HDMIPreviewOptions` schema **MUST** be specified with the `holePunch` field.
If the `holePunch` field is set to `true` then the parameters **MUST** include the `dimensions` field for the `HDMIPreviewOptions`.
```javascript
HDMIInput.select('HDMI1','start', {"holdPunch": true, "dimensions": {"x":10, y: 10, "width":100, "height": 100}}).then(() => {
console.log("Successfully selected HDMI1 port");
})
```
```
121 changes: 0 additions & 121 deletions src/openrpc/hdmi-input.json
Original file line number Diff line number Diff line change
Expand Up @@ -125,12 +125,6 @@
"$ref": "#/components/schemas/HDMISelectType"
},
"required": true
},
{
"name": "options",
"schema": {
"$ref": "#/components/schemas/HDMIPreviewOptions"
}
}
],
"result": {
Expand Down Expand Up @@ -173,55 +167,6 @@
"name": "port",
"value": null
}
},
{
"name": "Default Example for preview",
"params": [
{
"name": "portId",
"value": "HDMI1"
},
{
"name": "type",
"value": "start"
},
{
"name": "options",
"value": {
"dimensions": {
"x": 40,
"y": 50,
"w": 100,
"h": 100
},
"holePunch": true
}
}
],
"result": {
"name": "ports",
"value": null
}
},
{
"name": "Default Example for stop preview",
"params": [
{
"name": "portId",
"value": "HDMI1"
},
{
"name": "type",
"value": "stop"
},
{
"name": "options",
"value": {
"holePunch": false
}
}
],
"result": null
}
]
},
Expand Down Expand Up @@ -622,72 +567,6 @@
"start",
"stop"
]
},
"HDMIPreviewOptions": {
"title": "HDMIPreviewOptions",
"type": "object",
"required": [
"holePunch"
],
"properties": {
"dimensions" : {
"$ref": "#/components/schemas/HDMIVideoDimension"
},
"holePunch": {
"description": "Used during preview modes where the player is showcased in a smaller dimension overlayed by the existing system ui application",
"type": "boolean"
}
},
"if": {
"properties": {
"holePunch": {
"const": true
}
}
},
"then": {
"properties": {
"required": [
"dimensions"
]
}
}
},
"HDMIVideoDimension": {
"title": "HDMIVideoDimension",
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "number",
"description": "x co-ordinate of the prevew",
"default": 0,
"minimum": 0
},
"y": {
"type": "number",
"description": "y co-ordinate of the prevew",
"default": 0,
"minimum": 0
},
"width": {
"type": "number",
"description": "width of the preview ",
"default": 10,
"minimum": 10
},
"height": {
"type": "number",
"description": "width of the preview ",
"default": 10,
"minimum": 10
}
}
}
}
}
Expand Down

0 comments on commit 5828f21

Please sign in to comment.