core/html/track/vtt/VTTCue.idl

/*
 * Copyright (c) 2013, Opera Software ASA. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of Opera Software ASA nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

// http://dev.w3.org/html5/webvtt/#the-vttcue-interface

enum AutoKeyword { "auto" };
enum DirectionSetting { "" /* horizontal */, "rl", "lr" };
// enum LineAlignSetting { "start", "middle", "end" };
// enum PositionAlignSetting { "start", "middle", "end", "auto" };
enum AlignSetting { "start", "middle", "end", "left", "right" };

[
    Constructor(double startTime, double endTime, DOMString text),
    ConstructorCallWith=Document,
    SetWrapperReferenceFrom=owner,
] interface VTTCue : TextTrackCue {
    // TODO(philipj): regionId has been replaced by a region attribute.
    [RuntimeEnabled=WebVTTRegions] attribute DOMString regionId;
    attribute DirectionSetting vertical;
    attribute boolean snapToLines;
    attribute (double or AutoKeyword) line;
    // attribute LineAlignSetting lineAlign;
    [RaisesException=Setter] attribute (double or AutoKeyword) position;
    // attribute PositionAlignSetting positionAlign;
    [RaisesException=Setter] attribute double size;
    attribute AlignSetting align;
    attribute DOMString text;
    DocumentFragment getCueAsHTML();
};