This is used for streaming dma. More...

#include <ntv2publicinterface.h>

Collaboration diagram for NTV2DmaStream:

Public Member Functions
	NTV2DmaStream (const NTV2Channel inChannel, const ULWord inFlags)
	Constructs an NTV2DmaStream object to use to specify a streaming flags. More...

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

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

	NTV2DmaStream (const NTV2_POINTER &inBuffer, const NTV2Channel inChannel, const ULWord inFlags)
	Constructs an NTV2DmaStream object to use to specify a streaming buffer. More...

	NTV2DmaStream (const ULWord *pInBuffer, const ULWord inByteCount, const NTV2Channel inChannel, const ULWord inFlags)
	Constructs an NTV2DmaStream object to use in a CNTV2Card::StartDmaStream. More...

Changing
bool	SetBuffer (const NTV2_POINTER &inBuffer)
	Sets the buffer to use for streaming. More...

bool	SetBuffer (const ULWord *pInBuffer, const ULWord inByteCount)
	Sets the buffer to use for streaming. More...

bool	SetChannel (const NTV2Channel inChannel)
	Sets the video channel to use for streaming. More...

void	SetFlags (const ULWord inFlags)
	Sets the action flags. More...

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

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

NTV2_POINTER	mBuffer
	Virtual address of a DMA stream buffer and its length. More...

NTV2Channel	mChannel
	Video stream channel. More...

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

ULWord	mStatus
	Action status. 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 streaming dma.

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

Definition at line 8568 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2DmaStream() [1/4]

NTV2DmaStream::NTV2DmaStream ( )

explicit

Constructs a default NTV2DmaStream struct.

Definition at line 2854 of file ntv2publicinterface.cpp.

◆ NTV2DmaStream() [2/4]

NTV2DmaStream::NTV2DmaStream	(	const NTV2_POINTER &	inBuffer,
		const NTV2Channel	inChannel,
		const ULWord	inFlags
	)

explicit

Constructs an NTV2DmaStream object to use to specify a streaming buffer.

Parameters

inBuffer	Specifies the memory to use for streaming.
inChannel	Specifies the video channel to use for streaming.
inFlags	Specifies action flags (start, stop, etc.).

Definition at line 2860 of file ntv2publicinterface.cpp.

◆ NTV2DmaStream() [3/4]

NTV2DmaStream::NTV2DmaStream	(	const ULWord *	pInBuffer,
		const ULWord	inByteCount,
		const NTV2Channel	inChannel,
		const ULWord	inFlags
	)

explicit

Constructs an NTV2DmaStream object to use in a CNTV2Card::StartDmaStream.

Parameters

pInBuffer	Specifies a pointer to the host buffer to stream to or from.
inByteCount	Specifies a the length of the buffer in bytes.
inChannel	Specifies the video channel to use for streaming.
inFlags	Specifies action flags (start, stop etc)

Definition at line 2869 of file ntv2publicinterface.cpp.

◆ NTV2DmaStream() [4/4]

NTV2DmaStream::NTV2DmaStream	(	const NTV2Channel	inChannel,
		const ULWord	inFlags
	)

explicit

Constructs an NTV2DmaStream object to use to specify a streaming flags.

Parameters

inChannel	Specifies the video channel to use for streaming.
inFlags	Specifies action flags (start, stop, etc.).

Definition at line 2878 of file ntv2publicinterface.cpp.

Member Function Documentation

◆ Clear()

void NTV2DmaStream::Clear ( void )

inline

Resets the struct to its initialized state.

Definition at line 8646 of file ntv2publicinterface.h.

◆ Print()

ostream & NTV2DmaStream::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 2899 of file ntv2publicinterface.cpp.

◆ SetBuffer() [1/2]

bool NTV2DmaStream::SetBuffer ( const NTV2_POINTER & inBuffer )

Sets the buffer to use for streaming.

Parameters

inBuffer Specifies the memory containing the DMA buffer.

Returns: True if successful; otherwise false.

Definition at line 2886 of file ntv2publicinterface.cpp.

◆ SetBuffer() [2/2]

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

inline

Sets the buffer to use for streaming.

Parameters

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

Returns: True if successful; otherwise false.

Definition at line 8627 of file ntv2publicinterface.h.

◆ SetChannel()

bool NTV2DmaStream::SetChannel ( const NTV2Channel inChannel )

Sets the video channel to use for streaming.

Parameters

inChannel Specifies the video channel.

Returns: True if successful; otherwise false.

Definition at line 2892 of file ntv2publicinterface.cpp.

◆ SetFlags()

void NTV2DmaStream::SetFlags ( const ULWord inFlags )

inline

Sets the action flags.

Parameters

inFlags Specifies action flags (fragment, swap, etc)

Definition at line 8641 of file ntv2publicinterface.h.

Member Data Documentation

◆ mBuffer

NTV2_POINTER NTV2DmaStream::mBuffer

Virtual address of a DMA stream buffer and its length.

Definition at line 8570 of file ntv2publicinterface.h.

◆ mChannel

NTV2Channel NTV2DmaStream::mChannel

Video stream channel.

Definition at line 8571 of file ntv2publicinterface.h.

◆ mFlags

ULWord NTV2DmaStream::mFlags

Action flags (lock, unlock, etc)

Definition at line 8572 of file ntv2publicinterface.h.

◆ mHeader

NTV2_HEADER NTV2DmaStream::mHeader

The common structure header – ALWAYS FIRST!

Definition at line 8569 of file ntv2publicinterface.h.

◆ mReserved

ULWord NTV2DmaStream::mReserved[32]

Reserved for future expansion.

Definition at line 8574 of file ntv2publicinterface.h.

◆ mStatus

ULWord NTV2DmaStream::mStatus

Action status.

Definition at line 8573 of file ntv2publicinterface.h.

◆ mTrailer

NTV2_TRAILER NTV2DmaStream::mTrailer

The common structure trailer – ALWAYS LAST!

Definition at line 8575 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

◆ NTV2DmaStream() [1/4]

◆ NTV2DmaStream() [2/4]

◆ NTV2DmaStream() [3/4]

◆ NTV2DmaStream() [4/4]

Member Function Documentation

◆ Clear()

◆ Print()

◆ SetBuffer() [1/2]

◆ SetBuffer() [2/2]

◆ SetChannel()

◆ SetFlags()

Member Data Documentation

◆ mBuffer

◆ mChannel

◆ mFlags

◆ mHeader

◆ mReserved

◆ mStatus

◆ mTrailer