Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add docs on captioning in video

...

The DSpace UI comes with a basic, out-of-the-box Media Viewer (disabled by default).  You can choose to enable it for This media viewer can support any files which have a MIME Type that begins with either "image/*" or , "video/*" MIME types, or both"audio/*".

Code Block
languageyml
titleFormat for 7.2 or later (config.*.yml)
# Whether to enable media viewer for image and/or video Bitstreams (i.e. Bitstreams whose MIME type starts with 'image' or 'video').
# When For images"image: true", this enables a gallery viewer where you can zoom or page through images.
# For videosWhen "video: true", this enables embedded video streaming.  This embedded video streamer also supports audio files.
mediaViewer:
  image: false
  video: false

As of 7.5 (or later), the Video viewer also supports WebVTT (or VTT) Captioning.  Video captioning requires that a WebVTT Caption file (.vtt) be uploaded into the DSpace Item (DSpace is not able to create or generate these .vtt files).  Here's an example of how to setup captioning:

  • The Item must already have a Bitstream which is a video file (in a "video/*" format) in the ORIGINAL bundle.  In this example, we'll assume it is named "myVideo.mp4"
  • Upload a corresponding WebVTT Caption file named "[video-filename]-[languageCode].vtt" to the ORIGINAL bundle. 
    • For a video named "myVideo.mp4", an English caption file would be named "myVideo.mp4-en.vtt". 
    • If an additional Spanish language caption file was uploaded, it should be named "myVideo.mp4-es.vtt".
    • All WebVTT Caption files MUST use two-letter ISO 639-1 Language Codes.  A list of all supported Language Codes can be found in "src/app/item-page/media-viewer/media-viewer-video/language-helper.ts"
  • Once the Caption file is uploaded, reload the video viewer (on the Item page). You should now see the "Captions" (or CC) option is now available. (Depending on the browser you use, this option may appear in the lower menu of the video, or require you to open an options menu.)  Selecting it will enable captioning in your language of choice.


Code Block
titleFormat for 7.1 or 7.0 (environment.*.ts)
// Whether to enable media viewer for image and/or video Bitstreams (i.e. Bitstreams whose MIME type starts with "image" or "video").
// For images, this enables a gallery viewer where you can zoom or page through images.
// For videos, this enables embedded video streaming
mediaViewer: {
  image: false,
  video: false,
},

...