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"
23 enum MEDIA_DEVICE_TYPE {
27 UNKNOWN_AUDIO_DEVICE = -1,
31 AUDIO_PLAYOUT_DEVICE = 0,
35 AUDIO_RECORDING_DEVICE = 1,
39 VIDEO_RENDER_DEVICE = 2,
43 VIDEO_CAPTURE_DEVICE = 3,
47 AUDIO_APPLICATION_PLAYOUT_DEVICE = 4,
53 enum AUDIO_MIXING_STATE_TYPE {
55 AUDIO_MIXING_STATE_PLAYING = 710,
57 AUDIO_MIXING_STATE_PAUSED = 711,
59 AUDIO_MIXING_STATE_STOPPED = 713,
63 AUDIO_MIXING_STATE_FAILED = 714,
65 AUDIO_MIXING_STATE_COMPLETED = 715,
67 AUDIO_MIXING_STATE_ALL_LOOPS_COMPLETED = 716,
73 enum AUDIO_MIXING_ERROR_TYPE {
75 AUDIO_MIXING_ERROR_CAN_NOT_OPEN = 701,
77 AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL = 702,
79 AUDIO_MIXING_ERROR_INTERRUPTED_EOF = 703,
81 AUDIO_MIXING_ERROR_OK = 0,
87 enum INJECT_STREAM_STATUS {
91 INJECT_STREAM_STATUS_START_SUCCESS = 0,
95 INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1,
99 INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2,
103 INJECT_STREAM_STATUS_START_TIMEDOUT = 3,
107 INJECT_STREAM_STATUS_START_FAILED = 4,
111 INJECT_STREAM_STATUS_STOP_SUCCESS = 5,
115 INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6,
119 INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7,
123 INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8,
127 INJECT_STREAM_STATUS_STOP_FAILED = 9,
131 INJECT_STREAM_STATUS_BROKEN = 10,
137 enum AUDIO_EQUALIZATION_BAND_FREQUENCY {
141 AUDIO_EQUALIZATION_BAND_31 = 0,
145 AUDIO_EQUALIZATION_BAND_62 = 1,
149 AUDIO_EQUALIZATION_BAND_125 = 2,
153 AUDIO_EQUALIZATION_BAND_250 = 3,
157 AUDIO_EQUALIZATION_BAND_500 = 4,
161 AUDIO_EQUALIZATION_BAND_1K = 5,
165 AUDIO_EQUALIZATION_BAND_2K = 6,
169 AUDIO_EQUALIZATION_BAND_4K = 7,
173 AUDIO_EQUALIZATION_BAND_8K = 8,
177 AUDIO_EQUALIZATION_BAND_16K = 9,
183 enum AUDIO_REVERB_TYPE {
187 AUDIO_REVERB_DRY_LEVEL = 0,
191 AUDIO_REVERB_WET_LEVEL = 1,
195 AUDIO_REVERB_ROOM_SIZE = 2,
199 AUDIO_REVERB_WET_DELAY = 3,
203 AUDIO_REVERB_STRENGTH = 4,
206 enum STREAM_FALLBACK_OPTIONS {
210 STREAM_FALLBACK_OPTION_DISABLED = 0,
215 STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1,
219 STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2,
228 PRIORITY_NORMAL = 100,
410 media::base::RENDER_MODE_TYPE
421 renderMode(media::base::RENDER_MODE_HIDDEN) {}
511 enum RTMP_STREAM_LIFE_CYCLE_TYPE {
514 RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL = 1,
517 RTMP_STREAM_LIFE_CYCLE_BIND2OWNER = 2,
580 lifecycle(RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL),
591 bool enableLocalPlayback;
595 enum CAMERA_DIRECTION {
606 enum CLOUD_PROXY_TYPE {
623 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
624 CAMERA_DIRECTION cameraDirection;
630 bool followEncodeDimensionRatio;
632 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
633 cameraDirection = CAMERA_REAR;
641 bool isCaptureWindow;
651 #if (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
662 SIZE() : width(0), height(0) {}
663 SIZE(
int ww,
int hh) : width(ww), height(hh) {}
667 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
668 struct ThumbImageBuffer {
673 ThumbImageBuffer() : buffer(nullptr), length(0), width(0), height(0) {}
676 enum ScreenCaptureSourceType {
677 ScreenCaptureSourceType_Unknown = -1,
678 ScreenCaptureSourceType_Window = 0,
679 ScreenCaptureSourceType_Screen = 1,
680 ScreenCaptureSourceType_Custom = 2,
683 struct ScreenCaptureSourceInfo {
684 ScreenCaptureSourceType type;
687 const char* sourceName;
688 ThumbImageBuffer thumbImage;
689 ThumbImageBuffer iconImage;
691 const char* processPath;
692 const char* sourceTitle;
695 ScreenCaptureSourceInfo() : type(ScreenCaptureSourceType_Unknown), sourceId(nullptr), sourceName(nullptr),
696 processPath(nullptr), sourceTitle(nullptr), primaryMonitor(false), isOccluded(false) {}
699 class IScreenCaptureSourceList {
701 virtual ~IScreenCaptureSourceList(){};
704 virtual unsigned int getCount() = 0;
705 virtual ScreenCaptureSourceInfo getSourceInfo(
unsigned int index) = 0;
706 virtual void release() = 0;
708 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
711 const char* imageUrl;
893 void SetAll(
const ChannelMediaOptions& change) {
894 #define SET_FROM(X) SetFrom(&X, change.X)
929 bool operator==(
const ChannelMediaOptions& o)
const {
930 #define BEGIN_COMPARE() bool b = true
931 #define ADD_COMPARE(X) b = (b && (X == o.X))
932 #define END_COMPARE()
973 ChannelMediaOptions& operator=(
const ChannelMediaOptions& replace) {
974 if (
this != &replace) {
975 #define REPLACE_BY(X) ReplaceBy(&X, replace.X)
1012 template <
typename T>
1013 static void SetFrom(Optional<T>* s,
const Optional<T>& o) {
1019 template <
typename T>
1020 static void ReplaceBy(Optional<T>* s,
const Optional<T>& o) {
1026 enum LOCAL_PROXY_MODE {
1029 kConnectivityFirst = 0,
1098 virtual const char* eventHandlerType()
const {
return "event_handler"; }
1171 unsigned short lost) {
1231 (void)speakerNumber;
1281 virtual void onAudioEffectFinished(
int soundId) {}
1394 virtual void onVideoSourceFrameSizeChanged(VIDEO_SOURCE_TYPE sourceType,
int width,
int height) {
1422 virtual void onVideoSizeChanged(uid_t uid,
int width,
int height,
int rotation) {
1674 virtual void onCameraReady() {}
1676 virtual void onCameraFocusAreaChanged(
int x,
int y,
int width,
int height) {
1683 virtual void onCameraExposureAreaChanged(
int x,
int y,
int width,
int height) {
1689 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
1690 virtual void onFacePositionChanged(
int imageWidth,
int imageHeight,
1691 const Rectangle* vecRectangle,
const int* vecDistance,
1695 (void) vecRectangle;
1700 virtual void onVideoStopped() {}
1775 virtual void onStreamMessage(uid_t userId,
int streamId,
const char* data,
size_t length, uint64_t sentTs) {
1932 virtual void onSnapshotTaken(uid_t uid,
const char* filePath,
int width,
int height,
int errCode) {
1988 RTMP_STREAM_PUBLISH_ERROR_TYPE errCode) {
2152 virtual void onLocalPublishFallbackToAudioOnly(
bool isFallbackOrRecover) {
2153 (void)isFallbackOrRecover;
2156 virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid,
bool isFallbackOrRecover) {
2158 (void)isFallbackOrRecover;
2175 unsigned short rxKBitRate) {
2196 unsigned short rxKBitRate) {
2209 CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) {
2235 (void)permissionType;
2284 virtual void onAudioSubscribeStateChanged(
const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState,
int elapseSinceLastState) {
2289 (void)elapseSinceLastState;
2301 virtual void onVideoSubscribeStateChanged(
const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState,
int elapseSinceLastState) {
2306 (void)elapseSinceLastState;
2317 virtual void onAudioPublishStateChanged(
const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState,
int elapseSinceLastState) {
2321 (void)elapseSinceLastState;
2332 virtual void onVideoPublishStateChanged(
const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState,
int elapseSinceLastState) {
2336 (void)elapseSinceLastState;
2339 virtual void onExtensionEvent(
const char* provider,
const char* ext_name,
const char* key,
const char* value) {
2346 virtual void onExtensionStarted(
const char* provider,
const char* ext_name) {
2351 virtual void onExtensionStopped(
const char* provider,
const char* ext_name) {
2356 virtual void onExtensionErrored(
const char* provider,
const char* ext_name,
int error,
const char* msg) {
2363 virtual void onUserAccountUpdated(uid_t uid,
const char* userAccount){
2391 virtual int setDevice(
const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
2404 virtual int getDevice(
int index,
char deviceNameUTF8[MAX_DEVICE_ID_LENGTH],
2405 char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
2444 virtual int setDevice(
const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
2454 virtual int getDevice(
char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
2456 #if defined(_WIN32) || (defined(__linux__) && !defined(__ANDROID__)) || \
2457 (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
2466 virtual int numberOfCapabilities(
const char* deviceIdUTF8) = 0;
2479 virtual int getCapability(
const char* deviceIdUTF8,
const uint32_t deviceCapabilityNumber,
VideoFormat& capability) = 0;
2617 INVALID_METADATA_SIZE_IN_BYTE = -1,
2618 DEFAULT_METADATA_SIZE_IN_BYTE = 512,
2619 MAX_METADATA_SIZE_IN_BYTE = 1024
2680 enum DIRECT_CDN_STREAMING_ERROR {
2682 DIRECT_CDN_STREAMING_ERROR_OK = 0,
2684 DIRECT_CDN_STREAMING_ERROR_FAILED = 1,
2686 DIRECT_CDN_STREAMING_ERROR_AUDIO_PUBLICATION = 2,
2688 DIRECT_CDN_STREAMING_ERROR_VIDEO_PUBLICATION = 3,
2690 DIRECT_CDN_STREAMING_ERROR_NET_CONNECT = 4,
2692 DIRECT_CDN_STREAMING_ERROR_BAD_NAME = 5,
2697 enum DIRECT_CDN_STREAMING_STATE {
2699 DIRECT_CDN_STREAMING_STATE_IDLE = 0,
2701 DIRECT_CDN_STREAMING_STATE_RUNNING = 1,
2703 DIRECT_CDN_STREAMING_STATE_STOPPED = 2,
2705 DIRECT_CDN_STREAMING_STATE_FAILED = 3,
2707 DIRECT_CDN_STREAMING_STATE_RECOVERING = 4,
2808 void SetAll(
const DirectCdnStreamingMediaOptions& change) {
2809 #define SET_FROM(X) SetFrom(&X, change.X)
2819 bool operator==(
const DirectCdnStreamingMediaOptions& o)
const {
2820 #define BEGIN_COMPARE() bool b = true
2821 #define ADD_COMPARE(X) b = (b && (X == o.X))
2822 #define END_COMPARE()
2833 #undef BEGIN_COMPARE
2839 DirectCdnStreamingMediaOptions& operator=(
const DirectCdnStreamingMediaOptions& replace) {
2840 if (
this != &replace) {
2841 #define REPLACE_BY(X) ReplaceBy(&X, replace.X)
2854 template <
typename T>
2855 static void SetFrom(Optional<T>* s,
const Optional<T>& o) {
2861 template <
typename T>
2862 static void ReplaceBy(Optional<T>* s,
const Optional<T>& o) {
2917 virtual int queryInterface(INTERFACE_ID_TYPE iid,
void** inter) = 0;
2974 virtual int joinChannel(
const char* token,
const char* channelId,
const char* info,
3015 virtual int joinChannel(
const char* token,
const char* channelId, uid_t uid,
3519 virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) __deprecated = 0;
3880 AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
3904 AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
4017 virtual int startAudioMixing(
const char* filePath,
bool loopback,
bool replace,
int cycle) = 0;
4069 virtual int startAudioMixing(
const char* filePath,
bool loopback,
bool replace,
int cycle,
int startPos) = 0;
4241 virtual int preloadEffect(
int soundId,
const char* filePath,
int startPos = 0) = 0;
4283 virtual int playEffect(
int soundId,
const char* filePath,
int loopCount,
double pitch,
double pan,
int gain,
bool publish =
false,
int startPos = 0) = 0;
4314 virtual int playAllEffects(
int loopCount,
double pitch,
double pan,
int gain,
bool publish =
false) = 0;
4695 int param1,
int param2) = 0;
4710 int param1,
int param2) = 0;
4851 virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
4873 VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
4964 virtual int enableEchoCancellationExternal(
bool enabled,
int audioSourceDelay) = 0;
5037 RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
5038 int samplesPerCall) = 0;
5060 RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
5061 int samplesPerCall) = 0;
5100 RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
5101 int samplesPerCall) = 0;
5229 virtual int adjustUserPlaybackSignalVolume(
unsigned int uid,
int volume) = 0;
5339 #if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
5340 virtual int loadExtensionProvider(
const char* path) = 0;
5355 const char* provider,
const char* key,
const char* value) = 0;
5371 const char* provider,
const char* extension,
bool enable=
true, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
5386 const char* provider,
const char* extension,
5387 const char* key,
const char* value, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
5403 const char* provider,
const char* extension,
5404 const char* key,
char* value,
int buf_len, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
5420 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
5430 virtual int switchCamera() = 0;
5439 virtual bool isCameraZoomSupported() = 0;
5448 virtual bool isCameraFaceDetectSupported() = 0;
5457 virtual bool isCameraTorchSupported() = 0;
5466 virtual bool isCameraFocusSupported() = 0;
5475 virtual bool isCameraAutoFocusFaceModeSupported() = 0;
5486 virtual int setCameraZoomFactor(
float factor) = 0;
5496 virtual int enableFaceDetection(
bool enabled) = 0;
5502 virtual float getCameraMaxZoomFactor() = 0;
5513 virtual int setCameraFocusPositionInPreview(
float positionX,
float positionY) = 0;
5522 virtual int setCameraTorchOn(
bool isOn) = 0;
5531 virtual int setCameraAutoFocusFaceModeEnabled(
bool enabled) = 0;
5544 virtual bool isCameraExposurePositionSupported() = 0;
5561 virtual int setCameraExposurePosition(
float positionXinView,
float positionYinView) = 0;
5563 #if defined(__APPLE__)
5571 virtual bool isCameraAutoExposureFaceModeSupported() = 0;
5581 virtual int setCameraAutoExposureFaceModeEnabled(
bool enabled) = 0;
5617 virtual int setDefaultAudioRouteToSpeakerphone(
bool defaultToSpeaker) = 0;
5645 virtual int setEnableSpeakerphone(
bool speakerOn) = 0;
5654 virtual bool isSpeakerphoneEnabled() = 0;
5656 #endif // __ANDROID__ || (__APPLE__ && TARGET_OS_IOS)
5658 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
5669 virtual IScreenCaptureSourceList* getScreenCaptureSources(
const SIZE& thumbSize,
const SIZE& iconSize,
const bool includeScreen) = 0;
5670 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
5671 #if (defined(__APPLE__) && TARGET_OS_IOS)
5696 virtual int setAudioSessionOperationRestriction(AUDIO_SESSION_OPERATION_RESTRICTION restriction) = 0;
5697 #endif // __APPLE__ && TARGET_OS_IOS
5699 #if defined(_WIN32) || (defined(__APPLE__) && !TARGET_OS_IPHONE && TARGET_OS_MAC)
5721 virtual int startScreenCaptureByDisplayId(uint32_t displayId,
const Rectangle& regionRect,
5724 #endif // __APPLE__ && TARGET_OS_MAC && !TARGET_OS_IPHONE
5751 virtual int startScreenCaptureByScreenRect(
const Rectangle& screenRect,
5757 #if defined(__ANDROID__)
5777 virtual int startScreenCapture(
void* mediaProjectionPermissionResultData,
5786 virtual int getAudioDeviceInfo(
DeviceInfo& deviceInfo) = 0;
5788 #endif // __ANDROID__
5790 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
5809 virtual int startScreenCaptureByWindowId(view_t windowId,
const Rectangle& regionRect,
5827 virtual int setScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint) = 0;
5845 virtual int setScreenCaptureScenario(SCREEN_SCENARIO_TYPE screenScenario) = 0;
5863 virtual int updateScreenCaptureRegion(
const Rectangle& regionRect) = 0;
5865 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
5867 #if defined(_WIN32) || defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
5891 virtual int stopScreenCapture() = 0;
5893 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC) || __ANDROID__
5927 virtual int rate(
const char* callId,
int rating,
5928 const char* description) = 0;
5943 virtual int complain(
const char* callId,
const char* description) = 0;
6096 virtual int stopLocalVideoTranscoder() = 0;
6100 virtual int stopPrimaryCameraCapture() = 0;
6101 virtual int stopSecondaryCameraCapture() = 0;
6103 virtual int setCameraDeviceOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation) = 0;
6104 virtual int setScreenCaptureOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation) = 0;
6108 virtual int stopPrimaryScreenCapture() = 0;
6109 virtual int stopSecondaryScreenCapture() = 0;
6120 virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0;
6435 const
char*
id, const
char* category, const
char* event, const
char* label,
int value) = 0;
6480 const
char* uuid, const
char* passwd,
long duration_ms,
bool auto_upload) = 0;
6482 virtual
int stopAudioFrameDump(const
char* channel_id, uid_t user_id, const
char* location) = 0;
6548 const
char* userAccount) = 0;
6860 virtual
int startRhythmPlayer(const
char* sound1, const
char* sound2, const AgoraRhythmPlayerConfig& config) = 0;
6906 virtual
int adjustCustomAudioPublishVolume(int32_t sourceId,
int volume) = 0;
6917 virtual
int adjustCustomAudioPlayoutVolume(int32_t sourceId,
int volume) = 0;
7021 virtual int64_t getCurrentMonotonicTimeInMs() = 0;
7041 virtual int setBool(
const char* key,
bool value) = 0;
7051 virtual int setInt(
const char* key,
int value) = 0;
7061 virtual int setUInt(
const char* key,
unsigned int value) = 0;
7081 virtual int setString(
const char* key,
const char* value) = 0;
7091 virtual int setObject(
const char* key,
const char* value) = 0;
7101 virtual int getBool(
const char* key,
bool& value) = 0;
7111 virtual int getInt(
const char* key,
int& value) = 0;
7121 virtual int getUInt(
const char* key,
unsigned int& value) = 0;
7190 queryInterface(engine, AGORA_IID_AUDIO_DEVICE_MANAGER);
7197 queryInterface(engine, AGORA_IID_VIDEO_DEVICE_MANAGER);
7202 enum QUALITY_REPORT_FORMAT_TYPE {
7205 QUALITY_REPORT_JSON = 0,
7208 QUALITY_REPORT_HTML = 1,
7212 enum MEDIA_DEVICE_STATE_TYPE {
7215 MEDIA_DEVICE_STATE_IDLE = 0,
7218 MEDIA_DEVICE_STATE_ACTIVE = 1,
7221 MEDIA_DEVICE_STATE_DISABLED = 2,
7224 MEDIA_DEVICE_STATE_NOT_PRESENT = 4,
7227 MEDIA_DEVICE_STATE_UNPLUGGED = 8
7230 enum VIDEO_PROFILE_TYPE {
7232 VIDEO_PROFILE_LANDSCAPE_120P = 0,
7234 VIDEO_PROFILE_LANDSCAPE_120P_3 = 2,
7236 VIDEO_PROFILE_LANDSCAPE_180P = 10,
7238 VIDEO_PROFILE_LANDSCAPE_180P_3 = 12,
7240 VIDEO_PROFILE_LANDSCAPE_180P_4 = 13,
7242 VIDEO_PROFILE_LANDSCAPE_240P = 20,
7244 VIDEO_PROFILE_LANDSCAPE_240P_3 = 22,
7246 VIDEO_PROFILE_LANDSCAPE_240P_4 = 23,
7248 VIDEO_PROFILE_LANDSCAPE_360P = 30,
7250 VIDEO_PROFILE_LANDSCAPE_360P_3 = 32,
7252 VIDEO_PROFILE_LANDSCAPE_360P_4 = 33,
7254 VIDEO_PROFILE_LANDSCAPE_360P_6 = 35,
7256 VIDEO_PROFILE_LANDSCAPE_360P_7 = 36,
7258 VIDEO_PROFILE_LANDSCAPE_360P_8 = 37,
7260 VIDEO_PROFILE_LANDSCAPE_360P_9 = 38,
7262 VIDEO_PROFILE_LANDSCAPE_360P_10 = 39,
7264 VIDEO_PROFILE_LANDSCAPE_360P_11 = 100,
7266 VIDEO_PROFILE_LANDSCAPE_480P = 40,
7268 VIDEO_PROFILE_LANDSCAPE_480P_3 = 42,
7270 VIDEO_PROFILE_LANDSCAPE_480P_4 = 43,
7272 VIDEO_PROFILE_LANDSCAPE_480P_6 = 45,
7274 VIDEO_PROFILE_LANDSCAPE_480P_8 = 47,
7276 VIDEO_PROFILE_LANDSCAPE_480P_9 = 48,
7278 VIDEO_PROFILE_LANDSCAPE_480P_10 = 49,
7280 VIDEO_PROFILE_LANDSCAPE_720P = 50,
7282 VIDEO_PROFILE_LANDSCAPE_720P_3 = 52,
7284 VIDEO_PROFILE_LANDSCAPE_720P_5 = 54,
7286 VIDEO_PROFILE_LANDSCAPE_720P_6 = 55,
7288 VIDEO_PROFILE_LANDSCAPE_1080P = 60,
7290 VIDEO_PROFILE_LANDSCAPE_1080P_3 = 62,
7292 VIDEO_PROFILE_LANDSCAPE_1080P_5 = 64,
7294 VIDEO_PROFILE_LANDSCAPE_1440P = 66,
7296 VIDEO_PROFILE_LANDSCAPE_1440P_2 = 67,
7298 VIDEO_PROFILE_LANDSCAPE_4K = 70,
7300 VIDEO_PROFILE_LANDSCAPE_4K_3 = 72,
7302 VIDEO_PROFILE_PORTRAIT_120P = 1000,
7304 VIDEO_PROFILE_PORTRAIT_120P_3 = 1002,
7306 VIDEO_PROFILE_PORTRAIT_180P = 1010,
7308 VIDEO_PROFILE_PORTRAIT_180P_3 = 1012,
7310 VIDEO_PROFILE_PORTRAIT_180P_4 = 1013,
7312 VIDEO_PROFILE_PORTRAIT_240P = 1020,
7314 VIDEO_PROFILE_PORTRAIT_240P_3 = 1022,
7316 VIDEO_PROFILE_PORTRAIT_240P_4 = 1023,
7318 VIDEO_PROFILE_PORTRAIT_360P = 1030,
7320 VIDEO_PROFILE_PORTRAIT_360P_3 = 1032,
7322 VIDEO_PROFILE_PORTRAIT_360P_4 = 1033,
7324 VIDEO_PROFILE_PORTRAIT_360P_6 = 1035,
7326 VIDEO_PROFILE_PORTRAIT_360P_7 = 1036,
7328 VIDEO_PROFILE_PORTRAIT_360P_8 = 1037,
7330 VIDEO_PROFILE_PORTRAIT_360P_9 = 1038,
7332 VIDEO_PROFILE_PORTRAIT_360P_10 = 1039,
7334 VIDEO_PROFILE_PORTRAIT_360P_11 = 1100,
7336 VIDEO_PROFILE_PORTRAIT_480P = 1040,
7338 VIDEO_PROFILE_PORTRAIT_480P_3 = 1042,
7340 VIDEO_PROFILE_PORTRAIT_480P_4 = 1043,
7342 VIDEO_PROFILE_PORTRAIT_480P_6 = 1045,
7344 VIDEO_PROFILE_PORTRAIT_480P_8 = 1047,
7346 VIDEO_PROFILE_PORTRAIT_480P_9 = 1048,
7348 VIDEO_PROFILE_PORTRAIT_480P_10 = 1049,
7350 VIDEO_PROFILE_PORTRAIT_720P = 1050,
7352 VIDEO_PROFILE_PORTRAIT_720P_3 = 1052,
7354 VIDEO_PROFILE_PORTRAIT_720P_5 = 1054,
7356 VIDEO_PROFILE_PORTRAIT_720P_6 = 1055,
7358 VIDEO_PROFILE_PORTRAIT_1080P = 1060,
7360 VIDEO_PROFILE_PORTRAIT_1080P_3 = 1062,
7362 VIDEO_PROFILE_PORTRAIT_1080P_5 = 1064,
7364 VIDEO_PROFILE_PORTRAIT_1440P = 1066,
7366 VIDEO_PROFILE_PORTRAIT_1440P_2 = 1067,
7368 VIDEO_PROFILE_PORTRAIT_4K = 1070,
7370 VIDEO_PROFILE_PORTRAIT_4K_3 = 1072,
7372 VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_LANDSCAPE_360P,
7383 #define getAgoraRtcEngineVersion getAgoraSdkVersion
7406 #define getAgoraRtcEngineErrorDescription getAgoraSdkErrorDescription
7407 #define setAgoraRtcEngineExternalSymbolLoader setAgoraSdkExternalSymbolLoader
virtual void onApiCallExecuted(int err, const char *api, const char *result)
Definition: IAgoraRtcEngine.h:1613
virtual int setDirectCdnStreamingAudioConfiguration(AUDIO_PROFILE_TYPE profile)=0
virtual const char * getErrorDescription(int code)=0
virtual int enableAudioSpectrumMonitor(int intervalInMS=100)=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:572
virtual int setAVSyncSource(const char *channelId, uid_t uid)=0
const char * appId
Definition: IAgoraRtcEngine.h:2525
virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters)=0
virtual void onRtmpStreamingEvent(const char *url, RTMP_STREAMING_EVENT eventCode)
Definition: IAgoraRtcEngine.h:2001
virtual int setBool(const char *key, bool value)=0
int regulatedCaptureFrameHeight
Definition: IAgoraRtcEngine.h:267
Definition: AgoraBase.h:5257
int publishDuration
Definition: IAgoraRtcEngine.h:376
virtual int stopDirectCdnStreaming()=0
Definition: AgoraBase.h:3920
virtual int setEncryptionSecret(const char *secret) __deprecated=0
Definition: AgoraBase.h:4730
Definition: AgoraBase.h:4564
virtual int muteAllRemoteVideoStreams(bool mute)=0
virtual int setRemoteVideoSubscriptionOptions(uid_t uid, const VideoSubscriptionOptions &options)=0
Definition: AgoraBase.h:3184
int audioChannels
Definition: IAgoraRtcEngine.h:494
int regulatedCaptureFrameWidth
Definition: IAgoraRtcEngine.h:263
virtual int pauseEffect(int soundId)=0
Definition: AgoraBase.h:4153
virtual int getString(const char *key, agora::util::AString &value)=0
virtual int muteLocalVideoStream(bool mute)=0
IRtcEngineEventHandler * eventHandler
Definition: IAgoraRtcEngine.h:2519
virtual int stopPreview(VIDEO_SOURCE_TYPE sourceType)=0
virtual int setInt(const char *key, int value)=0
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode)=0
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:1330
Definition: IAgoraRtcEngine.h:383
int canvasHeight
Definition: IAgoraRtcEngine.h:433
virtual int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset)=0
int videoHeight
Definition: IAgoraRtcEngine.h:2722
Definition: AgoraBase.h:3846
virtual int enableLocalVideo(bool enabled)=0
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1246
virtual int getInt(const char *key, int &value)=0
virtual int joinChannel(const char *token, const char *channelId, uid_t uid, const ChannelMediaOptions &options)=0
virtual void onFirstLocalVideoFrame(int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1379
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:1415
virtual int createDataStream(int *streamId, DataStreamConfig &config)=0
uid_t uid
Definition: IAgoraRtcEngine.h:238
virtual int stopChannelMediaRelay()=0
virtual int switchChannel(const char *token, const char *channel)=0
virtual void onStreamPublished(const char *url, int error) __deprecated
Definition: IAgoraRtcEngine.h:2041
Optional< THREAD_PRIORITY_TYPE > threadPriority
Definition: IAgoraRtcEngine.h:2576
virtual int registerAudioEncodedFrameObserver(const AudioEncodedFrameObserverConfig &config, IAudioEncodedFrameObserver *observer)=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:467
virtual int pauseAudioMixing()=0
virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel)=0
Definition: AgoraRefPtr.h:44
virtual int clearVideoWatermark()=0
virtual IVideoDeviceCollection * enumerateVideoDevices()=0
bool stopAudioMixing
Definition: IAgoraRtcEngine.h:1066
virtual const char * getVersion(int *build)=0
int totalActiveTime
Definition: IAgoraRtcEngine.h:372
virtual int setAudioMixingPitch(int pitch)=0
int videoWidth
Definition: IAgoraRtcEngine.h:2717
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngine.h:2174
const char * publishUrl
Definition: IAgoraRtcEngine.h:565
int lifecycle
Definition: IAgoraRtcEngine.h:547
virtual int startPreview()=0
LOCAL_PROXY_MODE mode
Definition: IAgoraRtcEngine.h:1053
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Definition: IAgoraRtcEngine.h:1626
Definition: IAgoraRtcEngine.h:1035
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngine.h:1957
virtual int getDevice(int index, char deviceNameUTF8[MAX_DEVICE_ID_LENGTH], char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
int videoBitrate
Definition: IAgoraRtcEngine.h:2732
virtual void onLastmileQuality(int quality)
Definition: IAgoraRtcEngine.h:1367
char deviceId[MAX_DEVICE_ID_LENGTH]
Definition: IAgoraRtcEngine.h:627
virtual void onUserEnableVideo(uid_t uid, bool enabled) __deprecated
Definition: IAgoraRtcEngine.h:1576
virtual int setRemoteRenderMode(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
Definition: AgoraBase.h:3634
int sentFrameRate
Definition: IAgoraRtcEngine.h:246
Definition: AgoraBase.h:2173
const char ** ipList
Definition: IAgoraRtcEngine.h:1038
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:2259
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: IAgoraRtcEngine.h:2218
int videoFramerate
Definition: IAgoraRtcEngine.h:479
virtual int enableAudioVolumeIndication(int interval, int smooth, bool reportVad)=0
virtual int registerPacketObserver(IPacketObserver *observer)=0
virtual int startAudioMixing(const char *filePath, bool loopback, bool replace, int cycle)=0
virtual int unregisterMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo *userInfo)=0
virtual int pauseAllEffects()=0
virtual int disableAudioSpectrumMonitor()=0
Definition: IAgoraRtcEngineEx.h:58
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:1840
Definition: AgoraBase.h:106
virtual int getBool(const char *key, bool &value)=0
int sentBitrate
Definition: IAgoraRtcEngine.h:242
virtual int getAudioMixingPublishVolume()=0
virtual int startAudioMixing(const char *filePath, bool loopback, bool replace, int cycle, int startPos)=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:1127
virtual int pushDirectCdnStreamingCustomVideoFrame(media::base::ExternalVideoFrame *frame)=0
int totalFrozenTime
Definition: IAgoraRtcEngine.h:358
virtual int stopPrimaryCustomAudioTrack()=0
virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType)=0
Definition: AgoraBase.h:1986
Definition: IAgoraRtcEngine.h:1094
double height
Definition: IAgoraRtcEngine.h:399
virtual int leaveChannel(const LeaveChannelOptions &options)=0
virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual void onStreamUnpublished(const char *url) __deprecated
Definition: IAgoraRtcEngine.h:2056
virtual void onUserMuteAudio(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:1537
Definition: AgoraBase.h:1849
bool enableAudioDevice
Definition: IAgoraRtcEngine.h:2540
virtual int registerLocalUserAccount(const char *appId, const char *userAccount)=0
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Definition: IAgoraRtcEngine.h:1340
Definition: AgoraBase.h:3483
const char * backgroundColor
Definition: IAgoraRtcEngine.h:436
virtual int getAudioMixingCurrentPosition()=0
virtual int startDirectCdnStreaming(IDirectCdnStreamingEventHandler *eventHandler, const char *publishUrl, const DirectCdnStreamingMediaOptions &options)=0
virtual int setAdvancedAudioOptions(media::base::AdvancedAudioOptions &options)=0
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
virtual int addInjectStreamUrl(const char *url, const InjectStreamConfig &config)=0
virtual int startEchoTest(int intervalInSeconds)=0
QUALITY_ADAPT_INDICATION qualityAdaptIndication
Definition: IAgoraRtcEngine.h:293
Definition: AgoraBase.h:2151
virtual int setMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall)=0
virtual int getVolumeOfEffect(int soundId)=0
virtual CONNECTION_STATE_TYPE getConnectionState()=0
Definition: AgoraBase.h:4245
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 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:1898
virtual int enableCustomAudioLocalPlayback(int sourceId, bool enabled)=0
virtual int startRhythmPlayer(const char *sound1, const char *sound2, const AgoraRhythmPlayerConfig &config)=0
virtual int configRhythmPlayer(const AgoraRhythmPlayerConfig &config)=0
virtual int adjustAudioMixingPublishVolume(int volume)=0
virtual int getAudioMixingDuration()=0
virtual void onUserMuteVideo(uid_t userId, bool muted) __deprecated
Definition: IAgoraRtcEngine.h:1555
virtual void onVideoDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1292
const char * appData
Definition: IAgoraRtcEngine.h:446
virtual void onVideoPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2332
virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain)=0
virtual void onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error)
Definition: IAgoraRtcEngine.h:1440
virtual int setParameters(const char *parameters)=0
virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_ERROR_TYPE errorCode)
Definition: IAgoraRtcEngine.h:1731
virtual int startChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration)=0
virtual int setObject(const char *key, const char *value)=0
int defaultLayout
Definition: IAgoraRtcEngine.h:544
virtual void onTranscodingUpdated()
Definition: IAgoraRtcEngine.h:2071
virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_ERROR_TYPE errorCode)
Definition: IAgoraRtcEngine.h:1718
virtual int updateRtmpTranscoding(const LiveTranscoding &transcoding)=0
virtual void onRequestToken()
Definition: IAgoraRtcEngine.h:1815
virtual void onError(int err, const char *msg)
Definition: IAgoraRtcEngine.h:1151
Definition: AgoraBase.h:5003
virtual int startRtmpStreamWithoutTranscoding(const char *url)=0
int regionCount
Definition: IAgoraRtcEngine.h:443
virtual int enableExtension(const char *provider, const char *extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
int height
Definition: IAgoraRtcEngine.h:530
virtual void onAudioMixingFinished() __deprecated
Definition: IAgoraRtcEngine.h:1279
const char * verifyDomainName
Definition: IAgoraRtcEngine.h:1050
Definition: IAgoraRtcEngine.h:7194
VIDEO_CODEC_TYPE codecType
Definition: IAgoraRtcEngine.h:302
Definition: AgoraBase.h:3823
virtual int adjustAudioMixingPlayoutVolume(int volume)=0
virtual int setProfile(const char *profile, bool merge)=0
int audioBitrate
Definition: IAgoraRtcEngine.h:491
virtual void onDirectCdnStreamingStateChanged(DIRECT_CDN_STREAMING_STATE state, DIRECT_CDN_STREAMING_ERROR error, const char *message)
Definition: IAgoraRtcEngine.h:2754
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngine.h:1228
virtual void onConnectionBanned()
Definition: IAgoraRtcEngine.h:1760
Definition: AgoraBase.h:3223
virtual int setLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option)=0
virtual int enableDualStreamMode(VIDEO_SOURCE_TYPE sourceType, bool enabled, const SimulcastStreamConfig &streamConfig)=0
Definition: IAgoraRtcEngine.h:2713
uid_t uid
Definition: IAgoraRtcEngine.h:316
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:1521
virtual int stopRtmpStream(const char *url)=0
Definition: AgoraBase.h:2139
double y
Definition: IAgoraRtcEngine.h:393
virtual int stopAudioMixing()=0
Definition: IAgoraRtcEngine.h:522
virtual int setLogLevel(commons::LOG_LEVEL level)=0
commons::LogConfig logConfig
Definition: IAgoraRtcEngine.h:2571
virtual void onChannelMediaRelayEvent(int code)
Definition: IAgoraRtcEngine.h:2148
virtual int setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType)=0
virtual int setRemoteVideoStreamType(uid_t uid, VIDEO_STREAM_TYPE streamType)=0
Definition: AgoraBase.h:5019
int height
Definition: IAgoraRtcEngine.h:471
virtual int startRtmpStreamWithTranscoding(const char *url, const LiveTranscoding &transcoding)=0
virtual void onStreamMessageError(uid_t userId, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngine.h:1796
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config)=0
virtual int stopAllEffects()=0
virtual int pauseAllChannelMediaRelay()=0
int captureFrameHeight
Definition: IAgoraRtcEngine.h:255
virtual int takeSnapshot(uid_t uid, const char *filePath)=0
save current time video frame to jpeg and write as a jpeg
int canvasWidth
Definition: IAgoraRtcEngine.h:428
bool stopMicrophoneRecording
Definition: IAgoraRtcEngine.h:1078
const char * rawStreamUrl
Definition: IAgoraRtcEngine.h:569
virtual int setString(const char *key, const char *value)=0
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Definition: IAgoraRtcEngine.h:1670
virtual int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2)=0
virtual void onTokenPrivilegeWillExpire(const char *token)
Definition: IAgoraRtcEngine.h:1831
int targetFrameRate
Definition: IAgoraRtcEngine.h:286
int audioBitrate
Definition: IAgoraRtcEngine.h:2737
virtual int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option)=0
virtual int setUInt(const char *key, unsigned int value)=0
CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraRtcEngine.h:2545
virtual int setEarMonitoringAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
virtual int setLiveTranscoding(const LiveTranscoding &transcoding)=0
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: IAgoraRtcEngine.h:1919
virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1266
Definition: AgoraBase.h:4746
virtual int removePublishStreamUrl(const char *url)=0
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost)
Definition: IAgoraRtcEngine.h:1170
Definition: IAgoraRtcEngine.h:1060
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Definition: IAgoraRtcEngine.h:1640
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:2727
virtual int stopLastmileProbeTest()=0
Definition: IAgoraRtcEngine.h:2372
virtual void onRtmpStreamingStateChanged(const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR_TYPE errCode)
Definition: IAgoraRtcEngine.h:1987
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:306
int avSyncTimeMs
Definition: IAgoraRtcEngine.h:367
virtual int removeInjectStreamUrl(const char *url)=0
virtual void onStreamMessage(uid_t userId, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngine.h:1775
int decoderOutputFrameRate
Definition: IAgoraRtcEngine.h:339
void * context
Definition: IAgoraRtcEngine.h:2532
virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource)=0
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1109
virtual int setEncryptionMode(const char *encryptionMode) __deprecated=0
int zOrder
Definition: IAgoraRtcEngine.h:403
int captureFrameRate
Definition: IAgoraRtcEngine.h:249
virtual int startPrimaryCustomAudioTrack(const AudioTrackConfig &config)=0
Definition: AgoraBase.h:4190
virtual int muteRemoteVideoStream(uid_t uid, bool mute)=0
virtual int getArray(const char *key, agora::util::AString &value)=0
Definition: IAgoraRtcEngine.h:2416
int frozenRate
Definition: IAgoraRtcEngine.h:362
virtual int enableLocalAudio(bool enabled)=0
virtual int setupLocalVideo(const VideoCanvas &canvas)=0
int appDataLength
Definition: IAgoraRtcEngine.h:449
virtual int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value)=0
virtual int stopEffect(int soundId)=0
double alpha
Definition: IAgoraRtcEngine.h:408
virtual void release(bool sync=false)=0
int encodedFrameHeight
Definition: IAgoraRtcEngine.h:276
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)
Definition: IAgoraRtcEngine.h:1881
int superResolutionType
Definition: IAgoraRtcEngine.h:380
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
virtual int setDefaultMuteAllRemoteAudioStreams(bool mute) __deprecated=0
virtual int updateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration)=0
virtual int setLogFile(const char *filePath)=0
virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration &config)=0
int delay __deprecated
Definition: IAgoraRtcEngine.h:324
int width
Definition: IAgoraRtcEngine.h:526
double width
Definition: IAgoraRtcEngine.h:397
virtual int getEffectsVolume()=0
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngine.h:2226
Definition: IAgoraLog.h:84
virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
virtual int setLogFileSize(unsigned int fileSizeInKBytes)=0
bool stopAllEffect
Definition: IAgoraRtcEngine.h:1072
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
Definition: IAgoraRtcEngine.h:234
virtual int startAudioFrameDump(const char *channel_id, uid_t user_id, const char *location, const char *uuid, const char *passwd, long duration_ms, bool auto_upload)=0
virtual int resumeAllChannelMediaRelay()=0
virtual void onUserStateChanged(uid_t uid, uint32_t state)
Definition: IAgoraRtcEngine.h:1586
Definition: IAgoraRtcEngine.h:2744
virtual void onAudioSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2284
virtual int startSecondaryCustomAudioTrack(const AudioTrackConfig &config)=0
Definition: AgoraBase.h:5156
Definition: IAgoraRtcEngine.h:7024
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: IAgoraRtcEngine.h:1946
virtual int setAudioMixingPosition(int pos)=0
virtual int setNumber(const char *key, double value)=0
int receivedBitrate
Definition: IAgoraRtcEngine.h:336
Definition: AgoraBase.h:2556
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
virtual void onFirstRemoteVideoFrame(uid_t userId, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1477
int encoderOutputFrameRate
Definition: IAgoraRtcEngine.h:270
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
virtual int setupRemoteVideo(const VideoCanvas &canvas)=0
virtual void onLastmileProbeResult(const LastmileProbeResult &result)
Definition: IAgoraRtcEngine.h:1184
virtual int startDeviceTest(view_t hwnd)=0
virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
virtual void onConnectionLost()
Definition: IAgoraRtcEngine.h:1743
bool owner
Definition: IAgoraRtcEngine.h:552
virtual int setInEarMonitoringVolume(int volume)=0
virtual int setDefaultMuteAllRemoteVideoStreams(bool mute) __deprecated=0
virtual int enableSoundPositionIndication(bool enabled)=0
const Region * regions
Definition: IAgoraRtcEngine.h:440
virtual int stopPreview()=0
virtual int muteRecordingSignal(bool mute)=0
virtual void onLocalUserRegistered(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2246
int encodedFrameWidth
Definition: IAgoraRtcEngine.h:273
Definition: AgoraBase.h:2250
virtual int enableFishCorrection(bool enabled, const FishCorrectionParams ¶ms)=0
virtual int setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset, int param1, int param2)=0
virtual int muteRemoteAudioStream(uid_t uid, bool mute)=0
virtual void onWarning(int warn, const char *msg)
Definition: IAgoraRtcEngine.h:1141
virtual int enableDualStreamMode(VIDEO_SOURCE_TYPE sourceType, bool enabled)=0
virtual void onLocalVideoStats(const LocalVideoStats &stats)
Definition: IAgoraRtcEngine.h:1657
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition: IAgoraRtcEngine.h:1932
virtual int setVoiceConversionParameters(VOICE_CONVERSION_PRESET preset, int param1, int param2)=0
virtual int adjustAudioMixingVolume(int volume)=0
Definition: AgoraBase.h:2215
Definition: AgoraBase.h:3364
virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted)
Definition: IAgoraRtcEngine.h:1968
virtual int leaveChannel()=0
virtual int setClientRole(CLIENT_ROLE_TYPE role)=0
int width
Definition: IAgoraRtcEngine.h:328
virtual void onMediaDeviceChanged(int deviceType)
Definition: IAgoraRtcEngine.h:1305
AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraRtcEngine.h:2555
int rendererOutputFrameRate
Definition: IAgoraRtcEngine.h:342
virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset)=0
virtual int rate(const char *callId, int rating, const char *description)=0
int targetBitrate
Definition: IAgoraRtcEngine.h:283
virtual int getCallId(agora::util::AString &callId)=0
Definition: IAgoraRtcEngine.h:463
virtual int uploadLogFile(agora::util::AString &requestId)=0
int encodedFrameCount
Definition: IAgoraRtcEngine.h:297
int bitrate
Definition: IAgoraRtcEngine.h:538
int regulatedCaptureFrameRate
Definition: IAgoraRtcEngine.h:259
Definition: IAgoraRtcEngine.h:2515
virtual void onFirstLocalVideoFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:1390
virtual int unloadAllEffects()=0
Definition: IAgoraRtcEngine.h:2878
virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions &options)=0
virtual int enableLoopbackRecording(bool enabled, const char *deviceName=NULL)=0
virtual void onActiveSpeaker(uid_t userId)
Definition: IAgoraRtcEngine.h:1917
Definition: IAgoraRtcEngine.h:640
virtual int getUInt(const char *key, unsigned int &value)=0
Definition: AgoraBase.h:4671
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:345
virtual int updateDirectCdnStreamingMediaOptions(const DirectCdnStreamingMediaOptions &options)=0
virtual int setLocalVoicePitch(double pitch)=0
int height
Definition: IAgoraRtcEngine.h:332
int captureFrameWidth
Definition: IAgoraRtcEngine.h:252
virtual int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset)=0
bool useExternalEglContext
Definition: IAgoraRtcEngine.h:2585
virtual int preloadEffect(int soundId, const char *filePath, int startPos=0)=0
virtual int stopEchoTest()=0
virtual int startAudioRecording(const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality)=0
virtual int enableRemoteSuperResolution(uid_t userId, bool enable)=0
virtual int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain)=0
Definition: AgoraBase.h:162
Definition: IAgoraRtcEngine.h:590
int ipListSize
Definition: IAgoraRtcEngine.h:1041
AUDIO_SAMPLE_RATE_TYPE audioSampleRate
Definition: IAgoraRtcEngine.h:487
virtual void onConnectionInterrupted()
Definition: IAgoraRtcEngine.h:1756
int framerate
Definition: IAgoraRtcEngine.h:534
virtual int resumeEffect(int soundId)=0
const char * injectStreamUrl
Definition: IAgoraRtcEngine.h:561
virtual void onAudioRoutingChanged(int routing)
Definition: IAgoraRtcEngine.h:2086
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:483
virtual int getObject(const char *key, agora::util::AString &value)=0
virtual int enableVideo()=0
virtual int setRemoteUserSpatialAudioParams(uid_t uid, const agora::SpatialAudioParams ¶ms)=0
virtual int enableDualStreamMode(bool enabled)=0
const char ** domainList
Definition: IAgoraRtcEngine.h:1044
virtual int startEchoTest()=0
virtual int updateChannelMediaOptions(const ChannelMediaOptions &options)=0
virtual int initialize(const RtcEngineContext &context)=0
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngine.h:1318
virtual int resumeAudioMixing()=0
Definition: IAgoraRtcEngine.h:710
virtual int unloadEffect(int soundId)=0
Definition: IAgoraRtcEngine.h:384
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:2301
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
virtual int adjustPlaybackSignalVolume(int volume)=0
virtual int addPublishStreamUrl(const char *url, bool transcodingEnabled)=0
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1456
virtual int setExtensionProviderProperty(const char *provider, const char *key, const char *value)=0
int injectStreamWidth
Definition: IAgoraRtcEngine.h:555
VIDEO_STREAM_TYPE rxStreamType
Definition: IAgoraRtcEngine.h:352
virtual int enableAudio()=0
virtual int stopDeviceTest()=0
virtual int disableVideo()=0
int videoGop
Definition: IAgoraRtcEngine.h:475
Definition: AgoraBase.h:5358
virtual int setLogFilter(unsigned int filter)=0
virtual int getLoopbackRecordingVolume()=0
virtual void onPermissionError(PERMISSION_TYPE permissionType)
Definition: IAgoraRtcEngine.h:2234
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngine.h:2269
virtual int addVideoWatermark(const RtcImage &watermark)=0
virtual int setLocalAccessPoint(const LocalAccessPointConfiguration &config)=0
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngine.h:2195
virtual int stopSecondaryCustomAudioTrack()=0
virtual int disableAudio()=0
virtual int muteAllRemoteAudioStreams(bool mute)=0
virtual void onRtcStats(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1255
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1502
Definition: IAgoraRtcEngine.h:7187
virtual int sendCustomReportMessage(const char *id, const char *category, const char *event, const char *label, int value)=0
int packetLossRate
Definition: IAgoraRtcEngine.h:348
Definition: AgoraBase.h:3211
Definition: AgoraBase.h:5324
int rendererOutputFrameRate
Definition: IAgoraRtcEngine.h:279
virtual void onDownlinkNetworkInfoUpdated(const DownlinkNetworkInfo &info)
Definition: IAgoraRtcEngine.h:1351
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1850
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) __deprecated=0
unsigned int areaCode
Definition: IAgoraRtcEngine.h:2566
Definition: IAgoraRtcEngine.h:621
Definition: IAgoraRtcEngine.h:312
virtual int startAudioRecording(const char *filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality)=0
int injectStreamHeight
Definition: IAgoraRtcEngine.h:558
int domainListSize
Definition: IAgoraRtcEngine.h:1047
virtual int joinChannel(const char *token, const char *channelId, const char *info, uid_t uid)=0
virtual int getNumber(const char *key, double &value)=0
Definition: AgoraBase.h:2509
virtual int setRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) __deprecated
Definition: IAgoraRtcEngine.h:1601
virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual void onChannelMediaRelayStateChanged(int state, int code)
Definition: IAgoraRtcEngine.h:2120
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:2317
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1862
virtual int startPreview(VIDEO_SOURCE_TYPE sourceType)=0
Definition: AgoraBase.h:4112
uid_t uid
Definition: IAgoraRtcEngine.h:387
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2208
virtual int adjustLoopbackRecordingVolume(int volume)=0
double x
Definition: IAgoraRtcEngine.h:390