This is used for bitstream maintainance. (New in SDK 16.0) More...

#include <ntv2publicinterface.h>

Collaboration diagram for NTV2Bitstream:

Public Member Functions
std::ostream &	Print (std::ostream &inOutStream) const
	Prints a human-readable representation of me to the given output stream. More...

	operator NTV2_HEADER * ()

bool	RPCEncode (NTV2_RPC_BLOB_TYPE &outBlob)

bool	RPCDecode (const NTV2_RPC_BLOB_TYPE &inBlob, size_t &inOutIndex)

Construction & Destruction
	NTV2Bitstream ()
	Constructs a default NTV2Bitstream struct. More...

	NTV2Bitstream (const NTV2Buffer &inBuffer, const ULWord inFlags)
	Constructs an NTV2Bitstream object to use in a CNTV2Card::LoadBitstream call. More...

	NTV2Bitstream (const ULWord *pInBuffer, const ULWord inByteCount, const ULWord inFlags)
	Constructs an NTV2Bitstream object to use in a CNTV2Card::LoadBitstream call. More...

Changing
bool	SetBuffer (const NTV2Buffer &inBuffer)
	Sets the buffer to lock for use in a subsequent call to CNTV2Card::LoadBitstream. More...

bool	SetBuffer (const ULWord *pInBuffer, const ULWord inByteCount)
	Sets the buffer to lock for use in a subsequent call to CNTV2Card::LoadBitstream. More...

void	SetFlags (const ULWord inFlags)
	Sets the action flags for use in a subsequent call to CNTV2Card::LoadBitstream. More...

void	Clear (void)
	Resets the struct to its initialized state. More...

Public Attributes
NTV2_HEADER	mHeader
	The common structure header – ALWAYS FIRST! More...

NTV2Buffer	mBuffer
	Virtual address of a bitstream buffer and its length. More...

ULWord	mFlags
	Action flags (lock, unlock, etc) More...

ULWord	mStatus
	Action status. More...

ULWord	mRegisters [16]
	Register data. More...

ULWord	mReserved [32]
	Reserved for future expansion. More...

NTV2_TRAILER	mTrailer
	The common structure trailer – ALWAYS LAST! More...

Detailed Description

This is used for bitstream maintainance. (New in SDK 16.0)

Note: This struct uses a constructor to properly initialize itself. Do not use memset or bzero to initialize or "clear" it.

Definition at line 8829 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2Bitstream() [1/3]

NTV2Bitstream::NTV2Bitstream ( )

explicit

Constructs a default NTV2Bitstream struct.

Definition at line 3063 of file ntv2publicinterface.cpp.

◆ NTV2Bitstream() [2/3]

NTV2Bitstream::NTV2Bitstream	(	const NTV2Buffer &	inBuffer,
		const ULWord	inFlags
	)

explicit

Constructs an NTV2Bitstream object to use in a CNTV2Card::LoadBitstream call.

Parameters

inBuffer	Specifies the memory containing the bitstream to load.
inFlags	Specifies action flags (fragment swap, etc.).

Definition at line 3069 of file ntv2publicinterface.cpp.

◆ NTV2Bitstream() [3/3]

NTV2Bitstream::NTV2Bitstream	(	const ULWord *	pInBuffer,
		const ULWord	inByteCount,
		const ULWord	inFlags
	)

explicit

Constructs an NTV2Bitstream object to use in a CNTV2Card::LoadBitstream call.

Parameters

pInBuffer	Specifies a pointer to the host buffer containing the bitstream to load.
inByteCount	Specifies a the length of the bitstream in bytes.
inFlags	Specifies action flags (fragment, swap, etc)

Definition at line 3077 of file ntv2publicinterface.cpp.

Member Function Documentation

◆ Clear()

void NTV2Bitstream::Clear ( void )

inline

Resets the struct to its initialized state.

Definition at line 8890 of file ntv2publicinterface.h.

◆ operator NTV2_HEADER *()

