Signaling (previously RTM) SDK v1.5.0 API Reference for Windows (C++)
IAgoraRtmCallManager.h
1//
2// Agora's RTM SDK
3//
4//
5// Copyright (c) 2019 Agora.io. All rights reserved.
6//
7#pragma once
8
9#include "IAgoraRtmService.h"
10
11namespace agora {
12 namespace rtm {
13
17 enum LOCAL_INVITATION_STATE {
18
22 LOCAL_INVITATION_STATE_IDLE = 0,
23
27 LOCAL_INVITATION_STATE_SENT_TO_REMOTE = 1,
28
32 LOCAL_INVITATION_STATE_RECEIVED_BY_REMOTE = 2,
33
37 LOCAL_INVITATION_STATE_ACCEPTED_BY_REMOTE = 3,
38
42 LOCAL_INVITATION_STATE_REFUSED_BY_REMOTE = 4,
43
47 LOCAL_INVITATION_STATE_CANCELED = 5,
48
52 LOCAL_INVITATION_STATE_FAILURE = 6,
53 };
54
58 enum REMOTE_INVITATION_STATE {
59
63 REMOTE_INVITATION_STATE_IDLE = 0,
64
68 REMOTE_INVITATION_STATE_INVITATION_RECEIVED = 1,
69
73 REMOTE_INVITATION_STATE_ACCEPT_SENT_TO_LOCAL = 2,
74
78 REMOTE_INVITATION_STATE_REFUSED = 3,
79
83 REMOTE_INVITATION_STATE_ACCEPTED = 4,
84
88 REMOTE_INVITATION_STATE_CANCELED = 5,
89
93 REMOTE_INVITATION_STATE_FAILURE = 6,
94 };
95
99 enum LOCAL_INVITATION_ERR_CODE {
100
104 LOCAL_INVITATION_ERR_OK = 0,
105
113 LOCAL_INVITATION_ERR_PEER_OFFLINE = 1,
114
118 LOCAL_INVITATION_ERR_PEER_NO_RESPONSE = 2,
119
123 LOCAL_INVITATION_ERR_INVITATION_EXPIRE = 3,
124
128 LOCAL_INVITATION_ERR_NOT_LOGGEDIN = 4,
129 };
130
134 enum REMOTE_INVITATION_ERR_CODE {
135
139 REMOTE_INVITATION_ERR_OK = 0,
140
144 REMOTE_INVITATION_ERR_PEER_OFFLINE = 1,
145
149 REMOTE_INVITATION_ERR_ACCEPT_FAILURE = 2,
150
154 REMOTE_INVITATION_ERR_INVITATION_EXPIRE = 3,
155 };
156
160 enum INVITATION_API_CALL_ERR_CODE {
161
165 INVITATION_API_CALL_ERR_OK = 0,
166
170 INVITATION_API_CALL_ERR_INVALID_ARGUMENT = 1,
171
175 INVITATION_API_CALL_ERR_NOT_STARTED = 2,
176
180 INVITATION_API_CALL_ERR_ALREADY_END = 3, // accepted, failure, canceled, refused
181
185 INVITATION_API_CALL_ERR_ALREADY_ACCEPT = 4, // more details
186
190 INVITATION_API_CALL_ERR_ALREADY_SENT = 5,
191 };
192
196 class ILocalCallInvitation
197 {
198 protected:
199 virtual ~ILocalCallInvitation() {}
200 public:
201
205 virtual const char *getCalleeId() const = 0;
206
212 virtual void setContent(const char *content) = 0;
213
219 virtual const char *getContent() const = 0;
220
228 virtual void setChannelId(const char *channelId) = 0;
229
233 virtual const char *getChannelId() const = 0;
234
240 virtual const char *getResponse() const = 0;
241
247 virtual LOCAL_INVITATION_STATE getState() const = 0;
248
252 virtual void release() = 0;
253 };
254
258 class IRemoteCallInvitation
259 {
260 protected:
261 virtual ~IRemoteCallInvitation() {}
262 public:
263
267 virtual const char *getCallerId() const = 0;
268
274 virtual const char *getContent() const = 0;
275
281 virtual void setResponse(const char *response) = 0;
282
288 virtual const char *getResponse() const = 0;
289
293 virtual const char *getChannelId() const = 0;
294
300 virtual REMOTE_INVITATION_STATE getState() const = 0;
301
305 virtual void release() = 0;
306 };
307
311 class IRtmCallEventHandler
312 {
313 public:
314 virtual ~IRtmCallEventHandler()
315 {
316 }
317
323 virtual void onLocalInvitationReceivedByPeer(ILocalCallInvitation *localInvitation)
324 {
325 (ILocalCallInvitation *) localInvitation;
326 }
327
333 virtual void onLocalInvitationCanceled(ILocalCallInvitation *localInvitation)
334 {
335 (ILocalCallInvitation *) localInvitation;
336 }
337
344 virtual void onLocalInvitationFailure(ILocalCallInvitation *localInvitation, LOCAL_INVITATION_ERR_CODE errorCode)
345 {
346 (ILocalCallInvitation *) localInvitation;
347 (LOCAL_INVITATION_ERR_CODE) errorCode;
348 }
349
356 virtual void onLocalInvitationAccepted(ILocalCallInvitation *localInvitation, const char *response)
357 {
358 (ILocalCallInvitation *) localInvitation;
359 (const char *) response;
360 }
361
368 virtual void onLocalInvitationRefused(ILocalCallInvitation *localInvitation, const char *response)
369 {
370 (ILocalCallInvitation *) localInvitation;
371 (const char *) response;
372 }
373
379 virtual void onRemoteInvitationRefused(IRemoteCallInvitation *remoteInvitation)
380 {
381 (IRemoteCallInvitation *) remoteInvitation;
382 }
383
389 virtual void onRemoteInvitationAccepted(IRemoteCallInvitation *remoteInvitation)
390 {
391 (IRemoteCallInvitation *) remoteInvitation;
392 }
393
399 virtual void onRemoteInvitationReceived(IRemoteCallInvitation *remoteInvitation)
400 {
401 (IRemoteCallInvitation *) remoteInvitation;
402 }
403
410 virtual void onRemoteInvitationFailure(IRemoteCallInvitation *remoteInvitation, REMOTE_INVITATION_ERR_CODE errorCode)
411 {
412 (IRemoteCallInvitation *) remoteInvitation;
413 }
414
420 virtual void onRemoteInvitationCanceled(IRemoteCallInvitation *remoteInvitation)
421 {
422 (IRemoteCallInvitation *) remoteInvitation;
423 }
424 };
425
429 class IRtmCallManager
430 {
431 protected:
432 virtual ~IRtmCallManager() {}
433 public:
434
443 virtual int sendLocalInvitation(ILocalCallInvitation *invitation)= 0;
444
453 virtual int acceptRemoteInvitation(IRemoteCallInvitation *invitation) = 0;
454
463 virtual int refuseRemoteInvitation(IRemoteCallInvitation *invitation) = 0;
464
473 virtual int cancelLocalInvitation(ILocalCallInvitation *invitation) = 0;
474
481 virtual ILocalCallInvitation *createLocalCallInvitation(const char *calleeId) = 0;
482
483 // sync_call
487 virtual void release() = 0;
488 };
489 }
490}
agora::rtm::ILocalCallInvitation
Definition: IAgoraRtmCallManager.h:197
agora::rtm::ILocalCallInvitation::setChannelId
virtual void setChannelId(const char *channelId)=0
agora::rtm::ILocalCallInvitation::getChannelId
virtual const char * getChannelId() const =0
agora::rtm::ILocalCallInvitation::getCalleeId
virtual const char * getCalleeId() const =0
agora::rtm::ILocalCallInvitation::setContent
virtual void setContent(const char *content)=0
agora::rtm::ILocalCallInvitation::getResponse
virtual const char * getResponse() const =0
agora::rtm::ILocalCallInvitation::~ILocalCallInvitation
virtual ~ILocalCallInvitation()
Definition: IAgoraRtmCallManager.h:199
agora::rtm::ILocalCallInvitation::getState
virtual LOCAL_INVITATION_STATE getState() const =0
agora::rtm::ILocalCallInvitation::getContent
virtual const char * getContent() const =0
agora::rtm::IRemoteCallInvitation
Definition: IAgoraRtmCallManager.h:259
agora::rtm::IRemoteCallInvitation::getState
virtual REMOTE_INVITATION_STATE getState() const =0
agora::rtm::IRemoteCallInvitation::getChannelId
virtual const char * getChannelId() const =0
agora::rtm::IRemoteCallInvitation::getCallerId
virtual const char * getCallerId() const =0
agora::rtm::IRemoteCallInvitation::setResponse
virtual void setResponse(const char *response)=0
agora::rtm::IRemoteCallInvitation::getContent
virtual const char * getContent() const =0
agora::rtm::IRemoteCallInvitation::~IRemoteCallInvitation
virtual ~IRemoteCallInvitation()
Definition: IAgoraRtmCallManager.h:261
agora::rtm::IRemoteCallInvitation::getResponse
virtual const char * getResponse() const =0
agora::rtm::IRtmCallEventHandler
Definition: IAgoraRtmCallManager.h:312
agora::rtm::IRtmCallEventHandler::onRemoteInvitationCanceled
virtual void onRemoteInvitationCanceled(IRemoteCallInvitation *remoteInvitation)
Definition: IAgoraRtmCallManager.h:420
agora::rtm::IRtmCallEventHandler::onLocalInvitationReceivedByPeer
virtual void onLocalInvitationReceivedByPeer(ILocalCallInvitation *localInvitation)
Definition: IAgoraRtmCallManager.h:323
agora::rtm::IRtmCallEventHandler::onRemoteInvitationFailure
virtual void onRemoteInvitationFailure(IRemoteCallInvitation *remoteInvitation, REMOTE_INVITATION_ERR_CODE errorCode)
Definition: IAgoraRtmCallManager.h:410
agora::rtm::IRtmCallEventHandler::~IRtmCallEventHandler
virtual ~IRtmCallEventHandler()
Definition: IAgoraRtmCallManager.h:314
agora::rtm::IRtmCallEventHandler::onLocalInvitationFailure
virtual void onLocalInvitationFailure(ILocalCallInvitation *localInvitation, LOCAL_INVITATION_ERR_CODE errorCode)
Definition: IAgoraRtmCallManager.h:344
agora::rtm::IRtmCallEventHandler::onRemoteInvitationAccepted
virtual void onRemoteInvitationAccepted(IRemoteCallInvitation *remoteInvitation)
Definition: IAgoraRtmCallManager.h:389
agora::rtm::IRtmCallEventHandler::onLocalInvitationAccepted
virtual void onLocalInvitationAccepted(ILocalCallInvitation *localInvitation, const char *response)
Definition: IAgoraRtmCallManager.h:356
agora::rtm::IRtmCallEventHandler::onLocalInvitationRefused
virtual void onLocalInvitationRefused(ILocalCallInvitation *localInvitation, const char *response)
Definition: IAgoraRtmCallManager.h:368
agora::rtm::IRtmCallEventHandler::onRemoteInvitationRefused
virtual void onRemoteInvitationRefused(IRemoteCallInvitation *remoteInvitation)
Definition: IAgoraRtmCallManager.h:379
agora::rtm::IRtmCallEventHandler::onLocalInvitationCanceled
virtual void onLocalInvitationCanceled(ILocalCallInvitation *localInvitation)
Definition: IAgoraRtmCallManager.h:333
agora::rtm::IRtmCallEventHandler::onRemoteInvitationReceived
virtual void onRemoteInvitationReceived(IRemoteCallInvitation *remoteInvitation)
Definition: IAgoraRtmCallManager.h:399
agora::rtm::IRtmCallManager
Definition: IAgoraRtmCallManager.h:430
agora::rtm::IRtmCallManager::sendLocalInvitation
virtual int sendLocalInvitation(ILocalCallInvitation *invitation)=0
agora::rtm::IRtmCallManager::release
virtual void release()=0
agora::rtm::IRtmCallManager::~IRtmCallManager
virtual ~IRtmCallManager()
Definition: IAgoraRtmCallManager.h:432
agora::rtm::IRtmCallManager::refuseRemoteInvitation
virtual int refuseRemoteInvitation(IRemoteCallInvitation *invitation)=0
agora::rtm::IRtmCallManager::cancelLocalInvitation
virtual int cancelLocalInvitation(ILocalCallInvitation *invitation)=0
agora::rtm::IRtmCallManager::acceptRemoteInvitation
virtual int acceptRemoteInvitation(IRemoteCallInvitation *invitation)=0
agora::rtm::IRtmCallManager::createLocalCallInvitation
virtual ILocalCallInvitation * createLocalCallInvitation(const char *calleeId)=0
agora::rtm::LOCAL_INVITATION_STATE
LOCAL_INVITATION_STATE
RETURNED TO THE CALLER. States of an outgoing call invitation.
Definition: IAgoraRtmCallManager.h:17
agora::rtm::LOCAL_INVITATION_STATE_IDLE
@ LOCAL_INVITATION_STATE_IDLE
Definition: IAgoraRtmCallManager.h:22
agora::rtm::LOCAL_INVITATION_STATE_CANCELED
@ LOCAL_INVITATION_STATE_CANCELED
Definition: IAgoraRtmCallManager.h:47
agora::rtm::LOCAL_INVITATION_STATE_SENT_TO_REMOTE
@ LOCAL_INVITATION_STATE_SENT_TO_REMOTE
Definition: IAgoraRtmCallManager.h:27
agora::rtm::LOCAL_INVITATION_STATE_RECEIVED_BY_REMOTE
@ LOCAL_INVITATION_STATE_RECEIVED_BY_REMOTE
Definition: IAgoraRtmCallManager.h:32
agora::rtm::LOCAL_INVITATION_STATE_REFUSED_BY_REMOTE
@ LOCAL_INVITATION_STATE_REFUSED_BY_REMOTE
Definition: IAgoraRtmCallManager.h:42
agora::rtm::LOCAL_INVITATION_STATE_FAILURE
@ LOCAL_INVITATION_STATE_FAILURE
Definition: IAgoraRtmCallManager.h:52
agora::rtm::LOCAL_INVITATION_STATE_ACCEPTED_BY_REMOTE
@ LOCAL_INVITATION_STATE_ACCEPTED_BY_REMOTE
Definition: IAgoraRtmCallManager.h:37
agora::rtm::INVITATION_API_CALL_ERR_CODE
INVITATION_API_CALL_ERR_CODE
Error codes of the call invitation methods.
Definition: IAgoraRtmCallManager.h:160
agora::rtm::INVITATION_API_CALL_ERR_ALREADY_SENT
@ INVITATION_API_CALL_ERR_ALREADY_SENT
Definition: IAgoraRtmCallManager.h:190
agora::rtm::INVITATION_API_CALL_ERR_OK
@ INVITATION_API_CALL_ERR_OK
Definition: IAgoraRtmCallManager.h:165
agora::rtm::INVITATION_API_CALL_ERR_ALREADY_END
@ INVITATION_API_CALL_ERR_ALREADY_END
Definition: IAgoraRtmCallManager.h:180
agora::rtm::INVITATION_API_CALL_ERR_ALREADY_ACCEPT
@ INVITATION_API_CALL_ERR_ALREADY_ACCEPT
Definition: IAgoraRtmCallManager.h:185
agora::rtm::INVITATION_API_CALL_ERR_NOT_STARTED
@ INVITATION_API_CALL_ERR_NOT_STARTED
Definition: IAgoraRtmCallManager.h:175
agora::rtm::INVITATION_API_CALL_ERR_INVALID_ARGUMENT
@ INVITATION_API_CALL_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmCallManager.h:170
agora::rtm::REMOTE_INVITATION_STATE
REMOTE_INVITATION_STATE
RETURNED TO THE CALLEE. States of an incoming call invitation.
Definition: IAgoraRtmCallManager.h:58
agora::rtm::REMOTE_INVITATION_STATE_REFUSED
@ REMOTE_INVITATION_STATE_REFUSED
Definition: IAgoraRtmCallManager.h:78
agora::rtm::REMOTE_INVITATION_STATE_FAILURE
@ REMOTE_INVITATION_STATE_FAILURE
Definition: IAgoraRtmCallManager.h:93
agora::rtm::REMOTE_INVITATION_STATE_IDLE
@ REMOTE_INVITATION_STATE_IDLE
Definition: IAgoraRtmCallManager.h:63
agora::rtm::REMOTE_INVITATION_STATE_ACCEPTED
@ REMOTE_INVITATION_STATE_ACCEPTED
Definition: IAgoraRtmCallManager.h:83
agora::rtm::REMOTE_INVITATION_STATE_INVITATION_RECEIVED
@ REMOTE_INVITATION_STATE_INVITATION_RECEIVED
Definition: IAgoraRtmCallManager.h:68
agora::rtm::REMOTE_INVITATION_STATE_ACCEPT_SENT_TO_LOCAL
@ REMOTE_INVITATION_STATE_ACCEPT_SENT_TO_LOCAL
Definition: IAgoraRtmCallManager.h:73
agora::rtm::REMOTE_INVITATION_STATE_CANCELED
@ REMOTE_INVITATION_STATE_CANCELED
Definition: IAgoraRtmCallManager.h:88
agora::rtm::LOCAL_INVITATION_ERR_CODE
LOCAL_INVITATION_ERR_CODE
RETURNED TO THE CALLER. Error codes of an outgoing call invitation.
Definition: IAgoraRtmCallManager.h:99
agora::rtm::LOCAL_INVITATION_ERR_INVITATION_EXPIRE
@ LOCAL_INVITATION_ERR_INVITATION_EXPIRE
Definition: IAgoraRtmCallManager.h:123
agora::rtm::LOCAL_INVITATION_ERR_PEER_NO_RESPONSE
@ LOCAL_INVITATION_ERR_PEER_NO_RESPONSE
Definition: IAgoraRtmCallManager.h:118
agora::rtm::LOCAL_INVITATION_ERR_OK
@ LOCAL_INVITATION_ERR_OK
Definition: IAgoraRtmCallManager.h:104
agora::rtm::LOCAL_INVITATION_ERR_NOT_LOGGEDIN
@ LOCAL_INVITATION_ERR_NOT_LOGGEDIN
Definition: IAgoraRtmCallManager.h:128
agora::rtm::LOCAL_INVITATION_ERR_PEER_OFFLINE
@ LOCAL_INVITATION_ERR_PEER_OFFLINE
Definition: IAgoraRtmCallManager.h:113
agora::rtm::REMOTE_INVITATION_ERR_CODE
REMOTE_INVITATION_ERR_CODE
RETURNED TO THE CALLEE. Error codes of an incoming call invitation.
Definition: IAgoraRtmCallManager.h:134
agora::rtm::REMOTE_INVITATION_ERR_PEER_OFFLINE
@ REMOTE_INVITATION_ERR_PEER_OFFLINE
Definition: IAgoraRtmCallManager.h:144
agora::rtm::REMOTE_INVITATION_ERR_ACCEPT_FAILURE
@ REMOTE_INVITATION_ERR_ACCEPT_FAILURE
Definition: IAgoraRtmCallManager.h:149
agora::rtm::REMOTE_INVITATION_ERR_OK
@ REMOTE_INVITATION_ERR_OK
Definition: IAgoraRtmCallManager.h:139
agora::rtm::REMOTE_INVITATION_ERR_INVITATION_EXPIRE
@ REMOTE_INVITATION_ERR_INVITATION_EXPIRE
Definition: IAgoraRtmCallManager.h:154
agora
Definition: IAgoraRtmCallManager.h:11
Generated by doxygen 1.9.3