Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CWebVTTHandler Class Reference

#include <WebVTTHandler.h>

Inheritance diagram for CWebVTTHandler:
CWebVTTISOHandler

Public Member Functions

 CWebVTTHandler ()
 
 ~CWebVTTHandler ()
 
bool Initialize ()
 Prepare the handler to the decoding.
 
void Reset ()
 
bool CheckSignature (const std::string &data)
 Verify the validity of the WebVTT signature.
 
void InitDecoderCue (double startTime, double endTime)
 To be used when packages dont have the CUE timing string. Initialize the decoder with following CUE timing, after this call the decoder is prepared to read the CUE text area by using DecodeLine method.
 
void DecodeLine (std::string line, std::vector< subtitleData > *subList)
 Decode a line of the WebVTT text data.
 
bool IsForcedMargins () const
 
void SetPeriodStart (double pts)
 

Protected Member Functions

void CalculateTextPosition (std::string &subtitleText)
 
void ConvertSubtitle (std::string &text)
 
void GetCueSettings (std::string &cueSettings)
 

Protected Attributes

subtitleData m_subtitleData
 

Constructor & Destructor Documentation

◆ CWebVTTHandler()

CWebVTTHandler::CWebVTTHandler ( )
inline

◆ ~CWebVTTHandler()

CWebVTTHandler::~CWebVTTHandler ( )
inline

Member Function Documentation

◆ CalculateTextPosition()

void CWebVTTHandler::CalculateTextPosition ( std::string & subtitleText)
protected

◆ CheckSignature()

bool CWebVTTHandler::CheckSignature ( const std::string & data)

Verify the validity of the WebVTT signature.

◆ ConvertSubtitle()

void CWebVTTHandler::ConvertSubtitle ( std::string & text)
protected

◆ DecodeLine()

void CWebVTTHandler::DecodeLine ( std::string line,
std::vector< subtitleData > * subList )

Decode a line of the WebVTT text data.

Parameters
lineThe line to decode
subListThe list to be filled with decoded subtitles

◆ GetCueSettings()

void CWebVTTHandler::GetCueSettings ( std::string & cueSettings)
protected

◆ InitDecoderCue()

void CWebVTTHandler::InitDecoderCue ( double startTime,
double endTime )

To be used when packages dont have the CUE timing string. Initialize the decoder with following CUE timing, after this call the decoder is prepared to read the CUE text area by using DecodeLine method.

Parameters
startTimeThe start time
endTimeThe end time

◆ Initialize()

bool CWebVTTHandler::Initialize ( )

Prepare the handler to the decoding.

◆ IsForcedMargins()

bool CWebVTTHandler::IsForcedMargins ( ) const
inline

◆ Reset()

void CWebVTTHandler::Reset ( )

◆ SetPeriodStart()

void CWebVTTHandler::SetPeriodStart ( double pts)
inline

Member Data Documentation

◆ m_subtitleData

subtitleData CWebVTTHandler::m_subtitleData
protected

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