Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
8 #pragma once // NOLINT(build/header_guard)
12 #include <api/cpp/aosl_ares_class.h>
16 class IAudioEncodedFrameSender;
17 class IRtcConnectionObserver;
18 class INetworkObserver;
20 class IVideoEncodedImageSender;
215 virtual int connect(
const char* token,
const char* channelId,
user_id_t userId, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
241 virtual int disconnect(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
289 virtual int renewToken(
const char* token, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
440 virtual int sendStreamMessage(
int streamId,
const char* data,
size_t length, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
475 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;
636 (void)newRoleOptions;
WLACC_MESSAGE_REASON
Definition: AgoraBase.h:4333
QUALITY_TYPE
Definition: AgoraBase.h:879
UPLOAD_ERROR_REASON
Definition: AgoraBase.h:5935
virtual void onStreamMessageError(user_id_t userId, int streamId, int code, int missed, int cached)
Definition: NGIAgoraRtcConnection.h:768
TConnectionInfo()
Definition: NGIAgoraRtcConnection.h:52
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition: AgoraBase.h:279
Definition: AgoraBase.h:6034
CHANNEL_PROFILE_TYPE channelProfile
Definition: NGIAgoraRtcConnection.h:126
Definition: AgoraBase.h:4171
virtual int connect(const char *token, const char *channelId, user_id_t userId, aosl_ref_t ares=AOSL_REF_INVALID)=0
ERROR_CODE_TYPE
Definition: AgoraBase.h:452
virtual void onChannelMediaRelayStateChanged(int state, int code)=0
user_id_t userId
Definition: NGIAgoraRtcConnection.h:76
Definition: IAgoraParameter.h:147
Definition: AgoraBase.h:4103
agora::Optional< int64_t > appDefinedStartTimeMs
Definition: NGIAgoraRtcConnection.h:81
int minPort
Definition: NGIAgoraRtcConnection.h:115
USER_OFFLINE_REASON_TYPE
Definition: AgoraBase.h:842
int maxPort
Definition: NGIAgoraRtcConnection.h:119
virtual void onDisconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
unsigned int uid_t
Definition: AgoraMediaBase.h:28
Definition: NGIAgoraRtcConnection.h:828
~IRtcConnection()
Definition: NGIAgoraRtcConnection.h:185
virtual void onChangeRoleFailure(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: NGIAgoraRtcConnection.h:642
virtual void onUserJoined(user_id_t userId)=0
Definition: NGIAgoraRtcConnection.h:505
virtual void onSetRtmFlagResult(int code)
Definition: NGIAgoraRtcConnection.h:801
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: NGIAgoraRtcConnection.h:781
virtual void onConnectionLost(const TConnectionInfo &connectionInfo)=0
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: NGIAgoraRtcConnection.h:790
virtual int stopLastmileProbeTest(aosl_ref_t ares=AOSL_REF_INVALID)=0
util::AString localUserId
Definition: NGIAgoraRtcConnection.h:42
virtual void onLocalUserRegistered(uid_t uid, const char *userAccount)
Definition: NGIAgoraRtcConnection.h:748
virtual int registerObserver(IRtcConnectionObserver *observer, void(*safeDeleter)(IRtcConnectionObserver *)=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: AgoraBase.h:233
int maxSendBitrate
Definition: NGIAgoraRtcConnection.h:111
virtual int unregisterObserver(IRtcConnectionObserver *observer)=0
@ CONNECTION_STATE_DISCONNECTED
Definition: AgoraBase.h:3741
virtual ILocalUser * getLocalUser()=0
virtual void onTransportStats(const RtcStats &stats)=0
Definition: NGIAgoraRtcConnection.h:55
virtual int getUserInfo(user_id_t userId, agora::UserInfo &userInfo)=0
virtual int startLastmileProbeTest(const LastmileProbeConfig &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
util::AString connectionIp
Definition: NGIAgoraRtcConnection.h:50
virtual void onReconnecting(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2455
virtual void onLastmileProbeResult(const LastmileProbeResult &result)=0
Definition: AgoraAtomicOps.h:21
ENCRYPTION_ERROR_TYPE
Definition: AgoraBase.h:5911
WLACC_SUGGEST_ACTION
Definition: AgoraBase.h:4347
Definition: AgoraBase.h:5686
virtual void onWlAccStats(const WlAccStats ¤tStats, const WlAccStats &averageStats)
Definition: NGIAgoraRtcConnection.h:822
bool autoSubscribeVideo
Definition: NGIAgoraRtcConnection.h:101
CONNECTION_CHANGED_REASON_TYPE
Definition: AgoraBase.h:4198
virtual int disconnect(aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: NGIAgoraRtcConnection.h:26
virtual void onUserLeft(user_id_t userId, USER_OFFLINE_REASON_TYPE reason)=0
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: NGIAgoraRtcConnection.h:754
virtual ~IRtcConnectionObserver()
Definition: NGIAgoraRtcConnection.h:507
virtual int getRemoteUsers(UserList &users)=0
virtual void onTokenPrivilegeWillExpire(const char *token)=0
Definition: AgoraBase.h:5699
bool autoSubscribeAudio
Definition: NGIAgoraRtcConnection.h:95
uid_t internalUid
Definition: NGIAgoraRtcConnection.h:46
virtual void onTokenPrivilegeDidExpire()=0
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: NGIAgoraRtcConnection.h:653
virtual void onWlAccMessage(WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char *wlAccMsg)
Definition: NGIAgoraRtcConnection.h:811
bool isDataChannelOnly
Definition: NGIAgoraRtcConnection.h:155
CLIENT_ROLE_TYPE clientRoleType
Definition: NGIAgoraRtcConnection.h:123
virtual void onConnecting(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
CHANNEL_PROFILE_TYPE
Definition: AgoraBase.h:267
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo *userInfo)=0
virtual int connect(const TConnectSettings &settings, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ CLIENT_ROLE_AUDIENCE
Definition: AgoraBase.h:2463
unsigned int conn_id_t
Definition: AgoraMediaBase.h:30
const char * token
Definition: NGIAgoraRtcConnection.h:59
virtual RtcStats getTransportStats()=0
int proxyType
Definition: NGIAgoraRtcConnection.h:48
Definition: AgoraBase.h:813
virtual int createDataStream(int *streamId, bool reliable, bool ordered, bool sync)=0
Definition: NGIAgoraLocalUser.h:56
Definition: AgoraBase.h:4369
virtual int sendStreamMessage(int streamId, const char *data, size_t length, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Definition: NGIAgoraRtcConnection.h:841
const char * channelId
Definition: NGIAgoraRtcConnection.h:70
RtcConnectionConfiguration()
Definition: NGIAgoraRtcConnection.h:157
virtual void onDownlinkNetworkInfoUpdated(const DownlinkNetworkInfo &info)
Definition: NGIAgoraRtcConnection.h:852
Definition: AgoraBase.h:5852
bool audioRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:136
virtual void onChangeRoleSuccess(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: NGIAgoraRtcConnection.h:633
Definition: AgoraBase.h:2259
virtual void onConnectionFailure(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual void onLastmileQuality(const QUALITY_TYPE quality)=0
bool isInteractiveAudience
Definition: NGIAgoraRtcConnection.h:150
Definition: NGIAgoraRtcConnection.h:89
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 agora::base::IAgoraParameter * getAgoraParameter()=0
bool enableAudioRecordingOrPlayout
Definition: NGIAgoraRtcConnection.h:107
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: NGIAgoraRtcConnection.h:677
conn_id_t id
Definition: NGIAgoraRtcConnection.h:30
Definition: NGIAgoraRtcConnection.h:183
Definition: AgoraBase.h:156
NETWORK_TYPE
Definition: AgoraBase.h:4387
virtual int renewToken(const char *token, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onError(ERROR_CODE_TYPE error, const char *msg)
Definition: NGIAgoraRtcConnection.h:707
virtual int unregisterNetworkObserver(INetworkObserver *observer)=0
virtual conn_id_t getConnId()=0
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: NGIAgoraRtcConnection.h:682
util::AString channelId
Definition: NGIAgoraRtcConnection.h:34
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
bool videoRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:141
virtual void onUserNetworkQuality(user_id_t userId, QUALITY_TYPE txQuality, QUALITY_TYPE rxQuality)
Definition: NGIAgoraRtcConnection.h:667
virtual void onSnapshotTaken(user_id_t userId, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition: NGIAgoraRtcConnection.h:695
LICENSE_ERROR_TYPE
Definition: AgoraBase.h:752
virtual void onConnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
CLIENT_ROLE_CHANGE_FAILED_REASON
Definition: AgoraBase.h:4309
virtual int enableEncryption(bool enabled, const EncryptionConfig &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
bool audioRecvEncodedFrame
Definition: NGIAgoraRtcConnection.h:131
const char * user_id_t
Definition: AgoraBase.h:807
Definition: AgoraBase.h:2504
virtual TConnectionInfo getConnectionInfo()=0
virtual void onReconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual ~INetworkObserver()
Definition: NGIAgoraRtcConnection.h:830
virtual int registerNetworkObserver(INetworkObserver *observer, void(*safeDeleter)(INetworkObserver *)=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
CONNECTION_STATE_TYPE state
Definition: NGIAgoraRtcConnection.h:38