Align integration docs with RelayTV API
This commit is contained in:
@@ -97,8 +97,10 @@ data:
|
||||
## Known Limitations
|
||||
|
||||
- `relaytv.play_now` currently maps to RelayTV `POST /play` (queue-clearing behavior).
|
||||
- RelayTV also exposes `POST /play_now`, but this integration does not currently use its preserve-current semantics.
|
||||
- No dedicated `enqueue` or `clear_queue` Home Assistant service is currently registered by this integration.
|
||||
- Overlay calls must include at least `text` or `image_url`.
|
||||
- Snapshots require active playback on the RelayTV server.
|
||||
- Integration uses local polling; it does not currently use WebSocket push updates.
|
||||
|
||||
## Compatibility
|
||||
|
||||
@@ -35,8 +35,11 @@ This integration provides a RelayTV `media_player` entity, RelayTV service actio
|
||||
|
||||
## Notes
|
||||
|
||||
- `smart_url` uses RelayTV `POST /smart`, which enqueues while already playing and otherwise starts playback immediately.
|
||||
- `play_now` and `announce` currently target RelayTV `POST /play`.
|
||||
- RelayTV also exposes `POST /play_now`, but this integration does not currently use its preserve-current behavior.
|
||||
- Overlay requires `text` or `image_url`.
|
||||
- Snapshot requires active playback on the RelayTV server.
|
||||
- Snapshot responses are normalized to absolute URLs for Home Assistant entity attributes.
|
||||
|
||||
For fuller documentation and examples, see the repository root README.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
smart_url:
|
||||
name: Smart play URL
|
||||
description: Resolve and play a shared URL in RelayTV (RelayTV POST /smart).
|
||||
description: RelayTV one-button URL handling via POST /smart. If RelayTV is already playing, the URL is enqueued; otherwise it starts immediate playback.
|
||||
target:
|
||||
entity:
|
||||
domain: media_player
|
||||
@@ -16,7 +16,7 @@ smart_url:
|
||||
|
||||
play_now:
|
||||
name: Play now
|
||||
description: Play a URL immediately (RelayTV POST /play). This clears the queue.
|
||||
description: Play a URL immediately using RelayTV POST /play. This clears the queue and does not currently use RelayTV POST /play_now preserve-current semantics.
|
||||
target:
|
||||
entity:
|
||||
domain: media_player
|
||||
@@ -42,7 +42,7 @@ play_now:
|
||||
|
||||
announce:
|
||||
name: Announce
|
||||
description: Alias for play_now. (RelayTV does not currently implement a distinct announcement mode.)
|
||||
description: Alias for play_now. This currently uses RelayTV POST /play and does not use a distinct announcement endpoint.
|
||||
target:
|
||||
entity:
|
||||
domain: media_player
|
||||
@@ -158,7 +158,7 @@ play_synced:
|
||||
|
||||
snapshot:
|
||||
name: Snapshot
|
||||
description: Capture a snapshot from RelayTV and expose snapshot_url on the entity.
|
||||
description: Capture a snapshot from RelayTV and expose snapshot_url on the entity. Active playback is required by the RelayTV server.
|
||||
target:
|
||||
entity:
|
||||
domain: media_player
|
||||
|
||||
Reference in New Issue
Block a user