Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0219 - add proposed provides property and remove subtitles #570

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

0219 - add proposed provides property and remove subtitles #570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions recipe/0219-using-caption-file/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Using Caption and Subtitle Files with Video Content
title: Using Caption Files with Video Content
id: 219
layout: recipe
tags: [video, caption, subtitle, presentation]
summary: "Providing a caption or subtitle file to a video resource."
summary: "Providing a caption file to a video resource."
viewers:
- Clover
- Ramp
Expand All @@ -15,15 +15,15 @@ topic: AV

## Use Case

Captions and subtitles may be available for your video content and you may want to enable them for your IIIF video resources.
Captions may be available for your video content and you may want to enable them for your IIIF video resources.

## Implementation notes

Caption and subtitle file formats are used to mark up the external text track resources in connection with the HTML track element of a video file. The markup file formats use time tags that allow for time alignment of the video content with the captions or subtitles.
Caption file formats are used to mark up the external text track resources in connection with the HTML track element of a video file. The markup file formats use time tags that allow for time alignment of the video content with the captions.

Offering the caption file as an Annotation on the Canvas that contains the media file itself enables us to express the relationship between the two. The `type` and `format` properties of the Annotation can be used by the client to identify files in a format supported by the media player for captions. The `motivation` value of `supplementing` indicates the fact that processing this Annotation is optional.
Offering the caption file as an Annotation on the Canvas that contains the media file itself enables us to express the relationship between the two. The `provides` property of the Annotation can be used by the client to identify caption files in a format that should be supported by the media player. The `type` property of the Annotation can also be used to verify that the file is in an appropriate format. The `motivation` value of `supplementing` indicates the fact that processing this Annotation is optional.

In addition to this implementation, one should consider offering the captions or subtitles as multiple timed annotations, making the text available in multiple ways. See [Using Annotations for Timed Text][0079].
In addition to this implementation, one can also offer captions as multiple timed annotations, making the text available in multiple ways. See [Using Annotations for Timed Text][0079].

While captions, subtitles, and transcripts each present some text interpretation of the A/V content, the ways in which they are consumed by users differ. For a more detailed discussion about these differences see [Transcripts, Captions, and Subtitles - General Considerations][0231].
Copy link

Choose a reason for hiding this comment

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

Would we want to address commenting here as well? Maybe link to that recipe?


Expand All @@ -35,7 +35,7 @@ When using segmented WebVTT with HLS, see [Serving HLS Files][0257].

## Example

In this example we use a caption file in the WebVTT format, but other options include a subtitle file in the [SRT](https://en.wikipedia.org/wiki/SubRip) (SubRip Text) or [TTML](https://w3c.github.io/ttml3/index.html) (Timed Text Markup Language) formats, or other text-based format used for the same purpose.
In this example we use a caption file in the WebVTT format, but other options include a caption file in the [SRT](https://en.wikipedia.org/wiki/SubRip) (SubRip Text) or [TTML](https://w3c.github.io/ttml3/index.html) (Timed Text Markup Language) formats, or other text-based format used for the same purpose.

{% include manifest_links.html viewers="Clover, Ramp, Aviary, Theseus" manifest="manifest.json" %}

Expand All @@ -44,8 +44,9 @@ In this example we use a caption file in the WebVTT format, but other options in
# Related recipes

- [Simplest Manifest - Video][0003]
- [Using Caption and Subtitle Files in Multiple Languages with Video Content][0074]
- [A Side-by-side Transcript of a Video Recording][0253]
- [Providing Access to Transcripts of A/V Content][0017]
- [Providing Alternative Representations][0046]
- [Using Annotations for Timed Text][0079]
Copy link

Choose a reason for hiding this comment

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

Any idea why this link isn't working on the preview site?

- [Serving HLS Files][0257]

Expand Down
1 change: 1 addition & 0 deletions recipe/0219-using-caption-file/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"id": "{{ id.path }}/canvas/page2/a1",
"type": "Annotation",
"motivation": "supplementing",
"provides": ["closedCaptions"],
"body": {
"id": "https://fixtures.iiif.io/video/indiana/lunchroom_manners/lunchroom_manners.vtt",
"type": "Text",
Expand Down
Loading