OpalMediaPatch Class Reference
#include <patch.h>
List of all members.
Detailed Description
Media stream "patch cord". This class is the thread of control that transfers data from one "source" OpalMediStream to one or more other "sink" OpalMediStream instances. It may use zero, one or two intermediary software codecs for each sink stream in order to match the media data formats the streams are capabile of doing natively.
Note the thread is not actually started straight away. It is expected that the Start() function is called on the patch when the creator code is ready for it to begin. For example all sink streams have been added.
Constructor & Destructor Documentation
Create a new patch. Note the thread is not started here.
- Parameters:
-
| source | Source media stream |
OpalMediaPatch::~OpalMediaPatch |
( |
|
) |
|
Member Function Documentation
Add a filter to the media pipeline. Use PDECLARE_NOTIFIER(RTP_DataFrame, YourClass, YourFunction) for the filter function notifier.
Add another "sink" OpalMediaStream to patch. The stream must not be a ReadOnly media stream for the patch to be able to write to it.
- Parameters:
-
| stream | Media stream to add. |
virtual void OpalMediaPatch::Close |
( |
|
) |
[virtual] |
Close the patch. This is an internal function that closes all of the sink streams and waits for the the thread to terminate. It is called when the source stream is called.
bool OpalMediaPatch::DispatchFrame |
( |
RTP_DataFrame & |
frame |
) |
[protected] |
virtual PBoolean OpalMediaPatch::ExecuteCommand |
( |
const OpalMediaCommand & |
command, |
|
|
PBoolean |
fromSink | |
|
) |
| | [virtual] |
Execute the command specified to the transcoder. The commands are highly context sensitive, for example VideoFastUpdate would only apply to a video transcoder.
The default behaviour passes the command on to the source or sinks and the sinks transcoders.
- Parameters:
-
| command | Command to execute. |
| fromSink | Flag for source or sink |
Filter a frame. Calls all filter functions.
virtual OpalTranscoder* OpalMediaPatch::GetAndLockSinkTranscoder |
( |
PINDEX |
i = 0 |
) |
const [virtual] |
Get the transcoder used within a sink stream
Get the media stream for a sink stream
Get the media format for a sink stream
Get the current source stream for patch.
virtual void OpalMediaPatch::GetStatistics |
( |
OpalMediaStatistics & |
statistics, |
|
|
bool |
fromSink | |
|
) |
| | const [virtual] |
virtual void OpalMediaPatch::Main |
( |
|
) |
[protected, virtual] |
Called from the associated patch thread
virtual bool OpalMediaPatch::OnPatchStart |
( |
|
) |
[virtual] |
Indicate the patch has started. Typically called from the beginning of the patch thread.
Default behaviour make sure jitter buffer is created.
Returns bool indicating all media streams are asynchronous so the patch should assure no thread startvation
void OpalMediaPatch::PrintOn |
( |
ostream & |
strm |
) |
const |
Standard stream print function. The PObject class has a << operator defined that calls this function polymorphically.
- Parameters:
-
| strm | Stream to output text representation |
virtual PBoolean OpalMediaPatch::PushFrame |
( |
RTP_DataFrame & |
|
) |
[inline, virtual] |
Remove a filter from the media pipeline.
Add existing "sink" OpalMediaStream to patch. If the stream is not a sink of this patch then this function does nothing.
- Parameters:
-
| stream | Media stream to remove |
virtual void OpalMediaPatch::SetCommandNotifier |
( |
const PNotifier & |
notifier, |
|
|
PBoolean |
fromSink | |
|
) |
| | [virtual] |
Set a notifier to receive commands generated by the transcoder. The commands are highly context sensitive, for example VideoFastUpdate would only apply to a video transcoder.
The default behaviour passes the command on to the source or sinks and the sinks transcoders.
- Parameters:
-
| notifier | Command to execute. |
| fromSink | Flag for source or sink |
virtual void OpalMediaPatch::Start |
( |
|
) |
[virtual] |
Start the patch. The default implementation simply starts the patch thread, which in turn calls Main()
Reimplemented in OpalPassiveMediaPatch.
virtual void OpalMediaPatch::UnLockSinkTranscoder |
( |
|
) |
const [virtual] |
virtual bool OpalMediaPatch::UpdateMediaFormat |
( |
const OpalMediaFormat & |
mediaFormat |
) |
[virtual] |
Update the source/sink media format. This can be used to adjust the parameters of a codec at run time. Note you cannot change the basic media format, eg change GSM0610 to G.711, only options for that format, eg 6k3 mode to 5k3 mode in G.723.1. If the formats are different then a OpalMediaFormat::Merge() is performed.
The default behaviour updates the source/sink media stream and the output side of any relevant transcoders.
- Parameters:
-
| mediaFormat | New media format |
Member Data Documentation
The documentation for this class was generated from the following file: