Declares data types and structures used in NTV2 "nub" packets. More...

#include "ntv2endian.h"
#include <vector>

Include dependency graph for ntv2nubtypes.h:

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

Namespaces
	ntv2nub

Macros
#define	NTV2_NUB_RGCHK(_cnt_)

Typedefs
typedef ULWord	NTV2NubProtocolVersion

typedef std::vector< uint8_t >	RPCBlob

Functions
const bool	ntv2nub::kDisableByteSwap (true)

const bool	ntv2nub::kEnableByteSwapIfNeeded (false)

PUSH Functions
These functions are used to encode 8/16/32/64-bit fields of NTV2 objects/structs into a byte sequence to send to a remote machine.
void	ntv2nub::PUSHU8 (const uint8_t val, RPCBlob &blob)
	Pushes an 8-bit value onto the given byte sequence. More...

void	ntv2nub::PUSHU16 (const uint16_t val, RPCBlob &blob, const bool dontSwap=false)
	Pushes a 16-bit value onto the given byte sequence. More...

void	ntv2nub::PUSHU32 (const uint32_t val, RPCBlob &blob, const bool dontSwap=false)
	Pushes a 32-bit value onto the given byte sequence. More...

void	ntv2nub::PUSHU64 (const uint64_t val, RPCBlob &blob, const bool dontSwap=false)
	Pushes a 64-bit value onto the given byte sequence. More...

POP Functions
These functions are used to decode NTV2 objects/structs from a received byte sequence.
bool	ntv2nub::POPU8 (uint8_t &outVal, const RPCBlob &blob, std::size_t &inOutNdx)
	Pops an 8-bit value off the given byte sequence at the given zero-based index position. More...

bool	ntv2nub::POPU16 (uint16_t &outVal, const RPCBlob &blob, std::size_t &inOutNdx, const bool dontSwap=false)
	Pops a 16-bit value off the given byte sequence at the given zero-based index position. More...

bool	ntv2nub::POPU32 (uint32_t &outVal, const RPCBlob &blob, std::size_t &inOutNdx, const bool dontSwap=false)
	Pops a 32-bit value off the given byte sequence at the given zero-based index position. More...

bool	ntv2nub::POPU64 (uint64_t &outVal, const RPCBlob &blob, std::size_t &inOutNdx, const bool dontSwap=false)
	Pops a 64-bit value off the given byte sequence at the given zero-based index position. More...

Detailed Description

Declares data types and structures used in NTV2 "nub" packets.

Copyright: (C) 2006-2022 AJA Video Systems, Inc.

Definition in file ntv2nubtypes.h.

Macro Definition Documentation

◆ NTV2_NUB_RGCHK

#define NTV2_NUB_RGCHK ( _cnt_ )

Definition at line 93 of file ntv2nubtypes.h.

Typedef Documentation

◆ NTV2NubProtocolVersion

typedef ULWord NTV2NubProtocolVersion

Definition at line 16 of file ntv2nubtypes.h.

◆ RPCBlob

typedef std::vector<uint8_t> RPCBlob

Definition at line 19 of file ntv2nubtypes.h.

Namespaces

Macros