OPAL  Version 3.18.8
OpalLocalEndPoint Class Reference

#include <localep.h>

Inheritance diagram for OpalLocalEndPoint:
Collaboration diagram for OpalLocalEndPoint:

Public Member Functions

Construction
 OpalLocalEndPoint (OpalManager &manager, const char *prefix=OPAL_LOCAL_PREFIX, bool useCallbacks=true)
 
 ~OpalLocalEndPoint ()
 
Overrides from OpalEndPoint
virtual OpalMediaFormatList GetMediaFormats () const
 
virtual PSafePtr< OpalConnectionMakeConnection (OpalCall &call, const PString &party, void *userData=NULL, unsigned int options=0, OpalConnection::StringOptions *stringOptions=NULL)
 
Customisation call backs
PSafePtr< OpalLocalConnectionGetLocalConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)
 
virtual OpalLocalConnectionCreateConnection (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, bool withMedia=false)
 
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)
 
Member access
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)
 
bool WillPauseTransmitMediaOnHold () const
 
void SetPauseTransmitMediaOnHold (bool pause)
 
void SetFarEndCameraCapabilityChangedNotifier (const PNotifier &notifier)
 Set a callback for when the far end camera control capabilities change. More...
 
const PNotifier & GetFarEndCameraCapabilityChangedNotifier () const
 Get a callback for when the far end camera control capabilities change. More...
 
void SetFarEndCameraActionNotifier (const PNotifier &notifier)
 Set a callback for when a far end camera control action comes from remote. More...
 
const PNotifier & GetFarEndCameraActionNotifier () const
 Get a callback for when a far end camera control action comes from remote. More...
 
- Public Member Functions inherited from OpalEndPoint
 P_DECLARE_BITWISE_ENUM (Attributes, 2,(NoAttributes, IsNetworkEndPoint, SupportsE164))
 
 OpalEndPoint (OpalManager &manager, const PCaselessString &prefix, Attributes attributes)
 
 ~OpalEndPoint ()
 
virtual void ShutDown ()
 
void PrintOn (ostream &strm) const
 
bool StartListeners (const PStringArray &interfaces, bool add=true)
 
virtual bool StartListener (const PString &address)
 
virtual bool StartListener (OpalListener *listener)
 
virtual PStringArray GetDefaultListeners () const
 
virtual PString GetDefaultTransport () const
 
virtual WORD GetDefaultSignalPort () const
 
OpalListenerFindListener (const OpalTransportAddress &iface)
 
bool FindListenerForProtocol (const char *proto, OpalTransportAddress &addr)
 
PBoolean StopListener (const OpalTransportAddress &iface)
 
PBoolean RemoveListener (OpalListener *listener)
 
OpalTransportAddressArray GetInterfaceAddresses (const OpalTransport *associatedTransport=NULL) const
 
 PDECLARE_AcceptHandlerNotifier (OpalEndPoint, NewIncomingConnection)
 
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, bool withMedia)
 
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, const OpalConnection *transferringConnection)
 
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< OpalConnectionGetConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite) const
 
template<class ConnClass >
PSafePtr< ConnClass > GetConnectionWithLockAs (const PString &token, PSafetyMode mode=PSafeReadWrite) const
 
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 bool GetMediaTransportAddresses (const OpalConnection &provider, const OpalConnection &consumer, unsigned sessionId, const OpalMediaType &mediaType, OpalTransportAddressArray &transports) const
 
virtual PBoolean OnOpenMediaStream (OpalConnection &connection, OpalMediaStream &stream)
 
virtual void OnClosedMediaStream (const OpalMediaStream &stream)
 
virtual void OnFailedMediaStream (OpalConnection &connection, bool fromRemote, const PString &reason)
 
void SetMediaCryptoSuites (const PStringArray &security)
 
PStringArray GetMediaCryptoSuites () const
 
virtual PStringArray GetAllMediaCryptoSuites () const
 
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)
 
virtual bool GetConferenceStates (OpalConferenceStates &states, const PString &name=PString::Empty()) const
 
virtual void OnConferenceStatusChanged (OpalEndPoint &endpoint, const PString &uri, OpalConferenceState::ChangeType change)
 
virtual PStringList GetNetworkURIs (const PString &name) const
 
virtual PBoolean GarbageCollection ()
 
OpalManagerGetManager () const
 
const PString & GetPrefixName () const
 
bool HasAttribute (Attributes opt) const
 
const OpalProductInfoGetProductInfo () 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)
 
