|
Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
12 #include "IAudioDeviceManager.h"
13 #include "IAgoraRhythmPlayer.h"
269 struct RtcConnection;
835 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) || defined(__OHOS__)
855 #if defined(__ANDROID__)
906 #if (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)|| (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__))
917 SIZE() : width(0), height(0) {}
918 SIZE(
int ww,
int hh) : width(ww), height(hh) {}
922 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) || (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__))
928 struct ThumbImageBuffer {
945 ThumbImageBuffer() : buffer(nullptr), length(0), width(0), height(0) {}
950 enum ScreenCaptureSourceType {
952 ScreenCaptureSourceType_Unknown = -1,
954 ScreenCaptureSourceType_Window = 0,
956 ScreenCaptureSourceType_Screen = 1,
958 ScreenCaptureSourceType_Custom = 2,
961 struct ScreenCaptureSourceInfo {
965 ScreenCaptureSourceType type;
973 const char* sourceName;
977 ThumbImageBuffer thumbImage;
981 ThumbImageBuffer iconImage;
985 const char* processPath;
989 const char* sourceTitle;
1005 bool minimizeWindow;
1012 int64_t sourceDisplayId;
1013 ScreenCaptureSourceInfo() : type(ScreenCaptureSourceType_Unknown), sourceId(0), sourceName(nullptr),
1014 processPath(nullptr), sourceTitle(nullptr), primaryMonitor(false), isOccluded(false), minimizeWindow(false), sourceDisplayId(-2) {}
1016 ScreenCaptureSourceInfo() : type(ScreenCaptureSourceType_Unknown), sourceId(0), sourceName(nullptr), processPath(nullptr), sourceTitle(nullptr), primaryMonitor(false), isOccluded(false) {}
1022 class IScreenCaptureSourceList {
1024 virtual ~IScreenCaptureSourceList(){};
1032 virtual unsigned int getCount() = 0;
1042 virtual ScreenCaptureSourceInfo getSourceInfo(
unsigned int index) = 0;
1049 virtual void release() = 0;
1051 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
1112 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
1354 #define SET_FROM(X) SetFrom(&X, change.X)
1361 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
1366 SET_FROM(publishSecondaryScreenTrack);
1368 SET_FROM(publishFourthScreenTrack);
1404 #define BEGIN_COMPARE() bool b = true
1405 #define ADD_COMPARE(X) b = (b && (X == o.X))
1406 #define END_COMPARE()
1414 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
1455 #undef BEGIN_COMPARE
1462 if (
this != &replace) {
1463 #define REPLACE_BY(X) ReplaceBy(&X, replace.X)
1470 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
1553 bool stopAudioMixing;
1702 (void)speakerNumber;
1750 virtual void onAudioMixingPositionChanged(int64_t position) {}
1767 virtual void onAudioEffectFinished(
int soundId) {}
2192 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) || defined(__OHOS__)
2223 virtual void onFacePositionChanged(
int imageWidth,
int imageHeight,
2224 const Rectangle* vecRectangle,
const int* vecDistance,
2228 (void) vecRectangle;
2566 (void)newRoleOptions;
2704 (void)isFallbackOrRecover;
2800 (void)permissionType;
2891 (void)elapseSinceLastState;
2908 (void)elapseSinceLastState;
2923 (void)elapseSinceLastState;
2940 (void)elapseSinceLastState;
3090 virtual int setDevice(
const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3102 virtual int getDevice(
int index,
char deviceNameUTF8[MAX_DEVICE_ID_LENGTH],
3103 char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3140 virtual int setDevice(
const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3150 virtual int getDevice(
char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3152 #if defined(_WIN32) || (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__)) || \
3153 (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
3171 virtual int numberOfCapabilities(
const char* deviceIdUTF8) = 0;
3190 virtual int getCapability(
const char* deviceIdUTF8,
const uint32_t deviceCapabilityNumber,
VideoFormat& capability) = 0;
3228 virtual ~IVideoEffectObject() {}
3235 enum class VIDEO_EFFECT_NODE_ID : uint32_t {
3239 STYLE_MAKEUP = 1U << 1,
3249 enum VIDEO_EFFECT_ACTION {
3280 virtual int addOrUpdateVideoEffect(uint32_t nodeId,
const char* templateName) = 0;
3293 virtual int removeVideoEffect(uint32_t nodeId) = 0;
3307 virtual int performVideoEffectAction(uint32_t nodeId, VIDEO_EFFECT_ACTION actionId) = 0;
3322 virtual int setVideoEffectFloatParam(
const char* option,
const char* key,
float param) = 0;
3337 virtual int setVideoEffectIntParam(
const char* option,
const char* key,
int param) = 0;
3354 virtual int setVideoEffectBoolParam(
const char* option,
const char* key,
bool param) = 0;
3368 virtual float getVideoEffectFloatParam(
const char* option,
const char* key) = 0;
3382 virtual int getVideoEffectIntParam(
const char* option,
const char* key) = 0;
3396 virtual bool getVideoEffectBoolParam(
const char* option,
const char* key) = 0;
3739 #define SET_FROM(X) SetFrom(&X, change.X)
3751 #define BEGIN_COMPARE() bool b = true
3752 #define ADD_COMPARE(X) b = (b && (X == o.X))
3753 #define END_COMPARE()
3765 #undef BEGIN_COMPARE
3772 if (
this != &replace) {
3773 #define REPLACE_BY(X) ReplaceBy(&X, replace.X)
3826 class IMediaRecorder;
4093 virtual int joinChannel(
const char* token,
const char* channelId,
const char* info,
uid_t uid) = 0;
4319 virtual int stopEchoTest() = 0;
4321 #if defined(__APPLE__) && TARGET_OS_IOS
5097 virtual int setSubscribeAudioBlocklist(
uid_t* uidList,
int uidNumber) = 0;
5131 virtual int setSubscribeVideoBlocklist(
uid_t* uidList,
int uidNumber) = 0;
5261 virtual int stopAudioRecording() = 0;
5352 virtual int startAudioMixing(
const char* filePath,
bool loopback,
int cycle) = 0;
5397 virtual int startAudioMixing(
const char* filePath,
bool loopback,
int cycle,
int startPos) = 0;
5407 virtual int stopAudioMixing() = 0;
5417 virtual int pauseAudioMixing() = 0;
5427 virtual int resumeAudioMixing() = 0;
5462 virtual int adjustAudioMixingVolume(
int volume) = 0;
5471 virtual int adjustAudioMixingPublishVolume(
int volume) = 0;
5480 virtual int getAudioMixingPublishVolume() = 0;
5489 virtual int adjustAudioMixingPlayoutVolume(
int volume) = 0;
5498 virtual int getAudioMixingPlayoutVolume() = 0;
5508 virtual int getAudioMixingDuration() = 0;
5519 virtual int getAudioMixingCurrentPosition() = 0;
5530 virtual int setAudioMixingPosition(
int pos ) = 0;
5560 virtual int setAudioMixingPitch(
int pitch) = 0;
5577 virtual int setAudioMixingPlaybackSpeed(
int speed) = 0;
5586 virtual int getEffectsVolume() = 0;
5596 virtual int setEffectsVolume(
int volume) = 0;
5620 virtual int preloadEffect(
int soundId,
const char* filePath,
int startPos = 0) = 0;
5662 virtual int playEffect(
int soundId,
const char* filePath,
int loopCount,
double pitch,
double pan,
int gain,
bool publish =
false,
int startPos = 0) = 0;
5693 virtual int playAllEffects(
int loopCount,
double pitch,
double pan,
int gain,
bool publish =
false) = 0;
5704 virtual int getVolumeOfEffect(
int soundId) = 0;
5716 virtual int setVolumeOfEffect(
int soundId,
int volume) = 0;
5725 virtual int pauseEffect(
int soundId) = 0;
5732 virtual int pauseAllEffects() = 0;
5741 virtual int resumeEffect(
int soundId) = 0;
5748 virtual int resumeAllEffects() = 0;
5757 virtual int stopEffect(
int soundId) = 0;
5764 virtual int stopAllEffects() = 0;
5773 virtual int unloadEffect(
int soundId) = 0;
5780 virtual int unloadAllEffects() = 0;
5799 virtual int getEffectDuration(
const char* filePath) = 0;
5816 virtual int setEffectPosition(
int soundId,
int pos) = 0;
5831 virtual int getEffectCurrentPosition(
int soundId) = 0;
5888 virtual int setRemoteUserSpatialAudioParams(
uid_t uid,
const agora::SpatialAudioParams& params) = 0;
6081 virtual int setAudioEffectParameters(
AUDIO_EFFECT_PRESET preset,
int param1,
int param2) = 0;
6126 int param1,
int param2) = 0;
6141 int param1,
int param2) = 0;
6153 virtual int setLocalVoicePitch(
double pitch) = 0;
6165 virtual int setLocalVoiceFormant(
double formantRatio) = 0;
6549 int samplesPerCall) = 0;
6572 int samplesPerCall) = 0;
6612 int samplesPerCall) = 0;
6914 #if defined(_WIN32) || defined(__linux__) || defined(__ANDROID__)
6915 virtual int loadExtensionProvider(
const char* path,
bool unload_after_use =
false) = 0;
6980 const char* provider,
const char* extension,
6997 const char* provider,
const char* extension,
7051 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) || defined(__OHOS__)
7060 virtual int switchCamera() = 0;
7069 virtual bool isCameraZoomSupported() = 0;
7078 virtual bool isCameraFaceDetectSupported() = 0;
7087 virtual bool isCameraTorchSupported() = 0;
7096 virtual bool isCameraFocusSupported() = 0;
7105 virtual bool isCameraAutoFocusFaceModeSupported() = 0;
7116 virtual int setCameraZoomFactor(
float factor) = 0;
7126 virtual int enableFaceDetection(
bool enabled) = 0;
7132 virtual float getCameraMaxZoomFactor() = 0;
7143 virtual int setCameraFocusPositionInPreview(
float positionX,
float positionY) = 0;
7152 virtual int setCameraTorchOn(
bool isOn) = 0;
7161 virtual int setCameraAutoFocusFaceModeEnabled(
bool enabled) = 0;
7174 virtual bool isCameraExposurePositionSupported() = 0;
7191 virtual int setCameraExposurePosition(
float positionXinView,
float positionYinView) = 0;
7205 virtual bool isCameraExposureSupported() = 0;
7217 virtual int setCameraExposureFactor(
float factor) = 0;
7219 #if defined(__APPLE__)
7227 virtual bool isCameraAutoExposureFaceModeSupported() = 0;
7237 virtual int setCameraAutoExposureFaceModeEnabled(
bool enabled) = 0;
7280 virtual int setDefaultAudioRouteToSpeakerphone(
bool defaultToSpeaker) = 0;
7308 virtual int setEnableSpeakerphone(
bool speakerOn) = 0;
7317 virtual bool isSpeakerphoneEnabled() = 0;
7325 virtual int setRouteInCommunicationMode(
int route) = 0;
7326 #endif // __ANDROID__ || (__APPLE__ && TARGET_OS_IOS) || __OHOS__
7328 #if defined(__APPLE__)
7336 virtual bool isCameraCenterStageSupported() = 0;
7346 virtual int enableCameraCenterStage(
bool enabled) = 0;
7349 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)|| (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__))
7360 virtual IScreenCaptureSourceList* getScreenCaptureSources(
const SIZE& thumbSize,
const SIZE& iconSize,
const bool includeScreen) = 0;
7361 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
7362 #if (defined(__APPLE__) && TARGET_OS_IOS)
7388 #endif // __APPLE__ && TARGET_OS_IOS
7390 #if defined(_WIN32) || (defined(__APPLE__) && !TARGET_OS_IPHONE && TARGET_OS_MAC) || (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__))
7412 virtual int startScreenCaptureByDisplayId(int64_t displayId,
const Rectangle& regionRect,
7415 #endif // __APPLE__ && TARGET_OS_MAC && !TARGET_OS_IPHONE
7441 virtual int startScreenCaptureByScreenRect(
const Rectangle& screenRect,
7446 #if defined(__ANDROID__)
7453 virtual int getAudioDeviceInfo(
DeviceInfo& deviceInfo) = 0;
7454 #endif // __ANDROID__
7456 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) || (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__))
7475 virtual int startScreenCaptureByWindowId(int64_t windowId,
const Rectangle& regionRect,
7511 virtual int updateScreenCaptureRegion(
const Rectangle& regionRect) = 0;
7527 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
7529 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) || defined(__OHOS__)
7550 virtual int updateScreenCapture(
const ScreenCaptureParameters2& captureParams) = 0;
7563 virtual int queryScreenCaptureCapability() = 0;
7578 #if defined(__ANDROID__)
7595 virtual int setExternalMediaProjection(
void* mediaProjection) = 0;
7599 #if defined(_WIN32) || defined(__APPLE__) || defined(__ANDROID__) || (defined(__linux__) && !defined(__ANDROID__) && !defined (__OHOS__))
7626 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC) || __ANDROID__
7660 virtual int rate(
const char* callId,
int rating,
const char* description) = 0;
7675 virtual int complain(
const char* callId,
const char* description) = 0;
8103 virtual int clearVideoWatermarks() = 0;
8197 virtual
int startAudioFrameDump(const
char* channel_id,
uid_t uid, const
char* location, const
char* uuid, const
char* passwd,
long duration_ms,
bool auto_upload) = 0;
9072 #define getAgoraRtcEngineVersion getAgoraSdkVersion
9095 #define getAgoraRtcEngineErrorDescription getAgoraSdkErrorDescription
9096 #define setAgoraRtcEngineExternalSymbolLoader setAgoraSdkExternalSymbolLoader
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config)=0
virtual int removeVideoWatermark(const char *id)=0
Remove a watermark image from the local video.
virtual int stopLocalVideoTranscoder()=0
virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1858
int delay
Definition: IAgoraRtcEngine.h:524
VIDEO_TRANSCODER_ERROR
Definition: AgoraBase.h:4587
UPLOAD_ERROR_REASON
Definition: AgoraBase.h:6896
virtual int configRhythmPlayer(const AgoraRhythmPlayerConfig &config)=0
virtual int getAudioTrackCount()=0
virtual void onRequestToken()
Definition: IAgoraRtcEngine.h:2393
int videoWidth
Definition: IAgoraRtcEngine.h:3638
@ AUDIO_EQUALIZATION_BAND_16K
Definition: IAgoraRtcEngine.h:205
virtual const char * getVersion(int *build)=0
@ VIDEO_PROFILE_LANDSCAPE_360P_10
Definition: IAgoraRtcEngine.h:8937
agora::media::MEDIA_SOURCE_TYPE mediaSourceType
Definition: IAgoraRtcEngine.h:3795
@ DIRECT_CDN_STREAMING_STATE_FAILED
Definition: IAgoraRtcEngine.h:3624
Definition: AgoraBase.h:7544
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition: AgoraBase.h:279
@ MEDIA_DEVICE_STATE_PLUGGED_IN
Definition: IAgoraRtcEngine.h:8895
@ VIDEO_PROFILE_LANDSCAPE_720P_3
Definition: IAgoraRtcEngine.h:8957
@ VIDEO_PROFILE_LANDSCAPE_360P_8
Definition: IAgoraRtcEngine.h:8933
@ DIRECT_CDN_STREAMING_REASON_FAILED
Definition: IAgoraRtcEngine.h:3599
@ VIDEO_PROFILE_LANDSCAPE_360P_3
Definition: IAgoraRtcEngine.h:8925
virtual int updateChannelMediaOptions(const ChannelMediaOptions &options)=0
virtual int setParameters(const char *parameters)=0
static void ReplaceBy(Optional< T > *s, const Optional< T > &o)
Definition: IAgoraRtcEngine.h:31
@ MEDIA_DEVICE_STATE_DISABLED
Definition: IAgoraRtcEngine.h:8891
virtual int setRemoteRenderMode(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
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:2378
virtual int uploadLogFile(agora::util::AString &requestId)=0
AUDIO_EQUALIZATION_BAND_FREQUENCY
Definition: IAgoraRtcEngine.h:165
Definition: AgoraBase.h:7053
virtual int enableExtension(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, bool enable=true)=0
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Definition: IAgoraRtcEngine.h:2121
Definition: AgoraBase.h:4758
virtual void onUserStateChanged(uid_t uid, REMOTE_USER_STATE state)
Definition: IAgoraRtcEngine.h:2083
Definition: AgoraBase.h:6375
Definition: AgoraBase.h:6093
virtual int updateLocalTranscoderConfiguration(const LocalTranscoderConfiguration &config)=0
virtual int initialize(const RtcEngineContext &context)=0
SCREEN_SCENARIO_TYPE
Definition: AgoraBase.h:3152
MEDIA_DEVICE_TYPE
Definition: IAgoraRtcEngine.h:40
CameraCapturerConfiguration()
Definition: IAgoraRtcEngine.h:864
Definition: AgoraBase.h:3772
int regionCount
Definition: IAgoraRtcEngine.h:657
VIDEO_SOURCE_TYPE
Definition: AgoraMediaBase.h:68
@ AUDIO_MIXING_STATE_PAUSED
Definition: IAgoraRtcEngine.h:82
@ VIDEO_PROFILE_LANDSCAPE_1080P_5
Definition: IAgoraRtcEngine.h:8967
REMOTE_AUDIO_STATE
Definition: AgoraBase.h:3496
unsigned int rxAudioBytes
Definition: IAgoraRtcEngine.h:479
Definition: AgoraBase.h:5111
virtual agora_refptr< IMediaPlayer > createMediaPlayer()=0
@ INJECT_STREAM_STATUS_START_FAILED
Definition: IAgoraRtcEngine.h:135
Definition: AgoraBase.h:1293
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2760
@ AUDIO_EQUALIZATION_BAND_2K
Definition: IAgoraRtcEngine.h:193
int avSyncTimeMs
Definition: IAgoraRtcEngine.h:574
Rectangle screenRect
Definition: IAgoraRtcEngine.h:884
ScreenCaptureConfiguration()
Definition: IAgoraRtcEngine.h:903
virtual void onConnectionBanned() 1
Definition: IAgoraRtcEngine.h:2293
unsigned int video_track_id_t
Definition: AgoraMediaBase.h:31
@ AUDIO_MIXING_STATE_STOPPED
Definition: IAgoraRtcEngine.h:84
@ UNKNOWN_AUDIO_DEVICE
Definition: IAgoraRtcEngine.h:44
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngine.h:1584
@ VIDEO_PROFILE_PORTRAIT_480P_3
Definition: IAgoraRtcEngine.h:9013
int width
Definition: IAgoraRtcEngine.h:532
Definition: IAgoraRtcEngine.h:598
Definition: AgoraBase.h:4688
int captureFrameRate
Definition: IAgoraRtcEngine.h:289
@ VIDEO_PROFILE_PORTRAIT_1440P_2
Definition: IAgoraRtcEngine.h:9041
int audioBitrate
Definition: IAgoraRtcEngine.h:705
@ VIDEO_PROFILE_LANDSCAPE_720P
Definition: IAgoraRtcEngine.h:8955
virtual int startDeviceTest(view_t hwnd)=0
@ AUDIO_APPLICATION_PLAYOUT_DEVICE
Definition: IAgoraRtcEngine.h:64
virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource, SegmentationProperty segproperty, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
virtual int enableEncryption(bool enabled, const EncryptionConfig &config)=0
AAudioDeviceManager(IRtcEngine *engine)
Definition: IAgoraRtcEngine.h:9052
AdvancedAudioOptions()
Definition: IAgoraRtcEngine.h:1061
virtual int setChannelProfile(CHANNEL_PROFILE_TYPE profile)=0
int videoHeight
Definition: IAgoraRtcEngine.h:3643
bool domainLimit
Definition: IAgoraRtcEngine.h:3485
@ VIDEO_PROFILE_LANDSCAPE_240P_3
Definition: IAgoraRtcEngine.h:8919
virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2935
virtual int sendRdtMessage(uid_t uid, RdtStreamType type, const char *data, size_t length)=0
Send Reliable message to remote uid in channel.
bool useExternalEglContext
Definition: IAgoraRtcEngine.h:3478
virtual int adjustCustomAudioPlayoutVolume(track_id_t trackId, int volume)=0
@ INJECT_STREAM_STATUS_STOP_NOT_FOUND
Definition: IAgoraRtcEngine.h:143
virtual void onCameraFocusAreaChanged(int x, int y, int width, int height)
Definition: IAgoraRtcEngine.h:2172
@ AGORA_IID_AUDIO_DEVICE_MANAGER
Definition: AgoraBase.h:906
USER_OFFLINE_REASON_TYPE
Definition: AgoraBase.h:888
@ VIDEO_PROFILE_PORTRAIT_360P
Definition: IAgoraRtcEngine.h:8993
unsigned int uid_t
Definition: AgoraMediaBase.h:28
Definition: AgoraRefPtr.h:44
@ VIDEO_PROFILE_DEFAULT
Definition: IAgoraRtcEngine.h:9047
@ MEDIA_DEVICE_STATE_IDLE
Definition: IAgoraRtcEngine.h:8885
int canvasHeight
Definition: IAgoraRtcEngine.h:647
@ VIDEO_PROFILE_PORTRAIT_180P_4
Definition: IAgoraRtcEngine.h:8985
int numChannels
Definition: IAgoraRtcEngine.h:398
int packetLossRate
Definition: IAgoraRtcEngine.h:555
Definition: AgoraObjects.h:3518
QUALITY_ADAPT_INDICATION
Definition: AgoraBase.h:2894
virtual int stopLastmileProbeTest()=0
const char * injectStreamUrl
Definition: IAgoraRtcEngine.h:775
VIDEO_APPLICATION_SCENARIO_TYPE
Definition: AgoraBase.h:3180
int injectStreamWidth
Definition: IAgoraRtcEngine.h:769
virtual int queryHDRCapability(VIDEO_MODULE_TYPE videoModule, HDR_CAPABILITY &capability)=0
Queries the HDR capability of the video module.
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: IAgoraRtcEngine.h:2563
virtual int startPreview(VIDEO_SOURCE_TYPE sourceType)=0
double y
Definition: IAgoraRtcEngine.h:608
virtual int64_t getCurrentMonotonicTimeInMs()=0
virtual ~IRtcEngineEventHandler()
Definition: IAgoraRtcEngine.h:1582
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats &stats)
Definition: IAgoraRtcEngine.h:2138
Definition: IAgoraRtcEngine.h:3791
virtual int setExtensionProperty(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, const char *key, const char *value)=0
@ VIDEO_PROFILE_LANDSCAPE_4K
Definition: IAgoraRtcEngine.h:8973
int totalActiveTime
Definition: IAgoraRtcEngine.h:579
virtual void onUserInfoUpdated(uid_t uid, const UserInfo &info)
Definition: IAgoraRtcEngine.h:2825
VIDEO_MIRROR_MODE_TYPE mirrorMode
Definition: IAgoraRtcEngine.h:1068
int totalFrozenTime
Definition: IAgoraRtcEngine.h:414
Definition: AgoraBase.h:7345
virtual void onExtensionStoppedWithContext(const ExtensionContext &context)
Definition: IAgoraRtcEngine.h:3007
@ CAMERA_REAR
Definition: IAgoraRtcEngine.h:809
virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume)=0
@ MEDIA_DEVICE_STATE_UNPLUGGED
Definition: IAgoraRtcEngine.h:8902
@ AUDIO_MIXING_REASON_TOO_FREQUENT_CALL
Definition: IAgoraRtcEngine.h:97
int receivedBitrate
Definition: IAgoraRtcEngine.h:407
Optional< THREAD_PRIORITY_TYPE > threadPriority
Definition: IAgoraRtcEngine.h:3469
@ VIDEO_PROFILE_PORTRAIT_720P_5
Definition: IAgoraRtcEngine.h:9029
virtual int setFaceShapeBeautyOptions(bool enabled, const FaceShapeBeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
@ INJECT_STREAM_STATUS_START_SUCCESS
Definition: IAgoraRtcEngine.h:119
Definition: AgoraBase.h:4332
virtual void onLocalUserRegistered(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2812
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:2347
virtual void onVideoStopped() 1
Definition: IAgoraRtcEngine.h:2240
AUDIO_SESSION_OPERATION_RESTRICTION
Definition: AgoraBase.h:828
int decoderOutputFrameRate
Definition: IAgoraRtcEngine.h:546
@ VIDEO_RENDER_DEVICE
Definition: IAgoraRtcEngine.h:56
@ VIDEO_PROFILE_LANDSCAPE_120P
Definition: IAgoraRtcEngine.h:8907
Definition: AgoraBase.h:2281
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2020
VideoFormat format
Definition: IAgoraRtcEngine.h:863
@ AUDIO_SAMPLE_RATE_48000
Definition: AgoraBase.h:3893
Rectangle regionRect
Definition: IAgoraRtcEngine.h:901
int audioBitrate
Definition: IAgoraRtcEngine.h:3658
virtual int stopAudioFrameDump(const char *channel_id, uid_t uid, const char *location)=0
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
virtual int setColorEnhanceOptions(bool enabled, const ColorEnhanceOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2919
@ INJECT_STREAM_STATUS_STOP_TIMEDOUT
Definition: IAgoraRtcEngine.h:151
int audioChannels
Definition: IAgoraRtcEngine.h:708
#define AGORA_CPP_API
Definition: AgoraBase.h:71
QUALITY_REPORT_FORMAT_TYPE
Definition: IAgoraRtcEngine.h:8872
virtual void onVideoSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2903
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) 1
Definition: IAgoraRtcEngine.h:1657
virtual int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset)=0
@ VIDEO_PROFILE_LANDSCAPE_480P_6
Definition: IAgoraRtcEngine.h:8947
InjectStreamConfig()
Definition: IAgoraRtcEngine.h:712
virtual bool unregisterEventHandler(IRtcEngineEventHandler *eventHandler)=0
virtual int complain(const char *callId, const char *description)=0
@ VIDEO_PROFILE_PORTRAIT_360P_8
Definition: IAgoraRtcEngine.h:9003
virtual void onRtmpStreamingEvent(const char *url, RTMP_STREAMING_EVENT eventCode)
Definition: IAgoraRtcEngine.h:2617
@ AUDIO_EQUALIZATION_BAND_250
Definition: IAgoraRtcEngine.h:181
Definition: AgoraBase.h:100
virtual int startRhythmPlayer(const char *sound1, const char *sound2, const AgoraRhythmPlayerConfig &config)=0
virtual int queryInterface(INTERFACE_ID_TYPE iid, void **inter)=0
VOICE_AI_TUNER_TYPE
Definition: AgoraBase.h:6057
@ HTTPS_PROXY_TYPE
Definition: IAgoraRtcEngine.h:1536
int rendererOutputFrameRate
Definition: IAgoraRtcEngine.h:549
Optional< int > audioProcessingChannels
Definition: IAgoraRtcEngine.h:1059
virtual void onCameraExposureAreaChanged(int x, int y, int width, int height)
Definition: IAgoraRtcEngine.h:2186
virtual int setHeadphoneEQParameters(int lowGain, int highGain)=0
double x
Definition: IAgoraRtcEngine.h:605
LOCAL_VIDEO_STREAM_REASON
Definition: AgoraBase.h:3360
int qualityChangedReason
Definition: IAgoraRtcEngine.h:475
virtual int enableSoundPositionIndication(bool enabled)=0
void * view_t
Definition: AgoraBase.h:854
@ VIDEO_PROFILE_LANDSCAPE_1440P_2
Definition: IAgoraRtcEngine.h:8971
@ AUDIO_MIXING_REASON_STOPPED_BY_USER
Definition: IAgoraRtcEngine.h:105
virtual int startLocalAudioMixer(const LocalAudioMixerConfiguration &config)=0
virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType)=0
Definition: AgoraBase.h:1960
int quality
Definition: IAgoraRtcEngine.h:380
Definition: IAgoraRtcEngine.h:1580
int encodedFrameHeight
Definition: IAgoraRtcEngine.h:316
virtual int muteRemoteAudioStream(uid_t uid, bool mute)=0
virtual void onAudioMetadataReceived(uid_t uid, const char *metadata, size_t length)
Definition: IAgoraRtcEngine.h:2968
@ AUDIO_REVERB_WET_DELAY
Definition: IAgoraRtcEngine.h:227
PRIORITY_TYPE
Definition: IAgoraRtcEngine.h:260
@ INJECT_STREAM_STATUS_BROKEN
Definition: IAgoraRtcEngine.h:159
VOICE_CONVERSION_PRESET
Definition: AgoraBase.h:5985
virtual void onUserEnableVideo(uid_t uid, bool enabled)
Definition: IAgoraRtcEngine.h:2073
bool dualStreamEnabled
Definition: IAgoraRtcEngine.h:350
virtual int setLogFilter(unsigned int filter)=0
@ VIDEO_BEAUTY_EFFECT
Definition: IAgoraRtcEngine.h:1541
VIDEO_MODULE_TYPE
Definition: AgoraBase.h:1885
virtual int startPreview()=0
virtual int enableVideoImageSource(bool enable, const ImageTrackOptions &options)=0
enable or disable video image source to replace the current video source published or resume it
Definition: AgoraBase.h:1649
double width
Definition: IAgoraRtcEngine.h:612
DIRECT_CDN_STREAMING_STATE
Definition: IAgoraRtcEngine.h:3616
int regulatedCaptureFrameHeight
Definition: IAgoraRtcEngine.h:307
int regulatedCaptureFrameRate
Definition: IAgoraRtcEngine.h:299
VOICE_BEAUTIFIER_PRESET
Definition: AgoraBase.h:5768
@ VIDEO_PROFILE_LANDSCAPE_1440P
Definition: IAgoraRtcEngine.h:8969
virtual int setScreenCaptureOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation)=0
CLOUD_PROXY_TYPE
Definition: IAgoraRtcEngine.h:818
@ RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL
Definition: IAgoraRtcEngine.h:728
virtual int joinChannel(const char *token, const char *channelId, const char *info, uid_t uid)=0
const char * extraInfo
Definition: IAgoraRtcEngine.h:786
Definition: AgoraBase.h:7030
virtual void onDirectCdnStreamingStateChanged(DIRECT_CDN_STREAMING_STATE state, DIRECT_CDN_STREAMING_REASON reason, const char *message)
Definition: IAgoraRtcEngine.h:3677
Definition: AgoraBase.h:4142
@ VIDEO_PROFILE_PORTRAIT_360P_11
Definition: IAgoraRtcEngine.h:9009
@ AUDIO_SCENARIO_DEFAULT
Definition: AgoraBase.h:3047
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_5
Definition: IAgoraRtcEngine.h:256
virtual void onError(int err, const char *msg)
Definition: IAgoraRtcEngine.h:1637
virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Definition: IAgoraRtcEngine.h:2848
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: IAgoraRtcEngine.h:2529
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngine.h:1699
@ VIDEO_PROFILE_LANDSCAPE_360P_9
Definition: IAgoraRtcEngine.h:8935
virtual int preloadChannel(const char *token, const char *channelId, uid_t uid)=0
@ HTTP_PROXY_TYPE
Definition: IAgoraRtcEngine.h:1533
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) 1
Definition: IAgoraRtcEngine.h:2098
virtual int getNetworkType()=0
@ AUDIO_REVERB_STRENGTH
Definition: IAgoraRtcEngine.h:231
Definition: AgoraBase.h:2175
int totalFrozenTime
Definition: IAgoraRtcEngine.h:565
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngine.h:2871
Face shape beauty options. This structure defines options for facial adjustments of different facial ...
Definition: AgoraBase.h:5389
@ PRIORITY_NORMAL
Definition: IAgoraRtcEngine.h:266
virtual int setEarMonitoringAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
Optional< bool > followEncodeDimensionRatio
Definition: IAgoraRtcEngine.h:861
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1611
VIDEO_CONTENT_HINT
Definition: AgoraBase.h:3130
virtual int muteAllRemoteVideoStreams(bool mute)=0
virtual int createDataStream(int *streamId, bool reliable, bool ordered)=0
@ VIDEO_PROFILE_PORTRAIT_180P
Definition: IAgoraRtcEngine.h:8981
const char * publishUrl
Definition: IAgoraRtcEngine.h:779
uint32_t frozenTimeByCustom
Definition: IAgoraRtcEngine.h:457
virtual const char * getErrorDescription(int code)=0
VIDEO_MIRROR_MODE_TYPE
Definition: AgoraBase.h:1858
bool owner
Definition: IAgoraRtcEngine.h:766
@ VIDEO_PROFILE_PORTRAIT_360P_9
Definition: IAgoraRtcEngine.h:9005
uid_t remoteUid
Definition: IAgoraRtcEngine.h:3802
Definition: AgoraMediaBase.h:41
virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig &streamConfig) 1=0
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Definition: IAgoraRtcEngine.h:2151
@ VIDEO_PROFILE_PORTRAIT_1080P
Definition: IAgoraRtcEngine.h:9033
virtual int destroyCustomVideoTrack(video_track_id_t video_track_id)=0
media::base::RENDER_MODE_TYPE renderMode
Definition: IAgoraRtcEngine.h:625
uint32_t frozenRateByCustomPlcCount
Definition: IAgoraRtcEngine.h:441
virtual int enableInstantMediaRendering()=0
Enable instant media rendering.
@ VIDEO_PROFILE_PORTRAIT_1080P_5
Definition: IAgoraRtcEngine.h:9037
int rendererOutputFrameRate
Definition: IAgoraRtcEngine.h:319
@ AUDIO_MIXING_STATE_FAILED
Definition: IAgoraRtcEngine.h:87
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2879
virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngine.h:2326
virtual int getCallId(agora::util::AString &callId)=0
virtual agora_refptr< IMediaRecorder > createMediaRecorder(const RecorderStreamInfo &info)=0
Definition: AgoraAtomicOps.h:21
HDR_CAPABILITY
Definition: AgoraBase.h:1900
@ NONE_PROXY
Definition: IAgoraRtcEngine.h:821
virtual int setSubscribeVideoAllowlist(uid_t *uidList, int uidNumber)=0
virtual int enableVoiceAITuner(bool enabled, VOICE_AI_TUNER_TYPE type)=0
int mosValue
Definition: IAgoraRtcEngine.h:436
int receivedBitrate
Definition: IAgoraRtcEngine.h:540
Definition: AgoraBase.h:5551
@ INJECT_STREAM_STATUS_START_ALREADY_EXISTS
Definition: IAgoraRtcEngine.h:123
@ VIDEO_PROFILE_PORTRAIT_240P
Definition: IAgoraRtcEngine.h:8987
static AGORA_CPP_API void release(RtcEngineReleaseCallback callback=nullptr)
@ CAMERA_FRONT
Definition: IAgoraRtcEngine.h:811
int framerate
Definition: IAgoraRtcEngine.h:748
@ VIDEO_PROFILE_PORTRAIT_240P_3
Definition: IAgoraRtcEngine.h:8989
ENCRYPTION_ERROR_TYPE
Definition: AgoraBase.h:6871
@ AUDIO_VIRTUAL_PLAYOUT_DEVICE
Definition: IAgoraRtcEngine.h:68
CAPTURE_BRIGHTNESS_LEVEL_TYPE
Definition: AgoraBase.h:3225
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
Definition: IAgoraRtcEngine.h:2548
virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
Definition: AgoraBase.h:6644
int64_t displayId
Definition: IAgoraRtcEngine.h:879
virtual int stopChannelMediaRelay()=0
int bitrate
Definition: IAgoraRtcEngine.h:752
virtual int updatePreloadChannelToken(const char *token)=0
virtual uint64_t getNtpWallTimeInMs()=0
virtual int destroyCustomEncodedVideoTrack(video_track_id_t video_track_id)=0
@ AUDIO_MIXING_REASON_OK
Definition: IAgoraRtcEngine.h:109
int frozenRate
Definition: IAgoraRtcEngine.h:569
virtual int adjustLoopbackSignalVolume(int volume)=0
@ VIDEO_PROFILE_LANDSCAPE_180P_3
Definition: IAgoraRtcEngine.h:8913
virtual int updateDirectCdnStreamingMediaOptions(const DirectCdnStreamingMediaOptions &options)=0
virtual int setHighPriorityUserList(uid_t *uidList, int uidNum, STREAM_FALLBACK_OPTIONS option)=0
@ DIRECT_CDN_STREAMING_REASON_NET_CONNECT
Definition: IAgoraRtcEngine.h:3605
@ VIDEO_PROFILE_LANDSCAPE_480P_8
Definition: IAgoraRtcEngine.h:8949
Definition: IAgoraRtcEngine.h:9057
virtual int setSubscribeAudioAllowlist(uid_t *uidList, int uidNumber)=0
SIMULCAST_STREAM_MODE
Definition: AgoraBase.h:2157
Optional< const char * > deviceId
Definition: IAgoraRtcEngine.h:852
int publishDuration
Definition: IAgoraRtcEngine.h:467
virtual int setDirectCdnStreamingAudioConfiguration(AUDIO_PROFILE_TYPE profile)=0
@ VIDEO_PROFILE_LANDSCAPE_180P
Definition: IAgoraRtcEngine.h:8911
Definition: AgoraBase.h:4556
@ VIDEO_PROFILE_PORTRAIT_480P_9
Definition: IAgoraRtcEngine.h:9021
virtual int startMediaRenderingTracing()=0
Start tracing media rendering events.
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
REMOTE_VIDEO_STATE
Definition: AgoraBase.h:3580
int audioLossRate
Definition: IAgoraRtcEngine.h:394
@ VIDEO_PROFILE_PORTRAIT_1440P
Definition: IAgoraRtcEngine.h:9039
virtual int pauseAllChannelMediaRelay()=0
int frameLossRate
Definition: IAgoraRtcEngine.h:552
virtual int selectAudioTrack(int index)=0
int videoFramerate
Definition: IAgoraRtcEngine.h:693
int receivedSampleRate
Definition: IAgoraRtcEngine.h:402
virtual int updateRtmpTranscoding(const LiveTranscoding &transcoding)=0
Definition: AgoraBase.h:3824
LOCAL_VIDEO_STREAM_STATE
Definition: AgoraBase.h:3337
CONNECTION_CHANGED_REASON_TYPE
Definition: AgoraBase.h:4782
@ AUDIO_EQUALIZATION_BAND_125
Definition: IAgoraRtcEngine.h:177
virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters)=0
@ VIDEO_PROFILE_PORTRAIT_120P_3
Definition: IAgoraRtcEngine.h:8979
uid_t uid
Definition: IAgoraRtcEngine.h:516
int totalActiveTime
Definition: IAgoraRtcEngine.h:463
virtual void onProxyConnected(const char *channel, uid_t uid, PROXY_TYPE proxyType, const char *localProxyIp, int elapsed)
Definition: IAgoraRtcEngine.h:1624
Definition: IAgoraRtcEngine.h:3634
int captureFrameHeight
Definition: IAgoraRtcEngine.h:295
@ AGORA_IID_VIDEO_DEVICE_MANAGER
Definition: AgoraBase.h:907
RTMP_STREAM_LIFE_CYCLE_TYPE
Definition: IAgoraRtcEngine.h:725
virtual int setLowlightEnhanceOptions(bool enabled, const LowlightEnhanceOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
@ VIDEO_PROFILE_PORTRAIT_360P_6
Definition: IAgoraRtcEngine.h:8999
virtual int setVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType)=0
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) 1=0
Definition: AgoraBase.h:2130
virtual void onVideoDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1778
virtual int getExtensionProperty(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, const char *key, char *value, int buf_len)=0
Definition: IAgoraRtcEngine.h:736
virtual int enableAudioVolumeIndication(int interval, int smooth, bool reportVad)=0
Definition: AgoraBase.h:4665
FACE_SHAPE_AREA
The specific facial area to be adjusted.
Definition: AgoraBase.h:5174
virtual int setAVSyncSource(const char *channelId, uid_t uid)=0
@ VIDEO_PROFILE_PORTRAIT_240P_4
Definition: IAgoraRtcEngine.h:8991
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:2001
int e2eDelay
Definition: IAgoraRtcEngine.h:528
@ AUDIO_EQUALIZATION_BAND_8K
Definition: IAgoraRtcEngine.h:201
virtual int setHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset)=0
virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_REASON reason)
Definition: IAgoraRtcEngine.h:2262
Definition: IAgoraRtcEngine.h:1055
PERMISSION_TYPE
Definition: AgoraBase.h:6953
@ AUDIO_MIXING_REASON_INTERRUPTED_EOF
Definition: IAgoraRtcEngine.h:99
int qoeQuality
Definition: IAgoraRtcEngine.h:471
virtual int setLogFileSize(unsigned int fileSizeInKBytes)=0
int regulatedCaptureFrameWidth
Definition: IAgoraRtcEngine.h:303
virtual void onAudioRoutingChanged(int routing)
Definition: IAgoraRtcEngine.h:2647
AUDIO_SAMPLE_RATE_TYPE audioSampleRate
Definition: IAgoraRtcEngine.h:701
virtual int startAudioRecording(const char *filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality)=0
const Region * regions
Definition: IAgoraRtcEngine.h:654
virtual ~IVideoDeviceCollection()
Definition: IAgoraRtcEngine.h:3072
OPTIONAL_ENUM_CLASS LOG_LEVEL
Definition: IAgoraLog.h:33
virtual int sendMediaControlMessage(uid_t uid, const char *data, size_t length)=0
Send media control message.
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_2
Definition: IAgoraRtcEngine.h:253
@ AUDIO_MIXING_STATE_PLAYING
Definition: IAgoraRtcEngine.h:80
@ DIRECT_CDN_STREAMING_STATE_IDLE
Definition: IAgoraRtcEngine.h:3618
virtual int addVideoWatermark(const char *watermarkUrl, const WatermarkOptions &options)=0
@ VIDEO_PROFILE_PORTRAIT_480P_8
Definition: IAgoraRtcEngine.h:9019
virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool isFallbackOrRecover)
Definition: IAgoraRtcEngine.h:2702
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: IAgoraRtcEngine.h:2775
IRtcEngineEventHandler * eventHandler
Definition: IAgoraRtcEngine.h:3407
@ VIDEO_PROFILE_LANDSCAPE_480P_3
Definition: IAgoraRtcEngine.h:8943
@ INJECT_STREAM_STATUS_STOP_FAILED
Definition: IAgoraRtcEngine.h:155
virtual int setRemoteVideoSubscriptionOptions(uid_t uid, const VideoSubscriptionOptions &options)=0
@ VIDEO_PROFILE_PORTRAIT_480P_10
Definition: IAgoraRtcEngine.h:9023
virtual int startScreenCapture(VIDEO_SOURCE_TYPE sourceType, const ScreenCaptureConfiguration &config)=0
virtual int disableVideo()=0
AVideoDeviceManager(IRtcEngine *engine)
Definition: IAgoraRtcEngine.h:9059
int hwEncoderAccelerating
Definition: IAgoraRtcEngine.h:355
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1961
Definition: AgoraBase.h:6392
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_6
Definition: IAgoraRtcEngine.h:257
virtual int createDataStream(int *streamId, const DataStreamConfig &config)=0
virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario)=0
virtual ~IDirectCdnStreamingEventHandler()
Definition: IAgoraRtcEngine.h:3669
virtual int setLocalAccessPoint(const LocalAccessPointConfiguration &config)=0
virtual void onLocalVideoTranscoderError(const TranscodingVideoStream &stream, VIDEO_TRANSCODER_ERROR error)
Definition: IAgoraRtcEngine.h:2860
virtual int setExtensionProviderProperty(const char *provider, const char *key, const char *value)=0
Definition: IAgoraRtcEngine.h:1547
@ VIDEO_PROFILE_PORTRAIT_120P
Definition: IAgoraRtcEngine.h:8977
CHANNEL_PROFILE_TYPE
Definition: AgoraBase.h:267
int sentBitrate
Definition: IAgoraRtcEngine.h:282
virtual int stopPreview(VIDEO_SOURCE_TYPE sourceType)=0
STREAM_SUBSCRIBE_STATE
Definition: AgoraBase.h:6969
virtual int startRtmpStreamWithTranscoding(const char *url, const LiveTranscoding &transcoding)=0
@ VIDEO_PROFILE_PORTRAIT_480P
Definition: IAgoraRtcEngine.h:9011
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:2429
virtual int queryDeviceScore()=0
virtual int enableExtension(const char *provider, const char *extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
INTERFACE_ID_TYPE
Definition: AgoraBase.h:905
@ AUDIO_REVERB_ROOM_SIZE
Definition: IAgoraRtcEngine.h:223
@ VIDEO_VIRTUAL_BACKGROUND
Definition: IAgoraRtcEngine.h:1540
virtual int sendStreamMessage(int streamId, const char *data, size_t length)=0
virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain)=0
virtual int startCameraCapture(VIDEO_SOURCE_TYPE sourceType, const CameraCapturerConfiguration &config)=0
Definition: IAgoraRtcEngine.h:3070
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig)=0
double height
Definition: IAgoraRtcEngine.h:614
virtual int setAINSMode(bool enabled, AUDIO_AINS_MODE mode)=0
int sentFrameRate
Definition: IAgoraRtcEngine.h:286
#define AGORA_API
Definition: AgoraBase.h:70
VIDEO_CODEC_TYPE
Definition: AgoraBase.h:1209
int encodedFrameWidth
Definition: IAgoraRtcEngine.h:313
int e2eDelay
Definition: IAgoraRtcEngine.h:483
@ DIRECT_CDN_STREAMING_REASON_BAD_NAME
Definition: IAgoraRtcEngine.h:3607
Definition: AgoraBase.h:5503
virtual int leaveChannel(const LeaveChannelOptions &options)=0
virtual int getLoopbackRecordingVolume()=0
virtual int registerPacketObserver(IPacketObserver *observer)=0
int videoBitrate
Definition: IAgoraRtcEngine.h:3653
virtual int stopRhythmPlayer()=0
virtual int muteLocalAudioStream(bool mute)=0
int fps
Definition: IAgoraRtcEngine.h:3648
@ VIDEO_PROFILE_LANDSCAPE_240P_4
Definition: IAgoraRtcEngine.h:8921
virtual void onExtensionStartedWithContext(const ExtensionContext &context)
Definition: IAgoraRtcEngine.h:2996
virtual int takeSnapshot(uid_t uid, const char *filePath)=0
virtual int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option)=0
@ AUDIO_EQUALIZATION_BAND_1K
Definition: IAgoraRtcEngine.h:189
@ VIDEO_PROFILE_LANDSCAPE_480P_9
Definition: IAgoraRtcEngine.h:8951
virtual int enableContentInspect(bool enabled, const media::ContentInspectConfig &config)=0
@ AUDIO_MIXING_REASON_CAN_NOT_OPEN
Definition: IAgoraRtcEngine.h:95
@ VIDEO_PROFILE_PORTRAIT_360P_4
Definition: IAgoraRtcEngine.h:8997
int frozenRate
Definition: IAgoraRtcEngine.h:419
virtual void onExtensionErrorWithContext(const ExtensionContext &context, int error, const char *message)
Definition: IAgoraRtcEngine.h:3021
virtual int addVideoWatermark(const WatermarkConfig &configs)=0
Add a watermark image to the local video.
@ VIDEO_PROFILE_LANDSCAPE_360P_6
Definition: IAgoraRtcEngine.h:8929
Definition: AgoraBase.h:5577
virtual int sendAudioMetadata(const char *metadata, size_t length)=0
send audio metadata
virtual int stopLocalAudioMixer()=0
Definition: IAgoraRtcEngine.h:3114
virtual int adjustCustomAudioPublishVolume(track_id_t trackId, int volume)=0
virtual int writeLog(commons::LOG_LEVEL level, const char *fmt,...)=0
@ AUDIO_REVERB_WET_LEVEL
Definition: IAgoraRtcEngine.h:219
@ VIDEO_CAPTURE_DEVICE
Definition: IAgoraRtcEngine.h:60
RdtState
Reliable Data Transmission tunnel state.
Definition: AgoraBase.h:7442
AUDIO_REVERB_TYPE
Definition: IAgoraRtcEngine.h:211
virtual int muteLocalVideoStream(bool mute)=0
int targetBitrate
Definition: IAgoraRtcEngine.h:322
INJECT_STREAM_STATUS
Definition: IAgoraRtcEngine.h:115
virtual int setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset, int param1, int param2)=0
virtual int setLogLevel(commons::LOG_LEVEL level)=0
virtual void onChannelMediaRelayStateChanged(int state, int code)
Definition: IAgoraRtcEngine.h:2680
virtual int setExtensionProperty(const char *provider, const char *extension, const char *key, const char *value, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority)=0
int jitterBufferDelay
Definition: IAgoraRtcEngine.h:390
@ VIDEO_PROFILE_PORTRAIT_720P_6
Definition: IAgoraRtcEngine.h:9031
int width
Definition: IAgoraRtcEngine.h:740
@ VIDEO_PROFILE_LANDSCAPE_1080P_3
Definition: IAgoraRtcEngine.h:8965
virtual int startDirectCdnStreaming(IDirectCdnStreamingEventHandler *eventHandler, const char *publishUrl, const DirectCdnStreamingMediaOptions &options)=0
virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
@ VIDEO_PROFILE_PORTRAIT_480P_4
Definition: IAgoraRtcEngine.h:9015
virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Definition: IAgoraRtcEngine.h:2952
commons::LogConfig logConfig
Definition: IAgoraRtcEngine.h:3464
int defaultLayout
Definition: IAgoraRtcEngine.h:758
@ STREAM_FALLBACK_OPTION_DISABLED
Definition: IAgoraRtcEngine.h:239
@ AUDIO_EQUALIZATION_BAND_31
Definition: IAgoraRtcEngine.h:169
@ UDP_PROXY_TYPE
Definition: IAgoraRtcEngine.h:1521
int canvasWidth
Definition: IAgoraRtcEngine.h:642
virtual int stopScreenCapture(VIDEO_SOURCE_TYPE sourceType)=0
void(*)() RtcEngineReleaseCallback
Occurs when the IRtcEngine is released.
Definition: IAgoraRtcEngine.h:3833
int appDataLength
Definition: IAgoraRtcEngine.h:663
PROXY_TYPE
Definition: IAgoraRtcEngine.h:1515
VIDEO_QOE_PREFERENCE_TYPE
Definition: AgoraBase.h:3202
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:1944
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW
Definition: IAgoraRtcEngine.h:243
ExtensionInfo()
Definition: IAgoraRtcEngine.h:3822
MEDIA_TRACE_EVENT
Definition: AgoraBase.h:7230
@ AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED
Definition: IAgoraRtcEngine.h:101
virtual int setDirectCdnStreamingVideoConfiguration(const VideoEncoderConfiguration &config)=0
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) 1
Definition: IAgoraRtcEngine.h:1896
RTMP_STREAMING_EVENT
Definition: AgoraBase.h:4118
int zOrder
Definition: IAgoraRtcEngine.h:618
virtual int registerAudioEncodedFrameObserver(const AudioEncodedFrameObserverConfig &config, IAudioEncodedFrameObserver *observer)=0
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_4
Definition: IAgoraRtcEngine.h:255
AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraRtcEngine.h:3438
@ STREAM_FALLBACK_OPTION_AUDIO_ONLY
Definition: IAgoraRtcEngine.h:247
virtual int setSimulcastConfig(const SimulcastConfig &simulcastConfig)=0
virtual int joinChannel(const char *token, const char *channelId, uid_t uid, const ChannelMediaOptions &options)=0
@ VIDEO_PROFILE_PORTRAIT_720P_3
Definition: IAgoraRtcEngine.h:9027
@ AUDIO_EQUALIZATION_BAND_500
Definition: IAgoraRtcEngine.h:185
int publishDuration
Definition: IAgoraRtcEngine.h:583
RemoteAudioStats()
Definition: IAgoraRtcEngine.h:485
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode)=0
virtual int joinChannelWithUserAccountEx(const char *token, const char *channelId, const char *userAccount, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
int targetFrameRate
Definition: IAgoraRtcEngine.h:325
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_1
Definition: IAgoraRtcEngine.h:252
virtual int sendCustomReportMessage(const char *id, const char *category, const char *event, const char *label, int value)=0
virtual void onUserMuteAudio(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:2037
@ NONE_PROXY_TYPE
Definition: IAgoraRtcEngine.h:1518
Definition: AgoraBase.h:1937
Definition: IAgoraLog.h:83
virtual int enableDualStreamMode(bool enabled) 1=0
virtual void onPermissionError(PERMISSION_TYPE permissionType)
Definition: IAgoraRtcEngine.h:2799
virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngine.h:1911
MEDIA_DEVICE_STATE_TYPE
Definition: IAgoraRtcEngine.h:8882
AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine()
virtual int preloadChannelWithUserAccount(const char *token, const char *channelId, const char *userAccount)=0
Definition: IAgoraRtcEngine.h:274
int mosValue
Definition: IAgoraRtcEngine.h:591
VIDEO_ORIENTATION
Definition: AgoraBase.h:987
int height
Definition: IAgoraRtcEngine.h:685
@ INJECT_STREAM_STATUS_STOP_UNAUTHORIZED
Definition: IAgoraRtcEngine.h:147
Aggregates statistics for all network paths used in multipath transmission.
Definition: AgoraBase.h:2625
@ STREAM_LAYER_COUNT_MAX
Definition: AgoraBase.h:2236
virtual int muteAllRemoteAudioStreams(bool mute)=0
virtual int enableLoopbackRecording(bool enabled, const char *deviceName=NULL)=0
@ TCP_PROXY_AUTO_FALLBACK_TYPE
Definition: IAgoraRtcEngine.h:1530
virtual int enableAudio()=0
Definition: IAgoraRtcEngine.h:3667
STREAM_FALLBACK_OPTIONS
Definition: IAgoraRtcEngine.h:234
@ MEDIA_DEVICE_STATE_ACTIVE
Definition: IAgoraRtcEngine.h:8888
virtual int getFaceShapeAreaOptions(agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA shapeArea, FaceShapeAreaOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:3042
virtual video_track_id_t createCustomEncodedVideoTrack(const SenderOptions &sender_option)=0
Definition: AgoraBase.h:6811
QUALITY_ADAPT_INDICATION qualityAdaptIndication
Definition: IAgoraRtcEngine.h:329
virtual int registerExtension(const char *provider, const char *extension, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
@ INJECT_STREAM_STATUS_START_TIMEDOUT
Definition: IAgoraRtcEngine.h:131
CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraRtcEngine.h:3424
@ AUDIO_PLAYOUT_DEVICE
Definition: IAgoraRtcEngine.h:48
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) 1
Definition: IAgoraRtcEngine.h:2449
REMOTE_AUDIO_STATE_REASON
Definition: AgoraBase.h:3530
bool autoRegisterAgoraExtensions
Definition: IAgoraRtcEngine.h:3492
RAW_AUDIO_FRAME_OP_MODE_TYPE
Definition: AgoraMediaBase.h:228
@ VIDEO_PROFILE_LANDSCAPE_480P_4
Definition: IAgoraRtcEngine.h:8945
virtual int setMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall)=0
virtual void onTokenPrivilegeWillExpire(const char *token)
Definition: IAgoraRtcEngine.h:2406
~AdvancedAudioOptions()
Definition: IAgoraRtcEngine.h:1062
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) 1
Definition: IAgoraRtcEngine.h:2461
@ VIDEO_PROFILE_LANDSCAPE_480P_10
Definition: IAgoraRtcEngine.h:8953
@ PRIORITY_HIGH
Definition: IAgoraRtcEngine.h:263
virtual int startLastmileProbeTest(const LastmileProbeConfig &config)=0
virtual void onUserMuteVideo(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:2056
const char * appId
Definition: IAgoraRtcEngine.h:3414
unsigned int rxVideoBytes
Definition: IAgoraRtcEngine.h:595
Definition: IAgoraRtcEngine.h:372
VideoCompositingLayout()
Definition: IAgoraRtcEngine.h:665
Definition: AgoraBase.h:4480
virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1738
uid_t uid
Definition: IAgoraRtcEngine.h:376
virtual void onCameraReady() 1
Definition: IAgoraRtcEngine.h:2160
AUDIO_EFFECT_PRESET
Definition: AgoraBase.h:5859
virtual int destroyMediaPlayer(agora_refptr< IMediaPlayer > media_player)=0
virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset)=0
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:2501
CAPTURE_BRIGHTNESS_LEVEL_TYPE captureBrightnessLevel
Definition: IAgoraRtcEngine.h:346
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2836
@ VIDEO_PROFILE_LANDSCAPE_360P
Definition: IAgoraRtcEngine.h:8923
VideoDimensions simulcastDimensions[SimulcastConfig::STREAM_LAYER_COUNT_MAX]
Definition: IAgoraRtcEngine.h:358
virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) 1=0
@ DIRECT_CDN_STREAMING_REASON_OK
Definition: IAgoraRtcEngine.h:3597
Defines the configuration for a watermark.
Definition: AgoraBase.h:2515
int encoderOutputFrameRate
Definition: IAgoraRtcEngine.h:310
VIDEO_CODEC_TYPE codecType
Definition: IAgoraRtcEngine.h:339
AUDIO_AINS_MODE
Definition: AgoraBase.h:2977
int decoderInputFrameRate
Definition: IAgoraRtcEngine.h:543
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1613
@ VIDEO_PROFILE_PORTRAIT_4K_3
Definition: IAgoraRtcEngine.h:9045
virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
Definition: AgoraBase.h:2672
int lifecycle
Definition: IAgoraRtcEngine.h:761
const char * license
Definition: IAgoraRtcEngine.h:3429
PublisherConfiguration()
Definition: IAgoraRtcEngine.h:788
@ VIDEO_PROFILE_PORTRAIT_1080P_3
Definition: IAgoraRtcEngine.h:9035
virtual int startRtmpStreamWithoutTranscoding(const char *url)=0
@ QUALITY_REPORT_HTML
Definition: IAgoraRtcEngine.h:8878
Definition: AgoraBase.h:5455
virtual int setRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
VIDEO_STREAM_TYPE rxStreamType
Definition: IAgoraRtcEngine.h:559
@ DIRECT_CDN_STREAMING_STATE_STOPPED
Definition: IAgoraRtcEngine.h:3622
virtual void onSetRtmFlagResult(int code)
Definition: IAgoraRtcEngine.h:3033
virtual int stopRtmpStream(const char *url)=0
virtual int startEchoTest(const EchoTestConfiguration &config)=0
uid_t uid
Definition: IAgoraRtcEngine.h:278
virtual int setLocalRenderTargetFps(VIDEO_SOURCE_TYPE sourceType, int targetFps)=0
virtual int setFaceShapeAreaOptions(const FaceShapeAreaOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
STREAM_PUBLISH_STATE
Definition: AgoraBase.h:7001
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1595
Definition: AgoraBase.h:2341
virtual int adjustPlaybackSignalVolume(int volume)=0
Definition: AgoraBase.h:3949
Definition: AgoraBase.h:7393
Definition: AgoraBase.h:2200
LOCAL_AUDIO_STREAM_STATE
Definition: AgoraBase.h:3266
@ VIDEO_MIRROR_MODE_DISABLED
Definition: AgoraBase.h:1870
virtual int setVideoDenoiserOptions(bool enabled, const VideoDenoiserOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
AUDIO_RECORDING_QUALITY_TYPE
Definition: AgoraBase.h:6234
virtual int setupRemoteVideo(const VideoCanvas &canvas)=0
virtual int stopCameraCapture(VIDEO_SOURCE_TYPE sourceType)=0
#define __deprecated
Definition: AgoraBase.h:74
const char * backgroundColor
Definition: IAgoraRtcEngine.h:650
@ VIDEO_PROFILE_LANDSCAPE_360P_4
Definition: IAgoraRtcEngine.h:8927
ScreenCaptureParameters params
Definition: IAgoraRtcEngine.h:893
virtual int setVoiceConversionParameters(VOICE_CONVERSION_PRESET preset, int param1, int param2)=0
@ VIDEO_PROFILE_LANDSCAPE_720P_5
Definition: IAgoraRtcEngine.h:8959
Definition: AgoraRefPtr.h:31
virtual int setupLocalVideo(const VideoCanvas &canvas)=0
Definition: IAgoraRtcEngine.h:677
HEADPHONE_EQUALIZER_PRESET
Definition: AgoraBase.h:6043
@ VIDEO_PROFILE_LANDSCAPE_240P
Definition: IAgoraRtcEngine.h:8917
virtual int startOrUpdateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration)=0
bool isCaptureWindow
Definition: IAgoraRtcEngine.h:875
virtual void onRtmpStreamingStateChanged(const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_REASON reason)
Definition: IAgoraRtcEngine.h:2605
@ QUALITY_REPORT_JSON
Definition: IAgoraRtcEngine.h:8875
@ AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED
Definition: IAgoraRtcEngine.h:103
virtual int startAudioRecording(const AudioRecordingConfiguration &config)=0
virtual void onConnectionInterrupted() 1
Definition: IAgoraRtcEngine.h:2288
int captureFrameWidth
Definition: IAgoraRtcEngine.h:292
virtual int getExtensionProperty(const char *provider, const char *extension, const char *key, char *value, int buf_len, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
Definition: IAgoraRtcEngine.h:3403
virtual int resumeAllChannelMediaRelay()=0
virtual int enableVideo()=0
virtual void onExtensionEventWithContext(const ExtensionContext &context, const char *key, const char *value)
Definition: IAgoraRtcEngine.h:2983
Definition: IAgoraRtcEngine.h:3841
int encodedBitrate
Definition: IAgoraRtcEngine.h:333
virtual int getDevice(int index, char deviceNameUTF8[MAX_DEVICE_ID_LENGTH], char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual void onAudioSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2886
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Definition: IAgoraRtcEngine.h:2110
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Definition: IAgoraRtcEngine.h:2721
virtual int setClientRole(CLIENT_ROLE_TYPE role)=0
AUDIO_MIXING_REASON_TYPE
Definition: IAgoraRtcEngine.h:93
uint32_t plcCount
Definition: IAgoraRtcEngine.h:445
Definition: IAgoraRtcEngine.h:869
virtual int startAudioRecording(const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality)=0
virtual IVideoDeviceCollection * enumerateVideoDevices()=0
Region()
Definition: IAgoraRtcEngine.h:627
int fps
Definition: IAgoraRtcEngine.h:1067
virtual int updateLocalAudioMixerConfiguration(const LocalAudioMixerConfiguration &config)=0
@ DIRECT_CDN_STREAMING_STATE_RECOVERING
Definition: IAgoraRtcEngine.h:3626
virtual ~IVideoDeviceManager()
Definition: IAgoraRtcEngine.h:3116
Definition: AgoraBase.h:6295
@ AUDIO_RECORDING_DEVICE
Definition: IAgoraRtcEngine.h:52
const char * channelId
Definition: IAgoraRtcEngine.h:3815
REMOTE_VIDEO_STATE_REASON
Definition: AgoraBase.h:3611
REMOTE_USER_STATE
Definition: AgoraBase.h:3671
int encodedFrameDepth
Definition: IAgoraRtcEngine.h:365
virtual void onRenewTokenResult(const char *token, RENEW_TOKEN_ERROR_CODE code)
Reports the result of calling renewToken.
Definition: IAgoraRtcEngine.h:3061
virtual int renewToken(const char *token)=0
@ DIRECT_CDN_STREAMING_REASON_AUDIO_PUBLICATION
Definition: IAgoraRtcEngine.h:3601
Definition: AgoraBase.h:1139
virtual int disableAudioSpectrumMonitor()=0
@ AUDIO_EQUALIZATION_BAND_62
Definition: IAgoraRtcEngine.h:173
virtual int setAdvancedAudioOptions(AdvancedAudioOptions &options, int sourceType=0)=0
RENEW_TOKEN_ERROR_CODE
Definition: AgoraBase.h:6908
virtual int startLocalVideoTranscoder(const LocalTranscoderConfiguration &config)=0
@ VIDEO_PROFILE_LANDSCAPE_360P_7
Definition: IAgoraRtcEngine.h:8931
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngine.h:2576
virtual void onRdtStateChanged(uid_t userId, RdtState state)
Occurs when the RDT tunnel state changed.
Definition: IAgoraRtcEngine.h:2362
@ AUDIO_MIXING_REASON_RESUMED_BY_USER
Definition: IAgoraRtcEngine.h:107
virtual int unregisterMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
virtual int muteRecordingSignal(bool mute)=0
virtual int enableSpatialAudio(bool enabled)=0
int videoGop
Definition: IAgoraRtcEngine.h:689
virtual int rate(const char *callId, int rating, const char *description)=0
ImageTrackOptions()
Definition: IAgoraRtcEngine.h:1069
FeatureType
Definition: IAgoraRtcEngine.h:1539
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:2480
Definition: AgoraBase.h:156
@ INJECT_STREAM_STATUS_STOP_SUCCESS
Definition: IAgoraRtcEngine.h:139
NETWORK_TYPE
Definition: AgoraBase.h:4927
virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted)
Definition: IAgoraRtcEngine.h:2588
#define OPTIONAL_NULLPTR
Definition: AgoraBase.h:90
@ VIDEO_PROFILE_PORTRAIT_360P_3
Definition: IAgoraRtcEngine.h:8995
@ VIDEO_PROFILE_PORTRAIT_720P
Definition: IAgoraRtcEngine.h:9025
const char * appData
Definition: IAgoraRtcEngine.h:660
CAMERA_STABILIZATION_MODE
Definition: AgoraBase.h:3242
virtual void onStreamMessage(uid_t uid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngine.h:2306
@ VIDEO_PROFILE_PORTRAIT_480P_6
Definition: IAgoraRtcEngine.h:9017
virtual int muteRemoteVideoStream(uid_t uid, bool mute)=0
virtual int setRemoteVideoStreamType(uid_t uid, VIDEO_STREAM_TYPE streamType)=0
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngine.h:1806
CAMERA_DIRECTION
Definition: IAgoraRtcEngine.h:807
virtual int setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType)=0
AUDIO_PROFILE_TYPE
Definition: AgoraBase.h:2995
virtual int startAudioFrameDump(const char *channel_id, uid_t uid, const char *location, const char *uuid, const char *passwd, long duration_ms, bool auto_upload)=0
virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel)=0
virtual int disableAudio()=0
virtual int leaveChannel()=0
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: IAgoraRtcEngine.h:2415
virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions &options)=0
LeaveChannelOptions()
Definition: IAgoraRtcEngine.h:1567
virtual void onDirectCdnStreamingStats(const DirectCdnStreamingStats &stats)
Definition: IAgoraRtcEngine.h:3683
@ DIRECT_CDN_STREAMING_STATE_RUNNING
Definition: IAgoraRtcEngine.h:3620
@ MEDIA_DEVICE_STATE_NOT_PRESENT
Definition: IAgoraRtcEngine.h:8899
@ INJECT_STREAM_STATUS_START_UNAUTHORIZED
Definition: IAgoraRtcEngine.h:127
uid_t uid
Definition: IAgoraRtcEngine.h:602
virtual int setRemoteRenderTargetFps(int targetFps)=0
virtual int destroyMediaRecorder(agora_refptr< IMediaRecorder > mediaRecorder)=0
virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel, int samplesPerCall)=0
virtual int setLogFile(const char *filePath)=0
void * context
Definition: IAgoraRtcEngine.h:3420
Definition: IAgoraRtcEngine.h:1065
const char * imageUrl
Definition: IAgoraRtcEngine.h:1066
@ VIDEO_PROFILE_PORTRAIT_4K
Definition: IAgoraRtcEngine.h:9043
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode) 1=0
Definition: IAgoraRtcEngine.h:599
virtual int registerLocalUserAccount(const char *appId, const char *userAccount)=0
int encodedFrameCount
Definition: IAgoraRtcEngine.h:336
virtual int stopPreview()=0
virtual video_track_id_t createCustomVideoTrack()=0
int height
Definition: IAgoraRtcEngine.h:536
virtual bool registerEventHandler(IRtcEngineEventHandler *eventHandler)=0
int height
Definition: IAgoraRtcEngine.h:744
RdtStreamType
Reliable Data Transmission Tunnel message stream type.
Definition: AgoraBase.h:7418
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Definition: IAgoraRtcEngine.h:1830
VIDEO_PROFILE_TYPE
Definition: IAgoraRtcEngine.h:8905
virtual int stopDirectCdnStreaming()=0
DIRECT_CDN_STREAMING_REASON
Definition: IAgoraRtcEngine.h:3595
@ AUDIO_EQUALIZATION_BAND_4K
Definition: IAgoraRtcEngine.h:197
RtcEngineContext()
Definition: IAgoraRtcEngine.h:3494
int width
Definition: IAgoraRtcEngine.h:681
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo *userInfo)=0
virtual int stopDeviceTest()=0
@ VIDEO_PROFILE_LANDSCAPE_720P_6
Definition: IAgoraRtcEngine.h:8961
virtual int adjustRecordingSignalVolume(int volume)=0
virtual void onTranscodingUpdated()
Definition: IAgoraRtcEngine.h:2632
@ VIDEO_PROFILE_LANDSCAPE_180P_4
Definition: IAgoraRtcEngine.h:8915
LICENSE_ERROR_TYPE
Definition: AgoraBase.h:798
virtual int joinChannelWithUserAccount(const char *token, const char *channelId, const char *userAccount)=0
Face shape area options. This structure defines options for facial adjustments on different facial ar...
Definition: AgoraBase.h:5168
@ AREA_CODE_GLOB
Definition: AgoraBase.h:6472
#define AGORA_CALL
Definition: AgoraBase.h:72
int64_t windowId
Definition: IAgoraRtcEngine.h:889
@ VIDEO_PROFILE_LANDSCAPE_480P
Definition: IAgoraRtcEngine.h:8941
virtual bool isFeatureAvailableOnDevice(FeatureType type)=0
Whether the target feature is available for the device.
@ TCP_PROXY_TYPE
Definition: IAgoraRtcEngine.h:1524
virtual int addVideoWatermark(const RtcImage &watermark) 1=0
virtual CONNECTION_STATE_TYPE getConnectionState()=0
virtual void onMultipathStats(const MultipathStats &stats)
Report the multipath transmission statistics.
Definition: IAgoraRtcEngine.h:3045
unsigned short txPacketLossRate
Definition: IAgoraRtcEngine.h:343
int networkTransportDelay
Definition: IAgoraRtcEngine.h:384
const char * rawStreamUrl
Definition: IAgoraRtcEngine.h:783
static void SetFrom(Optional< T > *s, const Optional< T > &o)
Definition: IAgoraRtcEngine.h:24
CLIENT_ROLE_CHANGE_FAILED_REASON
Definition: AgoraBase.h:4903
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1714
Definition: IAgoraRtcEngine.h:9050
@ VIDEO_PROFILE_PORTRAIT_360P_10
Definition: IAgoraRtcEngine.h:9007
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
virtual void onLastmileQuality(int quality)
Definition: IAgoraRtcEngine.h:1846
@ LOCAL_PROXY_TYPE
Definition: IAgoraRtcEngine.h:1527
Definition: AgoraBase.h:1950
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngine.h:2786
@ VIDEO_PROFILE_PORTRAIT_360P_7
Definition: IAgoraRtcEngine.h:9001
virtual int getFaceShapeBeautyOptions(FaceShapeBeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Definition: AgoraBase.h:3810
Definition: AgoraBase.h:7473
@ DIRECT_CDN_STREAMING_REASON_VIDEO_PUBLICATION
Definition: IAgoraRtcEngine.h:3603
@ VIDEO_PROFILE_LANDSCAPE_120P_3
Definition: IAgoraRtcEngine.h:8909
virtual int queryCodecCapability(CodecCapInfo *codecInfo, int &size)=0
Definition: AgoraBase.h:7244
virtual int enableAudioSpectrumMonitor(int intervalInMS=100)=0
virtual void onRtcStats(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1723
@ UDP_PROXY
Definition: IAgoraRtcEngine.h:824
virtual void onActiveSpeaker(uid_t uid)
Definition: IAgoraRtcEngine.h:2521
virtual void onConnectionLost()
Definition: IAgoraRtcEngine.h:2275
bool stopMicrophoneRecording
Definition: IAgoraRtcEngine.h:1565
int injectStreamHeight
Definition: IAgoraRtcEngine.h:772
virtual int setInEarMonitoringVolume(int volume)=0
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed)
Definition: IAgoraRtcEngine.h:1875
Definition: IAgoraRtcEngine.h:833
uid_t localUid
Definition: IAgoraRtcEngine.h:3820
@ VIDEO_PROFILE_LANDSCAPE_4K_3
Definition: IAgoraRtcEngine.h:8975
@ VIDEO_PROFILE_PORTRAIT_180P_3
Definition: IAgoraRtcEngine.h:8983
Definition: IAgoraRtcEngine.h:512
AUDIO_MIXING_STATE_TYPE
Definition: IAgoraRtcEngine.h:78
virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1975
Definition: AgoraOptional.h:413
virtual int enableLocalVideo(bool enabled)=0
virtual int enableCustomAudioLocalPlayback(track_id_t trackId, bool enabled)=0
Definition: AgoraBase.h:2927
virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile)=0
RTMP_STREAM_PUBLISH_STATE
Definition: AgoraBase.h:3992
@ AUDIO_VIRTUAL_RECORDING_DEVICE
Definition: IAgoraRtcEngine.h:72
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_3
Definition: IAgoraRtcEngine.h:254
int videoBitrate
Definition: IAgoraRtcEngine.h:697
virtual int setVideoQoEPreference(VIDEO_QOE_PREFERENCE_TYPE qoePreference)=0
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Definition: IAgoraRtcEngine.h:2745
@ RTMP_STREAM_LIFE_CYCLE_BIND2OWNER
Definition: IAgoraRtcEngine.h:731
virtual int enableLocalAudio(bool enabled)=0
virtual int enableWebSdkInteroperability(bool enabled) 1=0
Definition: AgoraBase.h:4983
@ VIDEO_PROFILE_LANDSCAPE_360P_11
Definition: IAgoraRtcEngine.h:8939
RTMP_STREAM_PUBLISH_REASON
Definition: AgoraBase.h:4035
@ AUDIO_REVERB_DRY_LEVEL
Definition: IAgoraRtcEngine.h:215
double alpha
Definition: IAgoraRtcEngine.h:623
@ VIDEO_PROFILE_LANDSCAPE_1080P
Definition: IAgoraRtcEngine.h:8963
uint32_t frozenCntByCustom
Definition: IAgoraRtcEngine.h:451
unsigned int areaCode
Definition: IAgoraRtcEngine.h:3447
Definition: AgoraBase.h:5658
AUDIO_SAMPLE_RATE_TYPE
Definition: AgoraBase.h:3881
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:1818
unsigned int track_id_t
Definition: AgoraMediaBase.h:29
LOCAL_AUDIO_STREAM_REASON
Definition: AgoraBase.h:3288
virtual void onLastmileProbeResult(const LastmileProbeResult &result)
Definition: IAgoraRtcEngine.h:1669