From 0ed14069b84b16044ead6d207ce069ea85bad36e Mon Sep 17 00:00:00 2001 From: Emily Lynema Date: Wed, 18 Dec 2024 17:16:40 -0500 Subject: [PATCH 1/4] Update 0219 Using Caption Files with Video Content - add proposed provides property and remove references to subtitles --- recipe/0219-using-caption-file/index.md | 17 +++++++++-------- recipe/0219-using-caption-file/manifest.json | 1 + 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/recipe/0219-using-caption-file/index.md b/recipe/0219-using-caption-file/index.md index f8f9ed393..b036650a7 100644 --- a/recipe/0219-using-caption-file/index.md +++ b/recipe/0219-using-caption-file/index.md @@ -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 @@ -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]. @@ -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" %} @@ -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] - [Serving HLS Files][0257] diff --git a/recipe/0219-using-caption-file/manifest.json b/recipe/0219-using-caption-file/manifest.json index 548a05c41..485211c39 100644 --- a/recipe/0219-using-caption-file/manifest.json +++ b/recipe/0219-using-caption-file/manifest.json @@ -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", From 8faf9a38c0601f54d87e691d80db61b1c9af8333 Mon Sep 17 00:00:00 2001 From: Emily Lynema Date: Mon, 10 Feb 2025 17:44:02 -0500 Subject: [PATCH 2/4] update typo referring to format property --- recipe/0219-using-caption-file/index.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/recipe/0219-using-caption-file/index.md b/recipe/0219-using-caption-file/index.md index b036650a7..ae72e37f5 100644 --- a/recipe/0219-using-caption-file/index.md +++ b/recipe/0219-using-caption-file/index.md @@ -21,8 +21,7 @@ Captions may be available for your video content and you may want to enable them 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 `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. - +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 `format` property of the Annotation can also be used to verify that the file is in an appropriate format. 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]. @@ -31,8 +30,6 @@ While captions, subtitles, and transcripts each present some text interpretation Formats other than [WebVTT](https://w3c.github.io/webvtt/) (Web Video Text Tracks) are supported in IIIF, but may not be as widely supported in viewers. -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 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. From f405ac519a1a22b1b41f19803644301d316482ea Mon Sep 17 00:00:00 2001 From: Emily Lynema Date: Mon, 10 Feb 2025 17:50:38 -0500 Subject: [PATCH 3/4] Update links.md --- _includes/links.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/links.md b/_includes/links.md index 0f7620a31..7460ccb2b 100644 --- a/_includes/links.md +++ b/_includes/links.md @@ -52,7 +52,7 @@ [0154]: {{ site.cookbook_url | absolute_url }}/recipe/0154-geo-extension/ "Locate a Manifest on a Web Map" [0232]: {{ site.cookbook_url | absolute_url }}/recipe/0232-image-thumbnail-canvas/ "Implementation discussion: Thumbnails on Canvases" -[0219]: {{ site.cookbook_url | absolute_url }}/recipe/0219-using-caption-file/ "Using Caption and Subtitle Files with Video Content" +[0219]: {{ site.cookbook_url | absolute_url }}/recipe/0219-using-caption-file/ "Using Caption Files with Video Content" [0230]: {{ site.cookbook_url | absolute_url }}/recipe/0230-navdate/ "Navigation by Chronology" [0231]: {{ site.cookbook_url | absolute_url }}/recipe/0231-transcript-meta-recipe/ "Transcripts, Captions, and Subtitles - General Considerations" From e85c61dcc88c0cb8751b530ccbb88c279748a5c1 Mon Sep 17 00:00:00 2001 From: Emily Lynema Date: Tue, 18 Feb 2025 12:28:26 -0500 Subject: [PATCH 4/4] updating list of related recipes --- recipe/0219-using-caption-file/index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/recipe/0219-using-caption-file/index.md b/recipe/0219-using-caption-file/index.md index ae72e37f5..22e4627d1 100644 --- a/recipe/0219-using-caption-file/index.md +++ b/recipe/0219-using-caption-file/index.md @@ -40,12 +40,11 @@ In this example we use a caption file in the WebVTT format, but other options in # Related recipes -- [Simplest Manifest - Video][0003] +- [Using Transcript Files with Video and Audio Content][0253] - [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] - [Using Annotations for Timed Text][0079] -- [Serving HLS Files][0257] +- [Providing Access to Transcripts of A/V Content][0017] +- [Annotating a Poetry Reading][0103] {% include acronyms.md %} {% include links.md %}