OSRTSTREAM Struct Reference
[Input/Output Data Stream Utility Functions]

#include <rtxStream.h>

List of all members.

Public Attributes

OSRTStreamReadProc read
OSRTStreamBlockingReadProc blockingRead
OSRTStreamWriteProc write
OSRTStreamFlushProc flush
OSRTStreamCloseProc close
OSRTStreamSkipProc skip
OSRTStreamMarkProc mark
OSRTStreamResetProc reset
OSRTStreamGetPosProc getPos
OSRTStreamSetPosProc setPos
void * extra
size_t bufsize
size_t readAheadLimit
size_t bytesProcessed
size_t markedBytesProcessed
size_t ioBytes
size_t nextMarkOffset
size_t segsize
OSUINT32 id
OSRTMEMBUF * pCaptureBuf
OSUINT16 flags

Detailed Description

The stream control block. A user may implement a customized stream by defining read, skip, close functions for input streams and write, flush, close for output streams.

Member Data Documentation

OSRTStreamBlockingReadProc OSRTSTREAM::blockingRead

pointer to blockingRead function

size_t OSRTSTREAM::bufsize

physical size of pctxt->buffer.data buffer

size_t OSRTSTREAM::bytesProcessed

the number of bytes processed by the application program

OSRTStreamCloseProc OSRTSTREAM::close

pointer to close function

void* OSRTSTREAM::extra

pointer to stream-specific data

OSUINT16 OSRTSTREAM::flags

flags (see OSRTSTRMF_* macros

OSRTStreamFlushProc OSRTSTREAM::flush

pointer to flush function

OSRTStreamGetPosProc OSRTSTREAM::getPos

pointer to getPos function

OSUINT32 OSRTSTREAM::id

id of stream (see OSRTSTRMID_* macros)

size_t OSRTSTREAM::ioBytes

the actual number of bytes read from or written to the stream

OSRTStreamMarkProc OSRTSTREAM::mark

pointer to mark function

size_t OSRTSTREAM::markedBytesProcessed

the marked number of bytes already processed

size_t OSRTSTREAM::nextMarkOffset

offset of next appropriate mark position

OSRTMEMBUF* OSRTSTREAM::pCaptureBuf

Buffer into which data read from stream can be captured for debugging purposes.

OSRTStreamReadProc OSRTSTREAM::read

pointer to read function

size_t OSRTSTREAM::readAheadLimit

read ahead limit (used by rtxStreamMark/rtxStreamReset

OSRTStreamResetProc OSRTSTREAM::reset

pointer to reset function

size_t OSRTSTREAM::segsize

size of decoded segment

OSRTStreamSetPosProc OSRTSTREAM::setPos

pointer to setPos function

OSRTStreamSkipProc OSRTSTREAM::skip

pointer to skip function

OSRTStreamWriteProc OSRTSTREAM::write

pointer to write function

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