Discuss: Event Metadata #1
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JamesUoM
reviewed
Mar 21, 2025
| (🟦) Metadata fields marked with this symbol are *Opencast-managed*: they are read-only for users/external applications. All other fields can be freely changed, as long as validity checks pass. | ||
|
|
||
| #### General | ||
| - `id: ID` 🟦: unique among all events. |
There was a problem hiding this comment.
As discussed recently, this needs clearer definition. Is the id unique to the system, tenancy ( or even globally)? I think the feeling was that id+organization should be unique because of the possibility of loading the same MediaPackage into different tenancies in the same system.
Need to add organization: NonBlankString ?
JamesUoM
reviewed
Mar 21, 2025
| - `creators: NonBlankString[]`: The people mainly responsible for creating this video and/or presenting the talk which this video is a recording of. Should contain human-readable names and not usernames. Plain text. This is the main "who?"-information shown in the UIs; other fields in `extraMetadata` (e.g. `dct:contributor`) might be shown too, but less prominently. | ||
| - `language: LangCode?`: describes the (main) language of this event and its metadata. For example, the audio language and (if applicable) language of video content is more important than the language of available subtitles. Generally, assets can have their own language specified. | ||
| - `series: SeriesID?`: optional ID of the series this event belongs to. Must be a valid series ID of an existing series at all time. | ||
| - `owner: Username`: TODO figure out details |
There was a problem hiding this comment.
Should we allow owner to also be a group rather than just an individual?
JamesUoM
reviewed
Mar 21, 2025
| - `startTime: DateTime?`: Actual real life datetime when the video recording started or will start, with timezone. If this is not applicable, for example because it's a short movie, this should be undefined. UIs should use this as primary date to show for a video and if unset, fallback to `created`. | ||
| - `endTime: DateTime?`: Like `startTime`, but when the video recording stopped. Due to cutting, recording pauses and etc, the `duration` is not necessarily `end - start`. | ||
| - `duration: Milliseconds` 🟦: duration of the event. As specified in ["assets"](./assets), this needs to always match the duration of all non-internal tracks. | ||
| - `updated: Timestamp` 🟦: Timestamp of when anything about this event was last changed. |
There was a problem hiding this comment.
modified ?
Again needs a clear definition of what affects a change e.g. if the series is modified
JamesUoM
reviewed
Mar 21, 2025
| - `endTime: DateTime?`: Like `startTime`, but when the video recording stopped. Due to cutting, recording pauses and etc, the `duration` is not necessarily `end - start`. | ||
| - `duration: Milliseconds` 🟦: duration of the event. As specified in ["assets"](./assets), this needs to always match the duration of all non-internal tracks. | ||
| - `updated: Timestamp` 🟦: Timestamp of when anything about this event was last changed. | ||
| - `created: Timestamp` 🟦: Timestamp of when the event was created in Opencast. It is set once when the event is first stored in Opencast's DB, and never changed again. This also implies that scheduled event's `created` date is when the scheduling took place, _not_ the time it is scheduled for (that would be `startDate`) |
JamesUoM
reviewed
Mar 21, 2025
| - `endTime: DateTime?`: Like `startTime`, but when the video recording stopped. Due to cutting, recording pauses and etc, the `duration` is not necessarily `end - start`. | ||
| - `duration: Milliseconds` 🟦: duration of the event. As specified in ["assets"](./assets), this needs to always match the duration of all non-internal tracks. | ||
| - `updated: Timestamp` 🟦: Timestamp of when anything about this event was last changed. | ||
| - `created: Timestamp` 🟦: Timestamp of when the event was created in Opencast. It is set once when the event is first stored in Opencast's DB, and never changed again. This also implies that scheduled event's `created` date is when the scheduling took place, _not_ the time it is scheduled for (that would be `startDate`) |
There was a problem hiding this comment.
available: DateTimeRange : publication period when the event is visible to intended audience. Can be unset or open-ended.
Maybe this should be specific to each publication?
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This discussion PR is for only event metadata.
To add new comments, go into the "files changed" tab and comment on individual lines or sections of lines. Or you can comment on existing discussion threads here. If you feel like you want to start a discussion about a broader topic (than something mainly referencing a few lines), consider open a new discussion here.