AJA NTV2 SDK  17.6.0.1688
NTV2 SDK 17.6.0.1688
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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 9012 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2StreamBuffer()

NTV2StreamBuffer::NTV2StreamBuffer ( )
explicit

Constructs a default NTV2StreamBuffer struct.

Definition at line 3111 of file ntv2publicinterface.cpp.

Member Function Documentation

◆ operator NTV2_HEADER *()

NTV2StreamBuffer::operator NTV2_HEADER * ( )
inline

Definition at line 9040 of file ntv2publicinterface.h.

◆ Print()

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

Definition at line 3117 of file ntv2publicinterface.cpp.

Member Data Documentation

◆ mActiveTime

LWord64 NTV2StreamBuffer::mActiveTime

Active time (on air interrupt time)

Definition at line 9024 of file ntv2publicinterface.h.

◆ mBuffer

NTV2Buffer NTV2StreamBuffer::mBuffer

Virtual address of a stream buffer and its length.

Definition at line 9017 of file ntv2publicinterface.h.

◆ mBufferCookie

ULWord64 NTV2StreamBuffer::mBufferCookie

Buffer User cookie.

Definition at line 9021 of file ntv2publicinterface.h.

◆ mBufferState

ULWord NTV2StreamBuffer::mBufferState

Buffer state.

Definition at line 9022 of file ntv2publicinterface.h.

◆ mChannel

NTV2Channel NTV2StreamBuffer::mChannel

Stream channel.

Definition at line 9014 of file ntv2publicinterface.h.

◆ mCompleteTime

LWord64 NTV2StreamBuffer::mCompleteTime

Complete time (off air interrupt time)

Definition at line 9025 of file ntv2publicinterface.h.

◆ mFlags

ULWord NTV2StreamBuffer::mFlags

Action flags.

Definition at line 9015 of file ntv2publicinterface.h.

◆ mFlushTime

LWord64 NTV2StreamBuffer::mFlushTime

Flush time (if flushed before on air)

Definition at line 9026 of file ntv2publicinterface.h.

◆ mHeader

NTV2_HEADER NTV2StreamBuffer::mHeader

The common structure header – ALWAYS FIRST!

Definition at line 9013 of file ntv2publicinterface.h.

◆ mNumSegments

ULWord NTV2StreamBuffer::mNumSegments

Number of segments.

Definition at line 9020 of file ntv2publicinterface.h.

◆ mQueueTime

LWord64 NTV2StreamBuffer::mQueueTime

Queue time (queued to driver by app)

Definition at line 9023 of file ntv2publicinterface.h.

◆ mReserved

ULWord NTV2StreamBuffer::mReserved[32]

Reserved for future expansion.

Definition at line 9028 of file ntv2publicinterface.h.

◆ mSegmentPitch

LWord NTV2StreamBuffer::mSegmentPitch

Segmented transfer pitch.

Definition at line 9019 of file ntv2publicinterface.h.

◆ mSegmentSize

ULWord NTV2StreamBuffer::mSegmentSize

Segmented transfer size.

Definition at line 9018 of file ntv2publicinterface.h.

◆ mStatus

ULWord NTV2StreamBuffer::mStatus

Action status.

Definition at line 9016 of file ntv2publicinterface.h.

◆ mTrailer

NTV2_TRAILER NTV2StreamBuffer::mTrailer

The common structure trailer – ALWAYS LAST!

Definition at line 9029 of file ntv2publicinterface.h.

◆ mTransferCount

ULWord64 NTV2StreamBuffer::mTransferCount

Number of transfers.

Definition at line 9027 of file ntv2publicinterface.h.


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