Pearl REST API change what an HDMI output displays
Pearl HDMI outputs can show a channel, a single input, the multiview grid, the device info screen, or the local console. The output ID (did) identifies each physical output, for example D1.
Applies to: Pearl-2, Pearl Mini, Pearl Nexus, Pearl Nano.
List the outputs to find the IDs and display names:
GET /api/v2.0/outputs
GET /api/v2.0/outputs?ids=D1,D2
Change the source shown on an output:
PUT /api/v2.0/outputs/{did}/settings?source=<value>
The source parameter is required. Accepted values are:
| Value | What is displayed |
|---|---|
A channel ID (cid) |
That channel's program output, for example source=1 |
An input ID (sid) |
That input directly, for example source=SRT1 |
multiview |
The MultiViewer grid |
deviceinfo |
The device information screen |
console |
The local console |
A request naming an output that does not exist returns 404 with a message such as output 'D30' not found.
To confirm the change took effect without physically checking the display, request the output preview image at GET /outputs/{did}/preview.