OPAL  Version 3.10.10
OpalMixerConnection Class Reference

#include <opalmixer.h>

Inheritance diagram for OpalMixerConnection:
OpalLocalConnection OpalConnection

Public Member Functions

Construction
 OpalMixerConnection (PSafePtr< OpalMixerNode > node, OpalCall &call, OpalMixerEndPoint &endpoint, void *userData, unsigned options=0, OpalConnection::StringOptions *stringOptions=NULL)
 ~OpalMixerConnection ()
Overrides from OpalConnection
virtual void OnReleased ()
virtual OpalMediaFormatList GetMediaFormats () const
virtual OpalMediaStreamCreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, PBoolean isSource)
virtual void OnStartMediaPatch (OpalMediaPatch &patch)
virtual void OnApplyStringOptions ()
 Call back for connection to act on changed string options.
virtual PBoolean SendUserInputString (const PString &value)
virtual PBoolean SendUserInputTone (char tone, unsigned duration=0)
Operations
void SetListenOnly (bool listenOnly)
bool GetListenOnly () const
PSafePtr< OpalMixerNodeGetNode () const
- Public Member Functions inherited from OpalLocalConnection
 OpalLocalConnection (OpalCall &call, OpalLocalEndPoint &endpoint, void *userData, unsigned options, OpalConnection::StringOptions *stringOptions, char tokenPrefix= 'L')
 ~OpalLocalConnection ()
virtual PBoolean IsNetworkConnection () const
virtual PBoolean SetUpConnection ()
virtual PBoolean SetAlerting (const PString &calleeName, PBoolean withMedia)
virtual PBoolean SetConnected ()
virtual OpalMediaStreamPtr OpenMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)
virtual bool OnOutgoingSetUp ()
virtual bool OnOutgoing ()
virtual bool OnIncoming ()
virtual void AlertingIncoming ()
virtual void AcceptIncoming ()
void * GetUserData () const
 Get user data pointer.
void SetUserData (void *v)
 Set user data pointer.
- Public Member Functions inherited from OpalConnection
virtual bool GarbageCollection ()
const StringOptionsGetStringOptions () const
 Get the string options associated with this connection.
void SetStringOptions (const StringOptions &options, bool overwrite)
 Set the string options associated with this connection.
virtual void EnableRecording ()
virtual void DisableRecording ()
 OpalConnection (OpalCall &call, OpalEndPoint &endpoint, const PString &token, unsigned options=0, OpalConnection::StringOptions *stringOptions=NULL)
 ~OpalConnection ()
