OPAL  Version 3.10.4
OpalLocalMediaStream Class Reference

#include <localep.h>

Inheritance diagram for OpalLocalMediaStream:
OpalMediaStream OpalMediaStreamPacing

Public Member Functions

Construction
 OpalLocalMediaStream (OpalLocalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, bool isSynchronous)
Overrides of OpalMediaStream class
virtual PBoolean ReadPacket (RTP_DataFrame &packet)
virtual PBoolean WritePacket (RTP_DataFrame &packet)
virtual PBoolean ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual PBoolean IsSynchronous () const

Protected Attributes

bool m_isSynchronous

Detailed Description

Local media stream. This class represents a media stream on the local machine that can receive media via virtual functions.


Constructor & Destructor Documentation

OpalLocalMediaStream::OpalLocalMediaStream ( OpalLocalConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
bool  isSource,
bool  isSynchronous 
)

Construct a new media stream for local system.

Parameters:
connConnection for media stream
mediaFormatMedia format for stream
sessionIDSession number for stream
isSourceIs a source stream
isSynchronousCan accept data and block accordingly

Member Function Documentation

virtual PBoolean OpalLocalMediaStream::IsSynchronous ( ) const [virtual]

Indicate if the media stream is synchronous. Returns true for LID streams.

Implements OpalMediaStream.

virtual PBoolean OpalLocalMediaStream::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:
dataData buffer to read to
sizeSize of buffer
lengthLength of data actually read

Reimplemented from OpalMediaStream.

virtual PBoolean OpalLocalMediaStream::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.

virtual PBoolean OpalLocalMediaStream::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:
dataData to write
lengthLength of data to read.
writtenLength of data actually written

Reimplemented from OpalMediaStream.

virtual PBoolean OpalLocalMediaStream::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.


Field Documentation


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