OSRTSTREAM Struct Reference

#include <rtxStream.h>

Public Attributes
OSRTStreamReadProc	read
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

bufsize

size_t OSRTSTREAM::bufsize

physical size of pctxt->buffer.data buffer. pctxt->buffer.size represents the logical size - the amount of actual data held in the buffer.

bytesProcessed

size_t OSRTSTREAM::bytesProcessed

the number of bytes processed by the application program

close

OSRTStreamCloseProc OSRTSTREAM::close

pointer to close function

extra

void* OSRTSTREAM::extra

pointer to stream-specific data

flags

OSUINT16 OSRTSTREAM::flags

flags (see OSRTSTRMF_* macros

flush

OSRTStreamFlushProc OSRTSTREAM::flush

pointer to flush function

getPos

OSRTStreamGetPosProc OSRTSTREAM::getPos

pointer to getPos function

id

OSUINT32 OSRTSTREAM::id

id of stream (see OSRTSTRMID_* macros)

ioBytes

size_t OSRTSTREAM::ioBytes

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

mark

OSRTStreamMarkProc OSRTSTREAM::mark

pointer to mark function

markedBytesProcessed

size_t OSRTSTREAM::markedBytesProcessed

the marked number of bytes already processed

nextMarkOffset

size_t OSRTSTREAM::nextMarkOffset

offset of next appropriate mark position

pCaptureBuf

OSRTMEMBUF* OSRTSTREAM::pCaptureBuf

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

read

OSRTStreamReadProc OSRTSTREAM::read

pointer to read function

readAheadLimit

size_t OSRTSTREAM::readAheadLimit

read ahead limit (used by rtxStreamMark/rtxStreamReset

reset

OSRTStreamResetProc OSRTSTREAM::reset

pointer to reset function

segsize

size_t OSRTSTREAM::segsize

size of decoded segment

setPos

OSRTStreamSetPosProc OSRTSTREAM::setPos

pointer to setPos function

skip

OSRTStreamSkipProc OSRTSTREAM::skip

pointer to skip function

write

OSRTStreamWriteProc OSRTSTREAM::write

pointer to write function

---

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

• rtxStream.h