|
Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
185 unsigned int speakerNumber,
int totalVolume) {
856 (void)newRoleOptions;
934 CONNECTION_STATE_TYPE state,
990 (void)remoteUserAccount;
1559 virtual int setSubscribeAudioBlocklistEx(
uid_t* uidList,
int uidNumber,
const RtcConnection& connection) = 0;
1618 virtual int setSubscribeVideoBlocklistEx(
uid_t* uidList,
int uidNumber,
const RtcConnection& connection) = 0;
1702 virtual int setRemoteUserSpatialAudioParamsEx(
uid_t uid,
const agora::SpatialAudioParams& params,
const RtcConnection& connection) = 0;
2675 virtual int preloadEffectEx(
const RtcConnection& connection,
int soundId,
const char* filePath,
int startPos = 0) = 0;
2724 virtual int playEffectEx(
const RtcConnection& connection,
int soundId,
const char* filePath,
int loopCount,
double pitch,
double pan,
int gain,
bool publish =
false,
int startPos = 0) = 0;
virtual void onAudioQuality(const RtcConnection &connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost) 1
Definition: IAgoraRtcEngineEx.h:150
virtual void onLicenseValidationFailure(const RtcConnection &connection, LICENSE_ERROR_TYPE reason)
Definition: IAgoraRtcEngineEx.h:705
UPLOAD_ERROR_REASON
Definition: AgoraBase.h:7498
virtual void onRequestToken()
Occurs when the token expires.
Definition: IAgoraRtcEngine.h:2903
Layout information of a specific sub-video stream within the mixed stream.
Definition: AgoraBase.h:8260
virtual void onMediaControlMessage(uid_t userId, const char *data, size_t length)
Occurs when the local user receives media control message sent by a remote user.
Definition: IAgoraRtcEngine.h:2880
The information of the user.
Definition: AgoraBase.h:7693
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Reports the statistics of the local audio stream.
Definition: IAgoraRtcEngine.h:2562
virtual int resumeAllChannelMediaRelayEx(const RtcConnection &connection)=0
Resumes the media stream relay to all target channels.
virtual void onUserStateChanged(uid_t uid, REMOTE_USER_STATE state)
Definition: IAgoraRtcEngine.h:2508
The volume information of users.
Definition: AgoraBase.h:4069
virtual void onMediaControlMessage(const RtcConnection &connection, uid_t userId, const char *data, size_t length)
Occurs when the local user receives media control message sent by a remote user.
Definition: IAgoraRtcEngineEx.h:679
VIDEO_SOURCE_TYPE
The type of the video source.
Definition: AgoraMediaBase.h:67
virtual void onRtcStats(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:214
REMOTE_AUDIO_STATE
Remote audio states.
Definition: AgoraBase.h:3792
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Occurs when the network connection state changes.
Definition: IAgoraRtcEngine.h:3336
virtual void onFirstLocalVideoFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:271
virtual void onConnectionBanned() 1
Occurs when the connection is banned by the Agora server.
Definition: IAgoraRtcEngine.h:2784
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngine.h:1807
virtual void onRemoteVideoTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Definition: IAgoraRtcEngineEx.h:915
virtual int muteAllRemoteVideoStreamsEx(bool mute, const RtcConnection &connection)=0
Stops or resumes subscribing to the video streams of all remote users.
virtual void onVideoRenderingTracingResult(const RtcConnection &connection, uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Definition: IAgoraRtcEngineEx.h:1026
virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Occurs when the video publishing state changes.
Definition: IAgoraRtcEngine.h:3554
virtual int takeSnapshotEx(const RtcConnection &connection, uid_t uid, const media::SnapshotConfig &config)=0
Gets a video screenshot of the specified observation point using the connection ID.
virtual int setSubscribeAudioAllowlistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
Sets the allowlist of subscriptions for audio streams.
USER_OFFLINE_REASON_TYPE
Reasons for a user being offline.
Definition: AgoraBase.h:969
const char * channelId
Definition: IAgoraRtcEngineEx.h:24
unsigned int uid_t
Definition: AgoraMediaBase.h:28
virtual void onUserMuteAudio(const RtcConnection &connection, uid_t remoteUid, bool muted) 1
Definition: IAgoraRtcEngineEx.h:414
virtual void onFirstRemoteAudioDecoded(const RtcConnection &connection, uid_t uid, int elapsed) 1
Definition: IAgoraRtcEngineEx.h:773
virtual void onSnapshotTaken(const RtcConnection &connection, uid_t uid, const char *filePath, int width, int height, int errCode)
Definition: IAgoraRtcEngineEx.h:1010
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Occurs when the user role or the audience latency level changes.
Definition: IAgoraRtcEngine.h:3130
virtual int getUserInfoByUidEx(uid_t uid, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
Gets the user information by passing in the user ID. It is same as agora::rtc::IRtcEngine::getUserInf...
virtual void onRejoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:129
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats &stats)
Reports the statistics of the local video stream.
Definition: IAgoraRtcEngine.h:2577
virtual int sendCustomReportMessageEx(const char *id, const char *category, const char *event, const char *label, int value, const RtcConnection &connection)=0
Agora supports reporting and analyzing customized messages.
virtual void onUserInfoUpdated(uid_t uid, const UserInfo &info)
Occurs when the SDK gets the user ID and user account of the remote user.
Definition: IAgoraRtcEngine.h:3425
virtual int muteRemoteVideoStreamEx(uid_t uid, bool mute, const RtcConnection &connection)=0
Stops or resumes receiving the video stream of a specified user.
virtual void onConnectionStateChanged(const RtcConnection &connection, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:933
Transcoding configurations for Media Push.
Definition: AgoraBase.h:4651
virtual void onRenewTokenResult(const RtcConnection &connection, const char *token, RENEW_TOKEN_ERROR_CODE code)
Definition: IAgoraRtcEngineEx.h:1101
virtual void onRdtMessage(uid_t userId, RdtStreamType type, const char *data, size_t length)
Occurs when the local user receives data via Reliable Data Transmission (RDT) from a remote user.
Definition: IAgoraRtcEngine.h:2849
virtual int leaveChannelEx(const RtcConnection &connection, const LeaveChannelOptions &options)=0
Sets channel options and leaves the channel.
virtual int startMediaRenderingTracingEx(const RtcConnection &connection)=0
Enables tracing the video frame rendering process.
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves...
Definition: IAgoraRtcEngine.h:2434
virtual void onVideoSizeChanged(const RtcConnection &connection, VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngineEx.h:311
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Occurs when the audio publishing state changes.
Definition: IAgoraRtcEngine.h:3537
virtual void onAudioMetadataReceived(const RtcConnection &connection, uid_t uid, const char *metadata, size_t length)
Definition: IAgoraRtcEngineEx.h:1069
virtual void onClientRoleChangeFailed(const RtcConnection &connection, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngineEx.h:867
virtual void onRemoteAudioStats(const RtcConnection &connection, const RemoteAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:510
virtual void onVideoSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Occurs when the video subscribing state changes.
Definition: IAgoraRtcEngine.h:3520
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) 1
Reports the statistics of the audio stream sent by each remote user.
Definition: IAgoraRtcEngine.h:1917
virtual void onConnectionBanned(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:583
The IRtcEngineEventHandlerEx class.
Definition: IAgoraRtcEngineEx.h:38
virtual void onUserAccountUpdated(const RtcConnection &connection, uid_t remoteUid, const char *remoteUserAccount)
Definition: IAgoraRtcEngineEx.h:987
virtual int enableContentInspectEx(bool enabled, const media::ContentInspectConfig &config, const RtcConnection &connection)=0
Enables or disables video screenshot and upload.
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngineEx.h:105
Video encoder configurations.
Definition: AgoraBase.h:2143
Definition: IAgoraRtcEngine.h:1803
virtual int sendStreamMessageEx(int streamId, const char *data, size_t length, const RtcConnection &connection)=0
Sends data stream messages.
virtual void onAudioMetadataReceived(uid_t uid, const char *metadata, size_t length)
Definition: IAgoraRtcEngine.h:3597
virtual void onUserEnableVideo(uid_t uid, bool enabled)
Occurs when a remote user enables or disables the video module.
Definition: IAgoraRtcEngine.h:2498
Video subscription options.
Definition: AgoraBase.h:1791
virtual void onConnectionInterrupted(const RtcConnection &connection) 1
Definition: IAgoraRtcEngineEx.h:575
virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Video frame rendering event callback.
Definition: IAgoraRtcEngine.h:3457
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Reports the volume information of users.
Definition: IAgoraRtcEngine.h:1974
virtual int setSimulcastConfigEx(const SimulcastConfig &simulcastConfig, const RtcConnection &connection)=0
Sets the simulcast video stream configuration.
virtual int enableLoopbackRecordingEx(const RtcConnection &connection, bool enabled, const char *deviceName=NULL)=0
Enables loopback audio capturing.
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) 1
Occurs when a specific remote user enables/disables the local video capturing function.
Definition: IAgoraRtcEngine.h:2533
virtual int adjustUserPlaybackSignalVolumeEx(uid_t uid, int volume, const RtcConnection &connection)=0
Adjusts the playback signal volume of a specified remote user.
The configuration of the low-quality video stream.
Definition: AgoraBase.h:2316
virtual int muteRemoteAudioStreamEx(uid_t uid, bool mute, const RtcConnection &connection)=0
Stops or resumes receiving the audio stream of a specified user.
virtual int createDataStreamEx(int *streamId, bool reliable, bool ordered, const RtcConnection &connection)=0
Creates a data stream.
virtual int sendMediaControlMessageEx(uid_t uid, const char *data, size_t length, const RtcConnection &connection)=0
Send media control message.
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngine.h:3486
virtual void onLocalAudioStats(const RtcConnection &connection, const LocalAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:498
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Occurs when a user rejoins the channel.
Definition: IAgoraRtcEngine.h:1849
virtual void onActiveSpeaker(const RtcConnection &connection, uid_t uid)
Definition: IAgoraRtcEngineEx.h:839
virtual void onFirstRemoteAudioFrame(const RtcConnection &connection, uid_t userId, int elapsed) 1
Definition: IAgoraRtcEngineEx.h:750
virtual int setDualStreamModeEx(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
Sets the dual-stream mode on the sender side.
VIDEO_MIRROR_MODE_TYPE
Video mirror mode.
Definition: AgoraBase.h:1998
virtual int enableEncryptionEx(const RtcConnection &connection, bool enabled, const EncryptionConfig &config)=0
Enables or disables the built-in encryption.
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Reports the statistics of the video stream sent by each remote users.
Definition: IAgoraRtcEngine.h:2593
CLIENT_ROLE_TYPE
The user role in the interactive live streaming.
Definition: AgoraBase.h:3037
virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached)
Occurs when the local user does not receive the data stream from the remote user.
Definition: IAgoraRtcEngine.h:2828
virtual int enableAudioVolumeIndicationEx(int interval, int smooth, bool reportVad, const RtcConnection &connection)=0
Enables the reporting of users' volume indication.
Definition: AgoraAtomicOps.h:21
virtual int startOrUpdateChannelMediaRelayEx(const ChannelMediaRelayConfiguration &configuration, const RtcConnection &connection)=0
Starts relaying media streams across channels or updates channels for media relay.
ENCRYPTION_ERROR_TYPE
Encryption error type.
Definition: AgoraBase.h:7473
virtual void onNetworkTypeChanged(const RtcConnection &connection, NETWORK_TYPE type)
Definition: IAgoraRtcEngineEx.h:950
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
Reports the result of taking a video snapshot.
Definition: IAgoraRtcEngine.h:3099
virtual void onStreamMessageError(const RtcConnection &connection, uid_t remoteUid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngineEx.h:621
SIMULCAST_STREAM_MODE
The mode in which the video stream is sent.
Definition: AgoraBase.h:2296
virtual void onRemoteVideoStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:332
REMOTE_VIDEO_STATE
The state of the remote video stream.
Definition: AgoraBase.h:3872
virtual int sendRdtMessageEx(uid_t uid, RdtStreamType type, const char *data, size_t length, const RtcConnection &connection)=0
Send Reliable message to remote uid in channel.
virtual void onEncryptionError(const RtcConnection &connection, ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngineEx.h:962
virtual void onStreamMessage(const RtcConnection &connection, uid_t remoteUid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngineEx.h:599
CONNECTION_CHANGED_REASON_TYPE
Reasons causing the change of the connection state.
Definition: AgoraBase.h:5139
virtual int startRtmpStreamWithoutTranscodingEx(const char *url, const RtcConnection &connection)=0
Starts pushing media streams to a CDN without transcoding.
virtual int adjustRecordingSignalVolumeEx(int volume, const RtcConnection &connection)=0
The configurations for the data stream.
Definition: AgoraBase.h:2271
virtual int setHighPriorityUserListEx(uid_t *uidList, int uidNum, STREAM_FALLBACK_OPTIONS option, const RtcConnection &connection)=0
virtual void onUserJoined(uid_t uid, int elapsed)
Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins ...
Definition: IAgoraRtcEngine.h:2410
virtual void onFirstLocalAudioFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:737
virtual void onRemoteAudioTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Definition: IAgoraRtcEngineEx.h:888
virtual void onLocalAudioStateChanged(const RtcConnection &connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Definition: IAgoraRtcEngineEx.h:794
virtual int joinChannelEx(const char *token, const RtcConnection &connection, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
Joins a channel.
virtual int enableDualStreamModeEx(bool enabled, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
Enables or disables dual-stream mode on the sender side.
virtual int getUserInfoByUserAccountEx(const char *userAccount, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
Gets the user information by passing in the user account. It is same as agora::rtc::IRtcEngine::getUs...
virtual int setParametersEx(const RtcConnection &connection, const char *parameters)=0
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Occurs when the local network type changes.
Definition: IAgoraRtcEngine.h:3354
virtual CONNECTION_STATE_TYPE getConnectionStateEx(const RtcConnection &connection)=0
Gets the current connection state of the SDK.
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Occurs when the remote video stream state changes.
Definition: IAgoraRtcEngine.h:2356
The options for leaving a channel.
Definition: IAgoraRtcEngine.h:1770
virtual void onUserEnableLocalVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled) 1
Definition: IAgoraRtcEngineEx.h:471
virtual void onUserStateChanged(const RtcConnection &connection, uid_t remoteUid, uint32_t state)
Definition: IAgoraRtcEngineEx.h:484
virtual void onRdtStateChanged(const RtcConnection &connection, uid_t userId, RdtState state)
Occurs when the RDT tunnel state changed.
Definition: IAgoraRtcEngineEx.h:661
virtual void onFirstLocalAudioFramePublished(int elapsed)
Occurs when the first audio frame is published.
Definition: IAgoraRtcEngine.h:2955
virtual void onRemoteAudioStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:817
virtual void onUserOffline(const RtcConnection &connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:397
virtual void onUserEnableVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled)
Definition: IAgoraRtcEngineEx.h:454
virtual void onUploadLogResult(const RtcConnection &connection, const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngineEx.h:973
virtual void onAudioVolumeIndication(const RtcConnection &connection, const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngineEx.h:184
virtual int addVideoWatermarkEx(const char *watermarkUrl, const WatermarkOptions &options, const RtcConnection &connection)=0
Adds a watermark image to the local video.
virtual int getCallIdEx(agora::util::AString &callId, const RtcConnection &connection)=0
Gets the call ID with the connection ID.
Contains connection information.
Definition: IAgoraRtcEngineEx.h:20
virtual void onLeaveChannel(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:201
RdtState
Reliable Data Transmission tunnel state.
Definition: AgoraBase.h:8114
virtual int muteLocalAudioStreamEx(bool mute, const RtcConnection &connection)=0
Stops or resumes publishing the local audio stream.
virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Occurs when the local user receives a mixed video stream carrying layout information.
Definition: IAgoraRtcEngine.h:3581
Definition: IAgoraRtcEngineEx.h:1107
virtual int setRemoteVideoSubscriptionOptionsEx(uid_t uid, const VideoSubscriptionOptions &options, const RtcConnection &connection)=0
Sets options for subscribing to remote video streams.
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason)
Occurs when the local video stream state changes.
Definition: IAgoraRtcEngine.h:2336
MEDIA_TRACE_EVENT
The rendering state of the media frame.
Definition: AgoraBase.h:7827
virtual int clearVideoWatermarkEx(const RtcConnection &connection)=0
Removes the watermark image from the video stream.
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) 1
Occurs when the first remote video frame is received and decoded.
Definition: IAgoraRtcEngine.h:2242
virtual int muteLocalVideoStreamEx(bool mute, const RtcConnection &connection)=0
Stops or resumes publishing the local video stream.
virtual void onUserMuteAudio(uid_t uid, bool muted)
Occurs when a remote user (in the communication profile) or a host (in the live streaming profile) st...
Definition: IAgoraRtcEngine.h:2456
virtual void onClientRoleChanged(const RtcConnection &connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: IAgoraRtcEngineEx.h:852
virtual int stopRtmpStreamEx(const char *url, const RtcConnection &connection)=0
Stops pushing media streams to a CDN.
virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Occurs when the video size or rotation of a specified user changes.
Definition: IAgoraRtcEngine.h:2261
virtual void onRdtMessage(const RtcConnection &connection, uid_t userId, RdtStreamType type, const char *data, size_t length)
Occurs when the local user receives data via Reliable Data Transmission (RDT) from a remote user.
Definition: IAgoraRtcEngineEx.h:644
The statistics of the local video stream.
Definition: IAgoraRtcEngine.h:311
VIDEO_ORIENTATION
The clockwise rotation of the video.
Definition: AgoraBase.h:1086
Aggregates statistics of each network path in multipath transmission.
Definition: AgoraBase.h:2781
virtual void onConnectionLost(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:558
STREAM_FALLBACK_OPTIONS
Options for handling audio and video stream fallback when network conditions are weak.
Definition: IAgoraRtcEngine.h:268
Built-in encryption configurations.
Definition: AgoraBase.h:7409
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) 1
Occurs when the SDK decodes the first remote audio frame for playback.
Definition: IAgoraRtcEngine.h:2980
REMOTE_AUDIO_STATE_REASON
The reason for the remote audio state change.
Definition: AgoraBase.h:3826
virtual void onTokenPrivilegeWillExpire(const char *token)
Occurs when the token expires in 30 seconds.
Definition: IAgoraRtcEngine.h:2925
virtual void onSetRtmFlagResult(const RtcConnection &connection, int code)
Definition: IAgoraRtcEngineEx.h:1038
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) 1
Occurs when the SDK receives the first audio frame from a specific remote user.
Definition: IAgoraRtcEngine.h:2996
virtual int updateRtmpTranscodingEx(const LiveTranscoding &transcoding, const RtcConnection &connection)=0
Updates the transcoding configuration.
virtual void onUserMuteVideo(uid_t uid, bool muted)
Occurs when a remote user stops or resumes publishing the video stream.
Definition: IAgoraRtcEngine.h:2478
Audio statistics of the remote user.
Definition: IAgoraRtcEngine.h:435
virtual int createDataStreamEx(int *streamId, const DataStreamConfig &config, const RtcConnection &connection)=0
Creates a data stream.
virtual int leaveChannelWithUserAccountEx(const char *channelId, const char *userAccount)=0
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Occurs when the remote audio state changes.
Definition: IAgoraRtcEngine.h:3041
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:3436
Used to configure watermark-related information.
Definition: AgoraBase.h:2673
VIDEO_STREAM_TYPE
The type of video streams.
Definition: AgoraBase.h:1746
virtual int leaveChannelEx(const RtcConnection &connection)=0
Leaves a channel.
Statistics of a call session.
Definition: AgoraBase.h:2828
virtual int removeVideoWatermarkEx(const char *id, const RtcConnection &connection)=0
Removes the specified watermark image from the local or remote video stream.
virtual void onSetRtmFlagResult(int code)
Definition: IAgoraRtcEngine.h:3672
virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration &config, const RtcConnection &connection)=0
Sets the video encoder configuration.
virtual void onRequestToken(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:696
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Occurs when a user joins a channel.
Definition: IAgoraRtcEngine.h:1829
Watermark image configurations.
Definition: AgoraBase.h:2495
virtual void onTranscodedStreamLayoutInfo(const RtcConnection &connection, uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Definition: IAgoraRtcEngineEx.h:1052
Local audio statistics.
Definition: AgoraBase.h:4261
Configure video streams of different quality levels.
Definition: AgoraBase.h:2344
LOCAL_AUDIO_STREAM_STATE
The state of the local audio.
Definition: AgoraBase.h:3491
#define __deprecated
Definition: AgoraBase.h:74
virtual void onUserMuteVideo(const RtcConnection &connection, uid_t remoteUid, bool muted)
Definition: IAgoraRtcEngineEx.h:435
virtual int muteRecordingSignalEx(bool mute, const RtcConnection &connection)=0
virtual void onConnectionInterrupted() 1
Occurs when the connection between the SDK and the server is interrupted.
Definition: IAgoraRtcEngine.h:2777
virtual void onUserJoined(const RtcConnection &connection, uid_t remoteUid, int elapsed)
Definition: IAgoraRtcEngineEx.h:376
Definition: IAgoraRtcEngine.h:4628
virtual void onAudioSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Occurs when the audio subscribing state changes.
Definition: IAgoraRtcEngine.h:3502
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Reports the transport-layer statistics of each remote audio stream.
Definition: IAgoraRtcEngine.h:2549
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Reports the transport-layer statistics of each remote audio stream.
Definition: IAgoraRtcEngine.h:3294
virtual int pauseAllChannelMediaRelayEx(const RtcConnection &connection)=0
Pauses the media stream relay to all target channels.
virtual void onMultipathStats(const RtcConnection &connection, const MultipathStats &stats)
Callback for multipath transmission statistics.
Definition: IAgoraRtcEngineEx.h:1086
REMOTE_VIDEO_STATE_REASON
The reason for the remote video state change.
Definition: AgoraBase.h:3904
virtual void onRenewTokenResult(const char *token, RENEW_TOKEN_ERROR_CODE code)
Callback for renewToken call result.
Definition: IAgoraRtcEngine.h:3704
virtual void onIntraRequestReceived(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:256
RtcConnection()
Definition: IAgoraRtcEngineEx.h:30
RENEW_TOKEN_ERROR_CODE
Represents the error codes after calling renewToken.
Definition: AgoraBase.h:7509
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Occurs when switching a user role fails.
Definition: IAgoraRtcEngine.h:3150
virtual void onRdtStateChanged(uid_t userId, RdtState state)
Occurs when the RDT tunnel state changed.
Definition: IAgoraRtcEngine.h:2864
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Occurs when the local audio stream state changes.
Definition: IAgoraRtcEngine.h:3017
Definition: AgoraBase.h:156
NETWORK_TYPE
Network type.
Definition: AgoraBase.h:5307
virtual int muteAllRemoteAudioStreamsEx(bool mute, const RtcConnection &connection)=0
Stops or resumes subscribing to the audio streams of all remote users.
virtual void onFirstRemoteVideoFrame(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:348
virtual int addVideoWatermarkEx(const WatermarkConfig &config, const RtcConnection &connection)=0
Adds a watermark image to the local video.
virtual int setSubscribeVideoAllowlistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
Sets the allowlist of subscriptions for video streams.
virtual void onStreamMessage(uid_t uid, int streamId, const char *data, size_t length, uint64_t sentTs)
Occurs when the local user receives the data stream from the remote user.
Definition: IAgoraRtcEngine.h:2803
virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions &options, const RtcConnection &connection)=0
Updates the channel media options after joining the channel.
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Reports the last mile network quality of each user in the channel.
Definition: IAgoraRtcEngine.h:2122
virtual int startRtmpStreamWithTranscodingEx(const char *url, const LiveTranscoding &transcoding, const RtcConnection &connection)=0
Starts Media Push and sets the transcoding configuration.
virtual void onTokenPrivilegeWillExpire(const RtcConnection &connection, const char *token)
Definition: IAgoraRtcEngineEx.h:721
uid_t localUid
Definition: IAgoraRtcEngineEx.h:28
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: IAgoraRtcEngine.h:2934
RtcConnection(const char *channel_id, uid_t local_uid)
Definition: IAgoraRtcEngineEx.h:31
virtual int stopChannelMediaRelayEx(const RtcConnection &connection)=0
Stops the media stream relay. Once the relay stops, the host quits all the target channels.
Screenshot and upload configuration.
Definition: AgoraMediaBase.h:1338
virtual void onJoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:115
virtual int setRemoteRenderRotationEx(uid_t uid, VIDEO_ORIENTATION rotation, const RtcConnection &connection)=0
virtual int sendAudioMetadataEx(const RtcConnection &connection, const char *metadata, size_t length)=0
RdtStreamType
Reliable Data Transmission Tunnel message stream type.
Definition: AgoraBase.h:8090
virtual int setRemoteRenderModeEx(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode, const RtcConnection &connection)=0
Sets the video display mode of a specified remote user.
virtual void onNetworkQuality(const RtcConnection &connection, uid_t remoteUid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngineEx.h:242
virtual int setRemoteVideoStreamTypeEx(uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection &connection)=0
Sets the video stream type to subscribe to.
LICENSE_ERROR_TYPE
Definition: AgoraBase.h:879
virtual void onRemoteVideoStats(const RtcConnection &connection, const RemoteVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:543
virtual int leaveChannelWithUserAccountEx(const char *channelId, const char *userAccount, const LeaveChannelOptions &options)=0
virtual void onMultipathStats(const MultipathStats &stats)
Callback for multipath transmission statistics.
Definition: IAgoraRtcEngine.h:3687
CLIENT_ROLE_CHANGE_FAILED_REASON
The reason for a user role switch failure.
Definition: AgoraBase.h:5277
virtual void onLeaveChannel(const RtcStats &stats)
Occurs when a user leaves a channel.
Definition: IAgoraRtcEngine.h:1995
virtual void onLocalVideoStats(const RtcConnection &connection, VIDEO_SOURCE_TYPE sourceType, const LocalVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:529
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Reports the built-in encryption errors.
Definition: IAgoraRtcEngine.h:3368
Indicators during video frame rendering progress.
Definition: AgoraBase.h:7841
virtual void onRtcStats(const RtcStats &stats)
Reports the statistics about the current call.
Definition: IAgoraRtcEngine.h:2007
virtual int takeSnapshotEx(const RtcConnection &connection, uid_t uid, const char *filePath)=0
Takes a snapshot of a video stream using connection ID.
virtual void onActiveSpeaker(uid_t uid)
Occurs when the most active remote speaker is detected.
Definition: IAgoraRtcEngine.h:3065
virtual void onConnectionLost()
Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the se...
Definition: IAgoraRtcEngine.h:2757
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed)
Occurs when the first video frame is published.
Definition: IAgoraRtcEngine.h:2216
Statistics of the remote video stream.
Definition: IAgoraRtcEngine.h:576
virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed)
Occurs when the renderer receives the first frame of the remote video.
Definition: IAgoraRtcEngine.h:2379
Setting of user role properties.
Definition: AgoraBase.h:3085
virtual void onFirstRemoteVideoDecoded(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:293
virtual int setRemoteVoicePositionEx(uid_t uid, double pan, double gain, const RtcConnection &connection)=0
Sets the 2D position (the position on the horizontal plane) of the remote user's voice.
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Reports the transport-layer statistics of each remote video stream.
Definition: IAgoraRtcEngine.h:3318
virtual int setupRemoteVideoEx(const VideoCanvas &canvas, const RtcConnection &connection)=0
Initializes the video view of a remote user.
Attributes of the video canvas object.
Definition: AgoraBase.h:5366
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:2134
LOCAL_AUDIO_STREAM_REASON
Reasons for local audio state changes.
Definition: AgoraBase.h:3513