Package com.brightcove.player.model

Class CaptionsDocument

java.lang.Object

com.brightcove.player.model.CaptionsDocument

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TTMLDocument, WebVTTDocument

public class CaptionsDocument
extends Object
implements Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<BrightcoveClosedCaption>	captions
protected Map<String,Region>	regions

Constructor Summary

Constructors

Constructor	Description
CaptionsDocument()

Method Summary

Modifier and Type	Method	Description
List<BrightcoveClosedCaption>	getCaptions()	Retrieves the List of BrightcoveClosedCaption objects for this document.
Map<String,Region>	getRegions()	Retrieves a Map of the Region objects in this document, keyed by their names.

Methods inherited from class java.lang.Object

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

Field Details

regions

protected Map<String,Region> regions

captions

protected List<BrightcoveClosedCaption> captions

Constructor Details

CaptionsDocument

public CaptionsDocument()

Method Details

getRegions

public Map<String,Region> getRegions()

Retrieves a Map of the Region objects in this document, keyed by their names.

Returns:

the region map

getCaptions

public List<BrightcoveClosedCaption> getCaptions()

Retrieves the List of BrightcoveClosedCaption objects for this document.

Returns:

the caption list