Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
NGIAgoraRtcConnection.h
1//
2// Agora SDK
3//
4// Created by Sting Feng in 2018-01.
5// Copyright (c) 2018 Agora.io. All rights reserved.
6//
7
8#pragma once // NOLINT(build/header_guard)
9
10#include "AgoraBase.h"
11#include "time_utils.h"
12#include <api/cpp/aosl_ares_class.h>
13
14namespace agora {
15namespace rtc {
19class IRtcConnection;
21class ILocalUser;
22
54
59 const char* token;
70 const char* channelId;
77 /*Reserved for future use*/
78 const char* info;
79 /*
80 App can provide a app defined start time to trace some events like connect cost , first video, etc.
81 */
83};
84
180
192 protected:
194
195 public:
223 virtual int connect(const char* token, const char* channelId, const char* info, user_id_t userId, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
224
236 virtual int connect(const TConnectSettings& settings, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
237
249 virtual int disconnect(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
250
278 virtual int startLastmileProbeTest(const LastmileProbeConfig& config, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
279
286 virtual int stopLastmileProbeTest(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
287
299 virtual int renewToken(const char* token, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
300
309
317 virtual ILocalUser* getLocalUser() = 0;
318
331 virtual int getRemoteUsers(UserList& users) = 0;
332
343 virtual int getUserInfo(user_id_t userId, agora::UserInfo& userInfo) = 0;
344
353 virtual int registerObserver(IRtcConnectionObserver* observer, void(*safeDeleter)(IRtcConnectionObserver*) = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
354
364 virtual int unregisterObserver(IRtcConnectionObserver* observer) = 0;
365
374 virtual int registerNetworkObserver(INetworkObserver* observer, void(*safeDeleter)(INetworkObserver*) = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
375
385 virtual int unregisterNetworkObserver(INetworkObserver* observer) = 0;
386
394 virtual conn_id_t getConnId() = 0;
395
404
413
433 virtual int createDataStream(int* streamId, bool reliable, bool ordered, bool sync) = 0;
434
451 virtual int sendStreamMessage(int streamId, const char* data, size_t length, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
452
463 virtual int sendRdtMessage(user_id_t userId, RdtStreamType type, const char *data, size_t length, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
464
475 virtual int sendMediaControlMessage(user_id_t userId, const char* data, size_t length, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
476
495 virtual int enableEncryption(bool enabled, const EncryptionConfig& config, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
496
510 virtual int sendCustomReportMessage(const char* id, const char* category, const char* event, const char* label, int value, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
522 virtual int getUserInfoByUserAccount(const char* userAccount, rtc::UserInfo* userInfo) = 0;
534 virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo* userInfo) = 0;
535
554 virtual int enableMultipath(bool enable, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
555
568 virtual int setUplinkMultipathMode(MultipathMode mode, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
569
582 virtual int setDownlinkMultipathMode(MultipathMode mode, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
583
596 virtual int setPreferMultipathType(MultipathType type, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
597};
598
603 public:
605
612 virtual void onConnected(const TConnectionInfo& connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason) = 0;
613
620 virtual void onDisconnected(const TConnectionInfo& connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason) = 0;
621
628 virtual void onConnecting(const TConnectionInfo& connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason) = 0;
629
636 virtual void onReconnecting(const TConnectionInfo& connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason) = 0;
637
638 // This should be deleted. onConnected is enough.
639 virtual void onReconnected(const TConnectionInfo& connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason) = 0;
640
646 virtual void onConnectionLost(const TConnectionInfo& connectionInfo) = 0;
647
655 virtual void onLastmileQuality(const QUALITY_TYPE quality) = 0;
656
664 virtual void onLastmileProbeResult(const LastmileProbeResult& result) = 0;
665
676 virtual void onTokenPrivilegeWillExpire(const char* token) = 0;
677
684 virtual void onTokenPrivilegeDidExpire() = 0;
685
697 virtual void onRenewTokenResult(const char* token, RENEW_TOKEN_ERROR_CODE code) = 0;
698
705 virtual void onConnectionFailure(const TConnectionInfo& connectionInfo,
707
715 virtual void onUserJoined(user_id_t userId) = 0;
716
725 virtual void onUserLeft(user_id_t userId, USER_OFFLINE_REASON_TYPE reason) = 0;
726
734 virtual void onTransportStats(const RtcStats& stats) = 0;
735
743 virtual void onChangeRoleSuccess(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions& newRoleOptions) {
744 (void)oldRole;
745 (void)newRole;
746 (void)newRoleOptions;
747 }
748
753 (void)reason;
754 (void)currentRole;
755 }
756
764 (void)error;
765 }
766
777 virtual void onUserNetworkQuality(user_id_t userId, QUALITY_TYPE txQuality,
778 QUALITY_TYPE rxQuality) {
779 (void)userId;
780 (void)txQuality;
781 (void)rxQuality;
782 }
783
788 (void)type;
789 }
790
792 virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result) { (void)result; }
805 virtual void onSnapshotTaken(user_id_t userId, const char* filePath, int width, int height, int errCode) {
806 (void)userId;
807 (void)filePath;
808 (void)width;
809 (void)height;
810 (void)errCode;
811 }
812
817 virtual void onError(ERROR_CODE_TYPE error, const char* msg) {
818 (void)error;
819 (void)msg;
820 }
821
851 virtual void onChannelMediaRelayStateChanged(int state, int code) = 0;
852
858 virtual void onLocalUserRegistered(uid_t uid, const char* userAccount) {
859 (void)uid;
860 (void)userAccount;
861 }
862
864 virtual void onUserAccountUpdated(uid_t uid, const char* userAccount) {
865 (void)uid;
866 (void)userAccount;
867 }
868
878 virtual void onStreamMessageError(user_id_t userId, int streamId, int code, int missed,
879 int cached) {
880 (void)userId;
881 (void)streamId;
882 (void)code;
883 (void)missed;
884 (void)cached;
885 }
886
891 virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType) {
892 (void)errorType;
893 }
894
900 virtual void onUploadLogResult(const char* requestId, bool success, UPLOAD_ERROR_REASON reason) {
901 (void)requestId;
902 (void)success;
903 (void)reason;
904 }
905
911 virtual void onSetRtmFlagResult(int code) {
912 (void)code;
913 }
914
920 virtual void onMultipathStats(const MultipathStats& stats) {
921 (void)stats;
922 }
923};
924
926 public:
927 virtual ~INetworkObserver() {}
928
929 public:
939 (void)info;
940 }
941
950 (void)info;
951 }
952};
953
954} // namespace rtc
955} // namespace agora
Definition AgoraOptional.h:413
Definition AgoraRefPtr.h:31
The interface class of Agora RTC SDK, which provides JSON configuration information of the SDK.
Definition IAgoraParameter.h:151
Definition NGIAgoraMediaNode.h:277
Definition NGIAgoraLocalUser.h:56
Definition NGIAgoraRtcConnection.h:925
virtual void onDownlinkNetworkInfoUpdated(const DownlinkNetworkInfo &info)
Definition NGIAgoraRtcConnection.h:949
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Definition NGIAgoraRtcConnection.h:938
virtual ~INetworkObserver()
Definition NGIAgoraRtcConnection.h:927
Definition NGIAgoraRtcConnection.h:191
virtual int disconnect(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int registerObserver(IRtcConnectionObserver *observer, void(*safeDeleter)(IRtcConnectionObserver *)=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int sendRdtMessage(user_id_t userId, RdtStreamType type, const char *data, size_t length, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int registerNetworkObserver(INetworkObserver *observer, void(*safeDeleter)(INetworkObserver *)=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setUplinkMultipathMode(MultipathMode mode, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int connect(const char *token, const char *channelId, const char *info, user_id_t userId, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int startLastmileProbeTest(const LastmileProbeConfig &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual conn_id_t getConnId()=0
virtual int createDataStream(int *streamId, bool reliable, bool ordered, bool sync)=0
virtual int unregisterNetworkObserver(INetworkObserver *observer)=0
virtual int sendCustomReportMessage(const char *id, const char *category, const char *event, const char *label, int value, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setPreferMultipathType(MultipathType type, aosl_ref_t ares=AOSL_REF_INVALID)=0
~IRtcConnection()
Definition NGIAgoraRtcConnection.h:193
virtual int setDownlinkMultipathMode(MultipathMode mode, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int sendMediaControlMessage(user_id_t userId, const char *data, size_t length, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int renewToken(const char *token, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo *userInfo)=0
virtual ILocalUser * getLocalUser()=0
virtual int sendStreamMessage(int streamId, const char *data, size_t length, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual RtcStats getTransportStats()=0
virtual int stopLastmileProbeTest(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
virtual TConnectionInfo getConnectionInfo()=0
virtual int getRemoteUsers(UserList &users)=0
virtual int getUserInfo(user_id_t userId, agora::UserInfo &userInfo)=0
virtual int unregisterObserver(IRtcConnectionObserver *observer)=0
virtual agora::base::IAgoraParameter * getAgoraParameter()=0
virtual int enableEncryption(bool enabled, const EncryptionConfig &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int enableMultipath(bool enable, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int connect(const TConnectSettings &settings, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition NGIAgoraRtcConnection.h:602
virtual void onChannelMediaRelayStateChanged(int state, int code)=0
virtual void onUserLeft(user_id_t userId, USER_OFFLINE_REASON_TYPE reason)=0
virtual void onConnectionLost(const TConnectionInfo &connectionInfo)=0
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition NGIAgoraRtcConnection.h:787
virtual void onConnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition NGIAgoraRtcConnection.h:891
virtual void onLastmileQuality(const QUALITY_TYPE quality)=0
virtual void onTokenPrivilegeWillExpire(const char *token)=0
virtual void onSnapshotTaken(user_id_t userId, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition NGIAgoraRtcConnection.h:805
virtual void onConnectionFailure(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual void onRenewTokenResult(const char *token, RENEW_TOKEN_ERROR_CODE code)=0
Reports the result of calling renewToken.
virtual void onError(ERROR_CODE_TYPE error, const char *msg)
Definition NGIAgoraRtcConnection.h:817
virtual ~IRtcConnectionObserver()
Definition NGIAgoraRtcConnection.h:604
virtual void onReconnecting(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition NGIAgoraRtcConnection.h:763
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition NGIAgoraRtcConnection.h:864
virtual void onChangeRoleFailure(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition NGIAgoraRtcConnection.h:752
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition NGIAgoraRtcConnection.h:792
virtual void onLastmileProbeResult(const LastmileProbeResult &result)=0
virtual void onLocalUserRegistered(uid_t uid, const char *userAccount)
Definition NGIAgoraRtcConnection.h:858
virtual void onMultipathStats(const MultipathStats &stats)
Definition NGIAgoraRtcConnection.h:920
virtual void onChangeRoleSuccess(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition NGIAgoraRtcConnection.h:743
virtual void onTransportStats(const RtcStats &stats)=0
virtual void onSetRtmFlagResult(int code)
Definition NGIAgoraRtcConnection.h:911
virtual void onUserNetworkQuality(user_id_t userId, QUALITY_TYPE txQuality, QUALITY_TYPE rxQuality)
Definition NGIAgoraRtcConnection.h:777
virtual void onReconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual void onTokenPrivilegeDidExpire()=0
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition NGIAgoraRtcConnection.h:900
virtual void onUserJoined(user_id_t userId)=0
virtual void onDisconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual void onStreamMessageError(user_id_t userId, int streamId, int code, int missed, int cached)
Definition NGIAgoraRtcConnection.h:878
virtual void onConnecting(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
Definition NGIAgoraMediaNode.h:470
CONTENT_INSPECT_RESULT
Definition AgoraMediaBase.h:1278
Definition AgoraExtensions.h:5
CONNECTION_CHANGED_REASON_TYPE
Reasons causing the change of the connection state.
Definition AgoraBase.h:5139
ENCRYPTION_ERROR_TYPE
Encryption error type.
Definition AgoraBase.h:7473
CLIENT_ROLE_TYPE
The user role in the interactive live streaming.
Definition AgoraBase.h:3037
@ CLIENT_ROLE_AUDIENCE
Definition AgoraBase.h:3045
CONNECTION_STATE_TYPE
Connection states.
Definition AgoraBase.h:4528
@ CONNECTION_STATE_DISCONNECTED
Definition AgoraBase.h:4536
USER_OFFLINE_REASON_TYPE
Reasons for a user being offline.
Definition AgoraBase.h:969
MultipathMode
The transmission mode of data over multiple network paths.
Definition AgoraBase.h:2718
MultipathType
Network path types used in multipath transmission.
Definition AgoraBase.h:2735
RENEW_TOKEN_ERROR_CODE
Represents the error codes after calling renewToken.
Definition AgoraBase.h:7509
RdtStreamType
Reliable Data Transmission Tunnel message stream type.
Definition AgoraBase.h:8090
CLIENT_ROLE_CHANGE_FAILED_REASON
The reason for a user role switch failure.
Definition AgoraBase.h:5277
NETWORK_TYPE
Network type.
Definition AgoraBase.h:5307
unsigned int uid_t
Definition AgoraMediaBase.h:28
unsigned int conn_id_t
Definition AgoraMediaBase.h:30
UPLOAD_ERROR_REASON
Definition AgoraBase.h:7498
QUALITY_TYPE
Network quality types.
Definition AgoraBase.h:1025
CopyableAutoPtr< IString > AString
Definition AgoraBase.h:182
Definition AgoraAtomicOps.h:21
CHANNEL_TYPE
Definition AgoraBase.h:299
@ CHANNEL_TYPE_STANDARD
Definition AgoraBase.h:303
util::AList< UserInfo > UserList
Definition AgoraBase.h:961
const char * user_id_t
Definition AgoraBase.h:934
ERROR_CODE_TYPE
Error codes.
Definition AgoraBase.h:477
CHANNEL_PROFILE_TYPE
The channel profile.
Definition AgoraBase.h:267
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition AgoraBase.h:275
LICENSE_ERROR_TYPE
Definition AgoraBase.h:879
The information of the user.
Definition AgoraBase.h:940
Setting of user role properties.
Definition AgoraBase.h:3085
Built-in encryption configurations.
Definition AgoraBase.h:7409
Configurations of the last-mile network test.
Definition AgoraBase.h:5046
Results of the uplink and downlink last-mile network tests.
Definition AgoraBase.h:5115
Aggregates statistics of each network path in multipath transmission.
Definition AgoraBase.h:2781
bool autoSubscribeAudio
Definition NGIAgoraRtcConnection.h:96
bool audioRecvMediaPacket
Definition NGIAgoraRtcConnection.h:137
RtcConnectionConfiguration()
Definition NGIAgoraRtcConnection.h:164
CLIENT_ROLE_TYPE clientRoleType
Definition NGIAgoraRtcConnection.h:124
bool isDataChannelOnly
Definition NGIAgoraRtcConnection.h:156
int maxSendBitrate
Definition NGIAgoraRtcConnection.h:112
CHANNEL_TYPE channelType
Definition NGIAgoraRtcConnection.h:162
int maxPort
Definition NGIAgoraRtcConnection.h:120
CHANNEL_PROFILE_TYPE channelProfile
Definition NGIAgoraRtcConnection.h:127
int minPort
Definition NGIAgoraRtcConnection.h:116
bool videoRecvMediaPacket
Definition NGIAgoraRtcConnection.h:142
bool isInteractiveAudience
Definition NGIAgoraRtcConnection.h:151
bool enableAudioRecordingOrPlayout
Definition NGIAgoraRtcConnection.h:108
bool audioRecvEncodedFrame
Definition NGIAgoraRtcConnection.h:132
bool autoSubscribeVideo
Definition NGIAgoraRtcConnection.h:102
Statistics of a call session.
Definition AgoraBase.h:2828
Definition NGIAgoraRtcConnection.h:55
const char * token
Definition NGIAgoraRtcConnection.h:59
agora::Optional< int64_t > appDefinedStartTimeMs
Definition NGIAgoraRtcConnection.h:82
const char * info
Definition NGIAgoraRtcConnection.h:78
const char * channelId
Definition NGIAgoraRtcConnection.h:70
user_id_t userId
Definition NGIAgoraRtcConnection.h:76
Definition NGIAgoraRtcConnection.h:26
util::AString connectionIp
Definition NGIAgoraRtcConnection.h:50
TConnectionInfo()
Definition NGIAgoraRtcConnection.h:52
conn_id_t id
Definition NGIAgoraRtcConnection.h:30
util::AString localUserId
Definition NGIAgoraRtcConnection.h:42
int proxyType
Definition NGIAgoraRtcConnection.h:48
uid_t internalUid
Definition NGIAgoraRtcConnection.h:46
CONNECTION_STATE_TYPE state
Definition NGIAgoraRtcConnection.h:38
util::AString channelId
Definition NGIAgoraRtcConnection.h:34
The information of the user.
Definition AgoraBase.h:7693