OpalRTPMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalRTPMediaStream:

OpalMediaStream List of all members.

Public Member Functions

Construction
 OpalRTPMediaStream (const OpalMediaFormat &mediaFormat, BOOL isSource, RTP_Session &rtpSession, unsigned minAudioJitterDelay, unsigned maxAudioJitterDelay)
Overrides of OpalMediaStream class
virtual BOOL Open ()
virtual BOOL Close ()
virtual BOOL ReadPacket (RTP_DataFrame &packet)
virtual BOOL WritePacket (RTP_DataFrame &packet)
virtual BOOL IsSynchronous () const
virtual void EnableJitterBuffer () const

Protected Attributes

RTP_SessionrtpSession
unsigned minAudioJitterDelay
unsigned maxAudioJitterDelay

Detailed Description

This class describes a media stream that transfers data to/from a RTP session.


Constructor & Destructor Documentation

OpalRTPMediaStream::OpalRTPMediaStream ( const OpalMediaFormat mediaFormat,
BOOL  isSource,
RTP_Session rtpSession,
unsigned  minAudioJitterDelay,
unsigned  maxAudioJitterDelay 
)

Construct a new media stream for RTP sessions.

Parameters:
mediaFormat  Media format for stream
isSource  Is a source stream
rtpSession  RTP session to stream to/from
minAudioJitterDelay  Minimum jitter buffer size (if applicable)
maxAudioJitterDelay  Maximum jitter buffer size (if applicable)


Member Function Documentation

virtual BOOL OpalRTPMediaStream::Close (  )  [virtual]

Close the media stream.

The default does nothing.

Reimplemented from OpalMediaStream.

virtual void OpalRTPMediaStream::EnableJitterBuffer (  )  const [virtual]

Enable jitter buffer for the media stream.

The default behaviour does nothing.

Reimplemented from OpalMediaStream.

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

Indicate if the media stream is synchronous. Returns FALSE for RTP streams.

Implements OpalMediaStream.

virtual BOOL OpalRTPMediaStream::Open (  )  [virtual]

Open the media stream using the media format.

The default behaviour simply sets the isOpen variable to TRUE.

Reimplemented from OpalMediaStream.

virtual BOOL OpalRTPMediaStream::ReadPacket ( RTP_DataFrame packet  )  [virtual]

Read an RTP frame of data from the source media stream. The new behaviour simply calls RTP_Session::ReadData().

Reimplemented from OpalMediaStream.

virtual BOOL OpalRTPMediaStream::WritePacket ( RTP_DataFrame packet  )  [virtual]

Write an RTP frame of data to the sink media stream. The new behaviour simply calls RTP_Session::WriteData().

Reimplemented from OpalMediaStream.


Member Data Documentation

unsigned OpalRTPMediaStream::maxAudioJitterDelay [protected]

unsigned OpalRTPMediaStream::minAudioJitterDelay [protected]

RTP_Session& OpalRTPMediaStream::rtpSession [protected]


The documentation for this class was generated from the following file:
Generated on Mon Sep 25 16:21:52 2006 for OPAL by  doxygen 1.4.7