OpalBandwidth GetInitialBandwidth (OpalBandwidth::Direction dir) const
 
bool SetInitialBandwidth (OpalBandwidth::Direction dir, OpalBandwidth bandwidth)
 
const OpalListenerList & GetListeners () const
 
const
OpalConnection::StringOptions
GetDefaultStringOptions () const
 
void SetDefaultStringOptions (const OpalConnection::StringOptions &opts, bool overwrite=false)
 
void SetDefaultStringOption (const PCaselessString &key, const PString &data)
 
void RemoveDefaultStringOption (const PCaselessString &key)
 
virtual PStringList GetAvailableStringOptions () const
 
OpalConnection::SendUserInputModes GetSendUserInputMode () const
 
void SetSendUserInputMode (OpalConnection::SendUserInputModes mode)
 
const PIPSocket::QoS & GetSignalQoS () const
 
void SetSignalQoS (const PIPSocket::QoS &qos)
 
const PIPSocket::QoS & GetMediaQoS (const OpalMediaType &type) const
 
void SetMediaQoS (const OpalMediaType &type, const PIPSocket::QoS &qos)
 
PINDEX GetMaxSizeUDP () const
 
void SetMaxSizeUDP (PINDEX size)
 

Protected Attributes

bool m_deferredAlerting
 
bool m_deferredAnswer
 
bool m_pauseTransmitMediaOnHold
 
CallbackMap m_useCallback
 
Synchronicity m_defaultAudioSynchronicity
 
Synchronicity m_defaultVideoSourceSynchronicity
 
PNotifier m_farEndCameraCapabilityChangedNotifier
 
PNotifier m_farEndCameraActionNotifier
 
- Protected Attributes inherited from OpalEndPoint
OpalManagerm_manager
 
PCaselessString m_prefixName
 
Attributes m_attributes
 
PINDEX m_maxSizeUDP
 
OpalProductInfo m_productInfo
 
PString m_defaultLocalPartyName
 
PString m_defaultDisplayName
 
PStringArray m_mediaCryptoSuites
 
PIPSocket::QoS m_signalQoS
 
OpalManager::MediaQoSMap m_mediaQoS
 
OpalBandwidth m_initialRxBandwidth
 
OpalBandwidth m_initialTxBandwidth
 
OpalConnection::StringOptions m_defaultStringOptions
 
OpalConnection::SendUserInputModes m_defaultSendUserInputMode
 
OpalListenerList m_listeners
 
OpalEndPoint::ConnectionDict m_connectionsActive
 

Media call backs

enum  Synchronicity { e_Synchronous, e_Asynchronous, e_SimulateSynchronous }
 
typedef map< OpalMediaType,
CallbackUsage > 
CallbackMap
 Map for indicating if a media type is to use callback virtual functions. More...
 
 P_DECLARE_BITWISE_ENUM (CallbackUsage, 2,(NoCallbacks, UseSourceCallback, UseSinkCallback))
 Enumeration for usage of media callback direction in CallbackMap. More...
 
bool UseCallback (const OpalMediaFormat &mediaFormat, bool isSource) const
 Indicate media type and direction is to use virtual callback functions. More...
 