void PrintOn (ostream &strm) const
virtual PBoolean OnIncomingConnection (unsigned int options, OpalConnection::StringOptions *stringOptions)
virtual PBoolean OnSetUpConnection ()
virtual void OnProceeding ()
virtual void OnAlerting ()
virtual AnswerCallResponse OnAnswerCall (const PString &callerName)
virtual void AnsweringCall (AnswerCallResponse response)
virtual void OnConnected ()
virtual void OnEstablished ()
virtual bool OnTransferNotify (const PStringToString &info, const OpalConnection *transferringConnection)
virtual void Release (CallEndReason reason=EndedByLocalUser, bool synchronous=false)
virtual PString GetDestinationAddress ()
virtual PBoolean ForwardCall (const PString &forwardParty)
PSafePtr< OpalConnectionGetOtherPartyConnection () const
template<class cls >
PSafePtr< cls > GetOtherPartyConnectionAs () const
virtual OpalMediaFormatList GetLocalMediaFormats ()
virtual void AdjustMediaFormats (bool local, const OpalConnection *otherConnection, OpalMediaFormatList &mediaFormats) const
virtual unsigned GetNextSessionID (const OpalMediaType &mediaType, bool isSource)
virtual
OpalMediaType::AutoStartMode 
GetAutoStart (const OpalMediaType &mediaType) const
virtual void AutoStartMediaStreams (bool force=false)
virtual bool SwitchFaxMediaStreams (bool toT38)
virtual void OnSwitchedFaxMediaStreams (bool toT38, bool success)
virtual bool OnSwitchingFaxMediaStreams (bool toT38)
virtual bool CloseMediaStream (unsigned sessionId, bool source)
virtual bool CloseMediaStream (OpalMediaStream &stream)
bool RemoveMediaStream (OpalMediaStream &strm)
virtual void StartMediaStreams ()
virtual void CloseMediaStreams ()
virtual void PauseMediaStreams (bool paused)
virtual void OnPauseMediaStream (OpalMediaStream &strm, bool paused)
OpalMediaStreamPtr GetMediaStream (const PString &streamID, bool source) const
OpalMediaStreamPtr GetMediaStream (unsigned sessionId, bool source) const
OpalMediaStreamPtr GetMediaStream (const OpalMediaType &mediaType, bool source, OpalMediaStreamPtr previous=NULL) const
virtual PBoolean OnOpenMediaStream (OpalMediaStream &stream)
virtual void OnClosedMediaStream (const OpalMediaStream &stream)
virtual void OnPatchMediaStream (PBoolean isSource, OpalMediaPatch &patch)
virtual void OnStopMediaPatch (OpalMediaPatch &patch)
virtual bool OnMediaCommand (OpalMediaStream &stream, const OpalMediaCommand &command)
virtual void AttachRFC2833HandlerToPatch (PBoolean isSource, OpalMediaPatch &patch)
virtual PBoolean IsMediaBypassPossible (unsigned sessionID) const
virtual PBoolean CreateVideoInputDevice (const OpalMediaFormat &mediaFormat, PVideoInputDevice *&device, PBoolean &autoDelete)
virtual PBoolean CreateVideoOutputDevice (const OpalMediaFormat &mediaFormat, PBoolean preview, PVideoOutputDevice *&device, PBoolean &autoDelete)
virtual bool SendVideoUpdatePicture (unsigned sessionID=0, bool force=false) const
virtual PBoolean SetAudioVolume (PBoolean source, unsigned percentage)
virtual PBoolean GetAudioVolume (PBoolean source, unsigned &percentage)
virtual bool SetAudioMute (bool source, bool mute)
virtual bool GetAudioMute (bool source, bool &mute)
virtual unsigned GetAudioSignalLevel (PBoolean source)
unsigned GetBandwidthAvailable () const
virtual PBoolean SetBandwidthAvailable (unsigned newBandwidth, PBoolean force=false)
virtual unsigned GetBandwidthUsed () const
virtual PBoolean SetBandwidthUsed (unsigned releasedBandwidth, unsigned requiredBandwidth)
OpalEndPointGetEndPoint () const
OpalCallGetCall () const
const PString & GetToken () const
PBoolean IsOriginating () const
const PTime & GetPhaseTime (Phases phase) const
const PTime & GetSetupUpTime () const
const PTime & GetAlertingTime () const
const PTime & GetConnectionStartTime () const
const PTime & GetConnectionEndTime () const
const OpalProductInfoGetProductInfo () const
void SetProductInfo (const OpalProductInfo &info)
virtual PString GetPrefixName () const
const PString & GetLocalPartyName () const
virtual void SetLocalPartyName (const PString &name)
virtual PString GetLocalPartyURL () const
const PString & GetDisplayName () const
void SetDisplayName (const PString &name)
virtual bool IsPresentationBlocked () const
const PString & GetRemotePartyName () const
void SetRemotePartyName (const PString &name)
const PString & GetRemotePartyNumber () const
const PString & GetRemotePartyAddress () const
void SetRemotePartyAddress (const PString &addr)
virtual PString GetRemotePartyURL () const
const PString & GetRedirectingParty () const
void SetRedirectingParty (const PString &party)
const PString GetRemotePartyCallbackURL () const
PCaselessString GetRemoteApplication () const
const OpalProductInfoGetRemoteProductInfo () const
const PString & GetCalledPartyName () const
const PString & GetCalledPartyNumber () const
virtual PString GetCalledPartyURL ()
void CopyPartyNames (const OpalConnection &other)
virtual PString GetAlertingType () const
virtual bool SetAlertingType (const PString &info)
virtual PString GetCallInfo () const
unsigned GetMinAudioJitterDelay () const
unsigned GetMaxAudioJitterDelay () const
void SetAudioJitterDelay (unsigned minDelay, unsigned maxDelay)
OpalSilenceDetectorGetSilenceDetector () const
virtual PString GetIdentifier () const
virtual PINDEX GetMaxRtpPayloadSize () const
virtual OpalTransportGetTransport () const
 PDICTIONARY (MediaAddressesDict, POrdinalKey, OpalTransportAddress)
MediaAddressesDict & GetMediaTransportAddresses ()
unsigned GetVideoUpdateRequestsSent () const
__inline Phases GetPhase () const
__inline bool IsEstablished () const
 Return true if connection is in the established phase.
__inline bool IsReleased () const
 Return true if connection is in the established phase.
