Skip to content

Add optional thumbnails to graphics manifest (Issue #20)#57

Merged
nytamin merged 1 commit intoebu:mainfrom
Richardpwe:feature/issue-20
Apr 15, 2026
Merged

Add optional thumbnails to graphics manifest (Issue #20)#57
nytamin merged 1 commit intoebu:mainfrom
Richardpwe:feature/issue-20

Conversation

@Richardpwe
Copy link
Copy Markdown
Contributor

Each entry has file (required, path to image) and optionally resolution (object with width and height in pixels). Allowed image formats: PNG, JPG, GIF, webp.

Why resolution instead of ratio:
We use resolution (width × height) instead of a predefined ratio enum (e.g. 16by9, 9by16) so that UIs get actual pixel dimensions and can derive the aspect ratio when needed (e.g. width/height). Multiple thumbnails in different resolutions are supported directly, and the schema stays flexible without a fixed set of ratio strings.

@dvdeurse
Copy link
Copy Markdown
Collaborator

Path to the image file, relative to the manifest or absolute

In case it is absolute, shouldn't it be a URI then?

@Richardpwe
Copy link
Copy Markdown
Contributor Author

Good point @dvdeurse.
To be more precise, I would phrase it as:

Reference to the image file, either: a relative path (resolved relative to the manifest), or an absolute URI (e.g. file://… or https://…).

If that sounds good to you, I’ll update the PR accordingly.

@nytamin nytamin linked an issue Mar 15, 2026 that may be closed by this pull request
"items": {
"type": "object",
"properties": {
"file": {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit-picking: should we name this property path instead?

@nytamin
Copy link
Copy Markdown
Collaborator

nytamin commented Mar 15, 2026

A possible thing to consider is if the Server API needs to be extended to support thumbnails in a meaningful way:
How a client/controller can retrieve thumbnails over the Server API, as I don't think it is aware of what URL a graphic is served from at the moment.

@jhobz
Copy link
Copy Markdown
Contributor

jhobz commented Mar 18, 2026

A possible thing to consider is if the Server API needs to be extended to support thumbnails in a meaningful way: How a client/controller can retrieve thumbnails over the Server API, as I don't think it is aware of what URL a graphic is served from at the moment.

Seconding this. Some clients could greatly benefit from being able to get the thumbnail for a graphic from the server. I don't think it needs to be a requirement that blocks this PR though. I think the API endpoint could come separately.

@nytamin nytamin added the Manifest Related to the OGraf Graphics manifest label Apr 15, 2026
@nytamin
Copy link
Copy Markdown
Collaborator

nytamin commented Apr 15, 2026

Note from Working Group 2026-04-15:

Q: Should we consider other image formats, especially for moving pictures?
Conclusion: Limiting the number of formats reduces the implementation effort for GUIs. Also having the limit is useful when architecturing security / testing.

Q: Do we need resolution specified?
A: Keeping the resolution is useful in CDN-like situations, and can improve performance.

OK to merge this PR in its current form, let's remember to add it to ServerAPI later.

@nytamin nytamin merged commit 5a40d89 into ebu:main Apr 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Manifest Related to the OGraf Graphics manifest

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Thumbnail

4 participants