#include <vtt_cue.h>

Public Member Functions
	VTTCue (double start_time, double end_time, const std::string &text)

	VTTCue (const VTTCue &cue)

	VTTCue (VTTCue &&cue)

	~VTTCue ()

VTTCue &	operator= (const VTTCue &cue)

VTTCue &	operator= (VTTCue &&cue)

TextTrackCue
std::string	id () const

void	SetId (const std::string &id)

double	start_time () const

void	SetStartTime (double time)

double	end_time () const

void	SetEndTime (double time)

bool	pause_on_exit () const

void	SetPauseOnExit (bool pause)

VTTCue
DirectionSetting	vertical () const

void	SetVertical (DirectionSetting setting)

bool	snap_to_lines () const

void	SetSnapToLines (bool snap)

LineAlignSetting	line_align () const

void	SetLineAlign (LineAlignSetting align)

double	line () const

void	SetLine (double line)

double	position () const

void	SetPosition (double position)

PositionAlignSetting	position_align () const

void	SetPositionAlign (PositionAlignSetting align)

double	size () const

void	SetSize (double size)

AlignSetting	align () const

void	SetAlign (AlignSetting align)

std::string	text () const

void	SetText (const std::string &text)

Detailed Description

This defines a text cue that is used for subtitles or closed-captioning. This type is internally thread-safe.

See also: https://w3c.github.io/webvtt/#the-vttcue-interface

Definition at line 147 of file vtt_cue.h.

Constructor & Destructor Documentation

§ VTTCue() [1/3]

shaka::media::VTTCue::VTTCue	(	double	start_time,
		double	end_time,
		const std::string &	text
	)

Definition at line 22 of file vtt_cue_public.cc.

§ VTTCue() [2/3]

shaka::media::VTTCue::VTTCue ( const VTTCue & cue )

Definition at line 36 of file vtt_cue_public.cc.

§ VTTCue() [3/3]

shaka::media::VTTCue::VTTCue ( VTTCue && cue )

Definition at line 51 of file vtt_cue_public.cc.

§ ~VTTCue()

shaka::media::VTTCue::~VTTCue ( )

Definition at line 27 of file vtt_cue.cc.

Member Function Documentation

§ align()

AlignSetting shaka::media::VTTCue::align ( ) const

Returns: The align setting of the Cue.

Definition at line 200 of file vtt_cue_public.cc.

§ end_time()

double shaka::media::VTTCue::end_time ( ) const

Returns: The end time the Cue should be rendered at.

Definition at line 110 of file vtt_cue_public.cc.

§ id()

std::string shaka::media::VTTCue::id ( ) const

Returns: The ID of the cue.

Definition at line 90 of file vtt_cue_public.cc.

§ line()

double shaka::media::VTTCue::line ( ) const

Returns: The Cue's line value, or NAN if using 'auto'.

Definition at line 160 of file vtt_cue_public.cc.

§ line_align()

LineAlignSetting shaka::media::VTTCue::line_align ( ) const

Returns: The Cue's line align setting.

Definition at line 150 of file vtt_cue_public.cc.

§ operator=() [1/2]

VTTCue & shaka::media::VTTCue::operator= ( const VTTCue & cue )

Definition at line 68 of file vtt_cue_public.cc.

§ operator=() [2/2]

VTTCue & shaka::media::VTTCue::operator= ( VTTCue && cue )

Definition at line 73 of file vtt_cue_public.cc.

§ pause_on_exit()

bool shaka::media::VTTCue::pause_on_exit ( ) const

Returns: Whether the media should pause when the cue stops rendering.

Definition at line 120 of file vtt_cue_public.cc.

§ position()

double shaka::media::VTTCue::position ( ) const

Returns: The Cue's position value, or NAN if using 'auto'.

Definition at line 170 of file vtt_cue_public.cc.

§ position_align()

PositionAlignSetting shaka::media::VTTCue::position_align ( ) const

Returns: The Cue's position align setting.

Definition at line 180 of file vtt_cue_public.cc.

§ SetAlign()

void shaka::media::VTTCue::SetAlign ( AlignSetting align )

Sets the align setting of the Cue.

Definition at line 205 of file vtt_cue_public.cc.

§ SetEndTime()

void shaka::media::VTTCue::SetEndTime ( double time )

Sets the end time the Cue should be rendered at.

Definition at line 115 of file vtt_cue_public.cc.

§ SetId()

void shaka::media::VTTCue::SetId ( const std::string & id )

Sets the ID of the cue to the given value.

Definition at line 95 of file vtt_cue_public.cc.

§ SetLine()

void shaka::media::VTTCue::SetLine ( double line )

Sets the Cue's line value, use NAN to signal 'auto'.

Definition at line 165 of file vtt_cue_public.cc.

§ SetLineAlign()

void shaka::media::VTTCue::SetLineAlign ( LineAlignSetting align )

Sets the Cue's line align setting.

Definition at line 155 of file vtt_cue_public.cc.

§ SetPauseOnExit()

void shaka::media::VTTCue::SetPauseOnExit ( bool pause )

Sets whether the media should pause when the cue stops rendering.

Definition at line 125 of file vtt_cue_public.cc.

§ SetPosition()

void shaka::media::VTTCue::SetPosition ( double position )

Sets the Cue's position value, use NAN to signal 'auto'.

Definition at line 175 of file vtt_cue_public.cc.

§ SetPositionAlign()

void shaka::media::VTTCue::SetPositionAlign ( PositionAlignSetting align )

Sets the Cue's position align setting.

Definition at line 185 of file vtt_cue_public.cc.

§ SetSize()

void shaka::media::VTTCue::SetSize ( double size )

Sets the Cue's size.

Definition at line 195 of file vtt_cue_public.cc.

§ SetSnapToLines()

void shaka::media::VTTCue::SetSnapToLines ( bool snap )

Sets whether the Cue snaps to lines.

Definition at line 145 of file vtt_cue_public.cc.

§ SetStartTime()

void shaka::media::VTTCue::SetStartTime ( double time )

Sets the start time the Cue should be rendered at.

Definition at line 105 of file vtt_cue_public.cc.

§ SetText()

void shaka::media::VTTCue::SetText ( const std::string & text )

Sets the text body of the cue.

Definition at line 215 of file vtt_cue_public.cc.

§ SetVertical()

void shaka::media::VTTCue::SetVertical ( DirectionSetting setting )

Sets the Cue's vertical direction setting.

Definition at line 135 of file vtt_cue_public.cc.

§ size()

double shaka::media::VTTCue::size ( ) const

Returns: The Cue's size.

Definition at line 190 of file vtt_cue_public.cc.

§ snap_to_lines()

bool shaka::media::VTTCue::snap_to_lines ( ) const

Returns: Whether the Cue snaps to lines.

Definition at line 140 of file vtt_cue_public.cc.

§ start_time()

double shaka::media::VTTCue::start_time ( ) const

Returns: The start time the Cue should be rendered at.

Definition at line 100 of file vtt_cue_public.cc.

§ text()

std::string shaka::media::VTTCue::text ( ) const

Returns: The text body of the Cue.

Definition at line 210 of file vtt_cue_public.cc.

§ vertical()

DirectionSetting shaka::media::VTTCue::vertical ( ) const

Returns: The Cue's vertical direction setting.

Definition at line 130 of file vtt_cue_public.cc.

The documentation for this class was generated from the following files:

shaka/include/shaka/media/vtt_cue.h
shaka/src/js/vtt_cue.cc
shaka/src/media/vtt_cue_public.cc

Public Member Functions