Agora C++ API Reference for All Platforms
|
8 #pragma once // NOLINT(build/header_guard)
10 #include "AgoraBase.h"
11 #include "time_utils.h"
12 #include <api/cpp/aosl_ares_class.h>
16 class IAudioEncodedFrameSender;
17 class IRtcConnectionObserver;
18 class INetworkObserver;
20 class IVideoEncodedImageSender;
216 virtual int connect(
const char* token,
const char* channelId,
const char* info,
user_id_t userId, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
242 virtual int disconnect(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
290 virtual int renewToken(
const char* token, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
441 virtual int sendStreamMessage(
int streamId,
const char* data,
size_t length, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
476 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;
637 (void)newRoleOptions;
virtual void onUserNetworkQuality(user_id_t userId, QUALITY_TYPE txQuality, QUALITY_TYPE rxQuality)
Definition: NGIAgoraRtcConnection.h:668
util::AString connectionIp
Definition: NGIAgoraRtcConnection.h:50
CONNECTION_STATE_TYPE state
Definition: NGIAgoraRtcConnection.h:38
bool audioRecvEncodedFrame
Definition: NGIAgoraRtcConnection.h:132
CHANNEL_PROFILE_TYPE channelProfile
Definition: NGIAgoraRtcConnection.h:127
Definition: AgoraBase.h:6458
Definition: AgoraBase.h:4377
virtual TConnectionInfo getConnectionInfo()=0
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: NGIAgoraRtcConnection.h:782
virtual void onError(ERROR_CODE_TYPE error, const char *msg)
Definition: NGIAgoraRtcConnection.h:708
agora::Optional< int64_t > appDefinedStartTimeMs
Definition: NGIAgoraRtcConnection.h:82
virtual void onConnecting(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
Definition: IAgoraParameter.h:147
int minPort
Definition: NGIAgoraRtcConnection.h:116
Definition: AgoraBase.h:4307
virtual ~INetworkObserver()
Definition: NGIAgoraRtcConnection.h:831
virtual void onTransportStats(const RtcStats &stats)=0
WLACC_MESSAGE_REASON
Definition: AgoraBase.h:4546
Definition: NGIAgoraRtcConnection.h:829
virtual int startLastmileProbeTest(const LastmileProbeConfig &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int sendStreamMessage(int streamId, const char *data, size_t length, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onChangeRoleSuccess(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: NGIAgoraRtcConnection.h:634
virtual void onChangeRoleFailure(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: NGIAgoraRtcConnection.h:643
Definition: NGIAgoraRtcConnection.h:506
virtual void onWlAccStats(const WlAccStats ¤tStats, const WlAccStats &averageStats)
Definition: NGIAgoraRtcConnection.h:823
~IRtcConnection()
Definition: NGIAgoraRtcConnection.h:186
virtual void onUserJoined(user_id_t userId)=0
virtual int getUserInfo(user_id_t userId, agora::UserInfo &userInfo)=0
virtual int renewToken(const char *token, aosl_ref_t ares=AOSL_REF_INVALID)=0
ERROR_CODE_TYPE
Definition: AgoraBase.h:452
const char * user_id_t
Definition: AgoraBase.h:809
Definition: AgoraBase.h:233
unsigned int conn_id_t
Definition: AgoraMediaBase.h:30
virtual void onReconnecting(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual void onDisconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual agora::base::IAgoraParameter * getAgoraParameter()=0
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo *userInfo)=0
TConnectionInfo()
Definition: NGIAgoraRtcConnection.h:52
bool autoSubscribeAudio
Definition: NGIAgoraRtcConnection.h:96
Definition: NGIAgoraRtcConnection.h:55
bool audioRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:137
RtcConnectionConfiguration()
Definition: NGIAgoraRtcConnection.h:158
Definition: AgoraAtomicOps.h:21
Definition: AgoraBase.h:6099
virtual ~IRtcConnectionObserver()
Definition: NGIAgoraRtcConnection.h:508
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: NGIAgoraRtcConnection.h:683
virtual RtcStats getTransportStats()=0
virtual int unregisterNetworkObserver(INetworkObserver *observer)=0
WLACC_SUGGEST_ACTION
Definition: AgoraBase.h:4560
Definition: NGIAgoraRtcConnection.h:26
virtual int getRemoteUsers(UserList &users)=0
virtual void onTokenPrivilegeWillExpire(const char *token)=0
NETWORK_TYPE
Definition: AgoraBase.h:4602
Definition: AgoraBase.h:6112
CHANNEL_PROFILE_TYPE
Definition: AgoraBase.h:267
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: NGIAgoraRtcConnection.h:755
bool isInteractiveAudience
Definition: NGIAgoraRtcConnection.h:151
virtual void onSetRtmFlagResult(int code)
Definition: NGIAgoraRtcConnection.h:802
virtual void onTokenPrivilegeDidExpire()=0
virtual int createDataStream(int *streamId, bool reliable, bool ordered, bool sync)=0
const char * info
Definition: NGIAgoraRtcConnection.h:78
virtual int connect(const char *token, const char *channelId, const char *info, user_id_t userId, aosl_ref_t ares=AOSL_REF_INVALID)=0
util::AString channelId
Definition: NGIAgoraRtcConnection.h:34
virtual void onLastmileProbeResult(const LastmileProbeResult &result)=0
virtual void onConnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual void onLocalUserRegistered(uid_t uid, const char *userAccount)
Definition: NGIAgoraRtcConnection.h:749
virtual void onStreamMessageError(user_id_t userId, int streamId, int code, int missed, int cached)
Definition: NGIAgoraRtcConnection.h:769
virtual ILocalUser * getLocalUser()=0
@ CONNECTION_STATE_DISCONNECTED
Definition: AgoraBase.h:3841
virtual void onDownlinkNetworkInfoUpdated(const DownlinkNetworkInfo &info)
Definition: NGIAgoraRtcConnection.h:853
virtual void onChannelMediaRelayStateChanged(int state, int code)=0
Definition: AgoraBase.h:815
virtual void onConnectionFailure(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
CONNECTION_CHANGED_REASON_TYPE
Definition: AgoraBase.h:4401
Definition: NGIAgoraLocalUser.h:56
CLIENT_ROLE_TYPE clientRoleType
Definition: NGIAgoraRtcConnection.h:124
Definition: AgoraBase.h:4584
bool enableAudioRecordingOrPlayout
Definition: NGIAgoraRtcConnection.h:108
virtual int stopLastmileProbeTest(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: NGIAgoraRtcConnection.h:678
virtual void onConnectionLost(const TConnectionInfo &connectionInfo)=0
bool videoRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:142
bool autoSubscribeVideo
Definition: NGIAgoraRtcConnection.h:102
virtual void onUserLeft(user_id_t userId, USER_OFFLINE_REASON_TYPE reason)=0
virtual void onSnapshotTaken(user_id_t userId, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition: NGIAgoraRtcConnection.h:696
virtual int connect(const TConnectSettings &settings, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: AgoraBase.h:6266
virtual void onWlAccMessage(WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char *wlAccMsg)
Definition: NGIAgoraRtcConnection.h:812
virtual int disconnect(aosl_ref_t ares=AOSL_REF_INVALID)=0
LICENSE_ERROR_TYPE
Definition: AgoraBase.h:754
virtual void onLastmileQuality(const QUALITY_TYPE quality)=0
const char * token
Definition: NGIAgoraRtcConnection.h:59
Definition: AgoraBase.h:2313
USER_OFFLINE_REASON_TYPE
Definition: AgoraBase.h:844
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: NGIAgoraRtcConnection.h:654
Definition: NGIAgoraRtcConnection.h:90
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
Definition: AgoraRefPtr.h:31
virtual int registerObserver(IRtcConnectionObserver *observer, void(*safeDeleter)(IRtcConnectionObserver *)=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
int maxPort
Definition: NGIAgoraRtcConnection.h:120
user_id_t userId
Definition: NGIAgoraRtcConnection.h:76
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Definition: NGIAgoraRtcConnection.h:842
UPLOAD_ERROR_REASON
Definition: AgoraBase.h:6350
util::AString localUserId
Definition: NGIAgoraRtcConnection.h:42
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: NGIAgoraRtcConnection.h:791
const char * channelId
Definition: NGIAgoraRtcConnection.h:70
Definition: NGIAgoraRtcConnection.h:184
Definition: AgoraBase.h:156
@ CLIENT_ROLE_AUDIENCE
Definition: AgoraBase.h:2520
CLIENT_ROLE_CHANGE_FAILED_REASON
Definition: AgoraBase.h:4522
unsigned int uid_t
Definition: AgoraMediaBase.h:28
virtual void onReconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
bool isDataChannelOnly
Definition: NGIAgoraRtcConnection.h:156
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2512
virtual conn_id_t getConnId()=0
ENCRYPTION_ERROR_TYPE
Definition: AgoraBase.h:6325
virtual int enableEncryption(bool enabled, const EncryptionConfig &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
int proxyType
Definition: NGIAgoraRtcConnection.h:48
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
CONNECTION_STATE_TYPE
Definition: AgoraBase.h:3834
virtual int unregisterObserver(IRtcConnectionObserver *observer)=0
int maxSendBitrate
Definition: NGIAgoraRtcConnection.h:112
Definition: video_node_i.h:28
uid_t internalUid
Definition: NGIAgoraRtcConnection.h:46
Definition: AgoraBase.h:2560
virtual int registerNetworkObserver(INetworkObserver *observer, void(*safeDeleter)(INetworkObserver *)=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
conn_id_t id
Definition: NGIAgoraRtcConnection.h:30
QUALITY_TYPE
Definition: AgoraBase.h:881
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition: AgoraBase.h:279