OPAL Version 3.10.4

- Main Page
- Related Pages
- Namespaces
- Data Structures
- Files

- Data Structures
- Class Hierarchy
- Data Fields

Public Member Functions | Protected Attributes
OpalLineMediaStream Class Reference

`#include <lidep.h>`

Inheritance diagram for OpalLineMediaStream:

## Public Member Functions

| ~OpalLineMediaStream ()
Construction
| OpalLineMediaStream (OpalLineConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, PBoolean isSource, OpalLine &line)
Overrides of OpalMediaStream class
virtual PBoolean | Open ()
virtual PBoolean | Close ()
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 | SetDataSize (PINDEX dataSize, PINDEX frameTime)
virtual PBoolean | IsSynchronous () const
virtual PBoolean | RequiresPatchThread (OpalMediaStream *stream) const
Member variable access
OpalLine & | GetLine ()
Public Member Functions inherited from OpalMediaStream
void | PrintOn (ostream &strm) const
virtual OpalMediaFormat | GetMediaFormat () const
bool | UpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual bool | InternalUpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual PBoolean | ExecuteCommand (const OpalMediaCommand &command)
virtual PBoolean | Start ()
virtual void | OnStartMediaPatch ()
virtual void | OnStopMediaPatch (OpalMediaPatch &patch)
virtual PBoolean | WritePackets (RTP_DataFrameList &packets)
bool | PushPacket (RTP_DataFrame &packet)
PINDEX | GetDataSize () const
virtual PBoolean | RequiresPatchThread () const
virtual bool | EnableJitterBuffer (bool enab=true) const
OpalConnection & | GetConnection () const
bool | IsSource () const
bool | IsSink () const
unsigned | GetSessionID () const
void | SetSessionID (unsigned id)
PString | GetID () const
unsigned | GetTimestamp () const
void | SetTimestamp (unsigned ts)
bool | GetMarker () const
void | SetMarker (bool m)
bool | IsPaused () const
virtual bool | SetPaused (bool pause, bool fromPatch=false)
bool | IsOpen () const
virtual PBoolean | SetPatch (OpalMediaPatch *patch)
OpalMediaPatch * | GetPatch () const
void | AddFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat()) const
bool | RemoveFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat()) const
virtual void | GetStatistics (OpalMediaStatistics &statistics, bool fromPatch=false) const
| ~OpalMediaStream ()

## Protected Attributes

OpalLine & | line
bool | notUsingRTP
bool | useDeblocking
unsigned | missedCount
BYTE | lastSID [4]
bool | lastFrameWasSignal
unsigned | directLineNumber
Protected Attributes inherited from OpalMediaStream
OpalConnection & | connection
unsigned | sessionID
PString | identifier
OpalMediaFormat | mediaFormat
bool | m_paused
bool | isSource
bool | isOpen
PINDEX | defaultDataSize
unsigned | timestamp
bool | marker
unsigned | mismatchedPayloadTypes
OpalMediaPatch * | mediaPatch
RTP_DataFrame::PayloadTypes | m_payloadType
unsigned | m_frameTime
PINDEX | m_frameSize

## Additional Inherited Members

Protected Member Functions inherited from OpalMediaStream
void | IncrementTimestamp (PINDEX size)
bool | InternalWriteData (const BYTE *data, PINDEX length, PINDEX &written)
| OpalMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

## 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,
|  | PBoolean | isSource,
|  | OpalLine & | line
| ) |  |

Construct a new media stream for Line Interface Devices.

Parameters:

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

OpalLineMediaStream::~OpalLineMediaStream | ( |  | ) |

## Member Function Documentation

virtual PBoolean OpalLineMediaStream::Close | ( |  | ) |

virtual

Close the media stream.

       The default does nothing.

Reimplemented from OpalMediaStream.

OpalLine& OpalLineMediaStream::GetLine | ( |  | ) |

inline

Get the line being used by this media stream.

References line.

virtual PBoolean OpalLineMediaStream::IsSynchronous | ( |  | ) | const

virtual

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

Implements OpalMediaStream.

virtual PBoolean 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 PBoolean 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 PBoolean OpalLineMediaStream::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 OpalLineMediaStream::RequiresPatchThread | ( | OpalMediaStream * | stream | ) | const

virtual

Indicate if the media stream requires a OpalMediaPatch thread (active patch). This is called on the source/sink stream and is passed the sink/source stream that the patch will initially be using. The function could conditionally require the patch thread to execute a thread reading and writing data, or prevent it from doing so as it can do so in hardware in some way.

The default behaviour here determines if both streams are on the same OpalLineInterfaceDevice and returns false if so.

Parameters:

  stream | Other stream in patch

Reimplemented from OpalMediaStream.

virtual PBoolean OpalLineMediaStream::SetDataSize | ( | PINDEX | dataSize,
|  | PINDEX | frameTime
| ) |  |

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 (in total)
  frameTime | Individual frame time (if applicable)

Reimplemented from OpalMediaStream.

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

unsigned OpalLineMediaStream::directLineNumber

protected

bool OpalLineMediaStream::lastFrameWasSignal

protected

BYTE OpalLineMediaStream::lastSID[4]

protected

OpalLine& OpalLineMediaStream::line

protected

Referenced by GetLine().

unsigned OpalLineMediaStream::missedCount

protected

bool OpalLineMediaStream::notUsingRTP

protected

bool OpalLineMediaStream::useDeblocking

protected

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

- lidep.h