AJA NTV2 SDK  18.0.0.2122
NTV2 SDK 18.0.0.2122
SCCSource Class Reference
Inheritance diagram for SCCSource:
[legend]
Collaboration diagram for SCCSource:
[legend]

Public Member Functions

 SCCSource (const double inCharsPerMinute, istream *pInInputStream, const string &inFilePath, const bool inDeleteInputStream=(0))
 
virtual ~SCCSource ()
 
virtual bool IsPlainTextSource (void) const
 
virtual bool EnqueueCCDataToFrame (CNTV2CaptionEncoder608Ptr inEncoder, const uint32_t inFrameNum)
 Enqueues next-available CC data into the given encoder for the given frame number. More...
 
virtual string GetNextCaptionCharacter (void)
 
virtual string GetNextCaptionWord (bool &outLineBreak)
 
virtual string GetNextCaptionRow (const bool inBreakLines=(0))
 
- Public Member Functions inherited from CaptionSource
 CaptionSource (const double inCharsPerMinute, istream *pInInputStream, const string &inFilePath, const bool inDeleteInputStream=(0))
 My only constructor. More...
 
virtual ~CaptionSource ()
 My destructor. If was told at construction time that I was to be responsible for deleting the input stream, then I'll delete it here. More...
 
virtual bool IsFinished (void) const
 
virtual void SetFinished (void)
 Sets my "finished" flag. More...
 
virtual void SetCaptionChannel (const NTV2Line21Channel inCCChannel)
 Sets my caption channel. More...
 
virtual NTV2Line21Channel GetCaptionChannel (void) const
 
virtual bool IsF1Channel (void) const
 
virtual void SetTextMode (const bool inIsTextMode)
 Sets my text mode. If I'm in text mode, I don't do any word breaking or line/row truncation. More...
 

Detailed Description

Definition at line 630 of file ntv2ccplayer.cpp.

Constructor & Destructor Documentation

◆ SCCSource()

SCCSource::SCCSource ( const double  inCharsPerMinute,
istream *  pInInputStream,
const string &  inFilePath,
const bool  inDeleteInputStream = (0) 
)
explicit

Definition at line 660 of file ntv2ccplayer.cpp.

◆ ~SCCSource()

virtual SCCSource::~SCCSource ( )
inlinevirtual

Definition at line 634 of file ntv2ccplayer.cpp.

Member Function Documentation

◆ EnqueueCCDataToFrame()

bool SCCSource::EnqueueCCDataToFrame ( CNTV2CaptionEncoder608Ptr  inEncoder,
const uint32_t  inFrameNum 
)
virtual

Enqueues next-available CC data into the given encoder for the given frame number.

Definition at line 735 of file ntv2ccplayer.cpp.

◆ GetNextCaptionCharacter()

virtual string SCCSource::GetNextCaptionCharacter ( void  )
inlinevirtual
Returns
Stubbed out – returns an empty string. (I'm not a plaintext generator.)

Reimplemented from CaptionSource.

Definition at line 639 of file ntv2ccplayer.cpp.

◆ GetNextCaptionRow()

virtual string SCCSource::GetNextCaptionRow ( const bool  inBreakLines = (0))
inlinevirtual
Returns
Stubbed out – returns an empty string. (I'm not a plaintext generator.)

Reimplemented from CaptionSource.

Definition at line 641 of file ntv2ccplayer.cpp.

◆ GetNextCaptionWord()

virtual string SCCSource::GetNextCaptionWord ( bool &  outLineBreak)
inlinevirtual
Returns
Stubbed out – returns an empty string. (I'm not a plaintext generator.)

Reimplemented from CaptionSource.

Definition at line 640 of file ntv2ccplayer.cpp.

◆ IsPlainTextSource()

virtual bool SCCSource::IsPlainTextSource ( void  ) const
inlinevirtual
Returns
True if I only produce plaintext; otherwise false.

Reimplemented from CaptionSource.

Definition at line 637 of file ntv2ccplayer.cpp.


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