Package com.github.bordertech.wcomponents

Enum Track.Kind

java.lang.Object

java.lang.Enum<Track.Kind>

com.github.bordertech.wcomponents.Track.Kind

All Implemented Interfaces:

Serializable, Comparable<Track.Kind>

Enclosing interface:

Track

public static enum Track.Kind
extends Enum<Track.Kind>

Describes the kind of track. This is used by the client to determine how the track should be handled.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CAPTIONS	Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information, suitable for when sound is unavailable or not clearly audible (e.g. because it is muted, drowned-out by ambient noise, or because the user is deaf).
CHAPTERS	Chapter titles, intended to be used for navigating the media resource.
DESCRIPTIONS	Textual descriptions of the video component of the media resource, intended for audio synthesis when the visual component is obscured, unavailable, or not usable (e.g. because the user is interacting with the application without a screen while driving, or because the user is blind).
METADATA	Tracks intended for use from script.
SUBTITLES	Transcription or translation of the dialogue, suitable for when the sound is available but not understood (e.g. because the user does not understand the language of the media resource's audio track).

Method Summary

Modifier and Type	Method	Description
static Track.Kind	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Track.Kind[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUBTITLES

public static final Track.Kind SUBTITLES

Transcription or translation of the dialogue, suitable for when the sound is available but not understood (e.g. because the user does not understand the language of the media resource's audio track). Overlaid on the video.

CAPTIONS

public static final Track.Kind CAPTIONS

Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information, suitable for when sound is unavailable or not clearly audible (e.g. because it is muted, drowned-out by ambient noise, or because the user is deaf). Overlaid on the video; labeled as appropriate for the hard-of-hearing.

DESCRIPTIONS

public static final Track.Kind DESCRIPTIONS

Textual descriptions of the video component of the media resource, intended for audio synthesis when the visual component is obscured, unavailable, or not usable (e.g. because the user is interacting with the application without a screen while driving, or because the user is blind). Synthesized as audio.

CHAPTERS

public static final Track.Kind CHAPTERS

Chapter titles, intended to be used for navigating the media resource. Displayed as an interactive (potentially nested) list in the user agent's interface.

METADATA

public static final Track.Kind METADATA

Tracks intended for use from script. Not displayed by the user agent.

Method Detail

values

public static Track.Kind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Track.Kind c : Track.Kind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Track.Kind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null