OpalIAX2MediaStream Class Reference

#include <iax2medstrm.h>

Inheritance diagram for OpalIAX2MediaStream:

List of all members.

Public Member Functions
Construction
	OpalIAX2MediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, BOOL isSource, unsigned minJitterDelay, unsigned maxJitterDelay, IAX2Connection &con)
Overrides of OpalMediaStream class
virtual BOOL	Open ()
virtual BOOL	Start ()
virtual BOOL	Close ()
virtual BOOL	ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual BOOL	WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual BOOL	IsSynchronous () const
Protected Attributes
IAX2Connection &	connection
PBYTEArray	pendingData
unsigned	minAudioJitterDelay
unsigned	maxAudioJitterDelay

---

Detailed Description

This class describes a media stream, which is an interface to the opal classes for generating encoded media data

---

Constructor & Destructor Documentation

OpalIAX2MediaStream::OpalIAX2MediaStream (  const OpalMediaFormat &  mediaFormat, unsigned  sessionID, BOOL  isSource, unsigned  minJitterDelay, unsigned  maxJitterDelay, IAX2Connection &  con )

Construct a new media stream for connecting to the media Parameters: mediaFormat  Media format for stream sessionID  Session number for stream isSource  Is a source stream minJitterDelay  Minimum delay from jitter buffer (ms) maxJitterDelay  Maximum delay from jitter buffer (ms) con  IAX connection to read/send incoming packets

---

Member Function Documentation

virtual BOOL OpalIAX2MediaStream::Close (   )  [virtual]

Close the media stream. The default does nothing. Reimplemented from OpalMediaStream.

virtual BOOL OpalIAX2MediaStream::IsSynchronous (   )  const [virtual]

Indicate if the media stream is synchronous. A synchronous stream is one that is regular, such as the sound frames from a sound card. Implements OpalMediaStream.

virtual BOOL OpalIAX2MediaStream::Open (   )  [virtual]

Open the media stream. Reimplemented from OpalMediaStream.

virtual BOOL OpalIAX2MediaStream::ReadData (  BYTE *  data, PINDEX  size, PINDEX &  length )  [virtual]

Read raw media data from the source media stream. The default behaviour reads from the OpalLine object. Parameters: size  Data buffer to read to length  Size of buffer Length of data actually read Reimplemented from OpalMediaStream.

virtual BOOL OpalIAX2MediaStream::Start (   )  [virtual]

Start the media stream. The default behaviour calls Resume() on the associated OpalMediaPatch thread if it was suspended. Reimplemented from OpalMediaStream.

virtual BOOL OpalIAX2MediaStream::WriteData (  const BYTE *  data, PINDEX  length, PINDEX &  written )  [virtual]

Write raw media data to the sink media stream. The default behaviour writes to the OpalLine object. Parameters: length  Data to write written  Length of data to read. Length of data actually written Reimplemented from OpalMediaStream.

---

Member Data Documentation

IAX2Connection& OpalIAX2MediaStream::connection [protected]

The connection is the source/sink of our data packets

unsigned OpalIAX2MediaStream::maxAudioJitterDelay [protected]

The endpoint has specified the max delay from a jitter buffer

unsigned OpalIAX2MediaStream::minAudioJitterDelay [protected]

The endpoint has specified the min delay from a jitter buffer

PBYTEArray OpalIAX2MediaStream::pendingData [protected]

There was unused data from an incoming ethernet frame. The unused data is stored here.

---

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

• iax2medstrm.h

---