AJA NTV2 SDK  17.5.0.1658
NTV2 SDK 17.5.0.1658
Public Member Functions | List of all members
SRTCaptionInfo Class Reference

Detailed caption information. More...

#include <ntv2srt.h>

Public Member Functions

 SRTCaptionInfo (const SRTSeqNum inSeqNum=0, const SRTTimestamp inStartTime=0, const SRTDuration inDuration=0, const std::string &inRawCaption=std::string(), const size_t inStartLineNum=0, const size_t inEndLineNum=0)
 
std::string caption (void) const
 
const std::string & rawCaption (void) const
 
SRTSeqNum sequenceNum (void) const
 
SRTTimestamp startTime (void) const
 
SRTDuration duration (void) const
 
SRTTimestamp endTime (void) const
 
const SRTWindow & window (void) const
 
bool hasWindow (void) const
 
uint16_t anchor (void) const
 
bool hasAnchor (void) const
 
bool isValid (void) const
 
bool hasAnchorTag (void) const
 
size_t startLineNumber (void) const
 
size_t endLineNumber (void) const
 
bool hasLineNumbers (void) const
 
size_t startLineOffset (void) const
 
size_t endLineOffset (void) const
 
bool isFirstCaption (void) const
 
bool getCharWithAttrs (const size_t inPos, std::string &outChar, bool &outIsBold, bool &outIsItalic, std::string &outColor) const
 
SRTCaptionInfo & reset (void)
 
SRTCaptionInfo & set (const SRTSeqNum inSeqNum, const SRTTimestamp inStartTime, const SRTDuration inDuration, const std::string &inRawCaption=std::string(), const size_t inStartLineNum=0, const size_t inEndLineNum=0)
 
SRTCaptionInfo & setFirstCaption (const bool inIsFirst=true)
 
SRTCaptionInfo & setWindow (const SRTWindow &inWindow)
 
SRTCaptionInfo & setAnchorPos (const uint16_t inAnchorPos)
 
SRTCaptionInfo & setLineNumbers (const size_t inStartLineNum, const size_t inEndLineNum)
 
std::ostream & printInfo (std::ostream &oss) const
 
std::ostream & printSRT (std::ostream &oss) const
 

Detailed Description

Detailed caption information.

Definition at line 61 of file ntv2srt.h.

Constructor & Destructor Documentation

◆ SRTCaptionInfo()

SRTCaptionInfo::SRTCaptionInfo ( const SRTSeqNum  inSeqNum = 0,
const SRTTimestamp  inStartTime = 0,
const SRTDuration  inDuration = 0,
const std::string &  inRawCaption = std::string(),
const size_t  inStartLineNum = 0,
const size_t  inEndLineNum = 0 
)
inlineexplicit

Definition at line 64 of file ntv2srt.h.

Member Function Documentation

◆ anchor()

uint16_t SRTCaptionInfo::anchor ( void  ) const
inline

Definition at line 77 of file ntv2srt.h.

◆ caption()

std::string SRTCaptionInfo::caption ( void  ) const

◆ duration()

SRTDuration SRTCaptionInfo::duration ( void  ) const
inline

Definition at line 73 of file ntv2srt.h.

◆ endLineNumber()

size_t SRTCaptionInfo::endLineNumber ( void  ) const
inline

Definition at line 82 of file ntv2srt.h.

◆ endLineOffset()

size_t SRTCaptionInfo::endLineOffset ( void  ) const
inline

Definition at line 85 of file ntv2srt.h.

◆ endTime()

SRTTimestamp SRTCaptionInfo::endTime ( void  ) const
inline

Definition at line 74 of file ntv2srt.h.

◆ getCharWithAttrs()

bool SRTCaptionInfo::getCharWithAttrs ( const size_t  inPos,
std::string &  outChar,
bool &  outIsBold,
bool &  outIsItalic,
std::string &  outColor 
) const

◆ hasAnchor()

bool SRTCaptionInfo::hasAnchor ( void  ) const
inline

Definition at line 78 of file ntv2srt.h.

◆ hasAnchorTag()

bool SRTCaptionInfo::hasAnchorTag ( void  ) const
inline

Definition at line 80 of file ntv2srt.h.

◆ hasLineNumbers()

bool SRTCaptionInfo::hasLineNumbers ( void  ) const
inline

Definition at line 83 of file ntv2srt.h.

◆ hasWindow()

bool SRTCaptionInfo::hasWindow ( void  ) const
inline

Definition at line 76 of file ntv2srt.h.

◆ isFirstCaption()

bool SRTCaptionInfo::isFirstCaption ( void  ) const
inline

Definition at line 86 of file ntv2srt.h.

◆ isValid()

bool SRTCaptionInfo::isValid ( void  ) const
inline

Definition at line 79 of file ntv2srt.h.

◆ printInfo()

std::ostream& SRTCaptionInfo::printInfo ( std::ostream &  oss) const

◆ printSRT()

std::ostream& SRTCaptionInfo::printSRT ( std::ostream &  oss) const

◆ rawCaption()

const std::string& SRTCaptionInfo::rawCaption ( void  ) const
inline

Definition at line 70 of file ntv2srt.h.

◆ reset()

SRTCaptionInfo& SRTCaptionInfo::reset ( void  )
inline

Definition at line 90 of file ntv2srt.h.

◆ sequenceNum()

SRTSeqNum SRTCaptionInfo::sequenceNum ( void  ) const
inline

Definition at line 71 of file ntv2srt.h.

◆ set()

SRTCaptionInfo& SRTCaptionInfo::set ( const SRTSeqNum  inSeqNum,
const SRTTimestamp  inStartTime,
const SRTDuration  inDuration,
const std::string &  inRawCaption = std::string(),
const size_t  inStartLineNum = 0,
const size_t  inEndLineNum = 0 
)
inline

Definition at line 91 of file ntv2srt.h.

◆ setAnchorPos()

SRTCaptionInfo& SRTCaptionInfo::setAnchorPos ( const uint16_t  inAnchorPos)
inline

Definition at line 102 of file ntv2srt.h.

◆ setFirstCaption()

SRTCaptionInfo& SRTCaptionInfo::setFirstCaption ( const bool  inIsFirst = true)
inline

Definition at line 100 of file ntv2srt.h.

◆ setLineNumbers()

SRTCaptionInfo& SRTCaptionInfo::setLineNumbers ( const size_t  inStartLineNum,
const size_t  inEndLineNum 
)
inline

Definition at line 103 of file ntv2srt.h.

◆ setWindow()

SRTCaptionInfo& SRTCaptionInfo::setWindow ( const SRTWindow &  inWindow)
inline

Definition at line 101 of file ntv2srt.h.

◆ startLineNumber()

size_t SRTCaptionInfo::startLineNumber ( void  ) const
inline

Definition at line 81 of file ntv2srt.h.

◆ startLineOffset()

size_t SRTCaptionInfo::startLineOffset ( void  ) const
inline

Definition at line 84 of file ntv2srt.h.

◆ startTime()

SRTTimestamp SRTCaptionInfo::startTime ( void  ) const
inline

Definition at line 72 of file ntv2srt.h.

◆ window()

const SRTWindow& SRTCaptionInfo::window ( void  ) const
inline

Definition at line 75 of file ntv2srt.h.

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