A class that defines the interface between the MIP SDK and stream-based content.
More...
#include <stream.h>
|
| virtual int64_t | Read (uint8_t *buffer, int64_t bufferLength)=0 |
| | Read into a buffer from the stream.
|
| |
| virtual int64_t | Write (const uint8_t *buffer, int64_t bufferLength)=0 |
| | Write into the stream from a buffer.
|
| |
| virtual bool | Flush ()=0 |
| | flush the stream.
|
| |
| virtual void | Seek (int64_t position)=0 |
| | Seek specific position within the stream.
|
| |
| virtual bool | CanRead () const =0 |
| | A check if stream can be read from.
|
| |
| virtual bool | CanWrite () const =0 |
| | A check if stream can be written to.
|
| |
| virtual int64_t | Position ()=0 |
| | Get the current position within the stream.
|
| |
| virtual int64_t | Size ()=0 |
| | Get the size of the content within the stream.
|
| |
| virtual void | Size (int64_t value)=0 |
| | Set the stream size.
|
| |
A class that defines the interface between the MIP SDK and stream-based content.
◆ CanRead()
| virtual bool Stream::CanRead |
( |
| ) |
const |
|
pure virtual |
A check if stream can be read from.
- Returns
- true if readable else false.
◆ CanWrite()
| virtual bool Stream::CanWrite |
( |
| ) |
const |
|
pure virtual |
A check if stream can be written to.
- Returns
- true if writeable else false.
◆ Flush()
| virtual bool Stream::Flush |
( |
| ) |
|
|
pure virtual |
flush the stream.
- Returns
- true if successful else false.
◆ Position()
| virtual int64_t Stream::Position |
( |
| ) |
|
|
pure virtual |
Get the current position within the stream.
- Returns
- position within the stream.
◆ Read()
| virtual int64_t Stream::Read |
( |
uint8_t * | buffer, |
|
|
int64_t | bufferLength ) |
|
pure virtual |
Read into a buffer from the stream.
- Parameters
-
| buffer | pointer to a buffer |
| bufferLength | buffer size. |
- Returns
- number of bytes read.
◆ Seek()
| virtual void Stream::Seek |
( |
int64_t | position | ) |
|
|
pure virtual |
Seek specific position within the stream.
- Parameters
-
| position | to seek into stream. |
◆ Size() [1/2]
| virtual int64_t Stream::Size |
( |
| ) |
|
|
pure virtual |
Get the size of the content within the stream.
- Returns
- the stream size.
◆ Size() [2/2]
| virtual void Stream::Size |
( |
int64_t | value | ) |
|
|
pure virtual |
Set the stream size.
- Parameters
-
◆ Write()
| virtual int64_t Stream::Write |
( |
const uint8_t * | buffer, |
|
|
int64_t | bufferLength ) |
|
pure virtual |
Write into the stream from a buffer.
- Parameters
-
| buffer | pointer to a buffer |
| bufferLength | buffer size. |
- Returns
- number of bytes written.
The documentation for this class was generated from the following file:
- /home/mbaldwin/docs/mip-sdk-for-cpp/src/api/mip/stream.h
