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
18
23
28
33
38
43
48
53 };
54
59
64
69
74
79
84
89
94 };
95
100
105
114
119
124
129 };
130
135
140
145
150
155 };
156
161
166
171
176
180 INVITATION_API_CALL_ERR_ALREADY_END = 3, // accepted, failure, canceled, refused
181
186
191 };
192
197 {
198 protected:
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
259 {
260 protected:
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
312 {
313 public:
315 {
316 }
317
324 {
325 (ILocalCallInvitation *) localInvitation;
326 }
327
333 virtual void onLocalInvitationCanceled(ILocalCallInvitation *localInvitation)
334 {
335 (ILocalCallInvitation *) localInvitation;
336 }
337
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
411 {
412 (IRemoteCallInvitation *) remoteInvitation;
413 }
414
420 virtual void onRemoteInvitationCanceled(IRemoteCallInvitation *remoteInvitation)
421 {
422 (IRemoteCallInvitation *) remoteInvitation;
423 }
424 };
425
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}
Definition: IAgoraRtmCallManager.h:197
virtual void setChannelId(const char *channelId)=0
virtual const char * getChannelId() const =0
virtual const char * getCalleeId() const =0
virtual void setContent(const char *content)=0
virtual const char * getResponse() const =0
virtual ~ILocalCallInvitation()
Definition: IAgoraRtmCallManager.h:199
virtual LOCAL_INVITATION_STATE getState() const =0
virtual const char * getContent() const =0
Definition: IAgoraRtmCallManager.h:259
virtual REMOTE_INVITATION_STATE getState() const =0
virtual const char * getChannelId() const =0
virtual const char * getCallerId() const =0
virtual void setResponse(const char *response)=0
virtual const char * getContent() const =0
virtual ~IRemoteCallInvitation()
Definition: IAgoraRtmCallManager.h:261
virtual const char * getResponse() const =0
Definition: IAgoraRtmCallManager.h:312
virtual void onRemoteInvitationCanceled(IRemoteCallInvitation *remoteInvitation)
Definition: IAgoraRtmCallManager.h:420
virtual void onLocalInvitationReceivedByPeer(ILocalCallInvitation *localInvitation)
Definition: IAgoraRtmCallManager.h:323
virtual void onRemoteInvitationFailure(IRemoteCallInvitation *remoteInvitation, REMOTE_INVITATION_ERR_CODE errorCode)
Definition: IAgoraRtmCallManager.h:410
virtual ~IRtmCallEventHandler()
Definition: IAgoraRtmCallManager.h:314
virtual void onLocalInvitationFailure(ILocalCallInvitation *localInvitation, LOCAL_INVITATION_ERR_CODE errorCode)
Definition: IAgoraRtmCallManager.h:344
virtual void onRemoteInvitationAccepted(IRemoteCallInvitation *remoteInvitation)
Definition: IAgoraRtmCallManager.h:389
virtual void onLocalInvitationAccepted(ILocalCallInvitation *localInvitation, const char *response)
Definition: IAgoraRtmCallManager.h:356
virtual void onLocalInvitationRefused(ILocalCallInvitation *localInvitation, const char *response)
Definition: IAgoraRtmCallManager.h:368
virtual void onRemoteInvitationRefused(IRemoteCallInvitation *remoteInvitation)
Definition: IAgoraRtmCallManager.h:379
virtual void onLocalInvitationCanceled(ILocalCallInvitation *localInvitation)
Definition: IAgoraRtmCallManager.h:333
virtual void onRemoteInvitationReceived(IRemoteCallInvitation *remoteInvitation)
Definition: IAgoraRtmCallManager.h:399
Definition: IAgoraRtmCallManager.h:430
virtual int sendLocalInvitation(ILocalCallInvitation *invitation)=0
virtual void release()=0
virtual ~IRtmCallManager()
Definition: IAgoraRtmCallManager.h:432
virtual int refuseRemoteInvitation(IRemoteCallInvitation *invitation)=0
virtual int cancelLocalInvitation(ILocalCallInvitation *invitation)=0
virtual int acceptRemoteInvitation(IRemoteCallInvitation *invitation)=0
virtual ILocalCallInvitation * createLocalCallInvitation(const char *calleeId)=0
LOCAL_INVITATION_STATE
RETURNED TO THE CALLER. States of an outgoing call invitation.
Definition: IAgoraRtmCallManager.h:17
@ LOCAL_INVITATION_STATE_IDLE
Definition: IAgoraRtmCallManager.h:22
@ LOCAL_INVITATION_STATE_CANCELED
Definition: IAgoraRtmCallManager.h:47
@ LOCAL_INVITATION_STATE_SENT_TO_REMOTE
Definition: IAgoraRtmCallManager.h:27
@ LOCAL_INVITATION_STATE_RECEIVED_BY_REMOTE
Definition: IAgoraRtmCallManager.h:32
@ LOCAL_INVITATION_STATE_REFUSED_BY_REMOTE
Definition: IAgoraRtmCallManager.h:42
@ LOCAL_INVITATION_STATE_FAILURE
Definition: IAgoraRtmCallManager.h:52
@ LOCAL_INVITATION_STATE_ACCEPTED_BY_REMOTE
Definition: IAgoraRtmCallManager.h:37
INVITATION_API_CALL_ERR_CODE
Error codes of the call invitation methods.
Definition: IAgoraRtmCallManager.h:160
@ INVITATION_API_CALL_ERR_ALREADY_SENT
Definition: IAgoraRtmCallManager.h:190
@ INVITATION_API_CALL_ERR_OK
Definition: IAgoraRtmCallManager.h:165
@ INVITATION_API_CALL_ERR_ALREADY_END
Definition: IAgoraRtmCallManager.h:180
@ INVITATION_API_CALL_ERR_ALREADY_ACCEPT
Definition: IAgoraRtmCallManager.h:185
@ INVITATION_API_CALL_ERR_NOT_STARTED
Definition: IAgoraRtmCallManager.h:175
@ INVITATION_API_CALL_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmCallManager.h:170
REMOTE_INVITATION_STATE
RETURNED TO THE CALLEE. States of an incoming call invitation.
Definition: IAgoraRtmCallManager.h:58
@ REMOTE_INVITATION_STATE_REFUSED
Definition: IAgoraRtmCallManager.h:78
@ REMOTE_INVITATION_STATE_FAILURE
Definition: IAgoraRtmCallManager.h:93
@ REMOTE_INVITATION_STATE_IDLE
Definition: IAgoraRtmCallManager.h:63
@ REMOTE_INVITATION_STATE_ACCEPTED
Definition: IAgoraRtmCallManager.h:83
@ REMOTE_INVITATION_STATE_INVITATION_RECEIVED
Definition: IAgoraRtmCallManager.h:68
@ REMOTE_INVITATION_STATE_ACCEPT_SENT_TO_LOCAL
Definition: IAgoraRtmCallManager.h:73
@ REMOTE_INVITATION_STATE_CANCELED
Definition: IAgoraRtmCallManager.h:88
LOCAL_INVITATION_ERR_CODE
RETURNED TO THE CALLER. Error codes of an outgoing call invitation.
Definition: IAgoraRtmCallManager.h:99
@ LOCAL_INVITATION_ERR_INVITATION_EXPIRE
Definition: IAgoraRtmCallManager.h:123
@ LOCAL_INVITATION_ERR_PEER_NO_RESPONSE
Definition: IAgoraRtmCallManager.h:118
@ LOCAL_INVITATION_ERR_OK
Definition: IAgoraRtmCallManager.h:104
@ LOCAL_INVITATION_ERR_NOT_LOGGEDIN
Definition: IAgoraRtmCallManager.h:128
@ LOCAL_INVITATION_ERR_PEER_OFFLINE
Definition: IAgoraRtmCallManager.h:113
REMOTE_INVITATION_ERR_CODE
RETURNED TO THE CALLEE. Error codes of an incoming call invitation.
Definition: IAgoraRtmCallManager.h:134
@ REMOTE_INVITATION_ERR_PEER_OFFLINE
Definition: IAgoraRtmCallManager.h:144
@ REMOTE_INVITATION_ERR_ACCEPT_FAILURE
Definition: IAgoraRtmCallManager.h:149
@ REMOTE_INVITATION_ERR_OK
Definition: IAgoraRtmCallManager.h:139
@ REMOTE_INVITATION_ERR_INVITATION_EXPIRE
Definition: IAgoraRtmCallManager.h:154
Definition: IAgoraRtmCallManager.h:11