OpalMixerEndPoint Class Reference

`#include <opalmixer.h>`

Inheritance diagram for OpalMixerEndPoint:

## Public Member Functions

Construction
| OpalMixerEndPoint (OpalManager &manager, const char *prefix)
| ~OpalMixerEndPoint ()
virtual void | ShutDown ()
Overrides from OpalEndPoint
virtual OpalMediaFormatList | GetMediaFormats () const
virtual PSafePtr< OpalConnection > | MakeConnection (OpalCall &call, const PString &party, void *userData=NULL, unsigned options=0, OpalConnection::StringOptions *stringOptions=NULL)
virtual PBoolean | GarbageCollection ()
Operations
PSafePtr< OpalMixerConnection > | GetMixerConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)
virtual OpalMixerConnection * | CreateConnection (PSafePtr< OpalMixerNode > node, OpalCall &call, void *userData, unsigned options, OpalConnection::StringOptions *stringOptions)
Mixer Operations
PSafePtr< OpalMixerNode > | AddNode (OpalMixerNodeInfo *info)
virtual OpalMixerNode * | CreateNode (OpalMixerNodeInfo *info)
PSafePtr< OpalMixerNode > | GetFirstNode (PSafetyMode mode=PSafeReference) const
PSafePtr< OpalMixerNode > | FindNode (const PString &name, PSafetyMode mode=PSafeReference)
void | RemoveNode (OpalMixerNode &node)
Member variable access
void | SetAdHocNodeInfo (const OpalMixerNodeInfo &info)
void | SetAdHocNodeInfo (OpalMixerNodeInfo *info)
OpalMixerNodeInfo * | GetAdHocNodeInfo ()
const OpalMixerNodeManager & | GetNodeManager () const
OpalMixerNodeManager & | GetNodeManager ()
Public Member Functions inherited from OpalLocalEndPoint
| OpalLocalEndPoint (OpalManager &manager, const char *prefix="local")
| ~OpalLocalEndPoint ()
virtual PSafePtr< OpalConnection > | MakeConnection (OpalCall &call, const PString &party, void *userData=NULL, unsigned int options=0, OpalConnection::StringOptions *stringOptions=NULL)
PSafePtr< OpalLocalConnection > | GetLocalConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)
virtual OpalLocalConnection * | CreateConnection (OpalCall &call, void *userData, unsigned options, OpalConnection::StringOptions *stringOptions)
virtual bool | OnOutgoingSetUp (const OpalLocalConnection &connection)
virtual bool | OnOutgoingCall (const OpalLocalConnection &connection)
virtual bool | OnIncomingCall (OpalLocalConnection &connection)
virtual bool | AlertingIncomingCall (const PString &token, OpalConnection::StringOptions *options=NULL)
virtual bool | AcceptIncomingCall (const PString &token, OpalConnection::StringOptions *options=NULL)
virtual bool | RejectIncomingCall (const PString &token, const OpalConnection::CallEndReason &reason=OpalConnection::EndedByAnswerDenied)
virtual bool | OnUserInput (const OpalLocalConnection &connection, const PString &indication)
virtual bool | OnReadMediaFrame (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, RTP_DataFrame &frame)
virtual bool | OnWriteMediaFrame (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, RTP_DataFrame &frame)
virtual bool | OnReadMediaData (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, void *data, PINDEX size, PINDEX &length)
virtual bool | OnWriteMediaData (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, const void *data, PINDEX length, PINDEX &written)
virtual Synchronicity | GetSynchronicity (const OpalMediaFormat &mediaFormat, bool isSource) const
Synchronicity | GetDefaultAudioSynchronicity () const
void | SetDefaultAudioSynchronicity (Synchronicity sync)
Synchronicity | GetDefaultVideoSourceSynchronicity () const
void | SetDefaultVideoSourceSynchronicity (Synchronicity sync)
bool | IsDeferredAlerting () const
void | SetDeferredAlerting (bool defer)
bool | IsDeferredAnswer () const
void | SetDeferredAnswer (bool defer)
Public Member Functions inherited from OpalEndPoint
| OpalEndPoint (OpalManager &manager, const PCaselessString &prefix, unsigned attributes)
| ~OpalEndPoint ()
void | PrintOn (ostream &strm) const
PBoolean | StartListeners (const PStringArray &interfaces)
PBoolean | StartListener (const OpalTransportAddress &iface)
PBoolean | StartListener (OpalListener *listener)
virtual PStringArray | GetDefaultListeners () const
virtual PString | GetDefaultTransport () const
OpalListener * | FindListener (const OpalTransportAddress &iface)
bool | FindListenerForProtocol (const char *proto, OpalTransportAddress &addr)
PBoolean | StopListener (const OpalTransportAddress &iface)
PBoolean | RemoveListener (OpalListener *listener)
OpalTransportAddressArray | GetInterfaceAddresses (PBoolean excludeLocalHost=true, const OpalTransport *associatedTransport=NULL)
| PDECLARE_NOTIFIER (PThread, OpalEndPoint, ListenerCallback)
virtual PBoolean | NewIncomingConnection (OpalTransport *transport)
virtual void | OnNewConnection (OpalCall &call, OpalConnection &connection)
virtual PBoolean | OnSetUpConnection (OpalConnection &connection)
virtual PBoolean | OnIncomingConnection (OpalConnection &connection, unsigned options, OpalConnection::StringOptions *stringOptions)
virtual void | OnProceeding (OpalConnection &connection)
virtual void | OnAlerting (OpalConnection &connection)
virtual OpalConnection::AnswerCallResponse | OnAnswerCall (OpalConnection &connection, const PString &caller)
virtual void | OnConnected (OpalConnection &connection)
virtual void | OnEstablished (OpalConnection &connection)
virtual void | OnReleased (OpalConnection &connection)
virtual void | OnHold (OpalConnection &connection, bool fromRemote, bool onHold)
virtual void | OnHold (OpalConnection &connection)
virtual PBoolean | OnForwarded (OpalConnection &connection, const PString &remoteParty)
virtual bool | OnTransferNotify (OpalConnection &connection, const PStringToString &info)
virtual PBoolean | ClearCall (const PString &token, OpalConnection::CallEndReason reason=OpalConnection::EndedByLocalUser, PSyncPoint *sync=NULL)
virtual PBoolean | ClearCallSynchronous (const PString &token, OpalConnection::CallEndReason reason=OpalConnection::EndedByLocalUser, PSyncPoint *sync=NULL)
virtual void | ClearAllCalls (OpalConnection::CallEndReason reason=OpalConnection::EndedByLocalUser, PBoolean wait=true)
PSafePtr< OpalConnection > | GetConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)
template<class ConnClass >
PSafePtr< ConnClass > | GetConnectionWithLockAs (const PString &token, PSafetyMode mode=PSafeReadWrite)
PStringList | GetAllConnections ()
PINDEX | GetConnectionCount () const
virtual PBoolean | HasConnection (const PString &token)
virtual void | DestroyConnection (OpalConnection *connection)
virtual void | AdjustMediaFormats (bool local, const OpalConnection &connection, OpalMediaFormatList &mediaFormats) const
virtual PBoolean | OnOpenMediaStream (OpalConnection &connection, OpalMediaStream &stream)
virtual void | OnClosedMediaStream (const OpalMediaStream &stream)
virtual PBoolean | CreateVideoInputDevice (const OpalConnection &connection, const OpalMediaFormat &mediaFormat, PVideoInputDevice *&device, PBoolean &autoDelete)
virtual PBoolean | CreateVideoOutputDevice (const OpalConnection &connection, const OpalMediaFormat &mediaFormat, PBoolean preview, PVideoOutputDevice *&device, PBoolean &autoDelete)
virtual void | OnUserInputString (OpalConnection &connection, const PString &value)
virtual void | OnUserInputTone (OpalConnection &connection, char tone, int duration)
virtual PString | ReadUserInput (OpalConnection &connection, const char *terminators="#\r\n", unsigned lastDigitTimeout=4, unsigned firstDigitTimeout=30)
virtual PBoolean | Message (const PString &to, const PString &body)
virtual PBoolean | Message (const PURL &to, const PString &type, const PString &body, PURL &from, PString &conversationId)
virtual PBoolean | Message (OpalIM &Message)
virtual void | OnMessageReceived (const OpalIM &message)
virtual void | OnMWIReceived (const PString &party, OpalManager::MessageWaitingType type, const PString &extraInfo)
OpalManager & | GetManager () const
const PString & | GetPrefixName () const
PBoolean | HasAttribute (Attributes opt) const
WORD | GetDefaultSignalPort () const
const OpalProductInfo & | GetProductInfo () const
void | SetProductInfo (const OpalProductInfo &info)
const PString & | GetDefaultLocalPartyName () const
virtual void | SetDefaultLocalPartyName (const PString &name)
const PString & | GetDefaultDisplayName () const
void | SetDefaultDisplayName (const PString &name)
unsigned | GetInitialBandwidth () const
void | SetInitialBandwidth (unsigned bandwidth)
const OpalListenerList & | GetListeners () const
const OpalConnection::StringOptions & | GetDefaultStringOptions () const
void | SetDefaultStringOptions (const OpalConnection::StringOptions &opts)
void | SetDefaultStringOption (const PCaselessString &key, const PString &data)
OpalConnection::SendUserInputModes | GetSendUserInputMode () const
void | SetSendUserInputMode (OpalConnection::SendUserInputModes mode)

