Caption plugin

This plugin is used to display some text over the video. It is typically used for subtitles. See the metadata section for textual informations representation in our generic format.

These are the specific options for configuring plugin behavior:

Options Type Description
metadataId String Metadata block id to bind to
level String which tclevel of textual metadata will be displayed.

Example

$("#myplayer-caption").mediaPlayer({
    src : "samples-data/examples/vid/amalia01.mp4",
    plugins : {
        dataServices : [
            'samples-data/examples/json/amalia01-text.json'
        ],
        list : [
            {
                'className' : 'fr.ina.amalia.player.plugins.CaptionsPlugin',
                'parameters' : {
                    metadataId : 'text-amalia01',
                    level : 1
                }
            }
        ]
    }
});

Documentation

Last updated : 2023-06-29
Institut National de l'Audiovisuel - INA ©2023