Captionator

[Cheetham, Anastasia]

On 2012-02-16, at 2:42 AM, Antranig Basman wrote:

> I have a suggestion that both "video" and "captions" structures (except for "currentTrack", etc.) be moved out of the model area of this component's options to top level, since they are "not ordinarily modifiable" during the lifetime of the component.

This makes a lot of sense to me.

> That change being done I'm happy we can push, but thought we should have a final check for any objections since it is a significant API change to the component

This is a pretty wide-reaching change. Might it be wise to do it under its own JIRA?

> we considered that returning the  captions.sources option to being an array to match video.sources was a sound idea

I think that converting the list of captions into an array makes sense (I've done so in my refactoring of the captions menu code), but I just want to double-check my understanding of how this works: The array of captions doesn't actually "match" the array of videos, right? There isn't any correlation between the list of videos and the list of captions: You could have a single video with several captions, or several video sources, but only one caption. And we'll also have transcripts, audio descriptions, etc. I'm just checking that there's not something I'm missing…

So assuming I'm understanding correctly, we're proposing that the Video Player accept two new options: an array of video source objects and an array of caption specification. The model will be reduced to mostly what's currently in a "states" object plus some of what was in the captions part of the model.

For example:

    var vp = fluid.videoPlayer(".videoPlayer", {
        videos: [{
            src: "ReorganizeFuture.mp4",
            type: "video/mp4"
        },
        {
            src: "ReorganizeFuture.webm",
            type: "video/webm"
    
        }],
        captions: [{
            src: "ReorganizeFuture.en.vtt",
            type: "text/vtt",
            srclang: "en",
            label: "English Subtitles",
            kind: "subtitles"
        },
        {
            src: "ReorganizeFuture.fr.vtt",
            type: "text/vtt",
            srclang: "fr",
            label: "French Subtitles",
            kind: "subtitles"
        }],
        model: {
            currentTrack: 0  // 0-based index into captions array
            fullscreen: true,
            volume: 60
        },
        controls: "custom",
        etc...
    });

Does this look like what people are thinking?

-- 
Anastasia Cheetham     Inclusive Design Research Centre
acheetham at ocadu.ca           Inclusive Design Institute
                                        OCAD University