## Protected Attributes

OpalMixerNodeInfo * | m_adHocNodeInfo
OpalMixerNodeManager | m_nodeManager
Protected Attributes inherited from OpalLocalEndPoint
bool | m_deferredAlerting
bool | m_deferredAnswer
Synchronicity | m_defaultAudioSynchronicity
Synchronicity | m_defaultVideoSourceSynchronicity
Protected Attributes inherited from OpalEndPoint
OpalManager & | manager
PCaselessString | prefixName
unsigned | attributeBits
WORD | defaultSignalPort
PINDEX | m_maxSizeUDP
OpalProductInfo | productInfo
PString | defaultLocalPartyName
PString | defaultDisplayName
unsigned | initialBandwidth
OpalConnection::StringOptions | m_defaultStringOptions
OpalConnection::SendUserInputModes | defaultSendUserInputMode
OpalListenerList | listeners
OpalEndPoint::ConnectionDict | connectionsActive
PMutex | inUseFlag

## Additional Inherited Members

Public Types inherited from OpalLocalEndPoint
enum | Synchronicity { e_Synchronous, e_Asynchronous, e_SimulateSyncronous }
Public Types inherited from OpalEndPoint
enum | Attributes { CanTerminateCall = 1, SupportsE164 = 2 }
Protected Member Functions inherited from OpalEndPoint
OpalConnection * | AddConnection (OpalConnection *connection)

