OpalMixerConnection Class Reference

#include <opalmixer.h>

Inheritance diagram for OpalMixerConnection:


Public Member Functions
Construction
	OpalMixerConnection (PSafePtr< OpalMixerNode > node, OpalCall &call, OpalMixerEndPoint &endpoint, void userData, unsigned options, OpalConnection::StringOptions stringOptions)
	~OpalMixerConnection ()
Overrides from OpalConnection
virtual void	OnReleased ()
virtual OpalMediaFormatList	GetMediaFormats () const
virtual OpalMediaStream *	CreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, PBoolean isSource)
virtual void	OnStartMediaPatch (OpalMediaPatch &patch)
virtual void	ApplyStringOptions (OpalConnection::StringOptions &stringOptions)
Operations
void	SetListenOnly (bool listenOnly)
bool	GetListenOnly () const
PSafePtr< OpalMixerNode >	GetNode () const
Protected Attributes
OpalMixerEndPoint &	m_endpoint
PSafePtr< OpalMixerNode >	m_node
bool	m_listenOnly

Detailed Description

Mixer connection.

Constructor & Destructor Documentation

OpalMixerConnection::OpalMixerConnection	(	PSafePtr< OpalMixerNode >	node,
		OpalCall &	call,
		OpalMixerEndPoint &	endpoint,
		void *	userData,
		unsigned	options,
		OpalConnection::StringOptions *	stringOptions
	)

Create a new connection.

Parameters:

node	Node the connection is in
call	Owner calll for connection
endpoint	Owner endpoint for connection
userData	Arbitrary data to pass to connection

OpalMixerConnection::~OpalMixerConnection ( )

Destroy connection.

Member Function Documentation

virtual void OpalMixerConnection::ApplyStringOptions ( OpalConnection::StringOptions & stringOptions ) [virtual]

Reimplemented from OpalConnection.

virtual OpalMediaStream* OpalMixerConnection::CreateMediaStream	(	const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		PBoolean	isSource
	)			`[virtual]`

Open a new media stream. This will create a media stream of an appropriate subclass as required by the underlying connection protocol. For instance H.323 would create an OpalRTPStream.

The sessionID parameter may not be needed by a particular media stream and may be ignored. In the case of an OpalRTPStream it us used.

Note that media streams may be created internally to the underlying protocol. This function is not the only way a stream can come into existance.

The default behaviour is pure.

Parameters:

mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream

Reimplemented from OpalLocalConnection.

bool OpalMixerConnection::GetListenOnly ( ) const [inline]

Get flag for this connection is in listen only mode.

virtual OpalMediaFormatList OpalMixerConnection::GetMediaFormats ( ) const [virtual]

Get the data formats this connection is capable of operating. This provides a list of media data format names that a OpalMediaStream may be created in within this connection.

The default behaviour calls GetMediaFormats() on the endpoint.

Reimplemented from OpalConnection.

PSafePtr<OpalMixerNode> OpalMixerConnection::GetNode ( ) const [inline]

Get the node that this connection is being mxied in.

virtual void OpalMixerConnection::OnReleased ( ) [virtual]

Clean up the termination of the connection. This function can do any internal cleaning up and waiting on background threads that may be using the connection object.

Note that there is not a one to one relationship with the OnEstablishedConnection() function. This function may be called without that function being called. For example if SetUpConnection() was used but the call never completed.

Classes that override this function should make sure they call the ancestor version for correct operation.

An application will not typically call this function as it is used by the OpalManager during a release of the connection.

The default behaviour calls the OpalEndPoint function of the same name.

Reimplemented from OpalConnection.

virtual void OpalMixerConnection::OnStartMediaPatch ( OpalMediaPatch & patch ) [virtual]

Call back when media stream patch thread starts.

Parameters:

patch

Patch being started

Reimplemented from OpalConnection.

void OpalMixerConnection::SetListenOnly ( bool listenOnly )

Set this connection to listen only mode.