AJA NTV2 SDK  17.1.3.1410
NTV2 SDK 17.1.3.1410
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
NTV2Caption608ChangeInfo Class Reference

This class is used to respond to dynamic events that occur during CEA-608 caption decoding. More...

#include <ntv2caption608types.h>

Collaboration diagram for NTV2Caption608ChangeInfo:
[legend]

Classes

union  _u
 

Public Types

enum  NTV2Caption608Change {
  NTV2DecoderChange_None = 0, NTV2DecoderChange_CurrentChannel = 1, NTV2DecoderChange_CurrentRow = 2, NTV2DecoderChange_CurrentColumn = 4,
  NTV2DecoderChange_CurrentScreen = 8, NTV2DecoderChange_CaptionMode = 16, NTV2DecoderChange_ScreenCharacter = 32, NTV2DecoderChange_ScreenAttribute = 64,
  NTV2DecoderChange_DrawScreen = 128, NTV2DecoderChange_All = 0xFFFF
}
 Used to determine what changed. Also can be used to choose which changes to pay attention to. More...
 
typedef enum NTV2Caption608ChangeInfo::NTV2Caption608Change NTV2Caption608Change
 Used to determine what changed. Also can be used to choose which changes to pay attention to. More...
 

Public Member Functions

 NTV2Caption608ChangeInfo (const NTV2Line21Channel inChannel)
 
 NTV2Caption608ChangeInfo (const NTV2Line21Channel inOldChannel, const NTV2Line21Channel inNewChannel)
 
 NTV2Caption608ChangeInfo (const NTV2Line21Channel inChannel, const UWord inWhatChanged, const UWord inOldValue, const UWord inNewValue)
 
 NTV2Caption608ChangeInfo (const NTV2Line21Channel inChannel, const UWord inScreen, const UWord inRow, const UWord inColumn, const NTV2_CC608_CodePoint inOldValue, const NTV2_CC608_CodePoint inNewValue)
 
 NTV2Caption608ChangeInfo (const NTV2Line21Channel inChannel, const UWord inScreen, const UWord inRow, const UWord inColumn, const NTV2Line21Attributes &inOldValue, const NTV2Line21Attributes &inNewValue)
 
std::ostream & Print (std::ostream &inOutStrm) const
 

Public Attributes

union NTV2Caption608ChangeInfo::_u u
 
UWord mWhatChanged
 Bit mask that indicates what changed. More...
 
NTV2Line21Channel mChannel
 Caption channel being changed. More...
 

Detailed Description

This class is used to respond to dynamic events that occur during CEA-608 caption decoding.

Definition at line 779 of file ntv2caption608types.h.

Member Typedef Documentation

◆ NTV2Caption608Change

typedef enum NTV2Caption608ChangeInfo::NTV2Caption608Change NTV2Caption608ChangeInfo::NTV2Caption608Change

Used to determine what changed. Also can be used to choose which changes to pay attention to.

Member Enumeration Documentation

◆ NTV2Caption608Change

enum NTV2Caption608ChangeInfo::NTV2Caption608Change

Used to determine what changed. Also can be used to choose which changes to pay attention to.

Enumerator
NTV2DecoderChange_None 

Invalid.

NTV2DecoderChange_CurrentChannel 

The current caption channel of interest changed (e.g., CC1 to CC3).

NTV2DecoderChange_CurrentRow 

The current caption row changed.

NTV2DecoderChange_CurrentColumn 

The current caption column changed.

NTV2DecoderChange_CurrentScreen 

The current caption screen changed.

NTV2DecoderChange_CaptionMode 

The current caption mode changed (e.g., pop-on to roll-up).

NTV2DecoderChange_ScreenCharacter 

The character displayed at a specific screen and position changed.

NTV2DecoderChange_ScreenAttribute 

The display attributes at a specific screen and position changed.

NTV2DecoderChange_DrawScreen 

If drawing entire caption screen, do it now.

NTV2DecoderChange_All 

All possible changes.

Definition at line 785 of file ntv2caption608types.h.

Constructor & Destructor Documentation

◆ NTV2Caption608ChangeInfo() [1/5]

NTV2Caption608ChangeInfo::NTV2Caption608ChangeInfo ( const NTV2Line21Channel  inChannel)
explicit

◆ NTV2Caption608ChangeInfo() [2/5]

NTV2Caption608ChangeInfo::NTV2Caption608ChangeInfo ( const NTV2Line21Channel  inOldChannel,
const NTV2Line21Channel  inNewChannel 
)
explicit

◆ NTV2Caption608ChangeInfo() [3/5]

NTV2Caption608ChangeInfo::NTV2Caption608ChangeInfo ( const NTV2Line21Channel  inChannel,
const UWord  inWhatChanged,
const UWord  inOldValue,
const UWord  inNewValue 
)
explicit

◆ NTV2Caption608ChangeInfo() [4/5]

NTV2Caption608ChangeInfo::NTV2Caption608ChangeInfo ( const NTV2Line21Channel  inChannel,
const UWord  inScreen,
const UWord  inRow,
const UWord  inColumn,
const NTV2_CC608_CodePoint  inOldValue,
const NTV2_CC608_CodePoint  inNewValue 
)
explicit

◆ NTV2Caption608ChangeInfo() [5/5]

NTV2Caption608ChangeInfo::NTV2Caption608ChangeInfo ( const NTV2Line21Channel  inChannel,
const UWord  inScreen,
const UWord  inRow,
const UWord  inColumn,
const NTV2Line21Attributes &  inOldValue,
const NTV2Line21Attributes &  inNewValue 
)
explicit

Member Function Documentation

◆ Print()

std::ostream& NTV2Caption608ChangeInfo::Print ( std::ostream &  inOutStrm) const

Member Data Documentation

◆ mChannel

NTV2Line21Channel NTV2Caption608ChangeInfo::mChannel

Caption channel being changed.

Definition at line 853 of file ntv2caption608types.h.

◆ mWhatChanged

UWord NTV2Caption608ChangeInfo::mWhatChanged

Bit mask that indicates what changed.

Definition at line 852 of file ntv2caption608types.h.

◆ u

union NTV2Caption608ChangeInfo::_u NTV2Caption608ChangeInfo::u
The documentation for this class was generated from the following file: