elemental.html.TrackElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-elemental Show documentation
There is a newer version: 2.9.0
/*
 * Copyright 2012 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package elemental.html;
import elemental.dom.Element;

import elemental.events.*;
import elemental.util.*;
import elemental.dom.*;
import elemental.html.*;
import elemental.css.*;
import elemental.stylesheets.*;

import java.util.Date;

/**
  * The track element is used as a child of the media elements—<audio>
 and <video>
—and does not represent anything on its own. It lets you specify timed text tracks (or time-based data).
The type of data that  track adds to the media is set in the kind attribute, which can take values of subtitles, captions, descriptions, chapters or metadata. The element points to a source file containing timed text that the browser exposes when the user requests additional data. 
  */
public interface TrackElement extends Element {

    static final int ERROR = 3;

    static final int LOADED = 2;

    static final int LOADING = 1;

    static final int NONE = 0;


  /**
    * This attribute indicates that the track should be enabled unless the user's preferences indicate that another track is more appropriate. This may only be used on one track element per media element.
    */
  boolean isDefaultValue();

  void setDefaultValue(boolean arg);


  /**
    * Kind of text track. The following keywords are allowed:  subtitles: A transcription or translation of the dialogue.
 captions: A transcription or translation of the dialogue or other sound effects. Suitable for users who are deaf or when the sound is muted.
 descriptions: Textual descriptions of the video content. Suitable for users who are blind.
 chapters: Chapter titles, intended to be used when the user is navigating the media resource.
 metadata: Tracks used by script. Not visible to the user.
 
    */
  String getKind();

  void setKind(String arg);


  /**
    * A user-readable title of the text track Used by the browser when listing available text tracks.
    */
  String getLabel();

  void setLabel(String arg);

  int getReadyState();


  /**
    * Address of the track. Must be a valid URL. This attribute must be defined.
    */
  String getSrc();

  void setSrc(String arg);


  /**
    * Language of the track text data.
    */
  String getSrclang();

  void setSrclang(String arg);

  TextTrack getTrack();
}