ndi_test.h File Reference

The declarations in this header file correspond to the definitions in ndi_test.c. More...

#include <stdbool.h>
#include <stdint.h>
#include "cdi_baseline_profile_02_00_api.h"
#include "cdi_log_api.h"
#include "cdi_os_api.h"
#include "fifo_api.h"
#include "cdi_pool_api.h"
#include "ndi_wrapper.h"
#include <Processing.NDI.Lib.h>

Go to the source code of this file.

Data Structures
struct	TestSettings
	A structure that holds all the test settings for a connection as set from the command line. More...
struct	TestConnectionInfo
	A structure for storing all info related to a specific connection, including test settings, connection configuration data from the SDK, and state information for the test connection. More...

Macros
#define	DEFAULT_TX_TIMEOUT   (20000)
	Enable this define to disable use of the RX linear buffer. Packets will arrive in SGL (Scatter Gather List).
#define	TestConsoleLog   SimpleConsoleLog
	Define TestConsoleLog.

Typedefs
typedef struct TestSettings	TestSettings
	A structure that holds all the test settings as set from the command line.
typedef struct TestConnectionInfo	TestConnectionInfo
	A structure for storing all info related to a specific connection, including test settings, connection configuration data from the SDK, and state information for the test connection.

Functions
void	TestConnectionCallback (const CdiCoreConnectionCbData *cb_data_ptr)
void	LogTimestamps (TestConnectionInfo *con_info_ptr, const FrameData *frame_data_ptr, CdiPtpTimestamp *cdi_timestamp_ptr)
	If enabled using the command line option, log timestamps for every frame.

Detailed Description

The declarations in this header file correspond to the definitions in ndi_test.c.

Macro Definition Documentation

DEFAULT_TX_TIMEOUT

#define DEFAULT_TX_TIMEOUT   (20000)

Enable this define to disable use of the RX linear buffer. Packets will arrive in SGL (Scatter Gather List).

Default Tx timeout.

Typedef Documentation

TestConnectionInfo

typedef struct TestConnectionInfo TestConnectionInfo

A structure for storing all info related to a specific connection, including test settings, connection configuration data from the SDK, and state information for the test connection.

Forward reference. Contains connection state and test settings.

Forward reference.

TestSettings

typedef struct TestSettings TestSettings

A structure that holds all the test settings as set from the command line.

Forward reference.

Function Documentation

LogTimestamps()

void LogTimestamps	(	TestConnectionInfo *	con_info_ptr,
		const FrameData *	frame_data_ptr,
		CdiPtpTimestamp *	cdi_timestamp_ptr )

If enabled using the command line option, log timestamps for every frame.

Parameters

con_info_ptr	Pointer to test connection information.
frame_data_ptr	Pointer to frame data.
cdi_timestamp_ptr	Pointer to CDI timestamp to log.

TestConnectionCallback()

void TestConnectionCallback

(

const CdiCoreConnectionCbData *

cb_data_ptr

)

Handle the connection callback.

Parameters

cb_data_ptr

Pointer to core connection callback data.