Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
12 #ifndef OPTIONAL_ENUM_CLASS
13 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
14 #define OPTIONAL_ENUM_CLASS enum class
16 #define OPTIONAL_ENUM_CLASS enum
20 #ifndef OPTIONAL_NULLPTR
21 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
22 #define OPTIONAL_NULLPTR nullptr
24 #define OPTIONAL_NULLPTR NULL
168 unsigned int speakerNumber,
int totalVolume) {
766 unsigned short rxKBitRate) {
788 unsigned short rxKBitRate) {
802 CONNECTION_STATE_TYPE state,
905 virtual int setRemoteUserSpatialAudioParamsEx(
uid_t uid,
const agora::SpatialAudioParams& params,
const RtcConnection& connection) = 0;
992 virtual int addPublishStreamUrlEx(
const char* url,
bool transcodingEnabled,
const RtcConnection& connection) = 0;
UPLOAD_ERROR_REASON
Definition: AgoraBase.h:5048
virtual void onConnectionInterrupted(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:547
virtual void onRequestToken()
Definition: IAgoraRtcEngine.h:1823
virtual void onRemoteVideoTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngineEx.h:787
Definition: AgoraBase.h:5093
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Definition: IAgoraRtcEngine.h:1634
Definition: AgoraBase.h:3024
VIDEO_SOURCE_TYPE
Definition: AgoraBase.h:2313
virtual void onRtcStats(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:199
REMOTE_AUDIO_STATE
Definition: AgoraBase.h:2754
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2218
virtual int setVideoProfileEx(int width, int height, int frameRate, int bitrate)=0
virtual void onFirstLocalVideoFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:251
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngine.h:1106
virtual void onFirstLocalVideoFrame(const RtcConnection &connection, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:239
virtual void onConnectionBanned()
Definition: IAgoraRtcEngine.h:1768
USER_OFFLINE_REASON_TYPE
Definition: AgoraBase.h:1197
const char * channelId
Definition: IAgoraRtcEngineEx.h:47
unsigned int uid_t
Definition: AgoraMediaBase.h:29
virtual void onUserMuteAudio(const RtcConnection &connection, uid_t remoteUid, bool muted) 1
Definition: IAgoraRtcEngineEx.h:413
virtual int getUserInfoByUidEx(uid_t uid, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
virtual void onRejoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:141
virtual int sendCustomReportMessageEx(const char *id, const char *category, const char *event, const char *label, int value, const RtcConnection &connection)=0
virtual int muteRemoteVideoStreamEx(uid_t uid, bool mute, const RtcConnection &connection)=0
virtual void onConnectionStateChanged(const RtcConnection &connection, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:801
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:1529
virtual void onFirstRemoteAudioDecoded(const RtcConnection &connection, uid_t uid, int elapsed)
Definition: IAgoraRtcEngineEx.h:669
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)
Definition: IAgoraRtcEngine.h:1889
virtual void onLocalVideoStateChanged(const RtcConnection &connection, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR errorCode)
Definition: IAgoraRtcEngineEx.h:331
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2327
virtual void onClientRoleChangeFailed(const RtcConnection &connection, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngineEx.h:746
virtual void onRemoteAudioStats(const RtcConnection &connection, const RemoteAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:496
virtual void onAudioQuality(const RtcConnection &connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost)
Definition: IAgoraRtcEngineEx.h:159
virtual void onVideoSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2311
virtual void onConnectionBanned(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:553
Definition: IAgoraRtcEngineEx.h:58
virtual void onActiveSpeaker(uid_t userId)
Definition: IAgoraRtcEngine.h:1925
virtual void onUserMuteVideo(uid_t userId, bool muted) 1
Definition: IAgoraRtcEngine.h:1563
virtual void onVideoSizeChanged(uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngine.h:1430
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngineEx.h:117
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost)
Definition: IAgoraRtcEngine.h:1178
Definition: AgoraBase.h:1867
Definition: IAgoraRtcEngine.h:1102
virtual int sendStreamMessageEx(int streamId, const char *data, size_t length, const RtcConnection &connection)=0
virtual int enableDualStreamModeEx(VIDEO_SOURCE_TYPE sourceType, bool enabled, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: IAgoraRtcEngine.h:1928
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngine.h:1236
virtual int enableLoopbackRecordingEx(const RtcConnection &connection, bool enabled, const char *deviceName=NULL)=0
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) 1
Definition: IAgoraRtcEngine.h:1609
Definition: AgoraBase.h:2032
virtual int muteRemoteAudioStreamEx(uid_t uid, bool mute, const RtcConnection &connection)=0
virtual int createDataStreamEx(int *streamId, bool reliable, bool ordered, const RtcConnection &connection)=0
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngine.h:2279
virtual void onLocalAudioStats(const RtcConnection &connection, const LocalAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:481
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1135
virtual void onActiveSpeaker(const RtcConnection &connection, uid_t uid)
Definition: IAgoraRtcEngineEx.h:720
virtual void onUserMuteVideo(const RtcConnection &connection, uid_t remoteUid, bool muted) 1
Definition: IAgoraRtcEngineEx.h:427
VIDEO_MIRROR_MODE_TYPE
Definition: AgoraBase.h:1849
virtual void onLocalVideoStats(const LocalVideoStats &stats)
Definition: IAgoraRtcEngine.h:1665
virtual int enableEncryptionEx(const RtcConnection &connection, bool enabled, const EncryptionConfig &config)=0
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Definition: IAgoraRtcEngine.h:1678
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2356
virtual int enableAudioVolumeIndicationEx(int interval, int smooth, bool reportVad, const RtcConnection &connection)=0
Definition: AgoraAtomicOps.h:21
virtual void onUserAccountUpdated(const RtcConnection &connection, uid_t remoteUid, const char *userAccount)
Definition: IAgoraRtcEngineEx.h:840
ENCRYPTION_ERROR_TYPE
Definition: AgoraBase.h:5041
virtual void onNetworkTypeChanged(const RtcConnection &connection, NETWORK_TYPE type)
Definition: IAgoraRtcEngineEx.h:813
virtual void onRemoteAudioTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngineEx.h:765
virtual void onStreamMessageError(const RtcConnection &connection, uid_t remoteUid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngineEx.h:595
virtual void onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error)
Definition: IAgoraRtcEngine.h:1448
virtual void onRemoteVideoStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:350
REMOTE_VIDEO_STATE
Definition: AgoraBase.h:2829
virtual void onEncryptionError(const RtcConnection &connection, ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngineEx.h:823
virtual void onStreamMessage(const RtcConnection &connection, uid_t remoteUid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngineEx.h:571
LOCAL_VIDEO_STREAM_STATE
Definition: AgoraBase.h:2693
CONNECTION_CHANGED_REASON_TYPE
Definition: AgoraBase.h:3783
Definition: AgoraBase.h:2020
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1510
virtual void onFirstLocalAudioFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:643
virtual int joinChannelEx(const char *token, const RtcConnection &connection, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
virtual void onSnapshotTaken(const char *channel, uid_t uid, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition: IAgoraRtcEngine.h:1941
virtual int getUserInfoByUserAccountEx(const char *userAccount, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: IAgoraRtcEngine.h:2228
virtual CONNECTION_STATE_TYPE getConnectionStateEx(const RtcConnection &connection)=0
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1464
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: IAgoraRtcEngine.h:1956
virtual void onUserEnableLocalVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled) 1
Definition: IAgoraRtcEngineEx.h:455
virtual void onUserStateChanged(const RtcConnection &connection, uid_t remoteUid, uint32_t state)
Definition: IAgoraRtcEngineEx.h:468
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:1848
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngine.h:2205
virtual void onRemoteAudioStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:709
virtual void onUserOffline(const RtcConnection &connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:399
virtual void onUploadLogResult(const RtcConnection &connection, const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngineEx.h:833
virtual void onAudioVolumeIndication(const RtcConnection &connection, const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngineEx.h:167
virtual int addVideoWatermarkEx(const char *watermarkUrl, const WatermarkOptions &options, const RtcConnection &connection)=0
LOCAL_AUDIO_STREAM_ERROR
Definition: AgoraBase.h:2663
Definition: IAgoraRtcEngineEx.h:36
virtual void onSnapshotTaken(const RtcConnection &connection, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition: IAgoraRtcEngineEx.h:313
virtual void onLeaveChannel(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:186
virtual int createDataStreamEx(int *streamId, DataStreamConfig &config, const RtcConnection &connection)=0
virtual void onStreamMessage(uid_t userId, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngine.h:1783
virtual void onConnectionInterrupted()
Definition: IAgoraRtcEngine.h:1764
virtual void onUserStateChanged(uid_t uid, uint32_t state)
Definition: IAgoraRtcEngine.h:1594
virtual void onStreamMessageError(uid_t userId, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngine.h:1804
Definition: IAgoraRtcEngineEx.h:847
virtual int clearVideoWatermarkEx(const RtcConnection &connection)=0
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) 1
Definition: IAgoraRtcEngine.h:1423
virtual void onVideoSourceFrameSizeChanged(const RtcConnection &connection, VIDEO_SOURCE_TYPE sourceType, int width, int height)
Definition: IAgoraRtcEngineEx.h:256
virtual void onUserMuteAudio(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:1545
virtual void onUserEnableVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled) 1
Definition: IAgoraRtcEngineEx.h:441
Definition: IAgoraRtcEngine.h:234
virtual void onConnectionLost(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:532
Definition: AgoraBase.h:4992
REMOTE_AUDIO_STATE_REASON
Definition: AgoraBase.h:2789
virtual void onTokenPrivilegeWillExpire(const char *token)
Definition: IAgoraRtcEngine.h:1839
Definition: AgoraBase.h:2418
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1870
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1906
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2373
virtual void onFirstRemoteAudioFrame(const RtcConnection &connection, uid_t userId, int elapsed)
Definition: IAgoraRtcEngineEx.h:655
virtual void onUserEnableVideo(uid_t uid, bool enabled) 1
Definition: IAgoraRtcEngine.h:1584
virtual void onVideoSizeChanged(const RtcConnection &connection, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngineEx.h:293
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1740
virtual int leaveChannelEx(const RtcConnection &connection)=0
Definition: AgoraBase.h:2131
virtual void onClientRoleChanged(const RtcConnection &connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: IAgoraRtcEngineEx.h:732
virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration &config, const RtcConnection &connection)=0
virtual void onRequestToken(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:615
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1117
Definition: AgoraBase.h:2096
Definition: AgoraBase.h:3204
LOCAL_AUDIO_STREAM_STATE
Definition: AgoraBase.h:2641
#define __deprecated
Definition: AgoraBase.h:63
virtual void onFirstLocalVideoFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:1398
virtual void onFirstLocalVideoFrame(int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1387
virtual void onUserJoined(const RtcConnection &connection, uid_t remoteUid, int elapsed)
Definition: IAgoraRtcEngineEx.h:386
Definition: IAgoraRtcEngine.h:2863
virtual void onAudioSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2294
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Definition: IAgoraRtcEngine.h:1648
virtual void onFirstRemoteVideoFrame(uid_t userId, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1485
LOCAL_VIDEO_STREAM_ERROR
Definition: AgoraBase.h:2715
REMOTE_VIDEO_STATE_REASON
Definition: AgoraBase.h:2857
virtual void onLocalAudioStateChanged(const RtcConnection &connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)
Definition: IAgoraRtcEngineEx.h:689
virtual void onIntraRequestReceived(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:228
RtcConnection()
Definition: IAgoraRtcEngineEx.h:53
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngine.h:1967
NETWORK_TYPE
Definition: AgoraBase.h:3896
virtual void onFirstRemoteVideoFrame(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:371
virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions &options, const RtcConnection &connection)=0
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngine.h:1326
virtual void onTokenPrivilegeWillExpire(const RtcConnection &connection, const char *token)
Definition: IAgoraRtcEngineEx.h:633
uid_t localUid
Definition: IAgoraRtcEngineEx.h:51
RtcConnection(const char *channel_id, uid_t local_uid)
Definition: IAgoraRtcEngineEx.h:54
virtual void onVideoPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2342
virtual void onLocalVideoStats(const RtcConnection &connection, const LocalVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:508
virtual void onJoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:125
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: IAgoraRtcEngineEx.h:301
virtual int setRemoteRenderModeEx(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode, const RtcConnection &connection)=0
virtual void onNetworkQuality(const RtcConnection &connection, uid_t remoteUid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngineEx.h:215
virtual int setRemoteVideoStreamTypeEx(uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection &connection)=0
virtual void onVideoSourceFrameSizeChanged(VIDEO_SOURCE_TYPE sourceType, int width, int height)
Definition: IAgoraRtcEngine.h:1402
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1858
virtual void onRemoteVideoStats(const RtcConnection &connection, const RemoteVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:520
CLIENT_ROLE_CHANGE_FAILED_REASON
Definition: AgoraBase.h:3874
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1254
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngine.h:2236
virtual void onRtcStats(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1263
virtual void onConnectionLost()
Definition: IAgoraRtcEngine.h:1751
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngine.h:2184
Definition: IAgoraRtcEngine.h:312
virtual void onFirstRemoteVideoDecoded(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:274
virtual int setRemoteVoicePositionEx(uid_t uid, double pan, double gain, const RtcConnection &connection)=0
virtual int setupRemoteVideoEx(const VideoCanvas &canvas, const RtcConnection &connection)=0
Definition: AgoraBase.h:3948
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:1338