## Detailed Description

Mixer EndPoint. This class represents an endpoint that mixes media. It can be used as the basis for a Multipoint Conferencing Unit.

## Constructor & Destructor Documentation

OpalMixerEndPoint::OpalMixerEndPoint | ( | OpalManager & | manager,
|  | const char * | prefix
| ) |  |

Create a new endpoint.

Parameters

  manager | Manager of all endpoints.
  prefix | Prefix for URL style address strings

OpalMixerEndPoint::~OpalMixerEndPoint | ( |  | ) |

Destroy endpoint.

## Member Function Documentation

PSafePtr<OpalMixerNode> OpalMixerEndPoint::AddNode | ( | OpalMixerNodeInfo * | info | ) |

Add a new node. The info variable should be created on the heap and it is subsequently owned by the node. NULL can be passed if defaults are to be used. Calls CreateNode.

Parameters

  info | Initial info for node

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

virtual

Create a connection for the PCSS endpoint. The default implementation is to create a OpalMixerConnection.

Parameters

  node | Node the connection is in
  call | Owner of connection
  userData | Arbitrary data to pass to connection
  options | Option bit mask to pass to connection
  stringOptions | Options to pass to connection

virtual OpalMixerNode* OpalMixerEndPoint::CreateNode | ( | OpalMixerNodeInfo * | info | ) |

virtual

Create a new node. This should create the new instance of the OpalMixerNode as required by the derived class, if any. The info variable should be created on the heap and it is subsequently owned by the node. NULL can be passed if defaults are to be used.

Parameters

  info | Initial info for node

PSafePtr<OpalMixerNode> OpalMixerEndPoint::FindNode | ( | const PString & | name,
|  | PSafetyMode | mode = `PSafeReference`
| ) |  |

inline

Find an existing node. This will search for the mixer node using GUID and then name.

Parameters

  name | GUID or alias name for node
  mode | Lock mode for returned pointer

References OpalMixerNodeManager::FindNode(), and m_nodeManager.

virtual PBoolean OpalMixerEndPoint::GarbageCollection | ( |  | ) |

virtual

Execute garbage collection for endpoint. Returns true if all garbage has been collected. Default behaviour deletes the objects in the connectionsActive list.

Reimplemented from OpalEndPoint.

OpalMixerNodeInfo* OpalMixerEndPoint::GetAdHocNodeInfo | ( |  | ) |

inline

Get default ad hoc mode information. The pointer returned from this function is passed to the CreateNode() function, so may be a reference to derived class, which a derived class of OpalMixerNode could use.

