OpalIMMediaStream Class Reference

#include <im.h>

Inheritance diagram for OpalIMMediaStream:

OpalMediaStream OpalMSRPMediaStream

Public Member Functions

 OpalIMMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)
virtual PBoolean IsSynchronous () const
virtual PBoolean RequiresPatchThread () const
bool ReadPacket (RTP_DataFrame &packet)
bool WritePacket (RTP_DataFrame &packet)

Constructor & Destructor Documentation

OpalIMMediaStream::OpalIMMediaStream ( OpalConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
bool  isSource 
)

Parameters:
mediaFormat  Media format for stream
sessionID  Session number for stream
isSource  Is a source stream


Member Function Documentation

virtual PBoolean OpalIMMediaStream::IsSynchronous (  )  const [inline, virtual]

Indicate if the media stream is synchronous. If this returns true then the media stream will block of the amount of time it takes to annunciate the data. For example if the media stream is over a sound card, and 480 bytes of data are to be written it will take 30 milliseconds to complete.

Implements OpalMediaStream.

bool OpalIMMediaStream::ReadPacket ( RTP_DataFrame packet  )  [virtual]

Read an RTP frame of data from the source media stream. The default behaviour simply calls ReadData() on the data portion of the RTP_DataFrame and sets the frames timestamp and marker from the internal member variables of the media stream class.

Reimplemented from OpalMediaStream.

Reimplemented in OpalMSRPMediaStream.

virtual PBoolean OpalIMMediaStream::RequiresPatchThread (  )  const [inline, virtual]

Reimplemented from OpalMediaStream.

Reimplemented in OpalMSRPMediaStream.

bool OpalIMMediaStream::WritePacket ( RTP_DataFrame packet  )  [virtual]

Write an RTP frame of data to the sink media stream. The default behaviour simply calls WriteData() on the data portion of the RTP_DataFrame and and sets the internal timestamp and marker from the member variables of the media stream class.

Reimplemented from OpalMediaStream.

Reimplemented in OpalMSRPMediaStream.


The documentation for this class was generated from the following file:
Generated on Mon Feb 21 20:19:23 2011 for OPAL by  doxygen 1.4.7