Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IPhoneCallServiceSink Class Referenceabstract

Phone call service event callback. More...

#include <IPhoneCallService.h>

Public Member Functions

virtual ~IPhoneCallServiceSink ()
 
virtual void OnAnswerSIPCallResult (bool succeeded, const SIPCallInfo &sipCallInfo, bool accepted)=0
 Answer incoming SIP call response callback.
 
virtual void OnAcceptSIPCallToMeetingResult (bool succeeded, const SIPCallInfo &sipCallInfo)=0
 Accept the upgrade SIP call to meeting result.
 
virtual void OnUpdateSIPCallPeerResult (bool succeeded, const SIPCallInfo &sipCallInfo)=0
 Make a call to peer result.
 
virtual void OnUpdateSIPCallAudioResult (bool succeeded)=0
 Update SIP call audio status result.
 
virtual void OnTransferSIPCallResult (bool succeeded, const SIPCallInfo &sipCallInfo, const SIPCallTransferInfo &transferInfo)=0
 Transfer SIP call result.
 
virtual void OnUpgradeSIPCallToMeetingResult (bool succeeded, const SIPCallInfo &sipCallInfo)=0
 Upgrade SIP call to meeting result.
 
virtual void OnReceiveIncomingSIPCallNotification (const SIPCallInfo &sipCallInfo)=0
 Receive incoming SIP call notification.
 
virtual void OnTreatSIPCallNotification (bool accepted, const SIPCallInfo &sipCallInfo)=0
 Treat SIP call notification.
 
virtual void OnInviteSIPCallToJoinMeetingNotification (const SIPCallInfo &sipCallInfo)=0
 The invitation to upgrade the SIP call to meeting.
 
virtual void OnTerminateSIPCallNotification (SIPCallTerminateReason reason, const SIPCallInfo &sipCallInfo)=0
 Terminate SIP call notification.
 
virtual void OnUpdateSIPCallAudioStatusNotification (bool muted)=0
 Update SIP call audio status notification.
 
virtual void OnUpdateSIPCallStatusNotification (const SIPCallInfo &sipCallInfo)=0
 Update SIP call notification.
 
virtual void OnTransferSIPCallNotification (bool succeeded, const SIPCallInfo &sipCallInfo)=0
 Transfer SIP call notification.
 
virtual void OnUpgradeSIPCallToMeetingNotification (bool succeeded, const SIPCallInfo &sipCallInfo)=0
 Upgrade the SIP call to meeting notification.
 
virtual void OnUpdateSIPServiceStatusNotification (const SIPService &sipService)=0
 Update SIP service info notification.
 

Detailed Description

Phone call service event callback.

Definition at line 254 of file IPhoneCallService.h.

Constructor & Destructor Documentation

◆ ~IPhoneCallServiceSink()

virtual IPhoneCallServiceSink::~IPhoneCallServiceSink ( )
inlinevirtual

Definition at line 257 of file IPhoneCallService.h.

257{}

Member Function Documentation

◆ OnAcceptSIPCallToMeetingResult()

virtual void IPhoneCallServiceSink::OnAcceptSIPCallToMeetingResult ( bool  succeeded,
const SIPCallInfo sipCallInfo 
)
pure virtual

Accept the upgrade SIP call to meeting result.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
succeededTRUE indicates accept the upgrade SIP call to meeting successfully. Otherwise not.
sipCallInfoThe SIP call which the peer wants to upgrade to meeting.

◆ OnAnswerSIPCallResult()

virtual void IPhoneCallServiceSink::OnAnswerSIPCallResult ( bool  succeeded,
const SIPCallInfo sipCallInfo,
bool  accepted 
)
pure virtual

Answer incoming SIP call response callback.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
succeededTURE indicates answer the incoming SIP call successfully. Otherwise not.
sipCallInfoThe SIP call which is answered.
acceptedTURE indicates accept the incoming SIP call. Otherwise not.

◆ OnInviteSIPCallToJoinMeetingNotification()

virtual void IPhoneCallServiceSink::OnInviteSIPCallToJoinMeetingNotification ( const SIPCallInfo sipCallInfo)
pure virtual

The invitation to upgrade the SIP call to meeting.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
sipCallInfoThe SIP call which the peer wants to upgrade to meeting.

