TextSubtitles Class Reference

#include <textsubtitleparser.h>

Detailed Description

Definition at line 39 of file textsubtitleparser.h.


Public Member Functions
	TextSubtitles ()
virtual	~TextSubtitles ()
bool	HasSubtitleChanged (uint64_t timecode) const
	Returns true in case the subtitle to display has changed since the last GetSubtitles() call.
QStringList	GetSubtitles (uint64_t timecode) const
	Returns the subtitles to display at the given timecode.
bool	IsFrameBasedTiming (void) const
	Returns true in case the subtitle timing data is frame-based.
void	SetFrameBasedTiming (bool frameBasedTiming)
void	AddSubtitle (const text_subtitle_t &newSub)
void	Clear (void)
uint	GetSubtitleCount (void) const
Private Attributes
TextSubtitleList	m_subtitles
text_subtitle_t	m_lastReturnedSubtitle
bool	m_frameBasedTiming

Constructor & Destructor Documentation

TextSubtitles::TextSubtitles ( ) [inline]

Definition at line 42 of file textsubtitleparser.h.

virtual TextSubtitles::~TextSubtitles ( ) [inline, virtual]

Definition at line 44 of file textsubtitleparser.h.

Member Function Documentation

bool TextSubtitles::HasSubtitleChanged ( uint64_t timecode ) const

Returns true in case the subtitle to display has changed since the last GetSubtitles() call.

This is used to avoid redisplaying subtitles that are already displaying.

Parameters:

timecode

The timecode (frame number or time stamp) of the current video position.

Returns:: True in case new subtitles should be displayed.

Definition at line 33 of file textsubtitleparser.cpp.

Referenced by NuppelVideoPlayer::DisplayTextSubtitles().

QStringList TextSubtitles::GetSubtitles ( uint64_t timecode ) const

Returns the subtitles to display at the given timecode.

Parameters:

timecode

The timecode (frame number or time stamp) of the current video position.

Returns:: The subtitles as a list of strings.

Definition at line 46 of file textsubtitleparser.cpp.

Referenced by NuppelVideoPlayer::DisplayTextSubtitles().

TextSubtitles::IsFrameBasedTiming ( void ) const [inline]

Returns true in case the subtitle timing data is frame-based.

If the timing is frame-based, the client should use frame counts as timecodes for the HasSubtitleChanged() and GetSubtitles() methods, otherwise the timecode is milliseconds from the video start.

Definition at line 56 of file textsubtitleparser.h.

Referenced by NuppelVideoPlayer::DisplayTextSubtitles(), and TextSubtitleParser::LoadSubtitles().

void TextSubtitles::SetFrameBasedTiming ( bool frameBasedTiming ) [inline]