AJA NTV2 SDK  17.0.1.1246
NTV2 SDK 17.0.1.1246
ntv2caption708service.h
Go to the documentation of this file.
1 
7 #ifndef __NTV2_CEA708_SERVICE_
8 #define __NTV2_CEA708_SERVICE_
9 
11 #include "ntv2caption708window.h"
12 #ifdef MSWindows
13  #include "windows.h"
14  #include "stdio.h"
15 #endif
16 
17 
18 
20 {
21  // INSTANCE METHODS
22  public:
24  virtual ~CNTV2Caption708Service ();
25 
26  virtual void InitService (const int inServiceIndex);
27  virtual bool SetServiceInfo (const NTV2_CC708ServiceInfo & inNewSvcInfo);
28 
35  virtual bool ParseInputServiceBlockToLocalQueue (const UByte * pInData, const size_t inByteCount);
36 
43  virtual size_t GetCommandSize (const UByte * pInData, const size_t inByteCount) const;
44 
51  virtual size_t Parse708Command (const UByte * pInData, const size_t inByteCount);
52 
53  virtual size_t DebugParse708Command (const UByte * pInData, const size_t inByteCount) const;
54 
62  virtual bool SetCurrentWindow (const int inWindowID);
63 
71  virtual bool ClearWindows (const UByte inWindowMap);
72 
80  virtual bool DeleteWindows (const UByte inWindowMap);
81 
89  virtual bool DisplayWindows (const UByte inWindowMap);
90 
98  virtual bool HideWindows (const UByte inWindowMap);
99 
107  virtual bool ToggleWindows (const UByte inWindowMap);
108 
117  virtual bool DefineWindow (const int inWindowID, const CC708WindowParms & inParameters);
118 
124  virtual bool SetWindowAttributes (const CC708WindowAttr & inAttributes);
125 
130  virtual void SetPenAttributes (const CC708PenAttr & inAttributes);
131 
136  virtual void SetPenColor (const CC708PenColor & inColor);
137 
142  virtual void SetPenLocation (const CC708PenLocation & inLocation);
143 
148  virtual void Delay (const int inTenthsSec);
149 
154  virtual void DelayCancel (void);
155 
159  virtual void Reset (void);
160 
161  virtual void AddCharacter (const UByte inChar, const CC708CodeGroup inCodeGroup);
162  virtual void DoETX (void);
163  virtual void DoBS (void);
164  virtual void DoFF (void);
165  virtual void DoCR (void);
166  virtual void DoHCR (void);
167 
168 
169  virtual bool PeekNextServiceBlockInfo (size_t & outBlockSize, size_t & outDataSize, int & outServiceNum, bool & outIsExtended) const;
170  virtual size_t PopServiceBlock (std::vector<UByte> & outData);
171  virtual size_t PopServiceBlockData (std::vector<UByte> & outData);
172  virtual size_t PopServiceBlock (UByte * pData);
173  virtual size_t PopServiceBlockData (UByte * pData);
174 
175  // Debug Methods
176  virtual NTV2CaptionLogMask SetLogMask (const NTV2CaptionLogMask inLogMask);
177 
178 
179  // INSTANCE DATA
180  private:
182  NTV2_CC708ServiceInfo mServiceInfo;
183  CNTV2Caption708ServiceBlockQueue mServiceBlockQueue;
184  int mCurrentWindow;
185 }; // CNTV2Caption708Service
186 
187 #endif // __NTV2_CEA708_SERVICE_
CC708WindowParms
Definition: ntv2captionencoder708.h:302
CNTV2Caption708Window
Definition: ntv2caption708window.h:73
CC708WindowAttr
Definition: ntv2captionencoder708.h:400
CC708PenColor
Definition: ntv2captionencoder708.h:530
CNTV2Caption708ServiceBlockQueue
I am a simple, thread-safe queue of CEA-708 caption service blocks.
Definition: ntv2caption708serviceblockqueue.h:28
CNTV2CaptionLogConfig::SetLogMask
virtual NTV2CaptionLogMask SetLogMask(const NTV2CaptionLogMask inLogMask)
Specifies what, if any, debug information I will write to my log stream.
Definition: ntv2captionlogging.h:187
CC708CodeGroup
CC708CodeGroup
Definition: ntv2caption708window.h:58
CC708PenAttr
Definition: ntv2captionencoder708.h:504
CNTV2Caption708Service
Definition: ntv2caption708service.h:19
ntv2caption708window.h
Declares the CNTV2Caption708Window class.
UByte
uint8_t UByte
Definition: ajatypes.h:241
AJAExport
#define AJAExport
Definition: export.h:33
NTV2_CC708NumWindows
@ NTV2_CC708NumWindows
Definition: ntv2captionencoder708.h:190
CC708PenLocation
Definition: ntv2captionencoder708.h:549
NTV2CaptionLogMask
uint64_t NTV2CaptionLogMask
Selectors to control what information is logged.
Definition: ntv2captionlogging.h:38
CNTV2CaptionLogConfig
Definition: ntv2captionlogging.h:77
ntv2caption708serviceblockqueue.h
Declares the CNTV2Caption708ServiceBlockQueue class.
NTV2_CC708ServiceInfo
Definition: ntv2caption708serviceinfo.h:67