org.wicketstuff.html5.media.webvtt

Class VttRegion

java.lang.Object

org.wicketstuff.html5.media.webvtt.VttRegion

public class VttRegion
extends Object

The region to be applied to a cue.

Further information:
https://dvcs.w3.org/hg/text-tracks/raw-file/default/608toVTT/region.html

Author:

Tobias Soloschenko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VttRegion.Scroll

Constructor Summary

Constructors

Constructor and Description
VttRegion(String id, String width, int lines, String regionAnchor, String viewportAnchor, VttRegion.Scroll scroll) Creates a region based on the required arguments

Method Summary

Methods

Modifier and Type	Method and Description
String	getId()
int	getLines()
String	getRegionAnchor()
StringBuilder	getRepresentation() Gets the representation as StringBuilder
VttRegion.Scroll	getScroll()
String	getViewportAnchor()
String	getWidth()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VttRegion

public VttRegion(String id,
         String width,
         int lines,
         String regionAnchor,
         String viewportAnchor,
         VttRegion.Scroll scroll)

Creates a region based on the required arguments

Parameters:

id - the id of the region

width - A number giving the width of the box within which the text of each line of the containing cues is to be rendered, to be interpreted as a percentage of the video width. Defaults to 100.

lines - A number giving the number of lines of the box within which the text of each line of the containing cues is to be rendered. Defaults to 3.

regionAnchor - Two numbers giving the x and y coordinates within the region which is anchored to the video viewport and does not change location even when the region does, e.g. because of font size changes. Defaults to (0,100), i.e. the bottom left corner of the region.

viewportAnchor - Two numbers giving the x and y coordinates within the video viewport to which the region anchor point is anchored. Defaults to (0,100), i.e. the bottom left corner of the viewport.

scroll - none: Indicates that the cues in the region are not to scroll and instead stay fixed at the location they were first painted in. up Indicates that the cues in the region will be added at the bottom of the region and push any already displayed cues in the region up until all lines of the new cue are visible in the region.

Method Detail

getId

public String getId()

getWidth

public String getWidth()

getLines

public int getLines()

getRegionAnchor

public String getRegionAnchor()

getViewportAnchor

public String getViewportAnchor()

getScroll

public VttRegion.Scroll getScroll()

getRepresentation

public StringBuilder getRepresentation()

Gets the representation as StringBuilder

Returns:

the representation as StringBuilder