AJA NTV2 SDK  17.0.1.1246
NTV2 SDK 17.0.1.1246
CaptionChannelPacketInfo Struct Reference

I am a container for a "Caption Channel Packet" – i.e., a wrapper for a clump of CEA-708 caption data. By CEA-708 rules, Caption Channel Packets are independent ("asynchronous") of video frame boundaries, which means a single Caption Channel Packet could span more than one frame, and/or multiple Caption Channel Packets can be sent in a single frame. Since we tend to parse things on a frame-by-frame basis (how quaint...), this means that at the beginning of each frame we could have an incomplete Caption Channel Packet (i.e. one that was started last frame but not yet completed), and at the end of each frame we could have zero, one or more completed Caption Channel Packets, and zero or one incomplete Packets (Caption Channel Packets that have been started but not completed). More...

#include <ntv2captiondecoder708.h>

Public Attributes

int ccpStatus
 kCaptionChannelClear/Started/Complete More...
 
int ccpSize
 The number of data words we're expecting according to the packet header (note, NOT the "packet_size_code" - this is the decoded size) More...
 
int ccpSequenceNum
 The sequence number (0, 1, 2, or 3) from the header. More...
 
int ccpCurrentSize
 The number of data words actually loaded into the ccpData array. More...
 
UByte ccpData [NTV2_CC708_MaxCaptionChannelPacketSize]
 Raw packet data. More...
 

Detailed Description

I am a container for a "Caption Channel Packet" – i.e., a wrapper for a clump of CEA-708 caption data. By CEA-708 rules, Caption Channel Packets are independent ("asynchronous") of video frame boundaries, which means a single Caption Channel Packet could span more than one frame, and/or multiple Caption Channel Packets can be sent in a single frame. Since we tend to parse things on a frame-by-frame basis (how quaint...), this means that at the beginning of each frame we could have an incomplete Caption Channel Packet (i.e. one that was started last frame but not yet completed), and at the end of each frame we could have zero, one or more completed Caption Channel Packets, and zero or one incomplete Packets (Caption Channel Packets that have been started but not completed).

Definition at line 53 of file ntv2captiondecoder708.h.

Member Data Documentation

◆ ccpCurrentSize

int CaptionChannelPacketInfo::ccpCurrentSize

The number of data words actually loaded into the ccpData array.

Definition at line 58 of file ntv2captiondecoder708.h.

◆ ccpData

UByte CaptionChannelPacketInfo::ccpData[NTV2_CC708_MaxCaptionChannelPacketSize]

Raw packet data.

Definition at line 60 of file ntv2captiondecoder708.h.

◆ ccpSequenceNum

int CaptionChannelPacketInfo::ccpSequenceNum

The sequence number (0, 1, 2, or 3) from the header.

Definition at line 57 of file ntv2captiondecoder708.h.

◆ ccpSize

int CaptionChannelPacketInfo::ccpSize

The number of data words we're expecting according to the packet header (note, NOT the "packet_size_code" - this is the decoded size)

Definition at line 56 of file ntv2captiondecoder708.h.

◆ ccpStatus

int CaptionChannelPacketInfo::ccpStatus

kCaptionChannelClear/Started/Complete

Definition at line 55 of file ntv2captiondecoder708.h.


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