AOIStream

Stream object

Synopsis:

#include <aoi.h>

typedef struct AOIStream AOIStream_t;

Description:

The AOIStream_t data type is private and defines a stream object, which simplifies usage of the AOStreamer interface. When you create a stream, the interface returns a pointer to an AOIStream_t object. You must pass in this pointer when closing the stream, and pass in the context data when seeking, reading, writing, or retrieving information from the stream.

The structure contains at least the following members:

const char *filespec: The name of the open file/stream.
const AOStreamer *streamer: The interface instance being used to stream the data.
const AOICtrl_t *control: A pointer to the interface control structure, if the interface is from an addon.
void *ctx: The streamer context; the data it points to are specific to the streamer.

Classification:

QNX Neutrino