bool SetCallbackUsage (const OpalMediaType &mediaType, CallbackUsage usage)
 Set callback usage for media type. More...
 
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 (OpalLocalConnection &connection, 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 bool CreateVideoInputDevice (const OpalConnection &connection, const OpalMediaFormat &mediaFormat, PVideoInputDevice *&device, bool &autoDelete)
 
virtual bool CreateVideoOutputDevice (const OpalConnection &connection, const OpalMediaFormat &mediaFormat, bool preview, PVideoOutputDevice *&device, bool &autoDelete)
 
virtual Synchronicity GetSynchronicity (const OpalMediaFormat &mediaFormat, bool isSource) const
 

Additional Inherited Members

- Protected Member Functions inherited from OpalEndPoint
OpalConnectionAddConnection (OpalConnection *connection)
 

Detailed Description

Local EndPoint. This class represents an endpoint on the local machine that can receive media via virtual functions.

Member Typedef Documentation

typedef map<OpalMediaType, CallbackUsage> OpalLocalEndPoint::CallbackMap

Map for indicating if a media type is to use callback virtual functions.

Member Enumeration Documentation

Indicate the synchronous mode for I/O. This indicates that the OnReadMediaXXX and OnWriteMediaXXX functions will execute blocking to the correct real time synchronisation. If GetSynchronicity() returns e_Synchronous, then, for example, when OnWriteMediaData() is sent 320 bytes of PCM data, it will block for 20 milliseconds.

If GetSynchronicity() returns e_SimulateSynchronous, then the system will try and simulate the correct timing using the operating system sleep function. This is not desirable as this function is notoriously inaccurate, and OPAL does it's best to compensate, but very often there is no other choice.

Note, it is important for the correct oeprating of the jitter buffer that one of the above two modes is used for audio.

If GetSynchronicity() returns e_Asynchronous, then the system will indicate that blocking is not required in any way. For example, when playing video, this is done as fast as data comes in from the network and there is no real time pacing required.

Enumerator
e_Synchronous 

Functions will block for correct real time.

e_Asynchronous 

Functions will not block, and do not require any real time handling.

e_SimulateSynchronous 

Functions wlll not block, but do require real time handling.

Constructor & Destructor Documentation

OpalLocalEndPoint::OpalLocalEndPoint ( OpalManager manager,
const char *  prefix = OPAL_LOCAL_PREFIX,
bool  useCallbacks = true 
)

Create a new endpoint.

Parameters
managerManager of all endpoints.
prefixPrefix for URL style address strings
useCallbacksIndicate all media is directed to the callback virtual functions
OpalLocalEndPoint::~OpalLocalEndPoint ( )

Destroy endpoint.

Member Function Documentation

virtual bool OpalLocalEndPoint::AcceptIncomingCall ( const PString &  token,
OpalConnection::StringOptions options = NULL 
)
virtual

Accept the incoming connection. Returns false if the connection token does not correspond to a valid connection.

Parameters
tokenToken of connection to accept call
optionsOptional string optiosn to apply
virtual bool OpalLocalEndPoint::AlertingIncomingCall ( const PString &  token,
OpalConnection::StringOptions options = NULL,
bool  withMedia = false 
)
virtual

Indicate alerting for the incoming connection. Returns false if the connection token does not correspond to a valid connection.

Parameters
tokenToken of connection to indicate alerting
optionsOptional string optiosn to apply
withMediaIndicate media should be started
virtual OpalLocalConnection* OpalLocalEndPoint::CreateConnection ( OpalCall call,
void *  userData,
unsigned  options,
OpalConnection::StringOptions stringOptions 
)
virtual

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

Parameters
callOwner of connection
userDataArbitrary data to pass to connection
optionsOption bit mask to pass to connection
stringOptionsOptions to pass to connection

Reimplemented in OpalSockEndPoint.

virtual bool OpalLocalEndPoint::CreateVideoInputDevice ( const OpalConnection connection,
const OpalMediaFormat mediaFormat,
PVideoInputDevice *&  device,
bool &  autoDelete 
)
virtual

Create an PVideoInputDevice for a source media stream.

Parameters
connectionConnection needing created video device
mediaFormatMedia format for stream
deviceCreated device
autoDeleteFlag for auto delete device

Reimplemented in OpalPCSSEndPoint.

virtual bool OpalLocalEndPoint::CreateVideoOutputDevice ( const OpalConnection connection,
const OpalMediaFormat mediaFormat,
bool  preview,
PVideoOutputDevice *&  device,
bool &  autoDelete 
)
virtual

Create an PVideoOutputDevice for a sink media stream or the preview display for a source media stream.

Parameters
connectionConnection needing created video device
mediaFormatMedia format for stream
previewFlag indicating is a preview output
deviceCreated device
autoDeleteFlag for auto delete device
Synchronicity OpalLocalEndPoint::GetDefaultAudioSynchronicity ( ) const
inline

Get default synchronous mode for audio sources and sinks.

References m_defaultAudioSynchronicity.

Synchronicity OpalLocalEndPoint::GetDefaultVideoSourceSynchronicity ( ) const
inline

Get default synchronous mode for video sources.

References m_defaultVideoSourceSynchronicity.

const PNotifier& OpalLocalEndPoint::GetFarEndCameraActionNotifier ( ) const
inline

Get a callback for when a far end camera control action comes from remote.

References m_farEndCameraActionNotifier.

const PNotifier& OpalLocalEndPoint::GetFarEndCameraCapabilityChangedNotifier ( ) const
inline

Get a callback for when the far end camera control capabilities change.

References m_farEndCameraCapabilityChangedNotifier.

PSafePtr<OpalLocalConnection> OpalLocalEndPoint::GetLocalConnectionWithLock ( 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
tokenToken to identify connection
modeLock mode
virtual OpalMediaFormatList OpalLocalEndPoint::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.

Implements OpalEndPoint.

Reimplemented in OpalMixerEndPoint, and OpalIVREndPoint.

virtual Synchronicity OpalLocalEndPoint::GetSynchronicity ( const OpalMediaFormat mediaFormat,
bool  isSource 
) const
virtual

Indicate the I/O synchronous mode. See Synchronicity for more details.

Default behaviour returns m_defaultAudioSynchronicity (initially e_Synchronous) when is audio source or sink, m_defaultVideoSourceSynchronicity (initially e_Synchronous) when a video source, e_Asynchronous in all other cases.

Parameters
mediaFormatMedia format for stream being opened.
isSourceStream is a a source
bool OpalLocalEndPoint::IsDeferredAlerting ( ) const
inline

Indicate OnAlerting() is be deferred or immediate.

References m_deferredAlerting.

bool OpalLocalEndPoint::IsDeferredAnswer ( ) const
inline

Indicate AcceptIncomingCall() execution is be deferred or immediate on OnIncomingCall().

References m_deferredAnswer.

virtual PSafePtr<OpalConnection> OpalLocalEndPoint::MakeConnection ( OpalCall call,
const PString &  party,
void *  userData = NULL,
unsigned int  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
callOwner of connection
partyRemote party to call
userDataArbitrary data to pass to connection
optionsoptions to pass to conneciton
stringOptionsOptions to pass to connection

Implements OpalEndPoint.

Reimplemented in OpalSockEndPoint, and OpalIVREndPoint.

virtual bool OpalLocalEndPoint::OnIncomingCall ( OpalLocalConnection connection)
virtual

Call back to indicate that there is an incoming call. Note this function should not block or it will impede the operation of the stack.

The default implementation returns true;

Returns
false is returned the call is aborted with status of EndedByLocalBusy.
Parameters
connectionConnection having event

Reimplemented in OpalConsolePCSSEndPoint, and OpalPCSSEndPoint.

virtual bool OpalLocalEndPoint::OnOutgoingCall ( const OpalLocalConnection connection)
virtual

Call back to indicate that remote is ringing. If false is returned the call is aborted.

The default implementation does nothing.

Parameters
connectionConnection having event

Reimplemented in OpalPCSSEndPoint.

virtual bool OpalLocalEndPoint::OnOutgoingSetUp ( const OpalLocalConnection connection)
virtual

Call back just before remote is contacted. If false is returned the call is aborted with EndedByNoAccept.

The default implementation returns true.

Parameters
connectionConnection having event
virtual bool OpalLocalEndPoint::OnReadMediaData ( OpalLocalConnection connection,
OpalMediaStream mediaStream,
void *  data,
PINDEX  size,
PINDEX &  length 
)
virtual

Call back to get media data for transmission. If false is returned the media stream will be closed.

Care with the handling of real time is required, see GetSynchronicity for more details.

The default implementation fills the buffer with zeros and returns true.

Parameters
connectionConnection for media
mediaStreamMedia stream data is required for
dataData to send
sizeMaximum size of data buffer
lengthNumber of bytes placed in buffer
virtual bool OpalLocalEndPoint::OnReadMediaFrame ( const OpalLocalConnection connection,
const OpalMediaStream mediaStream,
RTP_DataFrame frame 
)
virtual

Call back to get media data for transmission. If false is returned then OnReadMediaData() is called.

Care with the handling of real time is required, see GetSynchronicity for more details.

The default implementation returns false.

Parameters
connectionConnection for media
mediaStreamMedia stream data is required for
frameRTP frame for data
virtual bool OpalLocalEndPoint::OnUserInput ( const OpalLocalConnection connection,
const PString &  indication 
)
virtual

Call back to indicate that the remote user has indicated something. If false is returned the call is aborted.

The default implementation does nothing.

Parameters
connectionConnection having event
indicationUser input received

Reimplemented in OpalPCSSEndPoint.

virtual bool OpalLocalEndPoint::OnWriteMediaData ( const OpalLocalConnection connection,
const OpalMediaStream mediaStream,
const void *  data,
PINDEX  length,
PINDEX &  written 
)
virtual

Call back to handle received media data. If false is returned the media stream will be closed.

It is expected that this function be real time. That is if 320 bytes of PCM-16 are written, this function should take 20ms to execute. If not then the jitter buffer will not operate correctly and audio will not be of high quality. This timing can be simulated if required, see GetSynchronicity for more details.

Note: For encoded audio media, if data is NULL then that indicates there is no incoming audio available from the jitter buffer. The application should output silence for a time. The written value should still contain the bytes of silence emitted, even though it will be larger that length. This does not occcur for raw (PCM-16) audio.

The default implementation ignores the media data and returns true.

Parameters
connectionConnection for media
mediaStreamMedia stream data is required for
dataData received
lengthAmount of data available to write
writtenAmount of data written
virtual bool OpalLocalEndPoint::OnWriteMediaFrame ( const OpalLocalConnection connection,
const OpalMediaStream mediaStream,
RTP_DataFrame frame 
)
virtual

Call back to handle received media data. If false is returned then OnWriteMediaData() is called.

Care with the handling of real time is required, see GetSynchronicity for more details.

Note it is the responsibility of this function to update the frame timestamp for correct operation of the jitter buffer.

The default implementation returns false.

Parameters
connectionConnection for media
mediaStreamMedia stream data is required for
frameRTP frame for data
OpalLocalEndPoint::P_DECLARE_BITWISE_ENUM ( CallbackUsage  ,
,
(NoCallbacks, UseSourceCallback, UseSinkCallback)   
)

Enumeration for usage of media callback direction in CallbackMap.

virtual bool OpalLocalEndPoint::RejectIncomingCall ( const PString &  token,
const OpalConnection::CallEndReason reason = OpalConnection::EndedByAnswerDenied 
)
virtual

Reject the incoming connection. Returns false if the connection token does not correspond to a valid connection.

Parameters
tokenToken of connection to accept call
reasonReason for rejecting the call
bool OpalLocalEndPoint::SetCallbackUsage ( const OpalMediaType mediaType,
CallbackUsage  usage 
)

Set callback usage for media type.

void OpalLocalEndPoint::SetDefaultAudioSynchronicity ( Synchronicity  sync)
inline

Set default synchronous mode for audio sources and sinks.

References m_defaultAudioSynchronicity.

void OpalLocalEndPoint::SetDefaultVideoSourceSynchronicity ( Synchronicity  sync)
inline

Set default synchronous mode for video sources.

References m_defaultVideoSourceSynchronicity.

void OpalLocalEndPoint::SetDeferredAlerting ( bool  defer)
inline

Indicate OnAlerting() is be deferred or immediate.

References m_deferredAlerting.

void OpalLocalEndPoint::SetDeferredAnswer ( bool  defer)
inline

Indicate AcceptIncomingCall() execution is be deferred or immediate on OnIncomingCall().

References m_deferredAnswer.

void OpalLocalEndPoint::SetFarEndCameraActionNotifier ( const PNotifier &  notifier)
inline

Set a callback for when a far end camera control action comes from remote.

References m_farEndCameraActionNotifier.

void OpalLocalEndPoint::SetFarEndCameraCapabilityChangedNotifier ( const PNotifier &  notifier)
inline

Set a callback for when the far end camera control capabilities change.

void OpalLocalEndPoint::SetPauseTransmitMediaOnHold ( bool  pause)
inline

Indicate when we put remote on hold, our media is also paused. If system will send music on hold or similar, then this should be set to false.

References m_pauseTransmitMediaOnHold.

bool OpalLocalEndPoint::UseCallback ( const OpalMediaFormat mediaFormat,
bool  isSource 
) const

Indicate media type and direction is to use virtual callback functions.

Parameters
mediaFormatMedia format to check
isSourceDirection of media stream
bool OpalLocalEndPoint::WillPauseTransmitMediaOnHold ( ) const
inline

Indicate when we put remote on hold, our media is also paused. If system will send music on hold or similar, then this should be set to false.

References m_pauseTransmitMediaOnHold.

Field Documentation

Synchronicity OpalLocalEndPoint::m_defaultAudioSynchronicity
protected
Synchronicity OpalLocalEndPoint::m_defaultVideoSourceSynchronicity
protected
bool OpalLocalEndPoint::m_deferredAlerting
protected
bool OpalLocalEndPoint::m_deferredAnswer
protected
PNotifier OpalLocalEndPoint::m_farEndCameraActionNotifier
protected
PNotifier OpalLocalEndPoint::m_farEndCameraCapabilityChangedNotifier
protected
bool OpalLocalEndPoint::m_pauseTransmitMediaOnHold
protected
CallbackMap OpalLocalEndPoint::m_useCallback
protected

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