Note if NULL, then ad hoc nodes are not created and incoming connections are refused. A user must ex[icitly call AddNode() to create a name that can be conected to.

Default bahaviour returns member variable m_adHocNodeInfo.

References m_adHocNodeInfo.

PSafePtr<OpalMixerNode> OpalMixerEndPoint::GetFirstNode | ( | PSafetyMode | mode = `PSafeReference` | ) | const

inline

Get the first node. The active nodes may be enumerated by the ++ operator on the PSafePtr.

Parameters

  mode | Lock mode for returned pointer

References OpalMixerNodeManager::GetFirstNode(), and m_nodeManager.

virtual OpalMediaFormatList OpalMixerEndPoint::GetMediaFormats | ( |  | ) | const

virtual

Get the data formats this endpoint is capable of operating. This provides a list of media data format names that may be used by an OpalMediaStream may be created by a connection from this endpoint.

Note that a specific connection may not actually support all of the media formats returned here, but should return no more.

The default behaviour returns the most basic media formats, PCM audio and YUV420P video.

Reimplemented from OpalLocalEndPoint.

PSafePtr<OpalMixerConnection> OpalMixerEndPoint::GetMixerConnectionWithLock | ( | const PString & | token,
|  | PSafetyMode | mode = `PSafeReadWrite`
| ) |  |

inline

Find a connection that uses the specified token. This searches the endpoint for the connection that contains the token as provided by functions such as MakeConnection(). If not then it attempts to use the token as a OpalCall token and find a connection of the same class.

Parameters

  token | Token to identify connection
  mode | Lock mode

const OpalMixerNodeManager& OpalMixerEndPoint::GetNodeManager | ( |  | ) | const

inline

Get the Node Manager for this endpoint.

References m_nodeManager.

OpalMixerNodeManager& OpalMixerEndPoint::GetNodeManager | ( |  | ) |

inline

References m_nodeManager.

virtual PSafePtr<OpalConnection> OpalMixerEndPoint::MakeConnection | ( | OpalCall & | call,
|  | const PString & | party,
|  | void * | userData = `NULL`,
|  | unsigned | options = `0`,
|  | OpalConnection::StringOptions * | stringOptions = `NULL`
| ) |  |

virtual

Set up a connection to a remote party. This is called from the OpalManager::MakeConnection() function once it has determined that this is the endpoint for the protocol.

The general form for this party parameter is:

     [proto:][alias@][transport$]address[:port]

where the various fields will have meanings specific to the endpoint type. For example, with H.323 it could be "h323:Fred@site.com" which indicates a user Fred at gatekeeper size.com. Whereas for the PSTN endpoint it could be "pstn:5551234" which is to call 5551234 on the first available PSTN line.

The proto field is optional when passed to a specific endpoint. If it is present, however, it must agree with the endpoints protocol name or false is returned.

This function usually returns almost immediately with the connection continuing to occur in a new background thread.

If false is returned then the connection could not be established. For example if a PSTN endpoint is used and the assiciated line is engaged then it may return immediately. Returning a non-NULL value does not mean that the connection will succeed, only that an attempt is being made.

The default behaviour is pure.

Parameters

  call | Owner of connection
  party | Remote party to call
  userData | Arbitrary data to pass to connection
  options | Option bit mask to pass to connection
  stringOptions | Options to pass to connection

void OpalMixerEndPoint::RemoveNode | ( | OpalMixerNode & | node | ) |

inline

Remove a node. Shut down all active connections with node, remove its name associations and delete it.

Parameters

  node | Initial info for node

References m_nodeManager, and OpalMixerNodeManager::RemoveNode().

void OpalMixerEndPoint::SetAdHocNodeInfo | ( | const OpalMixerNodeInfo & | info | ) |

Set default ad hoc node information. The pointer is passed to the CreateNode() function, so may be a reference to derived class, which a derived class of OpalMixerNode could use.

Note if NULL, then ad hoc nodes are not created and incoming connections are refused. A user must ex[icitly call AddNode() to create a name that can be conected to.

The version that takes a reference will utilise the CLone() function to create a copy of the mixer info.

void OpalMixerEndPoint::SetAdHocNodeInfo | ( | OpalMixerNodeInfo * | info | ) |

virtual void OpalMixerEndPoint::ShutDown | ( |  | ) |

virtual

Shut down the endpoint, this is called by the OpalManager just before destroying the object and can be handy to make sure some things are stopped before the vtable gets clobbered.

Reimplemented from OpalEndPoint.

## Field Documentation

OpalMixerNodeInfo* OpalMixerEndPoint::m_adHocNodeInfo

protected

Referenced by GetAdHocNodeInfo().

OpalMixerNodeManager OpalMixerEndPoint::m_nodeManager

protected

Referenced by FindNode(), GetFirstNode(), GetNodeManager(), and RemoveNode().

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

- opalmixer.h