void SetPhase (Phases phaseToSet)
CallEndReason GetCallEndReason () const
PString GetCallEndReasonText () const
virtual void SetCallEndReason (CallEndReason reason)
void ClearCall (CallEndReason reason=EndedByLocalUser, PSyncPoint *sync=NULL)
virtual void ClearCallSynchronous (PSyncPoint *sync, CallEndReason reason=EndedByLocalUser)
unsigned GetQ931Cause () const
void SetQ931Cause (unsigned v)
virtual bool TransferConnection (const PString &remoteParty)
virtual bool Hold (bool fromRemote, bool placeOnHold)
virtual bool IsOnHold (bool fromRemote)
virtual void OnHold (bool fromRemote, bool onHold)
virtual void SetSendUserInputMode (SendUserInputModes mode)
virtual SendUserInputModes GetSendUserInputMode () const
virtual SendUserInputModes GetRealSendUserInputMode () const
virtual void OnUserInputString (const PString &value)
virtual void OnUserInputTone (char tone, unsigned duration)
void SendUserInputHookFlash (unsigned duration=500)
virtual PString GetUserInput (unsigned timeout=30)
virtual void SetUserInput (const PString &input)
virtual PString ReadUserInput (const char *terminators="#\r\n", unsigned lastDigitTimeout=4, unsigned firstDigitTimeout=30)
virtual PBoolean PromptUserInput (PBoolean play)

Protected Attributes

OpalMixerEndPointm_endpoint
PSafePtr< OpalMixerNodem_node
bool m_listenOnly
- Protected Attributes inherited from OpalLocalConnection
OpalLocalEndPointendpoint
void * m_userData
- Protected Attributes inherited from OpalConnection
OpalCallownerCall
OpalEndPointendpoint
PString callToken
PBoolean originating
OpalProductInfo productInfo
PString localPartyName
PString displayName
PString remotePartyName
PString remotePartyURL
OpalProductInfo remoteProductInfo
PString remotePartyNumber
PString remotePartyAddress
PString m_redirectingParty
CallEndReason callEndReason
PString m_calledPartyNumber
PString m_calledPartyName
SendUserInputModes sendUserInputMode
PString userInputString
PSyncPoint userInputAvailable
OpalSilenceDetectorsilenceDetector
OpalMediaFormat m_filterMediaFormat
OpalMediaFormatList m_localMediaFormats
MediaAddressesDict mediaTransportAddresses
PSafeList< OpalMediaStreammediaStreams
unsigned minAudioJitterDelay
unsigned maxAudioJitterDelay
unsigned bandwidthAvailable
StringOptions m_stringOptions
PString m_recordingFilename
PNotifier m_recordAudioNotifier
PNotifier m_recordVideoNotifier
unsigned m_VideoUpdateRequestsSent
AutoStartMap m_autoStartInfo
enum OpalConnection:: { ... }  m_faxMediaStreamsSwitchState
ZeroTime m_phaseTime [NumPhases]

Additional Inherited Members

