Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
8 #pragma once // NOLINT(build/header_guard)
15 class IAudioEncodedFrameSender;
16 class IRtcConnectionObserver;
17 class INetworkObserver;
19 class IVideoEncodedImageSender;
468 virtual int sendCustomReportMessage(
const char*
id,
const char* category,
const char* event,
const char* label,
int value) = 0;
703 virtual void onSnapshotTaken(
const char* channel,
uid_t uid,
const char* filePath,
int width,
int height,
int errCode) {
QUALITY_TYPE
Definition: AgoraBase.h:1231
UPLOAD_ERROR_REASON
Definition: AgoraBase.h:5048
virtual void onStreamMessageError(user_id_t userId, int streamId, int code, int missed, int cached)
Definition: NGIAgoraRtcConnection.h:787
TConnectionInfo()
Definition: NGIAgoraRtcConnection.h:47
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition: AgoraBase.h:285
virtual void onSnapshotTaken(const char *channel, uid_t uid, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition: NGIAgoraRtcConnection.h:703
Definition: AgoraBase.h:5093
size_t bytesPerSample
Definition: NGIAgoraRtcConnection.h:91
CHANNEL_PROFILE_TYPE channelProfile
Definition: NGIAgoraRtcConnection.h:148
Definition: AgoraBase.h:3756
virtual int enableEncryption(bool enabled, const EncryptionConfig &config)=0
ERROR_CODE_TYPE
Definition: AgoraBase.h:477
virtual void onChannelMediaRelayStateChanged(int state, int code)=0
Definition: IAgoraParameter.h:225
virtual base::NtpTime getNtpTime()=0
virtual int sendCustomReportMessage(const char *id, const char *category, const char *event, const char *label, int value)=0
Definition: AgoraBase.h:3682
int minPort
Definition: NGIAgoraRtcConnection.h:133
USER_OFFLINE_REASON_TYPE
Definition: AgoraBase.h:1197
int maxPort
Definition: NGIAgoraRtcConnection.h:137
virtual void onDisconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
unsigned int uid_t
Definition: AgoraMediaBase.h:29
Definition: NGIAgoraRtcConnection.h:816
~IRtcConnection()
Definition: NGIAgoraRtcConnection.h:191
virtual void onChangeRoleFailure(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: NGIAgoraRtcConnection.h:646
virtual void onUserJoined(user_id_t userId)=0
Definition: NGIAgoraRtcConnection.h:511
AudioSubscriptionOptions & operator=(const AudioSubscriptionOptions &rhs)
Definition: NGIAgoraRtcConnection.h:68
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: NGIAgoraRtcConnection.h:800
Definition: time_utils.h:13
virtual void onConnectionLost(const TConnectionInfo &connectionInfo)=0
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: NGIAgoraRtcConnection.h:809
virtual int stopLastmileProbeTest()=0
size_t numberOfChannels
Definition: NGIAgoraRtcConnection.h:95
util::AString localUserId
Definition: NGIAgoraRtcConnection.h:41
virtual void onLocalUserRegistered(uid_t uid, const char *userAccount)
Definition: NGIAgoraRtcConnection.h:767
uint32_t sampleRateHz
Definition: NGIAgoraRtcConnection.h:99
Definition: AgoraBase.h:239
int maxSendBitrate
Definition: NGIAgoraRtcConnection.h:129
virtual int unregisterObserver(IRtcConnectionObserver *observer)=0
@ CONNECTION_STATE_DISCONNECTED
Definition: AgoraBase.h:3385
@ TWO_BYTES_PER_SAMPLE
Definition: AgoraMediaBase.h:97
virtual ILocalUser * getLocalUser()=0
virtual void onTransportStats(const RtcStats &stats)=0
virtual int registerObserver(IRtcConnectionObserver *observer, void(*safeDeleter)(IRtcConnectionObserver *)=NULL)=0
virtual void onWarning(WARN_CODE_TYPE warning, const char *msg)
Definition: NGIAgoraRtcConnection.h:726
virtual int getUserInfo(user_id_t userId, agora::UserInfo &userInfo)=0
virtual void onReconnecting(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2356
virtual void onLastmileProbeResult(const LastmileProbeResult &result)=0
Definition: AgoraAtomicOps.h:21
ENCRYPTION_ERROR_TYPE
Definition: AgoraBase.h:5041
Definition: AgoraBase.h:4839
AudioSubscriptionOptions()
Definition: NGIAgoraRtcConnection.h:54
bool autoSubscribeVideo
Definition: NGIAgoraRtcConnection.h:119
CONNECTION_CHANGED_REASON_TYPE
Definition: AgoraBase.h:3783
Definition: NGIAgoraRtcConnection.h:25
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:773
virtual ~IRtcConnectionObserver()
Definition: NGIAgoraRtcConnection.h:513
virtual int getRemoteUsers(UserList &users)=0
AudioSubscriptionOptions audioSubscriptionOptions
Definition: NGIAgoraRtcConnection.h:141
virtual void onTokenPrivilegeWillExpire(const char *token)=0
Definition: AgoraBase.h:4855
bool autoSubscribeAudio
Definition: NGIAgoraRtcConnection.h:113
uid_t internalUid
Definition: NGIAgoraRtcConnection.h:45
bool packetOnly
Definition: NGIAgoraRtcConnection.h:87
virtual void onTokenPrivilegeDidExpire()=0
CLIENT_ROLE_TYPE clientRoleType
Definition: NGIAgoraRtcConnection.h:145
virtual void onConnecting(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual int sendStreamMessage(int streamId, const char *data, size_t length)=0
CHANNEL_PROFILE_TYPE
Definition: AgoraBase.h:273
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo *userInfo)=0
AudioSubscriptionOptions(const AudioSubscriptionOptions &rhs)
Definition: NGIAgoraRtcConnection.h:61
@ CLIENT_ROLE_AUDIENCE
Definition: AgoraBase.h:2364
unsigned int conn_id_t
Definition: AgoraMediaBase.h:31
virtual void onApiCallExecuted(int err, const char *api, const char *result)
Definition: NGIAgoraRtcConnection.h:683
Definition: NGIAgoraRtcConnection.h:53
virtual RtcStats getTransportStats()=0
Definition: AgoraBase.h:1168
virtual int createDataStream(int *streamId, bool reliable, bool ordered, bool sync)=0
Definition: NGIAgoraLocalUser.h:51
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Definition: NGIAgoraRtcConnection.h:829
RtcConnectionConfiguration()
Definition: NGIAgoraRtcConnection.h:165
virtual void onDownlinkNetworkInfoUpdated(const DownlinkNetworkInfo &info)
Definition: NGIAgoraRtcConnection.h:840
Definition: AgoraBase.h:4992
bool audioRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:158
WARN_CODE_TYPE
Definition: AgoraBase.h:316
Definition: AgoraBase.h:2131
virtual void onConnectionFailure(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual void onLastmileQuality(const QUALITY_TYPE quality)=0
Definition: NGIAgoraRtcConnection.h:107
Definition: AgoraRefPtr.h:31
virtual agora::base::IAgoraParameter * getAgoraParameter()=0
virtual int renewToken(const char *token)=0
virtual int disconnect()=0
virtual int registerNetworkObserver(INetworkObserver *observer, void(*safeDeleter)(INetworkObserver *)=NULL)=0
bool enableAudioRecordingOrPlayout
Definition: NGIAgoraRtcConnection.h:125
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: NGIAgoraRtcConnection.h:671
conn_id_t id
Definition: NGIAgoraRtcConnection.h:29
Definition: NGIAgoraRtcConnection.h:189
Definition: AgoraBase.h:162
NETWORK_TYPE
Definition: AgoraBase.h:3896
virtual void onError(ERROR_CODE_TYPE error, const char *msg)
Definition: NGIAgoraRtcConnection.h:716
virtual int unregisterNetworkObserver(INetworkObserver *observer)=0
virtual conn_id_t getConnId()=0
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: NGIAgoraRtcConnection.h:690
util::AString channelId
Definition: NGIAgoraRtcConnection.h:33
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
bool videoRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:163
virtual void onUserNetworkQuality(user_id_t userId, QUALITY_TYPE txQuality, QUALITY_TYPE rxQuality)
Definition: NGIAgoraRtcConnection.h:661
virtual int connect(const char *token, const char *channelId, user_id_t userId)=0
virtual void onConnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
CLIENT_ROLE_CHANGE_FAILED_REASON
Definition: AgoraBase.h:3874
bool audioRecvEncodedFrame
Definition: NGIAgoraRtcConnection.h:153
const char * user_id_t
Definition: AgoraBase.h:1162
virtual void onChangeRoleSuccess(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: NGIAgoraRtcConnection.h:638
virtual TConnectionInfo getConnectionInfo()=0
virtual void onReconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual int startLastmileProbeTest(const LastmileProbeConfig &config)=0
virtual ~INetworkObserver()
Definition: NGIAgoraRtcConnection.h:818
CONNECTION_STATE_TYPE state
Definition: NGIAgoraRtcConnection.h:37