RDK Documentation (Open Sourced RDK Components)
Public Member Functions | Protected Attributes
WebVTTParser Class Reference

WebVTT parser class. More...

#include <webvttParser.h>

Inheritance diagram for WebVTTParser:
Inheritance graph
Collaboration diagram for WebVTTParser:
Collaboration graph

Public Member Functions

 WebVTTParser (AampLogManager *logObj, PrivateInstanceAAMP *aamp, SubtitleMimeType type)
 
virtual bool init (double startPosSeconds, unsigned long long basePTS)
 
virtual bool processData (char *buffer, size_t bufferLen, double position, double duration)
 
virtual bool close ()
 
virtual void reset ()
 
virtual void setProgressEventOffset (double offset)
 
virtual void addCueData (VTTCue *cue)
 
virtual void sendCueData ()
 
virtual void updateTimestamp (unsigned long long positionMs)
 
- Public Member Functions inherited from SubtitleParser
 SubtitleParser (AampLogManager *logObj, PrivateInstanceAAMP *aamp, SubtitleMimeType type)
 
 SubtitleParser (const SubtitleParser &)=delete
 Copy Constructor.
 
SubtitleParser & operator= (const SubtitleParser &)=delete
 Assignment operator Overloading.
 
virtual void pause (bool pause)
 
virtual void mute (bool mute)
 
virtual void isLinear (bool isLinear)
 
virtual void setTextStyle (const std::string &options)
 

Protected Attributes

unsigned long long mStartPTS
 
unsigned long long mPtsOffset
 
double mStartPos
 
double mCurrentPos
 
bool mReset
 
CueTimeStamp lastCue
 
std::queue< VTTCue * > mVttQueue
 
guint mVttQueueIdleTaskId
 
pthread_mutex_t mVttQueueMutex
 
double mProgressOffset
 
- Protected Attributes inherited from SubtitleParser
SubtitleMimeType mType
 
PrivateInstanceAAMP * mAamp
 
AampLogManager * mLogObj
 

yes

WebVTT parser class.

Class for WebVTT parser implementation in AAMP

Definition at line 56 of file webvttParser.h.

Field Documentation

◆ mStartPTS

unsigned long long WebVTTParser::mStartPTS
protected

start/base PTS for current period

Definition at line 74 of file webvttParser.h.

◆ mPtsOffset

unsigned long long WebVTTParser::mPtsOffset
protected

offset between cue local time and MPEG time

Definition at line 75 of file webvttParser.h.

◆ mStartPos

double WebVTTParser::mStartPos
protected

position of first fragment in playlist

Definition at line 76 of file webvttParser.h.

◆ mCurrentPos

double WebVTTParser::mCurrentPos
protected

current fragment position in playlist

Definition at line 77 of file webvttParser.h.

◆ mReset

bool WebVTTParser::mReset
protected

true if waiting for first fragment after processing a discontinuity or at start

Definition at line 78 of file webvttParser.h.

◆ lastCue

CueTimeStamp WebVTTParser::lastCue
protected

holds timestamp of last parsed cue

Definition at line 80 of file webvttParser.h.

◆ mVttQueue

std::queue<VTTCue*> WebVTTParser::mVttQueue
protected

queue for storing parsed cues

Definition at line 82 of file webvttParser.h.

◆ mVttQueueIdleTaskId

guint WebVTTParser::mVttQueueIdleTaskId
protected

task id for handler that sends cues upstream

Definition at line 83 of file webvttParser.h.

◆ mVttQueueMutex

pthread_mutex_t WebVTTParser::mVttQueueMutex
protected

mutex for synchronising queue access

Definition at line 84 of file webvttParser.h.

◆ mProgressOffset

double WebVTTParser::mProgressOffset
protected

offset value in progress event compared to playlist position

Definition at line 85 of file webvttParser.h.

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