CDI SDK
SDK for transporting chunks of data reliably and with low latency using a polled mode network driver.
Loading...
Searching...
No Matches
StreamSettings Struct Reference

A structure that holds all the settings for a stream as set from the command line. More...

#include <test_args.h>

Data Fields

int stream_id
 Unique stream ID.
 
int payload_size
 The payload size in bytes of the test payload.
 
bool avm_auto_rx
 For receiver, auto-detect incoming AVM data and output to log.
 
CdiBaselineAvmPayloadType avm_data_type
 If connection protocol is AVM, then this field holds the data type.
 
CdiAvmVideoConfig video_params
 Video parameters set by user with –avm_video option. Unused if not –avm_video payload type.
 
CdiAvmAudioConfig audio_params
 Audio parameters set by user with –avm_audio option. Unused if not –avm_audio payload type.
 
CdiAvmAncillaryDataConfig ancillary_data_params
 Ancillary parameters set by user with –avm_anc option. Unused if not –avm_anc payload type.
 
int config_skip
 The number of payloads to skip before sending the video or audio parameters again.
 
TestPatternType pattern_type
 Enum representing the data pattern type.
 
CdiAvmConfig avm_config
 The configuration structure to send with AVM payloads.
 
int unit_size
 
uint64_t pattern_start
 64-bit start value for the test pattern.
 
bool riff_file
 
const char * file_read_str
 
const char * file_write_str
 String defining the output file name for test data from the receiver.
 
int dest_port
 The destination port number. Only used if stream.
 
const char * remote_adapter_ip_str
 The remote network adapter IP address.
 

Detailed Description

A structure that holds all the settings for a stream as set from the command line.

Field Documentation

◆ file_read_str

const char* StreamSettings::file_read_str

String defining the input file name for test data. If this is specified for a transmitter it overrides any pattern options. If specified on the receiver the received data will be checked against this file.

◆ riff_file

bool StreamSettings::riff_file

Specifies that the files provided by file_read_str and/or file_write_str will be read and written as RIFF files, which specify the payload size along with the payload data.

◆ unit_size

int StreamSettings::unit_size

The bit size of the groups to not split across sgl entries. As an example for video avoid splitting pixels by setting this to the pixel_depth times the number of samples per pixel.


The documentation for this struct was generated from the following file: