Skip to content

Commit 3279ccb

Browse files
committed
docs: documented video-player url compatibility
1 parent 5fc8f20 commit 3279ccb

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

docs/guide/data_ui_blocks/dynamic_components.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ Component identification: [`video-player`](../../spec/component.md#video-player)
3939

4040
Video player is UI block to play a single video from [video URL provided in the input data](../input_data.md#video-url).
4141

42+
Title is also generated, and link pointing to the video cover image for YouTube videos is provided.
43+
44+
!!!warning
45+
Ability to play videos from video service url's (YouTube, Vimeo) or support for video file
46+
formats (`avi`, `mpeg`, `mov`, ...) can vary in individual [UI renderers](../renderer/index.md)!
47+
4248
Example rendering by Red Hat Design System for a prompt `Play trailer of Toy Story movie`:
4349

4450
![Video Player Data UI Block rendering by Red Hat Design System](../../img/data_ui_block_video.jpg "Video Player Data UI Block rendering by Red Hat Design System")

docs/guide/input_data.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,12 @@ Field with Image URL is important for [`image`](data_ui_blocks/dynamic_component
241241

242242
### Video URL
243243

244-
**ToDo** [`video-player`](data_ui_blocks/dynamic_components.md#video-player) component impl
244+
To interpret data field as an url pointing to the video, it must match any of this:
245+
246+
* data field value must be http/s url containing `.youtube.` or `youtu.be`
247+
* data field value must be http/s url and data field name must end with [extension defined in `VIDEO_DATA_PATH_SUFFIXES`](https://github.com/RedHat-UX/next-gen-ui-agent/tree/main/libs/next_gen_ui_agent/data_transform/types.py)
248+
249+
Field with Video URL is important for [`video-player`](data_ui_blocks/dynamic_components.md#video-player) component.
245250

246251
### Other URL
247252

libs/next_gen_ui_rhds_renderer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Next Gen UI Agent utilises [Stevedore Plugin framework](https://docs.openstack.o
1414
* [LLM selected and configured dynamic componets](https://redhat-ux.github.io/next-gen-ui-agent/guide/dynamic_components/)
1515
* Supported: `one-card`, `image`, `video-player`
1616
* Tech-Preview: `set-of-cards`, `table`
17-
17+
* `video-player` supports only YouTube video url's
1818

1919
## Installation
2020

0 commit comments

Comments
 (0)