OPAL Version 3.10.4

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

- Data Structures
- Class Hierarchy
- Data Fields

Protected Attributes
OpalIAX2MediaStream Class Reference

`#include <iax2medstrm.h>`

Inheritance diagram for OpalIAX2MediaStream:

## Public Member Functions

Overrides of OpalMediaStream class
virtual PBoolean | Open ()
virtual PBoolean | Start ()
virtual PBoolean | Close ()
virtual PBoolean | ReadPacket (RTP_DataFrame &packet)
virtual PBoolean | WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual PBoolean | IsSynchronous () const
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 void | OnStartMediaPatch ()
virtual void | OnStopMediaPatch (OpalMediaPatch &patch)
virtual PBoolean | WritePackets (RTP_DataFrameList &packets)
virtual PBoolean | WritePacket (RTP_DataFrame &packet)
virtual PBoolean | ReadData (BYTE *data, PINDEX size, PINDEX &length)
bool | PushPacket (RTP_DataFrame &packet)
virtual PBoolean | SetDataSize (PINDEX dataSize, PINDEX frameTime)
PINDEX | GetDataSize () const
virtual PBoolean | RequiresPatchThread (OpalMediaStream *stream) 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

IAX2Connection & | connection
PBYTEArray | pendingData
Protected Attributes inherited from OpalMediaStream
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, which is an interface to the opal classes for generating encoded media data

## Member Function Documentation

virtual PBoolean OpalIAX2MediaStream::Close | ( |  | ) |

virtual

Close the media stream.

       The default does nothing.

Reimplemented from OpalMediaStream.

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

virtual

Indicate if the media stream is synchronous. false if this stream is from the network.

Returns:
  true if this stream is from a sound card.

Implements OpalMediaStream.

virtual PBoolean OpalIAX2MediaStream::Open | ( |  | ) |

virtual

Open the media stream.

Reimplemented from OpalMediaStream.

virtual PBoolean OpalIAX2MediaStream::ReadPacket | ( | RTP_DataFrame & | packet | ) |

virtual

Goes to the IAX2Connection class, and removes a packet from the connection. The connection class turned the media packet into a RTP_DataFrame class, and jitter buffered it.

Returns:
  true on successful read of a packet, false on faulty read.

Parameters:

  packet | Data buffer to read to

Reimplemented from OpalMediaStream.

virtual PBoolean OpalIAX2MediaStream::Start | ( |  | ) |

virtual

Start the media stream.

    The default behaviour calls Resume() on the associated
    OpalMediaPatch thread if it was suspended.

Reimplemented from OpalMediaStream.

virtual PBoolean OpalIAX2MediaStream::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 write.
  written | Length of data actually written

Reimplemented from OpalMediaStream.

## Field Documentation

IAX2Connection& OpalIAX2MediaStream::connection

protected

The connection is the source/sink of our data packets

Reimplemented from OpalMediaStream.

PBYTEArray OpalIAX2MediaStream::pendingData

protected

There was unused data from an incoming ethernet frame. The unused data is stored here.

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

- iax2medstrm.h