AJA NTV2 SDK  17.0.1.1246
NTV2 SDK 17.0.1.1246
CCGenConfig Struct Reference

This class is used to configure a caption generator for a single caption channel. More...

#include <ntv2ccplayer.h>

Collaboration diagram for CCGenConfig:
[legend]

Public Member Functions

 CCGenConfig ()
 Constructs a default generator configuration. More...
 
AJALabelValuePairs Get (void) const
 

Public Attributes

NTV2StringList fFilesToPlay
 A list of zero or more strings containing paths to text files to be "played". More...
 
AtEndAction fEndAction
 The action to take after the file list has finished playing. More...
 
NTV2Line21Mode fCaptionMode
 The CEA-608 caption mode to use. More...
 
NTV2Line21Channel fCaptionChannel
 The caption channel to use. More...
 
bool fNewLinesAreNewRows
 If true, newlines break caption rows; otherwise are treated as whitespace. More...
 
double fCharsPerMinute
 The rate at which caption characters get enqueued, in characters per minute. More...
 
NTV2Line21Attrs fAttributes
 The character attributes to use. More...
 

Detailed Description

This class is used to configure a caption generator for a single caption channel.

Definition at line 43 of file ntv2ccplayer.h.

Constructor & Destructor Documentation

◆ CCGenConfig()

CCGenConfig::CCGenConfig ( )
inlineexplicit

Constructs a default generator configuration.

Definition at line 57 of file ntv2ccplayer.h.

Member Function Documentation

◆ Get()

AJALabelValuePairs CCGenConfig::Get ( void  ) const

Definition at line 211 of file ntv2ccplayer.cpp.

Member Data Documentation

◆ fAttributes

NTV2Line21Attrs CCGenConfig::fAttributes

The character attributes to use.

Definition at line 52 of file ntv2ccplayer.h.

◆ fCaptionChannel

NTV2Line21Channel CCGenConfig::fCaptionChannel

The caption channel to use.

Definition at line 49 of file ntv2ccplayer.h.

◆ fCaptionMode

NTV2Line21Mode CCGenConfig::fCaptionMode

The CEA-608 caption mode to use.

Definition at line 48 of file ntv2ccplayer.h.

◆ fCharsPerMinute

double CCGenConfig::fCharsPerMinute

The rate at which caption characters get enqueued, in characters per minute.

Definition at line 51 of file ntv2ccplayer.h.

◆ fEndAction

AtEndAction CCGenConfig::fEndAction

The action to take after the file list has finished playing.

Definition at line 47 of file ntv2ccplayer.h.

◆ fFilesToPlay

NTV2StringList CCGenConfig::fFilesToPlay

A list of zero or more strings containing paths to text files to be "played".

Definition at line 46 of file ntv2ccplayer.h.

◆ fNewLinesAreNewRows

bool CCGenConfig::fNewLinesAreNewRows

If true, newlines break caption rows; otherwise are treated as whitespace.

Definition at line 50 of file ntv2ccplayer.h.


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