SideInfo()

Updated: April 19, 2023

Synopsis:

#include <aoi.h>

int32_t (*SideInfo)(void *ctx,
                    char **sinfo,
                    int32_t *slen);

Arguments:

ctx
A pointer to the context for the stream you want to retrieve side information from.
sinfo
A pointer to space for storing the address of a new buffer containing the side information. The side information and address of the buffer are written by the function.
slen
A pointer to space for storing the length of the sinfo buffer.

Description:

This function should write the current side information for the stream in a new buffer. Specifically, it should allocate memory for and fill in the buffer, write its address at the location pointed to by sinfo, and write the side information length to the location pointed to by slen.

Note that side information can change any time, and often does, as in the case for inline information in streaming audio.

Returns:

0 if successful, -1 if an error occurs.