NTV2Bitstream::operator NTV2_HEADER * ( )

inline

Returns: My address casted to an NTV2_HEADER pointer.

Definition at line 8903 of file ntv2publicinterface.h.

◆ Print()

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

Prints a human-readable representation of me to the given output stream.

Parameters

inOutStream Specifies the output stream to use.

Returns: A reference to the output stream.

Definition at line 3091 of file ntv2publicinterface.cpp.

◆ RPCDecode()

bool NTV2Bitstream::RPCDecode	(	const NTV2_RPC_BLOB_TYPE &	inBlob,
		size_t &	inOutIndex
	)

Definition at line 4309 of file ntv2publicinterface.cpp.

◆ RPCEncode()

bool NTV2Bitstream::RPCEncode ( NTV2_RPC_BLOB_TYPE & outBlob )

Definition at line 4292 of file ntv2publicinterface.cpp.

◆ SetBuffer() [1/2]

bool NTV2Bitstream::SetBuffer ( const NTV2Buffer & inBuffer )

Sets the buffer to lock for use in a subsequent call to CNTV2Card::LoadBitstream.

Parameters

inBuffer Specifies the memory containing the bitstream to load.

Returns: True if successful; otherwise false.

Definition at line 3085 of file ntv2publicinterface.cpp.

◆ SetBuffer() [2/2]

bool NTV2Bitstream::SetBuffer	(	const ULWord *	pInBuffer,
		const ULWord	inByteCount
	)

inline

Sets the buffer to lock for use in a subsequent call to CNTV2Card::LoadBitstream.

Parameters

pInBuffer	Specifies a pointer to the host buffer contiaining the bitstread to load.
inByteCount	Specifies a the length of the buffer to load in bytes.

Returns: True if successful; otherwise false.

Definition at line 8879 of file ntv2publicinterface.h.

◆ SetFlags()

void NTV2Bitstream::SetFlags ( const ULWord inFlags )

inline

Sets the action flags for use in a subsequent call to CNTV2Card::LoadBitstream.

Parameters

inFlags Specifies action flags (fragment, swap, etc)

Definition at line 8885 of file ntv2publicinterface.h.

Member Data Documentation

◆ mBuffer

NTV2Buffer NTV2Bitstream::mBuffer

Virtual address of a bitstream buffer and its length.

Definition at line 8831 of file ntv2publicinterface.h.

◆ mFlags

ULWord NTV2Bitstream::mFlags

Action flags (lock, unlock, etc)

Definition at line 8832 of file ntv2publicinterface.h.

◆ mHeader

NTV2_HEADER NTV2Bitstream::mHeader

The common structure header – ALWAYS FIRST!

Definition at line 8830 of file ntv2publicinterface.h.

◆ mRegisters

ULWord NTV2Bitstream::mRegisters[16]

Register data.

Definition at line 8834 of file ntv2publicinterface.h.

◆ mReserved

ULWord NTV2Bitstream::mReserved[32]

Reserved for future expansion.

Definition at line 8835 of file ntv2publicinterface.h.

◆ mStatus

ULWord NTV2Bitstream::mStatus

Action status.

Definition at line 8833 of file ntv2publicinterface.h.

◆ mTrailer

NTV2_TRAILER NTV2Bitstream::mTrailer

The common structure trailer – ALWAYS LAST!

Definition at line 8836 of file ntv2publicinterface.h.

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

/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2publicinterface.h
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2publicinterface.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NTV2Bitstream() [1/3]

◆ NTV2Bitstream() [2/3]

◆ NTV2Bitstream() [3/3]

Member Function Documentation

◆ Clear()

◆ operator NTV2_HEADER *()

◆ Print()

◆ RPCDecode()

◆ RPCEncode()

◆ SetBuffer() [1/2]

◆ SetBuffer() [2/2]

◆ SetFlags()

Member Data Documentation

◆ mBuffer

◆ mFlags

◆ mHeader

◆ mRegisters

◆ mReserved

◆ mStatus

◆ mTrailer