MPLAB® Harmony Graphics Suite > Graphics Library > Legato Graphics Library > Legato Interface > b) Core Functions > leStream_Init Function
MPLAB® Harmony Graphics Suite
leStream_Init Function

A stream object is a construct that is capable of making external data read requests to the application. It is responsible for opening, reading from, and closing an external device to the standard application data streaming interface. 

It can also be configured to manage a local data cache for faster data streaming speed.

C
void leStream_Init(
    leStream* stream, 
    leStreamDescriptor* desc, 
    uint32_t cacheSize, 
    uint8_t* cacheBuf, 
    void* userData
);
Parameters
Parameters 
Description 
leStream* stream 
the stream struct to initialize 
leStreamDescriptor* desc 
the stream descriptor to read from 
uint32_t cacheSize 
the size of the cache being passed in 
uint8_t* cacheBuf 
a buffer to use as a local cache 
void* userData 
a user data pointer for general purpose use 
MPLAB® Harmony Graphics Suite