|
Agora Java API Reference for Android
|
9 #include "AgoraMediaBase.h"
10 #include "IAgoraLog.h"
11 #include "AgoraOptional.h"
12 #include "IAudioDeviceManager.h"
13 #include "IAgoraRhythmPlayer.h"
14 #include "IAgoraMediaEngine.h"
15 #include "IAgoraH265Transcoder.h"
24 static void SetFrom(Optional<T>* s,
const Optional<T>& o) {
31 static void ReplaceBy(Optional<T>* s,
const Optional<T>& o) {
40 enum MEDIA_DEVICE_TYPE {
44 UNKNOWN_AUDIO_DEVICE = -1,
48 AUDIO_PLAYOUT_DEVICE = 0,
52 AUDIO_RECORDING_DEVICE = 1,
56 VIDEO_RENDER_DEVICE = 2,
60 VIDEO_CAPTURE_DEVICE = 3,
64 AUDIO_APPLICATION_PLAYOUT_DEVICE = 4,
68 AUDIO_VIRTUAL_PLAYOUT_DEVICE = 5,
72 AUDIO_VIRTUAL_RECORDING_DEVICE = 6,
78 enum AUDIO_MIXING_STATE_TYPE {
80 AUDIO_MIXING_STATE_PLAYING = 710,
82 AUDIO_MIXING_STATE_PAUSED = 711,
84 AUDIO_MIXING_STATE_STOPPED = 713,
87 AUDIO_MIXING_STATE_FAILED = 714,
93 enum AUDIO_MIXING_REASON_TYPE {
95 AUDIO_MIXING_REASON_CAN_NOT_OPEN = 701,
97 AUDIO_MIXING_REASON_TOO_FREQUENT_CALL = 702,
99 AUDIO_MIXING_REASON_INTERRUPTED_EOF = 703,
101 AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED = 721,
103 AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED = 723,
105 AUDIO_MIXING_REASON_STOPPED_BY_USER = 724,
107 AUDIO_MIXING_REASON_RESUMED_BY_USER = 726,
109 AUDIO_MIXING_REASON_OK = 0,
115 enum INJECT_STREAM_STATUS {
119 INJECT_STREAM_STATUS_START_SUCCESS = 0,
123 INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1,
127 INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2,
131 INJECT_STREAM_STATUS_START_TIMEDOUT = 3,
135 INJECT_STREAM_STATUS_START_FAILED = 4,
139 INJECT_STREAM_STATUS_STOP_SUCCESS = 5,
143 INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6,
147 INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7,
151 INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8,
155 INJECT_STREAM_STATUS_STOP_FAILED = 9,
159 INJECT_STREAM_STATUS_BROKEN = 10,
165 enum AUDIO_EQUALIZATION_BAND_FREQUENCY {
169 AUDIO_EQUALIZATION_BAND_31 = 0,
173 AUDIO_EQUALIZATION_BAND_62 = 1,
177 AUDIO_EQUALIZATION_BAND_125 = 2,
181 AUDIO_EQUALIZATION_BAND_250 = 3,
185 AUDIO_EQUALIZATION_BAND_500 = 4,
189 AUDIO_EQUALIZATION_BAND_1K = 5,
193 AUDIO_EQUALIZATION_BAND_2K = 6,
197 AUDIO_EQUALIZATION_BAND_4K = 7,
201 AUDIO_EQUALIZATION_BAND_8K = 8,
205 AUDIO_EQUALIZATION_BAND_16K = 9,
211 enum AUDIO_REVERB_TYPE {
215 AUDIO_REVERB_DRY_LEVEL = 0,
219 AUDIO_REVERB_WET_LEVEL = 1,
223 AUDIO_REVERB_ROOM_SIZE = 2,
227 AUDIO_REVERB_WET_DELAY = 3,
231 AUDIO_REVERB_STRENGTH = 4,
234 enum STREAM_FALLBACK_OPTIONS {
239 STREAM_FALLBACK_OPTION_DISABLED = 0,
243 STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1,
247 STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2,
252 STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_1 = 3,
253 STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_2 = 4,
254 STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_3 = 5,
255 STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_4 = 6,
256 STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_5 = 7,
257 STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_6 = 8,
266 PRIORITY_NORMAL = 100,
269 struct RtcConnection;
625 media::base::RENDER_MODE_TYPE renderMode;
635 renderMode(media::base::RENDER_MODE_HIDDEN) {}
725 enum RTMP_STREAM_LIFE_CYCLE_TYPE {
728 RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL = 1,
731 RTMP_STREAM_LIFE_CYCLE_BIND2OWNER = 2,
794 lifecycle(RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL),
807 enum CAMERA_DIRECTION {
818 enum CLOUD_PROXY_TYPE {
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)
1066 const char* imageUrl;
1068 VIDEO_MIRROR_MODE_TYPE mirrorMode;
1069 ImageTrackOptions() : imageUrl(NULL), fps(1), mirrorMode(VIDEO_MIRROR_MODE_DISABLED) {}
1112 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
1353 void SetAll(
const ChannelMediaOptions& change) {
1354 #define SET_FROM(X) SetFrom(&X, change.X)
1361 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
1362 SET_FROM(publishScreenCaptureVideo);
1363 SET_FROM(publishScreenCaptureAudio);
1403 bool operator==(
const ChannelMediaOptions& o)
const {
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__)
1415 ADD_COMPARE(publishScreenCaptureVideo);
1416 ADD_COMPARE(publishScreenCaptureAudio);
1455 #undef BEGIN_COMPARE
1461 ChannelMediaOptions& operator=(
const ChannelMediaOptions& replace) {
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__)
1471 REPLACE_BY(publishScreenCaptureVideo);
1472 REPLACE_BY(publishScreenCaptureAudio);
1518 NONE_PROXY_TYPE = 0,
1527 LOCAL_PROXY_TYPE = 3,
1530 TCP_PROXY_AUTO_FALLBACK_TYPE = 4,
1533 HTTP_PROXY_TYPE = 5,
1536 HTTPS_PROXY_TYPE = 6,
1540 VIDEO_VIRTUAL_BACKGROUND = 1,
1541 VIDEO_BEAUTY_EFFECT = 2,
1584 virtual const char* eventHandlerType()
const {
return "event_handler"; }
1624 virtual void onProxyConnected(
const char* channel, uid_t uid, PROXY_TYPE proxyType,
const char* localProxyIp,
int elapsed) {
1657 virtual void onAudioQuality(uid_t uid,
int quality,
unsigned short delay,
unsigned short lost) __deprecated {
1702 (void)speakerNumber;
1911 virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid,
int width,
int height,
int rotation) {
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;
2306 virtual void onStreamMessage(uid_t uid,
int streamId,
const char* data,
size_t length, uint64_t sentTs) {
2347 virtual void onRdtMessage(uid_t userId, RdtStreamType type,
const char *data,
size_t length) {
2548 virtual void onSnapshotTaken(uid_t uid,
const char* filePath,
int width,
int height,
int errCode) {
2566 (void)newRoleOptions;
2606 RTMP_STREAM_PUBLISH_REASON reason) {
2704 (void)isFallbackOrRecover;
2761 CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) {
2800 (void)permissionType;
2886 virtual void onAudioSubscribeStateChanged(
const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState,
int elapseSinceLastState) {
2891 (void)elapseSinceLastState;
2903 virtual void onVideoSubscribeStateChanged(
const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState,
int elapseSinceLastState) {
2908 (void)elapseSinceLastState;
2919 virtual void onAudioPublishStateChanged(
const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState,
int elapseSinceLastState) {
2923 (void)elapseSinceLastState;
2935 virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source,
const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState,
int 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;
3524 INVALID_METADATA_SIZE_IN_BYTE = -1,
3525 DEFAULT_METADATA_SIZE_IN_BYTE = 512,
3526 MAX_METADATA_SIZE_IN_BYTE = 1024
3595 enum DIRECT_CDN_STREAMING_REASON {
3597 DIRECT_CDN_STREAMING_REASON_OK = 0,
3599 DIRECT_CDN_STREAMING_REASON_FAILED = 1,
3601 DIRECT_CDN_STREAMING_REASON_AUDIO_PUBLICATION = 2,
3603 DIRECT_CDN_STREAMING_REASON_VIDEO_PUBLICATION = 3,
3605 DIRECT_CDN_STREAMING_REASON_NET_CONNECT = 4,
3607 DIRECT_CDN_STREAMING_REASON_BAD_NAME = 5,
3616 enum DIRECT_CDN_STREAMING_STATE {
3618 DIRECT_CDN_STREAMING_STATE_IDLE = 0,
3620 DIRECT_CDN_STREAMING_STATE_RUNNING = 1,
3622 DIRECT_CDN_STREAMING_STATE_STOPPED = 2,
3624 DIRECT_CDN_STREAMING_STATE_FAILED = 3,
3626 DIRECT_CDN_STREAMING_STATE_RECOVERING = 4,
3738 void SetAll(
const DirectCdnStreamingMediaOptions& change) {
3739 #define SET_FROM(X) SetFrom(&X, change.X)
3750 bool operator==(
const DirectCdnStreamingMediaOptions& o)
const {
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
3771 DirectCdnStreamingMediaOptions& operator=(
const DirectCdnStreamingMediaOptions& replace) {
3772 if (
this != &replace) {
3773 #define REPLACE_BY(X) ReplaceBy(&X, replace.X)
3826 class IMediaRecorder;
3833 using RtcEngineReleaseCallback = void(*)();
3867 AGORA_CPP_API
static void release(RtcEngineReleaseCallback callback =
nullptr);
4093 virtual int joinChannel(
const char* token,
const char* channelId,
const char* info, uid_t uid) = 0;
4321 #if defined(__APPLE__) && TARGET_OS_IOS
4804 virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) __deprecated = 0;
5200 AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
5224 AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
5397 virtual int startAudioMixing(
const char* filePath,
bool loopback,
int cycle,
int startPos) = 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;
6126 int param1,
int param2) = 0;
6141 int param1,
int param2) = 0;
6326 virtual int writeLog(commons::LOG_LEVEL level,
const char* fmt, ...) = 0;
6346 virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
6369 VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
6548 RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
6549 int samplesPerCall) = 0;
6571 RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
6572 int samplesPerCall) = 0;
6611 RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
6612 int samplesPerCall) = 0;
6759 virtual int adjustUserPlaybackSignalVolume(uid_t uid,
int volume) = 0;
6914 #if defined(_WIN32) || defined(__linux__) || defined(__ANDROID__)
6915 virtual int loadExtensionProvider(
const char* path,
bool unload_after_use =
false) = 0;
6943 virtual int registerExtension(
const char* provider,
const char* extension, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6965 virtual int enableExtension(
const char* provider,
const char* extension,
bool enable=
true, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6980 const char* provider,
const char* extension,
6981 const char* key,
const char* value, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6997 const char* provider,
const char* extension,
6998 const char* key,
char* value,
int buf_len, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
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;
7244 virtual int setCameraStabilizationMode(CAMERA_STABILIZATION_MODE mode) = 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)
7387 virtual int setAudioSessionOperationRestriction(AUDIO_SESSION_OPERATION_RESTRICTION restriction) = 0;
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,
7493 virtual int setScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint) = 0;
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__))
7616 virtual int setScreenCaptureScenario(SCREEN_SCENARIO_TYPE screenScenario) = 0;
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;
7756 virtual int stopLocalVideoTranscoder() = 0;
7870 virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0;
7998 virtual int sendRdtMessage(uid_t uid, RdtStreamType type,
const char *data,
size_t length) = 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;
8571 virtual
int startRhythmPlayer(const
char* sound1, const
char* sound2, const AgoraRhythmPlayerConfig& config) = 0;
8646 virtual
int takeSnapshot(uid_t uid, const media::SnapshotConfig& config) = 0;
8667 virtual
int adjustCustomAudioPublishVolume(track_id_t trackId,
int volume) = 0;
8678 virtual
int adjustCustomAudioPlayoutVolume(track_id_t trackId,
int volume) = 0;
8772 virtual int64_t getCurrentMonotonicTimeInMs() = 0;
8872 enum QUALITY_REPORT_FORMAT_TYPE {
8875 QUALITY_REPORT_JSON = 0,
8878 QUALITY_REPORT_HTML = 1,
8882 enum MEDIA_DEVICE_STATE_TYPE {
8885 MEDIA_DEVICE_STATE_IDLE = 0,
8888 MEDIA_DEVICE_STATE_ACTIVE = 1,
8891 MEDIA_DEVICE_STATE_DISABLED = 2,
8895 MEDIA_DEVICE_STATE_PLUGGED_IN = 3,
8899 MEDIA_DEVICE_STATE_NOT_PRESENT = 4,
8902 MEDIA_DEVICE_STATE_UNPLUGGED = 8
8905 enum VIDEO_PROFILE_TYPE {
8907 VIDEO_PROFILE_LANDSCAPE_120P = 0,
8909 VIDEO_PROFILE_LANDSCAPE_120P_3 = 2,
8911 VIDEO_PROFILE_LANDSCAPE_180P = 10,
8913 VIDEO_PROFILE_LANDSCAPE_180P_3 = 12,
8915 VIDEO_PROFILE_LANDSCAPE_180P_4 = 13,
8917 VIDEO_PROFILE_LANDSCAPE_240P = 20,
8919 VIDEO_PROFILE_LANDSCAPE_240P_3 = 22,
8921 VIDEO_PROFILE_LANDSCAPE_240P_4 = 23,
8923 VIDEO_PROFILE_LANDSCAPE_360P = 30,
8925 VIDEO_PROFILE_LANDSCAPE_360P_3 = 32,
8927 VIDEO_PROFILE_LANDSCAPE_360P_4 = 33,
8929 VIDEO_PROFILE_LANDSCAPE_360P_6 = 35,
8931 VIDEO_PROFILE_LANDSCAPE_360P_7 = 36,
8933 VIDEO_PROFILE_LANDSCAPE_360P_8 = 37,
8935 VIDEO_PROFILE_LANDSCAPE_360P_9 = 38,
8937 VIDEO_PROFILE_LANDSCAPE_360P_10 = 39,
8939 VIDEO_PROFILE_LANDSCAPE_360P_11 = 100,
8941 VIDEO_PROFILE_LANDSCAPE_480P = 40,
8943 VIDEO_PROFILE_LANDSCAPE_480P_3 = 42,
8945 VIDEO_PROFILE_LANDSCAPE_480P_4 = 43,
8947 VIDEO_PROFILE_LANDSCAPE_480P_6 = 45,
8949 VIDEO_PROFILE_LANDSCAPE_480P_8 = 47,
8951 VIDEO_PROFILE_LANDSCAPE_480P_9 = 48,
8953 VIDEO_PROFILE_LANDSCAPE_480P_10 = 49,
8955 VIDEO_PROFILE_LANDSCAPE_720P = 50,
8957 VIDEO_PROFILE_LANDSCAPE_720P_3 = 52,
8959 VIDEO_PROFILE_LANDSCAPE_720P_5 = 54,
8961 VIDEO_PROFILE_LANDSCAPE_720P_6 = 55,
8963 VIDEO_PROFILE_LANDSCAPE_1080P = 60,
8965 VIDEO_PROFILE_LANDSCAPE_1080P_3 = 62,
8967 VIDEO_PROFILE_LANDSCAPE_1080P_5 = 64,
8969 VIDEO_PROFILE_LANDSCAPE_1440P = 66,
8971 VIDEO_PROFILE_LANDSCAPE_1440P_2 = 67,
8973 VIDEO_PROFILE_LANDSCAPE_4K = 70,
8975 VIDEO_PROFILE_LANDSCAPE_4K_3 = 72,
8977 VIDEO_PROFILE_PORTRAIT_120P = 1000,
8979 VIDEO_PROFILE_PORTRAIT_120P_3 = 1002,
8981 VIDEO_PROFILE_PORTRAIT_180P = 1010,
8983 VIDEO_PROFILE_PORTRAIT_180P_3 = 1012,
8985 VIDEO_PROFILE_PORTRAIT_180P_4 = 1013,
8987 VIDEO_PROFILE_PORTRAIT_240P = 1020,
8989 VIDEO_PROFILE_PORTRAIT_240P_3 = 1022,
8991 VIDEO_PROFILE_PORTRAIT_240P_4 = 1023,
8993 VIDEO_PROFILE_PORTRAIT_360P = 1030,
8995 VIDEO_PROFILE_PORTRAIT_360P_3 = 1032,
8997 VIDEO_PROFILE_PORTRAIT_360P_4 = 1033,
8999 VIDEO_PROFILE_PORTRAIT_360P_6 = 1035,
9001 VIDEO_PROFILE_PORTRAIT_360P_7 = 1036,
9003 VIDEO_PROFILE_PORTRAIT_360P_8 = 1037,
9005 VIDEO_PROFILE_PORTRAIT_360P_9 = 1038,
9007 VIDEO_PROFILE_PORTRAIT_360P_10 = 1039,
9009 VIDEO_PROFILE_PORTRAIT_360P_11 = 1100,
9011 VIDEO_PROFILE_PORTRAIT_480P = 1040,
9013 VIDEO_PROFILE_PORTRAIT_480P_3 = 1042,
9015 VIDEO_PROFILE_PORTRAIT_480P_4 = 1043,
9017 VIDEO_PROFILE_PORTRAIT_480P_6 = 1045,
9019 VIDEO_PROFILE_PORTRAIT_480P_8 = 1047,
9021 VIDEO_PROFILE_PORTRAIT_480P_9 = 1048,
9023 VIDEO_PROFILE_PORTRAIT_480P_10 = 1049,
9025 VIDEO_PROFILE_PORTRAIT_720P = 1050,
9027 VIDEO_PROFILE_PORTRAIT_720P_3 = 1052,
9029 VIDEO_PROFILE_PORTRAIT_720P_5 = 1054,
9031 VIDEO_PROFILE_PORTRAIT_720P_6 = 1055,
9033 VIDEO_PROFILE_PORTRAIT_1080P = 1060,
9035 VIDEO_PROFILE_PORTRAIT_1080P_3 = 1062,
9037 VIDEO_PROFILE_PORTRAIT_1080P_5 = 1064,
9039 VIDEO_PROFILE_PORTRAIT_1440P = 1066,
9041 VIDEO_PROFILE_PORTRAIT_1440P_2 = 1067,
9043 VIDEO_PROFILE_PORTRAIT_4K = 1070,
9045 VIDEO_PROFILE_PORTRAIT_4K_3 = 1072,
9047 VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_LANDSCAPE_360P,
9072 #define getAgoraRtcEngineVersion getAgoraSdkVersion
9095 #define getAgoraRtcEngineErrorDescription getAgoraSdkErrorDescription
9096 #define setAgoraRtcEngineExternalSymbolLoader setAgoraSdkExternalSymbolLoader
virtual int setDirectCdnStreamingAudioConfiguration(AUDIO_PROFILE_TYPE profile)=0
virtual const char * getErrorDescription(int code)=0
virtual int enableAudioSpectrumMonitor(int intervalInMS=100)=0
virtual int setSubscribeVideoAllowlist(uid_t *uidList, int uidNumber)=0
virtual int adjustRecordingSignalVolume(int volume)=0
virtual int enableWebSdkInteroperability(bool enabled) __deprecated=0
virtual int enableSpatialAudio(bool enabled)=0
const char * extraInfo
Definition: IAgoraRtcEngine.h:786
virtual int setAVSyncSource(const char *channelId, uid_t uid)=0
Definition: AgoraBase.h:7544
const char * appId
Definition: IAgoraRtcEngine.h:3414
virtual int setSubscribeAudioBlocklist(uid_t *uidList, int uidNumber)=0
virtual int sendRdtMessage(uid_t uid, RdtStreamType type, const char *data, size_t length)=0
Send Reliable message to remote uid in channel.
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2836
virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters)=0
virtual void onRtmpStreamingEvent(const char *url, RTMP_STREAMING_EVENT eventCode)
Definition: IAgoraRtcEngine.h:2617
virtual void onExtensionErrorWithContext(const ExtensionContext &context, int error, const char *message)
Definition: IAgoraRtcEngine.h:3021
int regulatedCaptureFrameHeight
Definition: IAgoraRtcEngine.h:307
virtual int setEffectPosition(int soundId, int pos)=0
Definition: AgoraBase.h:7053
int publishDuration
Definition: IAgoraRtcEngine.h:583
Definition: AgoraBase.h:5428
virtual int stopDirectCdnStreaming()=0
Definition: AgoraBase.h:4758
Definition: AgoraBase.h:6375
Definition: AgoraBase.h:6093
virtual int muteAllRemoteVideoStreams(bool mute)=0
virtual int setRemoteVideoSubscriptionOptions(uid_t uid, const VideoSubscriptionOptions &options)=0
Definition: AgoraBase.h:3772
int e2eDelay
Definition: IAgoraRtcEngine.h:528
int audioChannels
Definition: IAgoraRtcEngine.h:708
@ SAVE
Definition: IAgoraRtcEngine.h:3251
int regulatedCaptureFrameWidth
Definition: IAgoraRtcEngine.h:303
virtual int pauseEffect(int soundId)=0
Definition: AgoraBase.h:5111
Definition: AgoraBase.h:1293
virtual int muteLocalVideoStream(bool mute)=0
IRtcEngineEventHandler * eventHandler
Definition: IAgoraRtcEngine.h:3407
virtual int stopPreview(VIDEO_SOURCE_TYPE sourceType)=0
virtual int startScreenCapture(VIDEO_SOURCE_TYPE sourceType, const ScreenCaptureConfiguration &config)=0
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:1818
Definition: IAgoraRtcEngine.h:598
int canvasHeight
Definition: IAgoraRtcEngine.h:647
virtual int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset)=0
int videoHeight
Definition: IAgoraRtcEngine.h:3643
Definition: AgoraBase.h:4688
virtual int enableLocalVideo(bool enabled)=0
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1714
virtual int joinChannel(const char *token, const char *channelId, uid_t uid, const ChannelMediaOptions &options)=0
virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_REASON reason)
Definition: IAgoraRtcEngine.h:2262
virtual void onDirectCdnStreamingStateChanged(DIRECT_CDN_STREAMING_STATE state, DIRECT_CDN_STREAMING_REASON reason, const char *message)
Definition: IAgoraRtcEngine.h:3677
virtual int getAudioTrackCount()=0
virtual void onStreamMessage(uid_t uid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngine.h:2306
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:1896
uid_t uid
Definition: IAgoraRtcEngine.h:278
virtual int stopChannelMediaRelay()=0
virtual void onAudioEffectFinished(int soundId)
Definition: IAgoraRtcEngine.h:1767
virtual float getVideoEffectFloatParam(const char *option, const char *key)=0
Gets a float parameter from the video effect.
Optional< THREAD_PRIORITY_TYPE > threadPriority
Definition: IAgoraRtcEngine.h:3469
virtual int registerAudioEncodedFrameObserver(const AudioEncodedFrameObserverConfig &config, IAudioEncodedFrameObserver *observer)=0
uint32_t frozenTimeByCustom
Definition: IAgoraRtcEngine.h:457
virtual int queryHDRCapability(VIDEO_MODULE_TYPE videoModule, HDR_CAPABILITY &capability)=0
Queries the HDR capability of the video module.
virtual int setFaceShapeBeautyOptions(bool enabled, const FaceShapeBeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
virtual int resumeAllEffects()=0
virtual int joinChannelWithUserAccountEx(const char *token, const char *channelId, const char *userAccount, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
int width
Definition: IAgoraRtcEngine.h:681
virtual int pauseAudioMixing()=0
virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel)=0
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Definition: IAgoraRtcEngine.h:2721
int totalActiveTime
Definition: IAgoraRtcEngine.h:463
Definition: AgoraRefPtr.h:44
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:2461
virtual IVideoDeviceCollection * enumerateVideoDevices()=0
bool stopAudioMixing
Definition: IAgoraRtcEngine.h:1553
virtual const char * getVersion(int *build)=0
int totalActiveTime
Definition: IAgoraRtcEngine.h:579
virtual int setAudioMixingPitch(int pitch)=0
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:1944
int videoWidth
Definition: IAgoraRtcEngine.h:3638
const char * publishUrl
Definition: IAgoraRtcEngine.h:779
virtual int enableVoiceAITuner(bool enabled, VOICE_AI_TUNER_TYPE type)=0
Definition: IAgoraRtcEngine.h:3791
virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Definition: IAgoraRtcEngine.h:2848
uid_t remoteUid
Definition: IAgoraRtcEngine.h:3802
int lifecycle
Definition: IAgoraRtcEngine.h:761
virtual int startPreview()=0
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Definition: IAgoraRtcEngine.h:2121
virtual int setAINSMode(bool enabled, AUDIO_AINS_MODE mode)=0
virtual int updateLocalAudioMixerConfiguration(const LocalAudioMixerConfiguration &config)=0
virtual void onCameraExposureAreaChanged(int x, int y, int width, int height)
Definition: IAgoraRtcEngine.h:2186
Definition: AgoraBase.h:7345
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngine.h:2576
virtual int getDevice(int index, char deviceNameUTF8[MAX_DEVICE_ID_LENGTH], char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
int videoBitrate
Definition: IAgoraRtcEngine.h:3653
virtual void onLastmileQuality(int quality)
Definition: IAgoraRtcEngine.h:1846
virtual int enableInstantMediaRendering()=0
Enable instant media rendering.
virtual int setRemoteRenderMode(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
Definition: AgoraBase.h:4332
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Definition: IAgoraRtcEngine.h:2745
VIDEO_EFFECT_ACTION
Actions that can be performed on video effect nodes.
Definition: IAgoraRtcEngine.h:3249
int sentFrameRate
Definition: IAgoraRtcEngine.h:286
Definition: AgoraBase.h:2281
virtual int setDirectCdnStreamingVideoConfiguration(const VideoEncoderConfiguration &config)=0
virtual int createDataStream(int *streamId, bool reliable, bool ordered)=0
virtual int setVolumeOfEffect(int soundId, int volume)=0
virtual void onUserInfoUpdated(uid_t uid, const UserInfo &info)
Definition: IAgoraRtcEngine.h:2825
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: IAgoraRtcEngine.h:2775
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:2449
int videoFramerate
Definition: IAgoraRtcEngine.h:693
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig)=0
virtual int stopAudioFrameDump(const char *channel_id, uid_t uid, const char *location)=0
virtual int enableAudioVolumeIndication(int interval, int smooth, bool reportVad)=0
virtual int registerPacketObserver(IPacketObserver *observer)=0
int networkTransportDelay
Definition: IAgoraRtcEngine.h:384
virtual int unregisterMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
virtual void onLocalVideoTranscoderError(const TranscodingVideoStream &stream, VIDEO_TRANSCODER_ERROR error)
Definition: IAgoraRtcEngine.h:2860
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo *userInfo)=0
virtual int pauseAllEffects()=0
virtual int disableAudioSpectrumMonitor()=0
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:2429
Definition: AgoraBase.h:100
int sentBitrate
Definition: IAgoraRtcEngine.h:282
virtual int getAudioMixingPublishVolume()=0
virtual int addVideoWatermark(const char *watermarkUrl, const WatermarkOptions &options)=0
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1611
int totalFrozenTime
Definition: IAgoraRtcEngine.h:565
virtual void onMultipathStats(const MultipathStats &stats)
Report the multipath transmission statistics.
Definition: IAgoraRtcEngine.h:3045
virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType)=0
int receivedBitrate
Definition: IAgoraRtcEngine.h:407
Definition: AgoraBase.h:1960
Definition: IAgoraRtcEngine.h:1580
double height
Definition: IAgoraRtcEngine.h:614
virtual int leaveChannel(const LeaveChannelOptions &options)=0
virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual int startAudioMixing(const char *filePath, bool loopback, int cycle, int startPos)=0
virtual void onUserMuteAudio(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:2037
Definition: AgoraBase.h:1649
virtual int registerLocalUserAccount(const char *appId, const char *userAccount)=0
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Definition: IAgoraRtcEngine.h:1830
Definition: AgoraBase.h:7030
Definition: AgoraBase.h:4142
const char * backgroundColor
Definition: IAgoraRtcEngine.h:650
virtual int getAudioMixingCurrentPosition()=0
virtual int startDirectCdnStreaming(IDirectCdnStreamingEventHandler *eventHandler, const char *publishUrl, const DirectCdnStreamingMediaOptions &options)=0
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
int encodedBitrate
Definition: IAgoraRtcEngine.h:333
QUALITY_ADAPT_INDICATION qualityAdaptIndication
Definition: IAgoraRtcEngine.h:329
virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig &streamConfig) __deprecated=0
Definition: AgoraBase.h:2175
virtual void onConnectionInterrupted() __deprecated
Definition: IAgoraRtcEngine.h:2288
virtual int setMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall)=0
virtual int getVolumeOfEffect(int soundId)=0
Face shape beauty options. This structure defines options for facial adjustments of different facial ...
Definition: AgoraBase.h:5389
virtual int setSubscribeAudioAllowlist(uid_t *uidList, int uidNumber)=0
virtual CONNECTION_STATE_TYPE getConnectionState()=0
const char * channelId
Definition: IAgoraRtcEngine.h:3815
virtual bool isFeatureAvailableOnDevice(FeatureType type)=0
Whether the target feature is available for the device.
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 enableEncryption(bool enabled, const EncryptionConfig &config)=0
virtual int getFaceShapeBeautyOptions(FaceShapeBeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
virtual int enableContentInspect(bool enabled, const media::ContentInspectConfig &config)=0
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:2501
virtual int startRhythmPlayer(const char *sound1, const char *sound2, const AgoraRhythmPlayerConfig &config)=0
virtual int configRhythmPlayer(const AgoraRhythmPlayerConfig &config)=0
virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel, int samplesPerCall)=0
Definition: AgoraMediaBase.h:41
VIDEO_EFFECT_NODE_ID
Types of video effect nodes that can be applied.
Definition: IAgoraRtcEngine.h:3235
virtual int adjustAudioMixingPublishVolume(int volume)=0
virtual int getAudioMixingDuration()=0
virtual int destroyMediaRecorder(agora_refptr< IMediaRecorder > mediaRecorder)=0
uint32_t frozenRateByCustomPlcCount
Definition: IAgoraRtcEngine.h:441
ScreenCaptureParameters params
Definition: IAgoraRtcEngine.h:893
virtual void onVideoDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1778
const char * appData
Definition: IAgoraRtcEngine.h:660
virtual int setVideoEffectBoolParam(const char *option, const char *key, bool param)=0
Sets a boolean parameter for the video effect.
int totalFrozenTime
Definition: IAgoraRtcEngine.h:414
virtual int setVideoEffectFloatParam(const char *option, const char *key, float param)=0
Sets a float parameter for the video effect.
virtual void onAudioMixingPositionChanged(int64_t position)
Reports current AudioMixing progress.
Definition: IAgoraRtcEngine.h:1750
virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain)=0
virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
Definition: AgoraBase.h:5551
int defaultLayout
Definition: IAgoraRtcEngine.h:758
virtual void onTranscodingUpdated()
Definition: IAgoraRtcEngine.h:2632
virtual int updateRtmpTranscoding(const LiveTranscoding &transcoding)=0
int64_t displayId
Definition: IAgoraRtcEngine.h:879
int publishDuration
Definition: IAgoraRtcEngine.h:467
virtual void onRequestToken()
Definition: IAgoraRtcEngine.h:2393
virtual void onError(int err, const char *msg)
Definition: IAgoraRtcEngine.h:1637
Definition: AgoraBase.h:6644
virtual uint64_t getNtpWallTimeInMs()=0
virtual int startRtmpStreamWithoutTranscoding(const char *url)=0
int regionCount
Definition: IAgoraRtcEngine.h:657
agora::media::MEDIA_SOURCE_TYPE mediaSourceType
Definition: IAgoraRtcEngine.h:3795
virtual void onProxyConnected(const char *channel, uid_t uid, PROXY_TYPE proxyType, const char *localProxyIp, int elapsed)
Definition: IAgoraRtcEngine.h:1624
virtual void onExtensionEventWithContext(const ExtensionContext &context, const char *key, const char *value)
Definition: IAgoraRtcEngine.h:2983
virtual int enableExtension(const char *provider, const char *extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
virtual void onUserStateChanged(uid_t uid, REMOTE_USER_STATE state)
Definition: IAgoraRtcEngine.h:2083
int height
Definition: IAgoraRtcEngine.h:744
virtual void onAudioMixingFinished() __deprecated
Definition: IAgoraRtcEngine.h:1758
Definition: IAgoraRtcEngine.h:9057
VIDEO_CODEC_TYPE codecType
Definition: IAgoraRtcEngine.h:339
uid_t localUid
Definition: IAgoraRtcEngine.h:3820
virtual int setSubscribeVideoBlocklist(uid_t *uidList, int uidNumber)=0
Definition: AgoraBase.h:4556
virtual int adjustAudioMixingPlayoutVolume(int volume)=0
virtual int removeVideoWatermark(const char *id)=0
Remove a watermark image from the local video.
int audioBitrate
Definition: IAgoraRtcEngine.h:705
virtual int setCameraDeviceOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation)=0
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngine.h:1699
virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngine.h:2326
Definition: AgoraBase.h:3824
bool dualStreamEnabled
Definition: IAgoraRtcEngine.h:350
virtual int writeLog(commons::LOG_LEVEL level, const char *fmt,...)=0
unsigned int rxAudioBytes
Definition: IAgoraRtcEngine.h:479
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode)=0
Definition: IAgoraRtcEngine.h:3634
uid_t uid
Definition: IAgoraRtcEngine.h:516
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2020
virtual int registerExtension(const char *provider, const char *extension, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
virtual int stopRtmpStream(const char *url)=0
Definition: AgoraBase.h:2130
virtual void onCameraFocusAreaChanged(int x, int y, int width, int height)
Definition: IAgoraRtcEngine.h:2172
double y
Definition: IAgoraRtcEngine.h:608
virtual int stopAudioMixing()=0
@ RESET
Definition: IAgoraRtcEngine.h:3253
Definition: IAgoraRtcEngine.h:736
virtual void onExtensionStartedWithContext(const ExtensionContext &context)
Definition: IAgoraRtcEngine.h:2996
virtual int setLogLevel(commons::LOG_LEVEL level)=0
commons::LogConfig logConfig
Definition: IAgoraRtcEngine.h:3464
virtual int setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType)=0
Definition: AgoraBase.h:4665
virtual int setRemoteVideoStreamType(uid_t uid, VIDEO_STREAM_TYPE streamType)=0
virtual void onUserEnableVideo(uid_t uid, bool enabled)
Definition: IAgoraRtcEngine.h:2073
virtual void onRtmpStreamingStateChanged(const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_REASON reason)
Definition: IAgoraRtcEngine.h:2605
int height
Definition: IAgoraRtcEngine.h:685
virtual int destroyVideoEffectObject(agora_refptr< IVideoEffectObject > videoEffectObject)=0
Destroys a video effect object.
virtual int startRtmpStreamWithTranscoding(const char *url, const LiveTranscoding &transcoding)=0
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config)=0
Definition: IAgoraRtcEngine.h:1055
virtual int queryCodecCapability(CodecCapInfo *codecInfo, int &size)=0
virtual int stopAllEffects()=0
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode) __deprecated=0
virtual int pauseAllChannelMediaRelay()=0
int captureFrameHeight
Definition: IAgoraRtcEngine.h:295
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) __deprecated
Definition: IAgoraRtcEngine.h:1657
virtual int startAudioMixing(const char *filePath, bool loopback, int cycle)=0
virtual int adjustLoopbackSignalVolume(int volume)=0
virtual int takeSnapshot(uid_t uid, const char *filePath)=0
const char * license
Definition: IAgoraRtcEngine.h:3429
Rectangle regionRect
Definition: IAgoraRtcEngine.h:901
int canvasWidth
Definition: IAgoraRtcEngine.h:642
virtual int sendMediaControlMessage(uid_t uid, const char *data, size_t length)=0
Send media control message.
bool stopMicrophoneRecording
Definition: IAgoraRtcEngine.h:1565
const char * rawStreamUrl
Definition: IAgoraRtcEngine.h:783
int mosValue
Definition: IAgoraRtcEngine.h:436
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Definition: IAgoraRtcEngine.h:2151
virtual int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2)=0
virtual int setColorEnhanceOptions(bool enabled, const ColorEnhanceOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
virtual void onTokenPrivilegeWillExpire(const char *token)
Definition: IAgoraRtcEngine.h:2406
int targetFrameRate
Definition: IAgoraRtcEngine.h:325
int audioBitrate
Definition: IAgoraRtcEngine.h:3658
virtual int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option)=0
virtual int getExtensionProperty(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, const char *key, char *value, int buf_len)=0
CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraRtcEngine.h:3424
virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool isFallbackOrRecover)
Definition: IAgoraRtcEngine.h:2702
virtual int setEarMonitoringAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: IAgoraRtcEngine.h:2529
virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1738
Definition: AgoraBase.h:6392
Definition: IAgoraRtcEngine.h:1547
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Definition: IAgoraRtcEngine.h:2110
virtual int setEffectsVolume(int volume)=0
virtual int playAllEffects(int loopCount, double pitch, double pan, int gain, bool publish=false)=0
int fps
Definition: IAgoraRtcEngine.h:3648
virtual int stopLastmileProbeTest()=0
virtual int setAdvancedAudioOptions(AdvancedAudioOptions &options, int sourceType=0)=0
virtual agora_refptr< IMediaPlayer > createMediaPlayer()=0
virtual int queryInterface(INTERFACE_ID_TYPE iid, void **inter)=0
Definition: IAgoraRtcEngine.h:3070
virtual int renewToken(const char *token)=0
virtual int pauseAudio() __deprecated=0
virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile)=0
virtual int sendStreamMessage(int streamId, const char *data, size_t length)=0
unsigned short txPacketLossRate
Definition: IAgoraRtcEngine.h:343
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats &stats)
Definition: IAgoraRtcEngine.h:2138
int avSyncTimeMs
Definition: IAgoraRtcEngine.h:574
virtual int setFilterEffectOptions(bool enabled, const FilterEffectOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
bool domainLimit
Definition: IAgoraRtcEngine.h:3485
Definition: AgoraBase.h:5503
virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) __deprecated=0
int decoderOutputFrameRate
Definition: IAgoraRtcEngine.h:546
void * context
Definition: IAgoraRtcEngine.h:3420
virtual int stopLocalAudioMixer()=0
virtual void onActiveSpeaker(uid_t uid)
Definition: IAgoraRtcEngine.h:2521
uint32_t frozenCntByCustom
Definition: IAgoraRtcEngine.h:451
int e2eDelay
Definition: IAgoraRtcEngine.h:483
virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1858
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1595
int audioLossRate
Definition: IAgoraRtcEngine.h:394
int zOrder
Definition: IAgoraRtcEngine.h:618
virtual int queryDeviceScore()=0
int captureFrameRate
Definition: IAgoraRtcEngine.h:289
Definition: AgoraBase.h:5577
virtual int setParameters(const char *parameters)=0
virtual int muteRemoteVideoStream(uid_t uid, bool mute)=0
virtual int setLowlightEnhanceOptions(bool enabled, const LowlightEnhanceOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Definition: IAgoraRtcEngine.h:3114
int frozenRate
Definition: IAgoraRtcEngine.h:569
int64_t windowId
Definition: IAgoraRtcEngine.h:889
virtual int enableLocalAudio(bool enabled)=0
virtual int setupLocalVideo(const VideoCanvas &canvas)=0
int appDataLength
Definition: IAgoraRtcEngine.h:663
virtual int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value)=0
virtual int stopEffect(int soundId)=0
double alpha
Definition: IAgoraRtcEngine.h:623
virtual int enableCustomAudioLocalPlayback(track_id_t trackId, bool enabled)=0
virtual int addOrUpdateVideoEffect(uint32_t nodeId, const char *templateName)=0
Adds or updates video effects with specified node ID and template.
bool isCaptureWindow
Definition: IAgoraRtcEngine.h:875
int encodedFrameHeight
Definition: IAgoraRtcEngine.h:316
virtual void onAudioMetadataReceived(uid_t uid, const char *metadata, size_t length)
Definition: IAgoraRtcEngine.h:2968
virtual int setLocalVoiceFormant(double formantRatio)=0
Optional< int > audioProcessingChannels
Definition: IAgoraRtcEngine.h:1059
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
virtual int setLogFile(const char *filePath)=0
virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource, SegmentationProperty segproperty, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration &config)=0
FACE_SHAPE_AREA
The specific facial area to be adjusted.
Definition: AgoraBase.h:5174
int delay __deprecated
Definition: IAgoraRtcEngine.h:524
Optional< const char * > deviceId
Definition: IAgoraRtcEngine.h:852
int quality
Definition: IAgoraRtcEngine.h:380
int width
Definition: IAgoraRtcEngine.h:740
double width
Definition: IAgoraRtcEngine.h:612
virtual int startEchoTest(const EchoTestConfiguration &config)=0
virtual int startOrUpdateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration)=0
virtual void onConnectionBanned() __deprecated
Definition: IAgoraRtcEngine.h:2293
virtual int getEffectsVolume()=0
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngine.h:2786
virtual void onCameraReady() __deprecated
Definition: IAgoraRtcEngine.h:2160
virtual int getEffectDuration(const char *filePath)=0
Definition: AgoraBase.h:1937
Definition: IAgoraLog.h:83
virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
virtual int setLogFileSize(unsigned int fileSizeInKBytes)=0
virtual void onRenewTokenResult(const char *token, RENEW_TOKEN_ERROR_CODE code)
Reports the result of calling renewToken.
Definition: IAgoraRtcEngine.h:3061
bool stopAllEffect
Definition: IAgoraRtcEngine.h:1559
virtual int preloadChannelWithUserAccount(const char *token, const char *channelId, const char *userAccount)=0
unsigned int rxVideoBytes
Definition: IAgoraRtcEngine.h:595
AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine()
virtual int setBeautyEffectOptions(bool enabled, const BeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
virtual int startAudioRecording(const AudioRecordingConfiguration &config)=0
bool autoRegisterAgoraExtensions
Definition: IAgoraRtcEngine.h:3492
Definition: IAgoraRtcEngine.h:274
virtual int setAudioMixingPlaybackSpeed(int speed)=0
virtual agora_refptr< IVideoEffectObject > createVideoEffectObject(const char *bundlePath, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Creates a video effect object and returns its pointer.
Aggregates statistics for all network paths used in multipath transmission.
Definition: AgoraBase.h:2625
virtual int resumeAllChannelMediaRelay()=0
virtual int setExtensionProperty(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, const char *key, const char *value)=0
Definition: IAgoraRtcEngine.h:3667
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:2480
virtual int setRemoteRenderTargetFps(int targetFps)=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 onVideoStopped() __deprecated
Definition: IAgoraRtcEngine.h:2240
Definition: AgoraBase.h:6811
virtual int destroyMediaPlayer(agora_refptr< IMediaPlayer > media_player)=0
VideoDimensions simulcastDimensions[SimulcastConfig::STREAM_LAYER_COUNT_MAX]
Definition: IAgoraRtcEngine.h:358
virtual int setAudioMixingPosition(int pos)=0
virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2935
int receivedBitrate
Definition: IAgoraRtcEngine.h:540
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
Definition: IAgoraRtcEngine.h:372
Definition: AgoraBase.h:4480
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
int encoderOutputFrameRate
Definition: IAgoraRtcEngine.h:310
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
virtual int performVideoEffectAction(uint32_t nodeId, VIDEO_EFFECT_ACTION actionId)=0
Performs an action on a specified video effect node.
virtual int setupRemoteVideo(const VideoCanvas &canvas)=0
virtual void onLastmileProbeResult(const LastmileProbeResult &result)
Definition: IAgoraRtcEngine.h:1669
virtual int startDeviceTest(view_t hwnd)=0
virtual int addVideoWatermark(const RtcImage &watermark) __deprecated=0
virtual bool getVideoEffectBoolParam(const char *option, const char *key)=0
Gets a boolean parameter from the video effect.
virtual void onConnectionLost()
Definition: IAgoraRtcEngine.h:2275
virtual void onUserMuteVideo(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:2056
bool owner
Definition: IAgoraRtcEngine.h:766
virtual int setInEarMonitoringVolume(int volume)=0
virtual int enableSoundPositionIndication(bool enabled)=0
const Region * regions
Definition: IAgoraRtcEngine.h:654
virtual int stopCameraCapture(VIDEO_SOURCE_TYPE sourceType)=0
virtual int stopPreview()=0
int mosValue
Definition: IAgoraRtcEngine.h:591
virtual int setVideoEffectIntParam(const char *option, const char *key, int param)=0
Sets an integer parameter for the video effect.
Defines the configuration for a watermark.
Definition: AgoraBase.h:2515
virtual int destroyCustomEncodedVideoTrack(video_track_id_t video_track_id)=0
virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngine.h:1911
virtual int muteRecordingSignal(bool mute)=0
virtual void onLocalUserRegistered(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2812
int encodedFrameWidth
Definition: IAgoraRtcEngine.h:313
Definition: AgoraBase.h:2672
Definition: AgoraBase.h:5455
virtual int setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset, int param1, int param2)=0
virtual int muteRemoteAudioStream(uid_t uid, bool mute)=0
virtual int setVideoDenoiserOptions(bool enabled, const VideoDenoiserOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
Definition: IAgoraRtcEngine.h:2548
virtual int destroyCustomVideoTrack(video_track_id_t video_track_id)=0
virtual int setVoiceConversionParameters(VOICE_CONVERSION_PRESET preset, int param1, int param2)=0
@ STREAM_LAYER_COUNT_MAX
Definition: AgoraBase.h:2236
virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1975
virtual int adjustAudioMixingVolume(int volume)=0
Definition: AgoraBase.h:2341
Definition: AgoraBase.h:3949
virtual int setLocalRenderTargetFps(VIDEO_SOURCE_TYPE sourceType, int targetFps)=0
Definition: AgoraBase.h:7393
virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted)
Definition: IAgoraRtcEngine.h:2588
Definition: AgoraBase.h:2200
virtual int leaveChannel()=0
virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario)=0
virtual int setClientRole(CLIENT_ROLE_TYPE role)=0
virtual int preloadChannel(const char *token, const char *channelId, uid_t uid)=0
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: IAgoraRtcEngine.h:2563
int width
Definition: IAgoraRtcEngine.h:532
AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraRtcEngine.h:3438
int rendererOutputFrameRate
Definition: IAgoraRtcEngine.h:549
virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset)=0
int decoderInputFrameRate
Definition: IAgoraRtcEngine.h:543
virtual int rate(const char *callId, int rating, const char *description)=0
int targetBitrate
Definition: IAgoraRtcEngine.h:322
Definition: AgoraRefPtr.h:31
int qualityChangedReason
Definition: IAgoraRtcEngine.h:475
virtual int getCallId(agora::util::AString &callId)=0
Definition: IAgoraRtcEngine.h:677
virtual int uploadLogFile(agora::util::AString &requestId)=0
virtual int startMediaRenderingTracing()=0
Start tracing media rendering events.
VideoFormat format
Definition: IAgoraRtcEngine.h:863
int encodedFrameCount
Definition: IAgoraRtcEngine.h:336
int bitrate
Definition: IAgoraRtcEngine.h:752
int regulatedCaptureFrameRate
Definition: IAgoraRtcEngine.h:299
virtual video_track_id_t createCustomEncodedVideoTrack(const SenderOptions &sender_option)=0
Definition: IAgoraRtcEngine.h:3403
virtual int unloadAllEffects()=0
Provides methods to manage and configure video effects, such as beauty, style makeup,...
Definition: IAgoraRtcEngine.h:3226
Definition: IAgoraRtcEngine.h:3841
virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions &options)=0
virtual int enableLoopbackRecording(bool enabled, const char *deviceName=NULL)=0
virtual int sendAudioMetadata(const char *metadata, size_t length)=0
send audio metadata
virtual agora_refptr< IMediaRecorder > createMediaRecorder(const RecorderStreamInfo &info)=0
virtual int addVideoWatermark(const WatermarkConfig &configs)=0
Add a watermark image to the local video.
Definition: IAgoraRtcEngine.h:869
virtual int setAudioMixingDualMonoMode(media::AUDIO_MIXING_DUAL_MONO_MODE mode)=0
Definition: AgoraBase.h:6295
virtual int getEffectCurrentPosition(int soundId)=0
virtual int updatePreloadChannelToken(const char *token)=0
virtual int resumeAudio() __deprecated=0
virtual int muteLocalAudioStream(bool mute)=0
virtual int joinChannelWithUserAccount(const char *token, const char *channelId, const char *userAccount)=0
virtual int setChannelProfile(CHANNEL_PROFILE_TYPE profile)=0
int frameLossRate
Definition: IAgoraRtcEngine.h:552
Definition: AgoraBase.h:1139
virtual int updateDirectCdnStreamingMediaOptions(const DirectCdnStreamingMediaOptions &options)=0
virtual int setLocalVoicePitch(double pitch)=0
virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Definition: IAgoraRtcEngine.h:2952
int height
Definition: IAgoraRtcEngine.h:536
int captureFrameWidth
Definition: IAgoraRtcEngine.h:292
virtual int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset)=0
static AGORA_CPP_API void release(RtcEngineReleaseCallback callback=nullptr)
bool useExternalEglContext
Definition: IAgoraRtcEngine.h:3478
virtual int preloadEffect(int soundId, const char *filePath, int startPos=0)=0
int frozenRate
Definition: IAgoraRtcEngine.h:419
virtual int setVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType)=0
uint32_t plcCount
Definition: IAgoraRtcEngine.h:445
virtual int stopEchoTest()=0
virtual int startAudioRecording(const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality)=0
virtual int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain)=0
Definition: AgoraBase.h:156
virtual int getNetworkType()=0
AUDIO_SAMPLE_RATE_TYPE audioSampleRate
Definition: IAgoraRtcEngine.h:701
virtual int enableExtension(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, bool enable=true)=0
int framerate
Definition: IAgoraRtcEngine.h:748
virtual int resumeEffect(int soundId)=0
const char * injectStreamUrl
Definition: IAgoraRtcEngine.h:775
virtual void onAudioRoutingChanged(int routing)
Definition: IAgoraRtcEngine.h:2647
virtual int playEffect(int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish=false, int startPos=0)=0
int videoBitrate
Definition: IAgoraRtcEngine.h:697
CAPTURE_BRIGHTNESS_LEVEL_TYPE captureBrightnessLevel
Definition: IAgoraRtcEngine.h:346
virtual int enableVideo()=0
virtual void onExtensionStoppedWithContext(const ExtensionContext &context)
Definition: IAgoraRtcEngine.h:3007
virtual int setRemoteUserSpatialAudioParams(uid_t uid, const agora::SpatialAudioParams ¶ms)=0
virtual int setHeadphoneEQParameters(int lowGain, int highGain)=0
virtual int removeVideoEffect(uint32_t nodeId)=0
Removes a video effect with specified node ID.
virtual int getFaceShapeAreaOptions(agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA shapeArea, FaceShapeAreaOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed)
Definition: IAgoraRtcEngine.h:1875
virtual int stopScreenCapture(VIDEO_SOURCE_TYPE sourceType)=0
virtual int updateChannelMediaOptions(const ChannelMediaOptions &options)=0
int numChannels
Definition: IAgoraRtcEngine.h:398
virtual void onSetRtmFlagResult(int code)
Definition: IAgoraRtcEngine.h:3033
virtual int createDataStream(int *streamId, const DataStreamConfig &config)=0
virtual int initialize(const RtcEngineContext &context)=0
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngine.h:1806
virtual int resumeAudioMixing()=0
Definition: IAgoraRtcEngine.h:1065
virtual int unloadEffect(int soundId)=0
Definition: IAgoraRtcEngine.h:599
virtual int stopRhythmPlayer()=0
virtual int getAudioMixingPlayoutVolume()=0
virtual int startLastmileProbeTest(const LastmileProbeConfig &config)=0
virtual void onVideoSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2903
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
int jitterBufferDelay
Definition: IAgoraRtcEngine.h:390
virtual int adjustPlaybackSignalVolume(int volume)=0
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1961
virtual int setExtensionProviderProperty(const char *provider, const char *key, const char *value)=0
int injectStreamWidth
Definition: IAgoraRtcEngine.h:769
virtual int startLocalAudioMixer(const LocalAudioMixerConfiguration &config)=0
VIDEO_STREAM_TYPE rxStreamType
Definition: IAgoraRtcEngine.h:559
virtual int enableAudio()=0
virtual int stopDeviceTest()=0
uid_t uid
Definition: IAgoraRtcEngine.h:376
virtual int disableVideo()=0
virtual int enableDualStreamMode(bool enabled) __deprecated=0
int videoGop
Definition: IAgoraRtcEngine.h:689
virtual int setVideoQoEPreference(VIDEO_QOE_PREFERENCE_TYPE qoePreference)=0
Face shape area options. This structure defines options for facial adjustments on different facial ar...
Definition: AgoraBase.h:5168
Definition: AgoraBase.h:7507
int encodedFrameDepth
Definition: IAgoraRtcEngine.h:365
virtual int setLogFilter(unsigned int filter)=0
virtual int getLoopbackRecordingVolume()=0
virtual void onPermissionError(PERMISSION_TYPE permissionType)
Definition: IAgoraRtcEngine.h:2799
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngine.h:2871
int qoeQuality
Definition: IAgoraRtcEngine.h:471
virtual int setFaceShapeAreaOptions(const FaceShapeAreaOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
virtual int setHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset)=0
virtual int startCameraCapture(VIDEO_SOURCE_TYPE sourceType, const CameraCapturerConfiguration &config)=0
virtual int setLocalAccessPoint(const LocalAccessPointConfiguration &config)=0
virtual void onRdtStateChanged(uid_t userId, RdtState state)
Occurs when the RDT tunnel state changed.
Definition: IAgoraRtcEngine.h:2362
virtual video_track_id_t createCustomVideoTrack()=0
virtual int disableAudio()=0
virtual int muteAllRemoteAudioStreams(bool mute)=0
virtual void onRtcStats(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1723
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:2001
Definition: IAgoraRtcEngine.h:9050
virtual int sendCustomReportMessage(const char *id, const char *category, const char *event, const char *label, int value)=0
Definition: AgoraBase.h:1950
int packetLossRate
Definition: IAgoraRtcEngine.h:555
int hwEncoderAccelerating
Definition: IAgoraRtcEngine.h:355
Definition: AgoraBase.h:3810
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
Definition: AgoraBase.h:7473
int rendererOutputFrameRate
Definition: IAgoraRtcEngine.h:319
Definition: AgoraBase.h:7244
virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2249
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
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 setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) __deprecated=0
unsigned int areaCode
Definition: IAgoraRtcEngine.h:3447
virtual int setSimulcastConfig(const SimulcastConfig &simulcastConfig)=0
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: IAgoraRtcEngine.h:2415
Definition: IAgoraRtcEngine.h:833
virtual int selectAudioTrack(int index)=0
Definition: IAgoraRtcEngine.h:512
virtual int startAudioRecording(const char *filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality)=0
int injectStreamHeight
Definition: IAgoraRtcEngine.h:772
Definition: AgoraOptional.h:52
virtual int joinChannel(const char *token, const char *channelId, const char *info, uid_t uid)=0
Definition: AgoraBase.h:2927
virtual int setRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
Rectangle screenRect
Definition: IAgoraRtcEngine.h:884
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) __deprecated
Definition: IAgoraRtcEngine.h:2098
virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual void onChannelMediaRelayStateChanged(int state, int code)
Definition: IAgoraRtcEngine.h:2680
virtual int complain(const char *callId, const char *description)=0
virtual int clearVideoWatermarks()=0
virtual int stopAudioRecording()=0
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2919
virtual int setHighPriorityUserList(uid_t *uidList, int uidNum, STREAM_FALLBACK_OPTIONS option)=0
virtual int setScreenCaptureOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation)=0
int receivedSampleRate
Definition: IAgoraRtcEngine.h:402
virtual int startPreview(VIDEO_SOURCE_TYPE sourceType)=0
Definition: AgoraBase.h:4983
uid_t uid
Definition: IAgoraRtcEngine.h:602
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2760
virtual int getVideoEffectIntParam(const char *option, const char *key)=0
Gets an integer parameter from the video effect.
Definition: AgoraBase.h:5658
double x
Definition: IAgoraRtcEngine.h:605