AJA NTV2 SDK  17.5.0.1242
NTV2 SDK 17.5.0.1242
NTV2StreamBuffer Class Reference

#include <ntv2publicinterface.h>

Collaboration diagram for NTV2StreamBuffer:
[legend]

Public Member Functions

 operator NTV2_HEADER * ()
 
std::ostream & Print (std::ostream &inOutStream) const
 
Construction & Destruction
 NTV2StreamBuffer ()
 Constructs a default NTV2StreamBuffer struct. More...
 

Public Attributes

NTV2_HEADER mHeader
 The common structure header – ALWAYS FIRST! More...
 
NTV2Channel mChannel
 Stream channel. More...
 
ULWord mFlags
 Action flags. More...
 
ULWord mStatus
 Action status. More...
 
NTV2Buffer mBuffer
 Virtual address of a stream buffer and its length. More...
 
ULWord mSegmentSize
 Segmented transfer size. More...
 
LWord mSegmentPitch
 Segmented transfer pitch. More...
 
ULWord mNumSegments
 Number of segments. More...
 
ULWord64 mBufferCookie
 Buffer User cookie. More...
 
ULWord mBufferState
 Buffer state. More...
 
LWord64 mQueueTime
 Queue time (queued to driver by app) More...
 
LWord64 mActiveTime
 Active time (on air interrupt time) More...
 
LWord64 mCompleteTime
 Complete time (off air interrupt time) More...
 
LWord64 mFlushTime
 Flush time (if flushed before on air) More...
 
ULWord64 mTransferCount
 Number of transfers. More...
 
ULWord mReserved [32]
 Reserved for future expansion. More...
 
NTV2_TRAILER mTrailer
 The common structure trailer – ALWAYS LAST! More...
 

Detailed Description

Definition at line 8762 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2StreamBuffer()

NTV2StreamBuffer::NTV2StreamBuffer ( )
explicit

Constructs a default NTV2StreamBuffer struct.

Definition at line 2989 of file ntv2publicinterface.cpp.

Member Function Documentation

◆ operator NTV2_HEADER *()

NTV2StreamBuffer::operator NTV2_HEADER * ( )
inline

Definition at line 8790 of file ntv2publicinterface.h.

◆ Print()

ostream & NTV2StreamBuffer::Print ( std::ostream &  inOutStream) const

Definition at line 2995 of file ntv2publicinterface.cpp.

Member Data Documentation

◆ mActiveTime

LWord64 NTV2StreamBuffer::mActiveTime

Active time (on air interrupt time)

Definition at line 8774 of file ntv2publicinterface.h.

◆ mBuffer

NTV2Buffer NTV2StreamBuffer::mBuffer

Virtual address of a stream buffer and its length.

Definition at line 8767 of file ntv2publicinterface.h.

◆ mBufferCookie

ULWord64 NTV2StreamBuffer::mBufferCookie

Buffer User cookie.

Definition at line 8771 of file ntv2publicinterface.h.

◆ mBufferState

ULWord NTV2StreamBuffer::mBufferState

Buffer state.

Definition at line 8772 of file ntv2publicinterface.h.

◆ mChannel

NTV2Channel NTV2StreamBuffer::mChannel

Stream channel.

Definition at line 8764 of file ntv2publicinterface.h.

◆ mCompleteTime

LWord64 NTV2StreamBuffer::mCompleteTime

Complete time (off air interrupt time)

Definition at line 8775 of file ntv2publicinterface.h.

◆ mFlags

ULWord NTV2StreamBuffer::mFlags

Action flags.

Definition at line 8765 of file ntv2publicinterface.h.

◆ mFlushTime

LWord64 NTV2StreamBuffer::mFlushTime

Flush time (if flushed before on air)

Definition at line 8776 of file ntv2publicinterface.h.

◆ mHeader

NTV2_HEADER NTV2StreamBuffer::mHeader

The common structure header – ALWAYS FIRST!

Definition at line 8763 of file ntv2publicinterface.h.

◆ mNumSegments

ULWord NTV2StreamBuffer::mNumSegments

Number of segments.

Definition at line 8770 of file ntv2publicinterface.h.

◆ mQueueTime

LWord64 NTV2StreamBuffer::mQueueTime

Queue time (queued to driver by app)

Definition at line 8773 of file ntv2publicinterface.h.

◆ mReserved

ULWord NTV2StreamBuffer::mReserved[32]

Reserved for future expansion.

Definition at line 8778 of file ntv2publicinterface.h.

◆ mSegmentPitch

LWord NTV2StreamBuffer::mSegmentPitch

Segmented transfer pitch.

Definition at line 8769 of file ntv2publicinterface.h.

◆ mSegmentSize

ULWord NTV2StreamBuffer::mSegmentSize

Segmented transfer size.

Definition at line 8768 of file ntv2publicinterface.h.

◆ mStatus

ULWord NTV2StreamBuffer::mStatus

Action status.

Definition at line 8766 of file ntv2publicinterface.h.

◆ mTrailer

NTV2_TRAILER NTV2StreamBuffer::mTrailer

The common structure trailer – ALWAYS LAST!

Definition at line 8779 of file ntv2publicinterface.h.

◆ mTransferCount

ULWord64 NTV2StreamBuffer::mTransferCount

Number of transfers.

Definition at line 8777 of file ntv2publicinterface.h.


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