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

#include <DVDSubtitleStream.h>

Public Member Functions

 CDVDSubtitleStream ()
 
virtual ~CDVDSubtitleStream ()
 
bool Open (const std::string &strFile)
 
bool IsIncompatible (CDVDInputStream *pInputStream, std::vector< uint8_t > &buf, size_t *bytesRead)
 Checks if the subtitle associated with the pInputStream is known to be incompatible, e.g., vob sub files.
 
std::string Read (int length)
 Read some data of specified length, from the current position.
 
bool Seek (int offset)
 Change the current data position to the specified offset.
 
bool ReadLine (std::string &line)
 Read a line of data.
 
const std::string & GetData ()
 Get the full data.
 

Constructor & Destructor Documentation

◆ CDVDSubtitleStream()

CDVDSubtitleStream::CDVDSubtitleStream ( )
default

◆ ~CDVDSubtitleStream()

CDVDSubtitleStream::~CDVDSubtitleStream ( )
virtualdefault

Member Function Documentation

◆ GetData()

const std::string & CDVDSubtitleStream::GetData ( )
inline

Get the full data.

Returns
The data

◆ IsIncompatible()

bool CDVDSubtitleStream::IsIncompatible ( CDVDInputStream * pInputStream,
std::vector< uint8_t > & buf,
size_t * bytesRead )

Checks if the subtitle associated with the pInputStream is known to be incompatible, e.g., vob sub files.

Parameters
[in]pInputStreamThe input stream for the subtitle to check.

◆ Open()

bool CDVDSubtitleStream::Open ( const std::string & strFile)

◆ Read()

std::string CDVDSubtitleStream::Read ( int length)

Read some data of specified length, from the current position.

Parameters
lengthThe length of data to be read
Returns
The string read

◆ ReadLine()

bool CDVDSubtitleStream::ReadLine ( std::string & line)

Read a line of data.

Parameters
[OUT]line The data read
Returns
True if read, otherwise false if EOF

◆ Seek()

bool CDVDSubtitleStream::Seek ( int offset)

Change the current data position to the specified offset.

Parameters
offsetThe new position
Returns
True if success, otherwise false

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