◆ OnReceiveIncomingSIPCallNotification()

virtual void IPhoneCallServiceSink::OnReceiveIncomingSIPCallNotification ( const SIPCallInfo sipCallInfo)
pure virtual

Receive incoming SIP call notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
sipCallInfoThe SIP call which is received.

◆ OnTerminateSIPCallNotification()

virtual void IPhoneCallServiceSink::OnTerminateSIPCallNotification ( SIPCallTerminateReason  reason,
const SIPCallInfo sipCallInfo 
)
pure virtual

Terminate SIP call notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
reasonThe reason why the SIP call is terminated.
sipCallInfoThe SIP call which is terminated.

◆ OnTransferSIPCallNotification()

virtual void IPhoneCallServiceSink::OnTransferSIPCallNotification ( bool  succeeded,
const SIPCallInfo sipCallInfo 
)
pure virtual

Transfer SIP call notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
succeededTRUE indicates the SIP call is transferred successfully. Otherwise not.
sipCallInfoThe SIP call which is transferred.

◆ OnTransferSIPCallResult()

virtual void IPhoneCallServiceSink::OnTransferSIPCallResult ( bool  succeeded,
const SIPCallInfo sipCallInfo,
const SIPCallTransferInfo transferInfo 
)
pure virtual

Transfer SIP call result.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
succeededTRUE indicates transfer the SIP call successfully. Otherwise not.
sipCallInfoThe SIP call which is transferred.
transferInfoThe struct includes transfer's type and peer URI who the call is transferred to, details SIPCallTransferInfo struct.

◆ OnTreatSIPCallNotification()

virtual void IPhoneCallServiceSink::OnTreatSIPCallNotification ( bool  accepted,
const SIPCallInfo sipCallInfo 
)
pure virtual

Treat SIP call notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
acceptedTRUE indicates the SIP call is accepted. Otherwise not.
sipCallInfoThe SIP call which is treated.

◆ OnUpdateSIPCallAudioResult()

virtual void IPhoneCallServiceSink::OnUpdateSIPCallAudioResult ( bool  succeeded)
pure virtual

Update SIP call audio status result.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
succeededTRUE indicates update SIP call audio successfully.Otherwise not.

◆ OnUpdateSIPCallAudioStatusNotification()

virtual void IPhoneCallServiceSink::OnUpdateSIPCallAudioStatusNotification ( bool  muted)
pure virtual

Update SIP call audio status notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
mutedThe status of SIP call audio.

◆ OnUpdateSIPCallPeerResult()

virtual void IPhoneCallServiceSink::OnUpdateSIPCallPeerResult ( bool  succeeded,
const SIPCallInfo sipCallInfo 
)
pure virtual

Make a call to peer result.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
succeededTRUE indicates call peer successfully. Otherwise not.
sipCallInfoThe call with peer.

◆ OnUpdateSIPCallStatusNotification()

virtual void IPhoneCallServiceSink::OnUpdateSIPCallStatusNotification ( const SIPCallInfo sipCallInfo)
pure virtual

Update SIP call notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
sipCallInfoThe new SIP call info.

◆ OnUpdateSIPServiceStatusNotification()

virtual void IPhoneCallServiceSink::OnUpdateSIPServiceStatusNotification ( const SIPService sipService)
pure virtual

Update SIP service info notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
sipServiceThe new SIP service info.

◆ OnUpgradeSIPCallToMeetingNotification()

virtual void IPhoneCallServiceSink::OnUpgradeSIPCallToMeetingNotification ( bool  succeeded,
const SIPCallInfo sipCallInfo 
)
pure virtual

Upgrade the SIP call to meeting notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
succeededTRUE indicates upgrade the SIP call to meeting successfully. Otherwise not.
sipCallInfoThe SIP call which is upgraded.

◆ OnUpgradeSIPCallToMeetingResult()

virtual void IPhoneCallServiceSink::OnUpgradeSIPCallToMeetingResult ( bool  succeeded,
const SIPCallInfo sipCallInfo 
)
pure virtual

Upgrade SIP call to meeting result.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
succeededTRUE indicates upgrade the SIP call to meeting successfully. Otherwise not.
sipCallInfoThe SIP call which is upgraded to meeting.