OPAL
Version 3.10.10
|
#include <localep.h>
Public Member Functions | |
Construction | |
OpalLocalConnection (OpalCall &call, OpalLocalEndPoint &endpoint, void *userData, unsigned options, OpalConnection::StringOptions *stringOptions, char tokenPrefix= 'L') | |
~OpalLocalConnection () | |
Overrides from OpalConnection | |
virtual PBoolean | IsNetworkConnection () const |
virtual void | OnApplyStringOptions () |
Call back for connection to act on changed string options. More... | |
virtual PBoolean | SetUpConnection () |
virtual PBoolean | SetAlerting (const PString &calleeName, PBoolean withMedia) |
virtual PBoolean | SetConnected () |
virtual OpalMediaStream * | CreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, PBoolean isSource) |
virtual OpalMediaStreamPtr | OpenMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource) |
virtual PBoolean | SendUserInputString (const PString &value) |
New operations | |
virtual bool | OnOutgoingSetUp () |
virtual bool | OnOutgoing () |
virtual bool | OnIncoming () |
virtual void | AlertingIncoming () |
virtual void | AcceptIncoming () |
Member variable access | |
void * | GetUserData () const |
Get user data pointer. More... | |
void | SetUserData (void *v) |
Set user data pointer. More... | |
![]() | |
virtual bool | GarbageCollection () |
const StringOptions & | GetStringOptions () const |
Get the string options associated with this connection. More... | |
void | SetStringOptions (const StringOptions &options, bool overwrite) |
Set the string options associated with this connection. More... | |
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 void | OnReleased () |
virtual PString | GetDestinationAddress () |
virtual PBoolean | ForwardCall (const PString &forwardParty) |
PSafePtr< OpalConnection > | GetOtherPartyConnection () const |
template<class cls > | |
PSafePtr< cls > | GetOtherPartyConnectionAs () const |
virtual OpalMediaFormatList | GetMediaFormats () 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 | OnStartMediaPatch (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) |
OpalEndPoint & | GetEndPoint () const |
OpalCall & | GetCall () 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 OpalProductInfo & | GetProductInfo () 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 OpalProductInfo & | GetRemoteProductInfo () 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) |
OpalSilenceDetector * | GetSilenceDetector () const |
virtual PString | GetIdentifier () const |
virtual PINDEX | GetMaxRtpPayloadSize () const |
virtual OpalTransport & | GetTransport () 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. More... | |
__inline bool | IsReleased () const |
Return true if connection is in the established phase. More... | |
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 PBoolean | SendUserInputTone (char tone, unsigned duration=0) |
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) |
Local connection. This class represents a connection on the local machine that can receive media via virtual functions.
OpalLocalConnection::OpalLocalConnection | ( | OpalCall & | call, |
OpalLocalEndPoint & | endpoint, | ||
void * | userData, | ||
unsigned | options, | ||
OpalConnection::StringOptions * | stringOptions, | ||
char | tokenPrefix = 'L' |
||
) |
Create a new connection.
call | Owner call for connection |
endpoint | Owner endpoint for connection |
userData | Arbitrary data to pass to connection |
options | Option bit mask to pass to connection |
stringOptions | Options to pass to connection |
tokenPrefix | Prefix for token generation |
OpalLocalConnection::~OpalLocalConnection | ( | ) |
Destroy connection.
|
virtual |
Accept the incoming connection.
|
virtual |
Indicate alerting for the incoming connection.
|
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.
mediaFormat | Media format for stream |
sessionID | Session number for stream |
isSource | Is a source stream |
Reimplemented from OpalConnection.
Reimplemented in OpalMixerConnection, OpalPCSSConnection, OpalIVRConnection, and OpalFaxConnection.
|
inline |
Get user data pointer.
|
inlinevirtual |
Get indication of connection being to a "network". This indicates the if the connection may be regarded as a "network" connection. The distinction is about if there is a concept of a "remote" party being connected to and is best described by example: sip, h323, iax and pstn are all "network" connections as they connect to something "remote". While pc, pots and ivr are not as the entity being connected to is intrinsically local.
Implements OpalConnection.
Reimplemented in OpalIVRConnection.
References OpalLocalEndPoint::OnOutgoingSetUp().
|
virtual |
Call back for connection to act on changed string options.
Reimplemented from OpalConnection.
Reimplemented in OpalMixerConnection.
|
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 call OpalLocalEndPoint::OnIncomingCall().
|
virtual |
Call back to indicate that remote is ringing.
The default implementation call OpalLocalEndPoint::OnOutgoingCall().
|
virtual |
Call back just before remote is contacted.
The default implementation call OpalLocalEndPoint::OnOutgoingSetUp().
|
virtual |
Open source or sink media stream for session.
mediaFormat | Media format to open |
sessionID | Session to start stream on |
isSource | Stream is a source/sink |
Reimplemented from OpalConnection.
|
virtual |
Send a user input indication to the remote endpoint. This sends an arbitrary string as a user indication. If DTMF tones in particular are required to be sent then the SendIndicationTone() function should be used.
The default behaviour plays the DTMF tones on the line.
value | String value of indication |
Reimplemented from OpalConnection.
Reimplemented in OpalMixerConnection, and OpalIVRConnection.
|
virtual |
Indicate to remote endpoint an alert is in progress. If this is an incoming connection and the AnswerCallResponse is in a AnswerCallDeferred or AnswerCallPending state, then this function is used to indicate to that endpoint that an alert is in progress. This is usually due to another connection which is in the call (the B party) has received an OnAlerting() indicating that its remote endpoint is "ringing".
The default behaviour does nothing.
calleeName | Name of endpoint being alerted. |
withMedia | Open media with alerting |
Implements OpalConnection.
|
virtual |
Indicate to remote endpoint we are connected.
The default behaviour sets the phase to ConnectedPhase, sets the connection start time and then checks if there is any media channels opened and if so, moves on to the established phase, calling OnEstablished().
In other words, this method is used to handle incoming calls, and is an indication that we have accepted the incoming call.
Reimplemented from OpalConnection.
|
virtual |
Start an outgoing connection. This function will initiate the connection to the remote entity, for example in H.323 it sends a SETUP, in SIP it sends an INVITE etc.
The default behaviour determines if this si incoming or outgoing call by checking if we are party A or B, then does approriate setting up of the conenction, including calling OnOutgoing() or OnIncoming() as appropriate.
Implements OpalConnection.
|
inline |
Set user data pointer.
|
protected |
|
protected |