Agora Java API Reference for Android
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 
13 namespace agora {
14 namespace rtc {
15 class IAudioEncodedFrameSender;
16 class IRtcConnectionObserver;
17 class INetworkObserver;
18 class IRtcConnection;
19 class IVideoEncodedImageSender;
20 class ILocalUser;
21 
29  conn_id_t id;
37  CONNECTION_STATE_TYPE state;
45  uid_t internalUid;
46 
47  int proxyType;
48 
49  util::AString connectionIp;
50 
51  TConnectionInfo() : id(-1), state(CONNECTION_STATE_DISCONNECTED), internalUid(0), proxyType(0) {}
52 };
53 
58  const char* token;
69  const char* channelId;
75  user_id_t userId;
76 
77  /*
78  App can provide a app defined start time to trace some events like connect cost , first video, etc.
79  */
80  agora::Optional<int64_t> appDefinedStartTimeMs;
81 };
82 
114  int minPort;
118  int maxPort;
122  CLIENT_ROLE_TYPE clientRoleType;
125  CHANNEL_PROFILE_TYPE channelProfile;
126 
131 
136 
141 
150 
152  : autoSubscribeAudio(true),
153  autoSubscribeVideo(true),
155  maxSendBitrate(-1),
156  minPort(0),
157  maxPort(0),
158  clientRoleType(CLIENT_ROLE_AUDIENCE),
159  channelProfile(CHANNEL_PROFILE_LIVE_BROADCASTING),
160  audioRecvEncodedFrame(false),
161  audioRecvMediaPacket(false),
162  videoRecvMediaPacket(false),
163  isInteractiveAudience(false) {}
164 };
165 
177  protected:
178  ~IRtcConnection() {}
179 
180  public:
208  virtual int connect(const char* token, const char* channelId, user_id_t userId) = 0;
209 
221  virtual int connect(const TConnectSettings& settings) = 0;
222 
234  virtual int disconnect() = 0;
235 
263  virtual int startLastmileProbeTest(const LastmileProbeConfig& config) = 0;
264 
271  virtual int stopLastmileProbeTest() = 0;
272 
282  virtual int renewToken(const char* token) = 0;
283 
292 
300  virtual ILocalUser* getLocalUser() = 0;
301 
314  virtual int getRemoteUsers(UserList& users) = 0;
315 
326  virtual int getUserInfo(user_id_t userId, agora::UserInfo& userInfo) = 0;
327 
336  virtual int registerObserver(IRtcConnectionObserver* observer, void(*safeDeleter)(IRtcConnectionObserver*) = NULL) = 0;
337 
347  virtual int unregisterObserver(IRtcConnectionObserver* observer) = 0;
348 
357  virtual int registerNetworkObserver(INetworkObserver* observer, void(*safeDeleter)(INetworkObserver*) = NULL) = 0;
358 
368  virtual int unregisterNetworkObserver(INetworkObserver* observer) = 0;
369 
377  virtual conn_id_t getConnId() = 0;
378 
387 
396 
416  virtual int createDataStream(int* streamId, bool reliable, bool ordered, bool sync) = 0;
417 
433  virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0;
434 
453  virtual int enableEncryption(bool enabled, const EncryptionConfig& config) = 0;
454 
468  virtual int sendCustomReportMessage(const char* id, const char* category, const char* event, const char* label, int value) = 0;
480  virtual int getUserInfoByUserAccount(const char* userAccount, rtc::UserInfo* userInfo) = 0;
492  virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo* userInfo) = 0;
505  virtual base::NtpTime getNtpTime() = 0;
506 };
507 
512  public:
513  virtual ~IRtcConnectionObserver() {}
514 
521  virtual void onConnected(const TConnectionInfo& connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason) = 0;
522 
529  virtual void onDisconnected(const TConnectionInfo& connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason) = 0;
530 
537  virtual void onConnecting(const TConnectionInfo& connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason) = 0;
538 
545  virtual void onReconnecting(const TConnectionInfo& connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason) = 0;
546 
547  // This should be deleted. onConnected is enough.
548  virtual void onReconnected(const TConnectionInfo& connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason) = 0;
549 
555  virtual void onConnectionLost(const TConnectionInfo& connectionInfo) = 0;
556 
564  virtual void onLastmileQuality(const QUALITY_TYPE quality) = 0;
565 
573  virtual void onLastmileProbeResult(const LastmileProbeResult& result) = 0;
574 
585  virtual void onTokenPrivilegeWillExpire(const char* token) = 0;
586 
593  virtual void onTokenPrivilegeDidExpire() = 0;
594 
601  virtual void onConnectionFailure(const TConnectionInfo& connectionInfo,
602  CONNECTION_CHANGED_REASON_TYPE reason) = 0;
603 
611  virtual void onUserJoined(user_id_t userId) = 0;
612 
621  virtual void onUserLeft(user_id_t userId, USER_OFFLINE_REASON_TYPE reason) = 0;
622 
630  virtual void onTransportStats(const RtcStats& stats) = 0;
631 
638  virtual void onChangeRoleSuccess(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) {
639  (void)oldRole;
640  (void)newRole;
641  }
642 
646  virtual void onChangeRoleFailure(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) {
647  (void)reason;
648  (void)currentRole;
649  }
650 
657  virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error) {
658  (void)error;
659  }
660 
671  virtual void onUserNetworkQuality(user_id_t userId, QUALITY_TYPE txQuality,
672  QUALITY_TYPE rxQuality) {
673  (void)userId;
674  (void)txQuality;
675  (void)rxQuality;
676  }
677 
681  virtual void onNetworkTypeChanged(NETWORK_TYPE type) {
682  (void)type;
683  }
684 
693  virtual void onApiCallExecuted(int err, const char* api, const char* result) {
694  (void)err;
695  (void)api;
696  (void)result;
697  }
698 
700  virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result) { (void)result; }
713  virtual void onSnapshotTaken(uid_t uid, const char* filePath, int width, int height, int errCode) {
714  (void)uid;
715  (void)filePath;
716  (void)width;
717  (void)height;
718  (void)errCode;
719  }
725  virtual void onError(ERROR_CODE_TYPE error, const char* msg) {
726  (void)error;
727  (void)msg;
728  }
729 
759  virtual void onChannelMediaRelayStateChanged(int state, int code) = 0;
760 
766  virtual void onLocalUserRegistered(uid_t uid, const char* userAccount) {
767  (void)uid;
768  (void)userAccount;
769  }
770 
772  virtual void onUserAccountUpdated(uid_t uid, const char* userAccount) {
773  (void)uid;
774  (void)userAccount;
775  }
776 
786  virtual void onStreamMessageError(user_id_t userId, int streamId, int code, int missed,
787  int cached) {
788  (void)userId;
789  (void)streamId;
790  (void)code;
791  (void)missed;
792  (void)cached;
793  }
794 
799  virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType) {
800  (void)errorType;
801  }
808  virtual void onUploadLogResult(const char* requestId, bool success, UPLOAD_ERROR_REASON reason) {
809  (void)requestId;
810  (void)success;
811  (void)reason;
812  }
813 
820  virtual void onWlAccMessage(WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char* wlAccMsg) {
821  (void)reason;
822  (void)action;
823  (void)wlAccMsg;
824  }
825 
831  virtual void onWlAccStats(WlAccStats currentStats, WlAccStats averageStats) {
832  (void)currentStats;
833  (void)averageStats;
834  }
835 };
836 
838  public:
839  virtual ~INetworkObserver() {}
840 
841  public:
850  virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo& info) {
851  (void)info;
852  }
853 
862  (void)info;
863  }
864 };
865 
866 } // namespace rtc
867 } // namespace agora
agora::rtc::IRtcConnectionObserver::onUserNetworkQuality
virtual void onUserNetworkQuality(user_id_t userId, QUALITY_TYPE txQuality, QUALITY_TYPE rxQuality)
Definition: NGIAgoraRtcConnection.h:671
agora::rtc::TConnectionInfo::state
CONNECTION_STATE_TYPE state
Definition: NGIAgoraRtcConnection.h:37
agora::rtc::RtcConnectionConfiguration::audioRecvEncodedFrame
bool audioRecvEncodedFrame
Definition: NGIAgoraRtcConnection.h:130
agora::rtc::RtcConnectionConfiguration::channelProfile
CHANNEL_PROFILE_TYPE channelProfile
Definition: NGIAgoraRtcConnection.h:125
agora::rtc::UserInfo
Definition: AgoraBase.h:5243
agora::rtc::LastmileProbeResult
Definition: AgoraBase.h:3679
agora::rtc::IRtcConnection::getConnectionInfo
virtual TConnectionInfo getConnectionInfo()=0
agora::rtc::IRtcConnectionObserver::onEncryptionError
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: NGIAgoraRtcConnection.h:799
agora::rtc::IRtcConnectionObserver::onError
virtual void onError(ERROR_CODE_TYPE error, const char *msg)
Definition: NGIAgoraRtcConnection.h:725
agora::rtc::IRtcConnectionObserver::onConnecting
virtual void onConnecting(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
agora::base::IAgoraParameter
Definition: IAgoraParameter.h:147
agora::rtc::RtcConnectionConfiguration::minPort
int minPort
Definition: NGIAgoraRtcConnection.h:114
agora::rtc::LastmileProbeConfig
Definition: AgoraBase.h:3605
agora::rtc::IRtcConnection::sendCustomReportMessage
virtual int sendCustomReportMessage(const char *id, const char *category, const char *event, const char *label, int value)=0
agora::rtc::IRtcConnectionObserver::onTransportStats
virtual void onTransportStats(const RtcStats &stats)=0
agora::rtc::INetworkObserver
Definition: NGIAgoraRtcConnection.h:837
agora::rtc::IRtcConnectionObserver::onChangeRoleFailure
virtual void onChangeRoleFailure(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: NGIAgoraRtcConnection.h:646
agora::rtc::IRtcConnectionObserver
Definition: NGIAgoraRtcConnection.h:511
agora::base::NtpTime
Definition: time_utils.h:13
agora::rtc::IRtcConnection::stopLastmileProbeTest
virtual int stopLastmileProbeTest()=0
agora::rtc::IRtcConnectionObserver::onUserJoined
virtual void onUserJoined(user_id_t userId)=0
agora::rtc::IRtcConnection::startLastmileProbeTest
virtual int startLastmileProbeTest(const LastmileProbeConfig &config)=0
agora::rtc::IRtcConnection::getUserInfo
virtual int getUserInfo(user_id_t userId, agora::UserInfo &userInfo)=0
agora::rtc::IRtcConnection::getNtpTime
virtual base::NtpTime getNtpTime()=0
agora::rtc::IRtcConnectionObserver::onSnapshotTaken
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition: NGIAgoraRtcConnection.h:713
agora::util::AList
Definition: AgoraBase.h:230
agora::rtc::IRtcConnection::disconnect
virtual int disconnect()=0
agora::rtc::IRtcConnectionObserver::onReconnecting
virtual void onReconnecting(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
agora::rtc::IRtcConnectionObserver::onDisconnected
virtual void onDisconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
agora::rtc::IRtcConnection::getAgoraParameter
virtual agora::base::IAgoraParameter * getAgoraParameter()=0
agora::rtc::IRtcConnection::getUserInfoByUid
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo *userInfo)=0
agora::rtc::RtcConnectionConfiguration::autoSubscribeAudio
bool autoSubscribeAudio
Definition: NGIAgoraRtcConnection.h:94
agora::rtc::TConnectSettings
Definition: NGIAgoraRtcConnection.h:54
agora::rtc::RtcConnectionConfiguration::audioRecvMediaPacket
bool audioRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:135
agora::rtc::IRtcConnectionObserver::onContentInspectResult
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: NGIAgoraRtcConnection.h:700
agora::rtc::IRtcConnection::getTransportStats
virtual RtcStats getTransportStats()=0
agora::rtc::IRtcConnection::unregisterNetworkObserver
virtual int unregisterNetworkObserver(INetworkObserver *observer)=0
agora::rtc::TConnectionInfo
Definition: NGIAgoraRtcConnection.h:25
agora::rtc::IRtcConnection::getRemoteUsers
virtual int getRemoteUsers(UserList &users)=0
agora::rtc::IRtcConnectionObserver::onTokenPrivilegeWillExpire
virtual void onTokenPrivilegeWillExpire(const char *token)=0
agora::rtc::IRtcConnection::renewToken
virtual int renewToken(const char *token)=0
agora::rtc::IRtcConnectionObserver::onUserAccountUpdated
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: NGIAgoraRtcConnection.h:772
agora::rtc::IRtcConnection::sendStreamMessage
virtual int sendStreamMessage(int streamId, const char *data, size_t length)=0
agora::rtc::RtcConnectionConfiguration::isInteractiveAudience
bool isInteractiveAudience
Definition: NGIAgoraRtcConnection.h:149
agora::rtc::IRtcConnection::connect
virtual int connect(const char *token, const char *channelId, user_id_t userId)=0
agora::rtc::IRtcConnectionObserver::onTokenPrivilegeDidExpire
virtual void onTokenPrivilegeDidExpire()=0
agora::rtc::IRtcConnection::createDataStream
virtual int createDataStream(int *streamId, bool reliable, bool ordered, bool sync)=0
agora::rtc::TConnectionInfo::channelId
util::AString channelId
Definition: NGIAgoraRtcConnection.h:33
agora::rtc::IRtcConnectionObserver::onLastmileProbeResult
virtual void onLastmileProbeResult(const LastmileProbeResult &result)=0
agora::rtc::IRtcConnectionObserver::onConnected
virtual void onConnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
agora::rtc::IRtcConnectionObserver::onLocalUserRegistered
virtual void onLocalUserRegistered(uid_t uid, const char *userAccount)
Definition: NGIAgoraRtcConnection.h:766
agora::rtc::IRtcConnectionObserver::onStreamMessageError
virtual void onStreamMessageError(user_id_t userId, int streamId, int code, int missed, int cached)
Definition: NGIAgoraRtcConnection.h:786
agora::rtc::IRtcConnection::getLocalUser
virtual ILocalUser * getLocalUser()=0
agora::rtc::INetworkObserver::onDownlinkNetworkInfoUpdated
virtual void onDownlinkNetworkInfoUpdated(const DownlinkNetworkInfo &info)
Definition: NGIAgoraRtcConnection.h:861
agora::rtc::IRtcConnectionObserver::onChannelMediaRelayStateChanged
virtual void onChannelMediaRelayStateChanged(int state, int code)=0
agora::UserInfo
Definition: AgoraBase.h:805
agora::rtc::IRtcConnectionObserver::onConnectionFailure
virtual void onConnectionFailure(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
agora::rtc::ILocalUser
Definition: NGIAgoraLocalUser.h:51
agora::rtc::RtcConnectionConfiguration::clientRoleType
CLIENT_ROLE_TYPE clientRoleType
Definition: NGIAgoraRtcConnection.h:122
agora::rtc::IRtcConnection::enableEncryption
virtual int enableEncryption(bool enabled, const EncryptionConfig &config)=0
agora::rtc::WlAccStats
Definition: AgoraBase.h:3860
agora::rtc::RtcConnectionConfiguration::enableAudioRecordingOrPlayout
bool enableAudioRecordingOrPlayout
Definition: NGIAgoraRtcConnection.h:106
agora::rtc::IRtcConnectionObserver::onNetworkTypeChanged
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: NGIAgoraRtcConnection.h:681
agora::rtc::IRtcConnectionObserver::onConnectionLost
virtual void onConnectionLost(const TConnectionInfo &connectionInfo)=0
agora::rtc::RtcConnectionConfiguration::videoRecvMediaPacket
bool videoRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:140
agora::rtc::RtcConnectionConfiguration::autoSubscribeVideo
bool autoSubscribeVideo
Definition: NGIAgoraRtcConnection.h:100
agora::rtc::IRtcConnectionObserver::onUserLeft
virtual void onUserLeft(user_id_t userId, USER_OFFLINE_REASON_TYPE reason)=0
agora::rtc::IRtcConnectionObserver::onApiCallExecuted
virtual void onApiCallExecuted(int err, const char *api, const char *result)
Definition: NGIAgoraRtcConnection.h:693
agora::rtc::EncryptionConfig
Definition: AgoraBase.h:5124
agora::rtc::IRtcConnectionObserver::onWlAccMessage
virtual void onWlAccMessage(WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char *wlAccMsg)
Definition: NGIAgoraRtcConnection.h:820
agora::rtc::IRtcConnectionObserver::onLastmileQuality
virtual void onLastmileQuality(const QUALITY_TYPE quality)=0
agora::rtc::TConnectSettings::token
const char * token
Definition: NGIAgoraRtcConnection.h:58
agora::rtc::RtcStats
Definition: AgoraBase.h:1932
agora::rtc::IRtcConnectionObserver::onLicenseValidationFailure
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: NGIAgoraRtcConnection.h:657
agora::rtc::IRtcConnection::registerObserver
virtual int registerObserver(IRtcConnectionObserver *observer, void(*safeDeleter)(IRtcConnectionObserver *)=NULL)=0
agora::rtc::RtcConnectionConfiguration
Definition: NGIAgoraRtcConnection.h:88
agora::rtc::IRtcConnection::connect
virtual int connect(const TConnectSettings &settings)=0
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::RtcConnectionConfiguration::maxPort
int maxPort
Definition: NGIAgoraRtcConnection.h:118
agora::rtc::TConnectSettings::userId
user_id_t userId
Definition: NGIAgoraRtcConnection.h:75
agora::rtc::INetworkObserver::onUplinkNetworkInfoUpdated
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Definition: NGIAgoraRtcConnection.h:850
agora::rtc::IRtcConnectionObserver::onWlAccStats
virtual void onWlAccStats(WlAccStats currentStats, WlAccStats averageStats)
Definition: NGIAgoraRtcConnection.h:831
agora::rtc::TConnectionInfo::localUserId
util::AString localUserId
Definition: NGIAgoraRtcConnection.h:41
agora::rtc::IRtcConnectionObserver::onUploadLogResult
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: NGIAgoraRtcConnection.h:808
agora::rtc::TConnectSettings::channelId
const char * channelId
Definition: NGIAgoraRtcConnection.h:69
agora::rtc::IRtcConnection
Definition: NGIAgoraRtcConnection.h:176
agora::util::CopyableAutoPtr
Definition: AgoraBase.h:153
agora::rtc::IRtcConnection::registerNetworkObserver
virtual int registerNetworkObserver(INetworkObserver *observer, void(*safeDeleter)(INetworkObserver *)=NULL)=0
agora::rtc::IRtcConnection::getConnId
virtual conn_id_t getConnId()=0
agora::rtc::IRtcConnection::getUserInfoByUserAccount
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
agora::rtc::IRtcConnection::unregisterObserver
virtual int unregisterObserver(IRtcConnectionObserver *observer)=0
agora::rtc::IRtcConnectionObserver::onChangeRoleSuccess
virtual void onChangeRoleSuccess(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: NGIAgoraRtcConnection.h:638
agora::rtc::RtcConnectionConfiguration::maxSendBitrate
int maxSendBitrate
Definition: NGIAgoraRtcConnection.h:110
agora::rtc::TConnectionInfo::internalUid
uid_t internalUid
Definition: NGIAgoraRtcConnection.h:45
agora::Optional< int64_t >
agora::rtc::TConnectionInfo::id
conn_id_t id
Definition: NGIAgoraRtcConnection.h:29