- Public Types inherited from OpalConnection
enum  CallEndReasonCodes {
  EndedByLocalUser, EndedByNoAccept, EndedByAnswerDenied, EndedByRemoteUser,
  EndedByRefusal, EndedByNoAnswer, EndedByCallerAbort, EndedByTransportFail,
  EndedByConnectFail, EndedByGatekeeper, EndedByNoUser, EndedByNoBandwidth,
  EndedByCapabilityExchange, EndedByCallForwarded, EndedBySecurityDenial, EndedByLocalBusy,
  EndedByLocalCongestion, EndedByRemoteBusy, EndedByRemoteCongestion, EndedByUnreachable,
  EndedByNoEndPoint, EndedByHostOffline, EndedByTemporaryFailure, EndedByQ931Cause,
  EndedByDurationLimit, EndedByInvalidConferenceID, EndedByNoDialTone, EndedByNoRingBackTone,
  EndedByOutOfService, EndedByAcceptingCallWaiting, EndedByGkAdmissionFailed, NumCallEndReasons
}
enum  AnswerCallResponse {
  AnswerCallNow, AnswerCallDenied, AnswerCallPending, AnswerCallDeferred,
  AnswerCallAlertWithMedia, AnswerCallDeferredWithMedia, AnswerCallProgress, AnswerCallNowAndReleaseCurrent,
  NumAnswerCallResponses
}
enum  Options {
  FastStartOptionDisable = 0x0001, FastStartOptionEnable = 0x0002, FastStartOptionMask = 0x0003, H245TunnelingOptionDisable = 0x0004,
  H245TunnelingOptionEnable = 0x0008, H245TunnelingOptionMask = 0x000c, H245inSetupOptionDisable = 0x0010, H245inSetupOptionEnable = 0x0020,
  H245inSetupOptionMask = 0x0030, DetectInBandDTMFOptionDisable = 0x0040, DetectInBandDTMFOptionEnable = 0x0080, DetectInBandDTMFOptionMask = 0x00c0,
  RTPAggregationDisable = 0x0100, RTPAggregationEnable = 0x0200, RTPAggregationMask = 0x0300, SendDTMFAsDefault = 0x0000,
  SendDTMFAsString = 0x0400, SendDTMFAsTone = 0x0800, SendDTMFAsRFC2833 = 0x0c00, SendDTMFMask = 0x0c00
}
enum  Phases {
  UninitialisedPhase, SetUpPhase, ProceedingPhase, AlertingPhase,
  ConnectedPhase, EstablishedPhase, ForwardingPhase, ReleasingPhase,
  ReleasedPhase, NumPhases
}
enum  SendUserInputModes {
  SendUserInputAsQ931, SendUserInputAsString, SendUserInputAsTone, SendUserInputAsRFC2833,
  SendUserInputInBand, SendUserInputAsProtocolDefault, NumSendUserInputModes, SendUserInputAsInlineRFC2833 = SendUserInputAsRFC2833
}
- Static Public Member Functions inherited from OpalConnection
static PString GetCallEndReasonText (CallEndReason reason)
static void SetCallEndReasonText (CallEndReasonCodes reasonCode, const PString &newText)
- Protected Types inherited from OpalConnection
enum  { e_NotSwitchingFaxMediaStreams, e_SwitchingToFaxMediaStreams, e_SwitchingFromFaxMediaStreams }
- Protected Member Functions inherited from OpalConnection
void OnConnectedInternal ()
 PDECLARE_NOTIFIER (PThread, OpalConnection, OnReleaseThreadMain)
 PDECLARE_NOTIFIER (RTP_DataFrame, OpalConnection, OnRecordAudio)
 PDECLARE_NOTIFIER (RTP_DataFrame, OpalConnection, OnRecordVideo)
void OnStartRecording (OpalMediaPatch *patch)
void OnStopRecording (OpalMediaPatch *patch)

Detailed Description

Mixer connection.

Constructor & Destructor Documentation

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

Create a new connection.

Parameters
nodeNode the connection is in
callOwner calll for connection
endpointOwner endpoint for connection
userDataArbitrary data to pass to connection
optionsOption bit map to be passed to connection
stringOptionsOptions to be passed to connection
OpalMixerConnection::~OpalMixerConnection ( )

Destroy connection.

Member Function Documentation

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
mediaFormatMedia format for stream
sessionIDSession number for stream
isSourceIs a source stream

Reimplemented from OpalLocalConnection.

bool OpalMixerConnection::GetListenOnly ( ) const
inline

Get flag for this connection is in listen only mode.

References m_listenOnly.

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.

References m_node.

virtual void OpalMixerConnection::OnApplyStringOptions ( )
virtual

Call back for connection to act on changed string options.

Reimplemented from OpalLocalConnection.

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
patchPatch being started

Reimplemented from OpalConnection.

virtual PBoolean OpalMixerConnection::SendUserInputString ( const PString &  value)
virtual

Send a user input indication to the remote endpoint. This is for sending arbitrary strings as user indications.

The default behaviour is to call SendUserInputTone() for each character in the string.

Parameters
valueString value of indication

Reimplemented from OpalLocalConnection.

virtual PBoolean OpalMixerConnection::SendUserInputTone ( char  tone,
unsigned  duration = 0 
)
virtual

Send a user input indication to the remote endpoint. This sends DTMF emulation user input. If something more sophisticated than the simple tones that can be sent using the SendUserInput() function.

A duration of zero indicates that no duration is to be indicated. A non-zero logical channel indicates that the tone is to be syncronised with the logical channel at the rtpTimestamp value specified.

The tone parameter must be one of "0123456789#*ABCD!" where '!' indicates a hook flash. If tone is a ' ' character then a signalUpdate PDU is sent that updates the last tone indication sent. See the H.245 specifcation for more details on this.

The default behaviour sends the tone using RFC2833.

Parameters
toneDTMF tone code
durationDuration of tone in milliseconds

Reimplemented from OpalConnection.

void OpalMixerConnection::SetListenOnly ( bool  listenOnly)

Set this connection to listen only mode.

Parameters
listenOnlyNew listen only state.

Field Documentation

OpalMixerEndPoint& OpalMixerConnection::m_endpoint
protected
bool OpalMixerConnection::m_listenOnly
protected

Referenced by GetListenOnly().

PSafePtr<OpalMixerNode> OpalMixerConnection::m_node
protected

Referenced by GetNode().


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