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

This is the generic AVM configuration structure which describes the format of each stream. More...

#include <cdi_avm_api.h>

Data Fields

char uri [257]
 
uint8_t data [1024]
 
int data_size
 The length of the data in bytes. Valid values are 0 through 1024, inclusive.
 

Detailed Description

This is the generic AVM configuration structure which describes the format of each stream.

Field Documentation

◆ data

uint8_t CdiAvmConfig::data[1024]

This data further describes the specifics of the stream where the specification pointed at by the URI has variables such as resolution, sampling rate, bit depth, etc. How this data is interpreted is determined by the uri member. Its length, which is specified by the data_size member, is limited to 1024 bytes.

◆ uri

char CdiAvmConfig::uri[257]

The URI unambiguously specifies the type (audio, video, ancillary data, or other) of data comprising an AVM stream within an AVM connection. Typically, it will be a URL to a document that describes how to interpret the bytes of the enclosing structure's data member as well as how payload data is to be formatted. As such, the scheme portion of the URI will normally be "http" or "https". In order to assure uniqueness of the URI, the host portion must be specified with its fully qualified domain name which must be registered with ICANN. The path component, and optional query and fragment parts, of the URI further define precisely the specification of the stream's data.

This is a C NUL terminated string whose length is limited to 256 characters. Reserved characters in the host, path, query, and fragment must be "percent-encoded". See RFC 3986 for details on percent encoding and which characters are reserved.


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