OpalLineMediaStream Class Reference

#include <lidep.h>

Inheritance diagram for OpalLineMediaStream:

List of all members.

Public Member Functions
Overrides of OpalMediaStream class
virtual BOOL	Open ()
virtual BOOL	Close ()
virtual BOOL	ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual BOOL	WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual BOOL	SetDataSize (PINDEX dataSize)
virtual BOOL	IsSynchronous () const
Member variable access
OpalLine &	GetLine ()
Protected Attributes
OpalLine &	line
BOOL	useDeblocking
unsigned	missedCount
BYTE	lastSID [4]
BOOL	lastFrameWasSignal

---

Detailed Description

This class describes a media stream that transfers data to/from a Line Interface Device.

---

Constructor & Destructor Documentation

OpalLineMediaStream::OpalLineMediaStream	(	OpalLineConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		BOOL	isSource,
		OpalLine &	line
	)

Construct a new media stream for Line Interface Devices.

Parameters:

mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream
line	LID line to stream to/from

OpalLineMediaStream::OpalLineMediaStream	(	OpalLineConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		BOOL	isSource,
		OpalLine &	line
	)

Construct a new media stream for Line Interface Devices.

Parameters:

mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream
line	LID line to stream to/from

---

Member Function Documentation

virtual BOOL OpalLineMediaStream::Open

(

)

[virtual]

Open the media stream.

The default behaviour sets the OpalLineInterfaceDevice format and calls Resume() on the associated OpalMediaPatch thread.

Reimplemented from OpalMediaStream.

virtual BOOL OpalLineMediaStream::Close

(

)

[virtual]

Close the media stream.

The default does nothing.

Reimplemented from OpalMediaStream.

virtual BOOL OpalLineMediaStream::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:

data	Data buffer to read to
size	Size of buffer
length	Length of data actually read

Reimplemented from OpalMediaStream.

virtual BOOL OpalLineMediaStream::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:

data	Data to write
length	Length of data to read.
written	Length of data actually written

Reimplemented from OpalMediaStream.

virtual BOOL OpalLineMediaStream::SetDataSize

(

PINDEX

dataSize

)

[virtual]

Set the data size in bytes that is expected to be used. Some media streams can make use of this information to perform optimisations.

The default behaviour does nothing.

Parameters:

dataSize

New data size

Reimplemented from OpalMediaStream.

virtual BOOL OpalLineMediaStream::IsSynchronous

(

)

const [virtual]

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

Implements OpalMediaStream.

OpalLine& OpalLineMediaStream::GetLine

(

)

[inline]

Get the line being used by this media stream.

---

Member Data Documentation

OpalLine& OpalLineMediaStream::line [protected]

BOOL OpalLineMediaStream::useDeblocking [protected]

unsigned OpalLineMediaStream::missedCount [protected]

BYTE OpalLineMediaStream::lastSID[4] [protected]

BOOL OpalLineMediaStream::lastFrameWasSignal [protected]

---

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

• lidep.h

---