ntv2vpidfromspec.h File Reference

Declares functions for the C implementations of VPID generation from a VPIDSpec. More...

#include "ajaexport.h"
#include "ntv2publicinterface.h"

Include dependency graph for ntv2vpidfromspec.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	VPIDSpec
	Contains all the information needed to generate a valid VPID. More...
struct	VPIDControl

Enumerations
enum	VPIDFlags {   dualStreamFlag = (1u << ( 0 )), output3GFlag = (1u << ( 1 )), output3GbFlag = (1u << ( 2 )), SMPTE425Flag = (1u << ( 3 )),   DC4KInPath = (1u << ( 4 )), CSCInPath = (1u << ( 5 )), KeySignal = (1u << ( 6 )) }

Functions
bool	SetVPIDFromSpec (ULWord *const pOutVPID, const VPIDSpec *const pInVPIDSpec)
	Generates a VPID based on the supplied specification. More...

Detailed Description

Declares functions for the C implementations of VPID generation from a VPIDSpec.

Copyright

(C) 2004-2022 AJA Video Systems, Inc.

Note

This file is included in driver builds. It must not contain any C++.

Definition in file ntv2vpidfromspec.h.

Enumeration Type Documentation

VPIDFlags

enum VPIDFlags

Enumerator
dualStreamFlag
output3GFlag
output3GbFlag
SMPTE425Flag
DC4KInPath
CSCInPath
KeySignal

Definition at line 46 of file ntv2vpidfromspec.h.

Function Documentation

SetVPIDFromSpec()

bool SetVPIDFromSpec	(	ULWord *const	pOutVPID,
		const VPIDSpec *const	pInVPIDSpec
	)

Generates a VPID based on the supplied specification.

Parameters

[out]	pOutVPID	Specifies the location where the generated VPID will be stored.
[in]	pInVPIDSpec	Specifies the location of the settings describing the VPID to be generated.

Returns

True if generation was successful, otherwise false.

Definition at line 27 of file ntv2vpidfromspec.cpp.