|
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;
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;
292 virtual int renewToken(
const char* token, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
443 virtual int sendStreamMessage(
int streamId,
const char* data,
size_t length, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
502 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;
738 (void)newRoleOptions;
QUALITY_TYPE
Definition: AgoraBase.h:925
virtual int enableMultipath(bool enable, aosl_ref_t ares=AOSL_REF_INVALID)=0
UPLOAD_ERROR_REASON
Definition: AgoraBase.h:6896
virtual void onStreamMessageError(user_id_t userId, int streamId, int code, int missed, int cached)
Definition: NGIAgoraRtcConnection.h:870
TConnectionInfo()
Definition: NGIAgoraRtcConnection.h:52
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition: AgoraBase.h:279
virtual int setDownlinkMultipathMode(MultipathMode mode, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: AgoraBase.h:7053
CHANNEL_PROFILE_TYPE channelProfile
Definition: NGIAgoraRtcConnection.h:127
Definition: AgoraBase.h:4758
ERROR_CODE_TYPE
Definition: AgoraBase.h:456
virtual void onChannelMediaRelayStateChanged(int state, int code)=0
user_id_t userId
Definition: NGIAgoraRtcConnection.h:76
Definition: IAgoraParameter.h:147
Definition: AgoraBase.h:4688
agora::Optional< int64_t > appDefinedStartTimeMs
Definition: NGIAgoraRtcConnection.h:82
int minPort
Definition: NGIAgoraRtcConnection.h:116
USER_OFFLINE_REASON_TYPE
Definition: AgoraBase.h:888
int maxPort
Definition: NGIAgoraRtcConnection.h:120
virtual void onDisconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
unsigned int uid_t
Definition: AgoraMediaBase.h:28
Definition: NGIAgoraRtcConnection.h:917
virtual void onRenewTokenResult(const char *token, RENEW_TOKEN_ERROR_CODE code)=0
Reports the result of calling renewToken.
~IRtcConnection()
Definition: NGIAgoraRtcConnection.h:186
virtual void onChangeRoleFailure(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: NGIAgoraRtcConnection.h:744
virtual void onUserJoined(user_id_t userId)=0
Definition: NGIAgoraRtcConnection.h:594
virtual void onSetRtmFlagResult(int code)
Definition: NGIAgoraRtcConnection.h:903
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: NGIAgoraRtcConnection.h:883
virtual void onConnectionLost(const TConnectionInfo &connectionInfo)=0
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: NGIAgoraRtcConnection.h:892
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:850
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:112
virtual int unregisterObserver(IRtcConnectionObserver *observer)=0
@ CONNECTION_STATE_DISCONNECTED
Definition: AgoraBase.h:4222
virtual ILocalUser * getLocalUser()=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 void onTransportStats(const RtcStats &stats)=0
MultipathMode
Defines how data is transmitted across multiple network paths.
Definition: AgoraBase.h:2562
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:2879
virtual void onLastmileProbeResult(const LastmileProbeResult &result)=0
Definition: AgoraAtomicOps.h:21
ENCRYPTION_ERROR_TYPE
Definition: AgoraBase.h:6871
Definition: AgoraBase.h:6644
virtual int setUplinkMultipathMode(MultipathMode mode, aosl_ref_t ares=AOSL_REF_INVALID)=0
bool autoSubscribeVideo
Definition: NGIAgoraRtcConnection.h:102
CONNECTION_CHANGED_REASON_TYPE
Definition: AgoraBase.h:4782
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:856
virtual ~IRtcConnectionObserver()
Definition: NGIAgoraRtcConnection.h:596
virtual int getRemoteUsers(UserList &users)=0
virtual void onTokenPrivilegeWillExpire(const char *token)=0
Definition: AgoraBase.h:6657
bool autoSubscribeAudio
Definition: NGIAgoraRtcConnection.h:96
uid_t internalUid
Definition: NGIAgoraRtcConnection.h:46
virtual void onTokenPrivilegeDidExpire()=0
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: NGIAgoraRtcConnection.h:755
bool isDataChannelOnly
Definition: NGIAgoraRtcConnection.h:156
CLIENT_ROLE_TYPE clientRoleType
Definition: NGIAgoraRtcConnection.h:124
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:2887
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:859
virtual int createDataStream(int *streamId, bool reliable, bool ordered, bool sync)=0
Definition: NGIAgoraLocalUser.h:56
virtual int sendStreamMessage(int streamId, const char *data, size_t length, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onMultipathStats(const MultipathStats &stats)
Definition: NGIAgoraRtcConnection.h:912
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Definition: NGIAgoraRtcConnection.h:930
const char * channelId
Definition: NGIAgoraRtcConnection.h:70
RtcConnectionConfiguration()
Definition: NGIAgoraRtcConnection.h:158
const char * info
Definition: NGIAgoraRtcConnection.h:78
Aggregates statistics for all network paths used in multipath transmission.
Definition: AgoraBase.h:2625
virtual void onDownlinkNetworkInfoUpdated(const DownlinkNetworkInfo &info)
Definition: NGIAgoraRtcConnection.h:941
Definition: AgoraBase.h:6811
bool audioRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:137
MultipathType
Defines the types of network paths used in multipath transmission.
Definition: AgoraBase.h:2579
virtual void onChangeRoleSuccess(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: NGIAgoraRtcConnection.h:735
Definition: AgoraBase.h:2672
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:151
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 agora::base::IAgoraParameter * getAgoraParameter()=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
bool enableAudioRecordingOrPlayout
Definition: NGIAgoraRtcConnection.h:108
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: NGIAgoraRtcConnection.h:779
virtual int setPreferMultipathType(MultipathType type, aosl_ref_t ares=AOSL_REF_INVALID)=0
RENEW_TOKEN_ERROR_CODE
Definition: AgoraBase.h:6908
conn_id_t id
Definition: NGIAgoraRtcConnection.h:30
Definition: NGIAgoraRtcConnection.h:184
Definition: AgoraBase.h:156
NETWORK_TYPE
Definition: AgoraBase.h:4927
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:809
virtual int unregisterNetworkObserver(INetworkObserver *observer)=0
virtual conn_id_t getConnId()=0
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: NGIAgoraRtcConnection.h:784
util::AString channelId
Definition: NGIAgoraRtcConnection.h:34
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
bool videoRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:142
virtual void onUserNetworkQuality(user_id_t userId, QUALITY_TYPE txQuality, QUALITY_TYPE rxQuality)
Definition: NGIAgoraRtcConnection.h:769
RdtStreamType
Reliable Data Transmission Tunnel message stream type.
Definition: AgoraBase.h:7418
virtual void onSnapshotTaken(user_id_t userId, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition: NGIAgoraRtcConnection.h:797
LICENSE_ERROR_TYPE
Definition: AgoraBase.h:798
virtual void onConnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
CLIENT_ROLE_CHANGE_FAILED_REASON
Definition: AgoraBase.h:4903
virtual int enableEncryption(bool enabled, const EncryptionConfig &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
bool audioRecvEncodedFrame
Definition: NGIAgoraRtcConnection.h:132
const char * user_id_t
Definition: AgoraBase.h:853
Definition: AgoraBase.h:2927
virtual int sendMediaControlMessage(user_id_t userId, const char *data, size_t length, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual TConnectionInfo getConnectionInfo()=0
virtual void onReconnected(const TConnectionInfo &connectionInfo, CONNECTION_CHANGED_REASON_TYPE reason)=0
virtual ~INetworkObserver()
Definition: NGIAgoraRtcConnection.h:919
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