8 #import <Foundation/Foundation.h>
26 - (BOOL)onPlaybackAudioFrameBeforeMixing:(
AgoraAudioFrame* _Nonnull)frame uid:(NSUInteger)uid;
54 - (NSData * _Nullable)readyToSendMetadataAtTimestamp:(NSTimeInterval)timestamp;
69 - (void)receiveMetadata:(NSData * _Nonnull)data fromUser:(NSInteger)uid atTimestamp:(NSTimeInterval)timestamp;
82 #pragma mark Delegate Methods
92 #pragma mark Core Delegate Methods
106 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didOccurWarning:(AgoraWarningCode)warningCode;
116 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didOccurError:(AgoraErrorCode)errorCode;
159 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine tokenPrivilegeWillExpire:(NSString *_Nonnull)token;
238 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didApiCallExecute:(NSInteger)error api:(NSString * _Nonnull)api result:(NSString * _Nonnull)result;
246 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didRefreshRecordingServiceStatus:(NSInteger)status;
248 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
262 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine device:(NSString * _Nonnull)deviceId type:(AgoraMediaDeviceType)deviceType stateChanged:(NSInteger) state;
267 #pragma mark Local User Core Delegate Methods
282 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didJoinChannel:(NSString * _Nonnull)channel withUid:(NSUInteger)uid elapsed:(NSInteger) elapsed;
297 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didRejoinChannel:(NSString * _Nonnull)channel withUid:(NSUInteger)uid elapsed:(NSInteger) elapsed;
335 #pragma mark Local User Audio Delegate Methods
352 - (void)rtcEngine:(
AgoraRtcEngineKit *_Nonnull)engine audioMixingStateChanged:(AgoraAudioMixingStateType)stateType
353 errorType:(AgoraAudioMixingErrorType)errorType;
360 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine firstLocalAudioFramePublished:(NSInteger)elapsed;
393 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didAudioRouteChanged:(AgoraAudioOutputRouting)routing;
408 - (void)rtcEngineDidAudioEffectFinish:(
AgoraRtcEngineKit * _Nonnull)engine soundId:(
int)soundId;
411 #pragma mark Local User Video Delegate Methods
432 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine cameraFocusDidChangedToRect:(CGRect)rect;
451 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine firstLocalVideoFrameWithSize:(CGSize)size elapsed:(NSInteger)elapsed;
460 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine localVideoStats:(AgoraRtcLocalVideoStats * _Nonnull)stats;
472 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didLocalPublishFallbackToAudioOnly:(BOOL)isFallbackOrRecover;
475 #pragma mark Remote User Core Delegate Methods
501 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didJoinedOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed;
529 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine receiveStreamMessageFromUid:(NSUInteger)uid streamId:(NSInteger)streamId data:(NSData * _Nonnull)data;
540 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didOccurStreamMessageErrorFromUid:(NSUInteger)uid streamId:(NSInteger)streamId error:(NSInteger)error missed:(NSInteger)missed cached:(NSInteger)cached;
543 #pragma mark Remote User Audio Delegate Methods
557 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine firstRemoteAudioFrameOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed;
575 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didAudioMuted:(BOOL)muted byUid:(NSUInteger)uid;
628 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine activeSpeaker:(NSUInteger)speakerUid;
642 - (void)rtcEngineRemoteAudioMixingDidFinish:(
AgoraRtcEngineKit * _Nonnull)engine;
664 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine audioTransportStatsOfUid:(NSUInteger)uid delay:(NSUInteger)delay lost:(NSUInteger)lost rxKBitRate:(NSUInteger)rxKBitRate;
678 #pragma mark Remote User Video Delegates Methods
693 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine firstRemoteVideoDecodedOfUid:(NSUInteger)uid size:(CGSize)size elapsed:(NSInteger)elapsed;
702 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine firstRemoteVideoFrameOfUid:(NSUInteger)uid size:(CGSize)size elapsed:(NSInteger)elapsed;
711 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine videoSizeChangedOfUid:(NSUInteger)uid size:(CGSize)size rotation:(NSInteger)rotation;
747 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine remoteVideoStateChangedOfUid:(NSUInteger)uid state:(AgoraVideoRemoteState)state reason:(
AgoraVideoRemoteReason)reason elapsed:(NSInteger)elapsed;
772 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didVideoMuted:(BOOL)muted byUid:(NSUInteger)uid __deprecated_msg("use rtcEngine:remoteVideoStateChangedOfUid:state:reason: instead.");
788 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didVideoEnabled:(BOOL)enabled byUid:(NSUInteger)uid __deprecated_msg("use rtcEngine:remoteVideoStateChangedOfUid:state:reason: instead.");
800 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didLocalVideoEnabled:(BOOL)enabled byUid:(NSUInteger)uid __deprecated_msg("use rtcEngine:remoteVideoStateChangedOfUid:state:reason: instead.");
835 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine didRemoteSubscribeFallbackToAudioOnly:(BOOL)isFallbackOrRecover byUid:(NSUInteger)uid;
847 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine videoTransportStatsOfUid:(NSUInteger)uid delay:(NSUInteger)delay lost:(NSUInteger)lost rxKBitRate:(NSUInteger)rxKBitRate;
850 #pragma mark Stream Publish Delegate Methods
864 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine streamStateChanged:(NSString * _Nonnull)url
874 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine streamPublishedWithUrl:(NSString * _Nonnull)url errorCode:(AgoraErrorCode)errorCode;
881 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine streamUnpublishedWithUrl:(NSString * _Nonnull)url;
896 - (void)rtcEngine:(
AgoraRtcEngineKit * _Nonnull)engine streamInjectedStatusOfUrl:(NSString * _Nonnull)url uid:(NSUInteger)uid status:(AgoraInjectStreamStatus)status;
903 - (void)rtcEngine:(
AgoraRtcEngineKit *_Nonnull)engine audioMixingStateChanged:(AgoraAudioMixingStateType)state
904 errorCode:(AgoraAudioMixingErrorType)errorCode;
907 #pragma mark - AgoraRtcEngineKit
921 #pragma mark Core Methods
934 @property(nonatomic, weak) id<AgoraRtcEngineDelegate> _Nullable
delegate;
998 - (int)joinChannelByToken:(NSString * _Nullable)token
999 channelId:(NSString * _Nonnull)channelId
1000 info:(NSString * _Nullable)info
1002 joinSuccess:(
void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
1065 - (int)joinChannelByToken:(NSString * _Nullable)token
1066 channelId:(NSString * _Nonnull)channelId
1069 joinSuccess:(
void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
1071 - (int)startMultipleVideoStreams:(
VIEW_CLASS * _Nonnull)view screen:(
VIEW_CLASS * _Nonnull)screenView remotes:(NSArray * _Nullable)remoteViews;
1099 - (int)leaveChannel:(
void(^ _Nullable)(
AgoraChannelStats * _Nonnull stat))leaveChannelBlock;
1163 - (int)renewToken:(NSString * _Nonnull)token;
1184 - (int)enableWebSdkInteroperability:(BOOL)enabled;
1200 + (instancetype _Nonnull)sharedEngineWithAppId:(NSString * _Nonnull)appId
1232 #pragma mark Core Audio
1289 - (int)enableLocalAudio:(BOOL)enabled;
1329 - (int)enableAudioVolumeIndication:(NSInteger)interval
1330 smooth:(NSInteger)smooth;
1333 #if TARGET_OS_IPHONE
1351 - (int)setEnableSpeakerphone:(BOOL)enableSpeaker;
1362 - (BOOL)isSpeakerphoneEnabled;
1391 - (int)setDefaultAudioRouteToSpeakerphone:(BOOL)defaultToSpeaker;
1405 - (int)adjustRecordingSignalVolume:(NSInteger)volume;
1418 - (int)adjustPlaybackSignalVolume:(NSInteger)volume;
1428 -(int)muteRecordingSignal:(BOOL)muted;
1440 - (int)muteLocalAudioStream:(BOOL)mute;
1455 - (int)muteRemoteAudioStream:(NSUInteger)uid mute:(BOOL)mute;
1482 - (int)muteAllRemoteAudioStreams:(BOOL)mute;
1498 - (int)setDefaultMuteAllRemoteAudioStreams:(BOOL)mute;
1500 - (int)registerMediaNodeProviderWithVendor:(NSString * _Nonnull)vendor
1501 provider:(
long long)provider;
1503 - (int)unregisterMediaNodeProviderWithVendor:(NSString * _Nonnull)vendor;
1505 - (int)enableLocalVideoFilter:(NSString * _Nonnull) name
1506 vendor:(NSString * _Nonnull)vendor
1507 enable:(
bool)enable;
1509 - (int)setLocalVideoFilterProperty:(NSString * _Nonnull) name
1510 vendor:(NSString * _Nonnull) vendor
1511 key:(NSString * _Nonnull) key
1512 value:(NSValue * _Nullable) value;
1514 - (int)getLocalVideoFilterProperty:(NSString * _Nonnull) name
1515 vendor:(NSString * _Nonnull) vendor
1516 key:(NSString * _Nonnull) key
1517 value:(NSValue * _Nullable) value;
1519 - (int)enableRemoteVideoFilter:(NSString * _Nonnull) name
1520 vendor:(NSString * _Nonnull)vendor
1521 enable:(
bool)enable;
1523 - (int)setRemoteVideoFilterProperty:(NSString * _Nonnull) name
1524 vendor:(NSString * _Nonnull) vendor
1525 key:(NSString * _Nonnull) key
1526 value:(NSValue * _Nullable) value;
1528 - (int)getRemoteVideoFilterProperty:(NSString * _Nonnull) name
1529 vendor:(NSString * _Nonnull) vendor
1530 key:(NSString * _Nonnull) key
1531 value:(NSValue * _Nullable) value;
1533 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
1546 -(int)enableLoopbackRecording:(BOOL)enabled
1547 deviceName:(NSString * _Nullable)deviceName;
1551 #pragma mark Core Video
1611 - (int)enableLocalVideo:(BOOL)enabled;
1630 - (int)setVideoEncoderConfiguration:(AgoraVideoEncoderConfiguration * _Nonnull)config;
1686 - (int)setLocalVideoMirrorMode:(AgoraVideoMirrorMode)mode;
1731 - (int)setRemoteRenderMode:(NSUInteger)uid
1747 - (int)muteLocalVideoStream:(BOOL)mute;
1774 - (int)muteAllRemoteVideoStreams:(BOOL)mute;
1790 - (int)setDefaultMuteAllRemoteVideoStreams:(BOOL)mute;
1807 - (int)muteRemoteVideoStream:(NSUInteger)uid
1811 #pragma mark Audio Effect
1827 - (int)setLocalVoicePitch:(
double)pitch;
1836 - (int)setLocalVoiceEqualizationOfBandFrequency:(AgoraAudioEqualizationBandFrequency)bandFrequency withGain:(NSInteger)gain;
1845 - (int)setLocalVoiceReverbOfType:(AgoraAudioReverbType)reverbType withValue:(NSInteger)value;
1868 - (int) setLocalVoiceChanger:(AgoraAudioVoiceChanger)voiceChanger;
1888 - (int) setLocalVoiceReverbPreset:(AgoraAudioReverbPreset)reverbPreset;
1890 #pragma mark Audio Effect Playback
1908 - (int)preloadEffect:(
int)soundId
1909 filePath:(NSString* _Nonnull)filePath;
1940 - (int)playEffect:(
int)soundId
1941 loopCount:(NSInteger)loopCount
1944 gain:(NSInteger)gain;
1981 - (int)playEffect:(
int)soundId
1982 loopCount:(NSInteger)loopCount
1985 gain:(NSInteger)gain
1986 publish:(BOOL)publish;
2017 - (int)playEffect:(
int)soundId
2018 filePath:(NSString* _Nonnull)filePath
2019 loopCount:(NSInteger)loopCount
2022 gain:(NSInteger)gain;
2060 - (int)playEffect:(
int)soundId
2061 filePath:(NSString* _Nonnull)filePath
2062 loopCount:(NSInteger)loopCount
2065 gain:(NSInteger)gain
2066 publish:(BOOL)publish;
2100 - (int)playAllEffectsWithLoopCount:(NSInteger)loopCount
2103 gain:(NSInteger)gain
2104 publish:(BOOL)publish;
2113 - (int)getEffectsVolume;
2123 - (int)setEffectsVolume:(NSInteger)volume;
2133 - (int)setVolumeOfEffect:(
int)soundId
2134 withVolume:(int)volume;
2144 - (int)getVolumeOfEffect:(
int)soundId;
2153 - (int)pauseEffect:(
int)soundId;
2160 - (int)pauseAllEffects;
2169 - (int)resumeEffect:(
int)soundId;
2176 - (int)resumeAllEffects;
2185 - (int)stopEffect:(
int)soundId;
2193 - (int)stopAllEffects;
2202 - (int)unloadEffect:(
int)soundId;
2211 - (int)unloadAllEffects;
2213 #pragma mark Audio Mixing
2254 - (int)startAudioMixing:(NSString * _Nonnull)filePath
2255 loopback:(BOOL)loopback
2256 replace:(BOOL)replace
2257 cycle:(NSInteger)cycle;
2268 - (int)stopAudioMixing;
2278 - (int)pauseAudioMixing;
2289 - (int)resumeAudioMixing;
2301 - (int)adjustAudioMixingVolume:(NSInteger)volume;
2312 - (int)adjustAudioMixingPublishVolume:(NSInteger)volume;
2322 - (int)getAudioMixingPublishVolume;
2332 - (int)adjustAudioMixingPlayoutVolume:(NSInteger)volume;
2342 - (int)getAudioMixingPlayoutVolume;
2354 - (int)getAudioMixingDuration;
2364 - (int)getAudioMixingCurrentPosition;
2376 - (int)setAudioMixingPosition:(NSInteger)pos;
2378 #pragma mark Audio Recording
2400 - (int)startAudioRecording:(NSString * _Nonnull)filePath
2401 quality:(AgoraAudioRecordingQuality)quality;
2410 - (int)stopAudioRecording;
2412 #pragma mark Echo Test
2431 - (int)startEchoTest:(
void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))successBlock;
2440 - (int)stopEchoTest;
2443 #pragma mark Miscellaneous Audio Control
2450 #if TARGET_OS_IPHONE
2463 - (int)enableInEarMonitoring:(BOOL)enabled;
2481 - (int)enableInEarMonitoring:(BOOL)enabled includeAudioFilter:(BOOL)includeAudioFilter;
2495 - (int)setInEarMonitoringVolume:(NSInteger)volume;
2505 - (void)setAudioSessionOperationRestriction:(AgoraAudioSessionOperationRestriction)restriction;
2509 #pragma mark Dual Video Mode
2526 - (int)enableDualStreamMode:(BOOL)enabled;
2548 - (int)setRemoteVideoStream:(NSUInteger)uid
2565 #pragma mark Stream Fallback
2589 - (int)setLocalPublishFallbackOption:(AgoraStreamFallbackOptions)option;
2602 - (int)setRemoteSubscribeFallbackOption:(AgoraStreamFallbackOptions)option;
2604 #pragma mark Video Quality Control
2621 - (int)setVideoQualityParameters:(BOOL)preferFrameRateOverImageQuality;
2623 #pragma mark External Media Source
2652 - (void)setExternalVideoSource:(BOOL)enable useTexture:(BOOL)useTexture pushMode:(BOOL)pushMode;
2691 - (int)setExternalAudioSource:(BOOL)enabled
2692 sampleRate:(NSInteger)sampleRate
2693 channels:(NSInteger)channels;
2714 - (int)setExternalAudioSource:(BOOL)enabled
2715 sampleRate:(NSInteger)sampleRate
2716 channels:(NSInteger)channels
2717 sourceNumber:(NSInteger)sourceNumber;
2727 - (int)pushExternalAudioFrameRawData:(
void * _Nonnull)data
2728 sourceId:(NSInteger)sourceId
2729 timestamp:(NSTimeInterval)timestamp;
2739 - (int)pushExternalAudioFrameSampleBuffer:(CMSampleBufferRef _Nonnull)sampleBuffer;
2764 - (int)setRecordingAudioFrameParametersWithSampleRate:(NSInteger)sampleRate
2765 channel:(NSInteger)channel
2767 samplesPerCall:(NSInteger)samplesPerCall;
2792 - (int)setPlaybackAudioFrameParametersWithSampleRate:(NSInteger)sampleRate
2793 channel:(NSInteger)channel
2795 samplesPerCall:(NSInteger)samplesPerCall;
2814 - (int)setMixedAudioFrameParametersWithSampleRate:(NSInteger)sampleRate
2815 channel:(NSInteger)channel
2816 samplesPerCall:(NSInteger)samplesPerCall;
2832 - (int)setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:(NSInteger)sampleRate
2833 channel:(NSInteger)channel;
2835 #pragma mark Built-in Encryption
2855 - (int)setEncryptionMode:(NSString * _Nullable)encryptionMode;
2870 - (int)setEncryptionSecret:(NSString * _Nullable)secret;
2872 #pragma mark Data Stream
2895 - (int)createDataStream:(NSInteger * _Nonnull)streamId
2896 reliable:(BOOL)reliable
2897 ordered:(BOOL)ordered;
2911 - (int)sendStreamMessage:(NSInteger)streamId
2912 data:(NSData * _Nonnull)data;
2914 #pragma mark Stream Publish
2933 - (int)addPublishStreamUrl:(NSString * _Nonnull)url transcodingEnabled:(BOOL)transcodingEnabled;
2944 - (int)removePublishStreamUrl:(NSString * _Nonnull)url;
2950 - (int)setLiveTranscoding:(AgoraLiveTranscoding *_Nullable)transcoding;
2959 - (int)addInjectStreamUrl:(NSString * _Nonnull)url config:(AgoraLiveInjectStreamConfig * _Nonnull)config;
2965 - (int)removeInjectStreamUrl:(NSString * _Nonnull)url;
2967 #pragma mark Deprecated CDN Publisher
2983 - (int)configPublisher:(AgoraPublisherConfiguration * _Nonnull)config __deprecated;
3002 - (int)setVideoCompositingLayout:(AgoraRtcVideoCompositingLayout * _Nonnull)layout __deprecated;
3009 - (int)clearVideoCompositingLayout __deprecated;
3011 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
3012 #pragma mark Screen Capture
3029 - (int)startScreenCapture:(NSUInteger)windowId
3030 withCaptureFreq:(NSInteger)captureFreq
3031 bitRate:(NSInteger)bitRate
3032 andRect:(CGRect)rect;
3041 - (int)stopScreenCapture;
3050 - (int)updateScreenCaptureRegion:(CGRect)rect;
3053 #if TARGET_OS_IPHONE
3054 #pragma mark Camera Control
3068 - (BOOL)isCameraZoomSupported;
3076 - (CGFloat)setCameraZoomFactor:(CGFloat)zoomFactor;
3085 - (BOOL)isCameraFocusPositionInPreviewSupported;
3094 - (BOOL)setCameraFocusPositionInPreview:(CGPoint)position;
3106 - (BOOL)isCameraTorchSupported;
3115 - (BOOL)setCameraTorchOn:(BOOL)isOn;
3124 - (BOOL)isCameraAutoFocusFaceModeSupported;
3133 - (BOOL)setCameraAutoFocusFaceModeEnabled:(BOOL)enable;
3147 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
3148 #pragma mark macOS Device
3161 - (void)monitorDeviceChange:(BOOL)enabled;
3175 - (NSArray<AgoraRtcDeviceInfo *> * _Nullable)enumerateDevices:(AgoraMediaDeviceType)type;
3184 - (AgoraRtcDeviceInfo * _Nullable)getDeviceInfo:(AgoraMediaDeviceType)type;
3196 - (int)setDevice:(AgoraMediaDeviceType)type deviceId:(NSString * _Nonnull)deviceId;
3206 - (int)getDeviceVolume:(AgoraMediaDeviceType)type;
3217 - (int)setDeviceVolume:(AgoraMediaDeviceType)type volume:(int)volume;
3229 - (int)startRecordingDeviceTest:(
int)indicationInterval;
3240 - (int)stopRecordingDeviceTest;
3256 - (int)startPlaybackDeviceTest:(NSString * _Nonnull)audioFileName;
3267 - (int)stopPlaybackDeviceTest;
3277 - (int)startCaptureDeviceTest:(NSView * _Nonnull)view;
3285 - (int)stopCaptureDeviceTest;
3288 #pragma mark Server Recording
3297 - (int)startRecordingService:(NSString * _Nonnull)recordingKey;
3301 - (int)stopRecordingService:(NSString * _Nonnull)recordingKey;
3308 - (int)refreshRecordingServiceStatus;
3310 #pragma mark Watermark
3323 - (int)addVideoWatermark:(AgoraImage * _Nonnull)watermark NS_SWIFT_NAME(addVideoWatermark(_:));
3327 - (int)clearVideoWatermarks;
3329 #pragma mark Custom Audio PCM Frame
3337 - (BOOL)setAudioFrameDelegate:(id<AgoraAudioFrameDelegate> _Nullable)
delegate;
3339 #pragma mark Custom Media Metadata
3357 - (BOOL)setMediaMetadataDataSource:(id<AgoraMediaMetadataDataSource> _Nullable)metadataDataSource withType:(
AgoraMetadataType)type;
3370 - (BOOL)setMediaMetadataDelegate:(id<AgoraMediaMetadataDelegate> _Nullable)metadataDelegate withType:(
AgoraMetadataType)type;
3372 #pragma mark Miscellaneous Methods
3391 + (NSString* _Nonnull)getErrorDescription: (NSInteger)error;
3398 - (
void * _Nullable)getNativeHandle;
3424 - (int)setLogFile:(NSString * _Nonnull)filePath;
3440 - (int)setLogFilter:(NSUInteger)filter;
3474 - (int)rate:(NSString * _Nonnull)callId
3475 rating:(NSInteger)rating
3476 description:(NSString * _Nullable)description;
3495 - (int)complain:(NSString * _Nonnull)callId
3496 description:(NSString * _Nullable)description;
3509 - (int)enableMainQueueDispatch:(BOOL)enabled;
3549 - (int)setParameters:(NSString * _Nonnull)options;
3556 - (NSString * _Nullable)getParameter:(NSString * _Nonnull)parameter
3557 args:(NSString * _Nullable)args;
3559 #pragma mark Deprecated Methods
3578 - (void)audioVolumeIndicationBlock:(
void(^ _Nullable)(NSArray * _Nonnull speakers, NSInteger totalVolume))audioVolumeIndicationBlock __deprecated_msg(
"use delegate instead.");
3587 - (void)firstLocalVideoFrameBlock:(
void(^ _Nullable)(NSInteger width, NSInteger height, NSInteger elapsed))firstLocalVideoFrameBlock __deprecated_msg(
"use delegate instead.");
3597 - (void)firstRemoteVideoDecodedBlock:(
void(^ _Nullable)(NSUInteger uid, NSInteger width, NSInteger height, NSInteger elapsed))firstRemoteVideoDecodedBlock __deprecated_msg(
"use delegate instead.");
3607 - (void)firstRemoteVideoFrameBlock:(
void(^ _Nullable)(NSUInteger uid, NSInteger width, NSInteger height, NSInteger elapsed))firstRemoteVideoFrameBlock __deprecated_msg(
"use delegate instead.");
3617 - (void)userJoinedBlock:(
void(^ _Nullable)(NSUInteger uid, NSInteger elapsed))userJoinedBlock __deprecated_msg(
"use delegate instead.");
3626 - (void)userOfflineBlock:(
void(^ _Nullable)(NSUInteger uid))userOfflineBlock __deprecated_msg(
"use delegate instead.");
3635 - (void)userMuteAudioBlock:(
void(^ _Nullable)(NSUInteger uid, BOOL muted))userMuteAudioBlock __deprecated_msg(
"use delegate instead.");
3644 - (void)userMuteVideoBlock:(
void(^ _Nullable)(NSUInteger uid, BOOL muted))userMuteVideoBlock __deprecated_msg(
"use delegate instead.");
3652 - (void)localVideoStatBlock:(
void(^ _Nullable)(NSInteger sentBitrate, NSInteger sentFrameRate))localVideoStatBlock __deprecated_msg(
"use delegate instead.");
3662 - (void)remoteVideoStatBlock:(
void(^ _Nullable)(NSUInteger uid, NSInteger delay, NSInteger receivedBitrate, NSInteger receivedFrameRate))remoteVideoStatBlock __deprecated_msg(
"use delegate instead.");
3667 - (void)cameraReadyBlock:(
void(^ _Nullable)(void))cameraReadyBlock __deprecated_msg(
"use delegate instead.");
3672 - (void)connectionLostBlock:(
void(^ _Nullable)(void))connectionLostBlock __deprecated_msg(
"use delegate instead.");
3683 - (void)rejoinChannelSuccessBlock:(
void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))rejoinChannelSuccessBlock __deprecated_msg(
"use delegate instead.");
3690 - (void)rtcStatsBlock:(
void(^ _Nullable)(
AgoraChannelStats * _Nonnull stat))rtcStatsBlock __deprecated_msg(
"use delegate instead.");
3699 - (void)leaveChannelBlock:(
void(^ _Nullable)(
AgoraChannelStats * _Nonnull stat))leaveChannelBlock __deprecated_msg(
"use delegate instead.");
3709 - (void)audioQualityBlock:(
void(^ _Nullable)(NSUInteger uid,
AgoraNetworkQuality quality, NSUInteger delay, NSUInteger lost))audioQualityBlock __deprecated_msg(
"use delegate instead.");
3718 - (void)networkQualityBlock:(
void(^ _Nullable)(NSUInteger uid,
AgoraNetworkQuality txQuality,
AgoraNetworkQuality rxQuality))networkQualityBlock __deprecated_msg(
"use delegate instead.");
3725 - (void)lastmileQualityBlock:(
void(^ _Nullable)(
AgoraNetworkQuality quality))lastmileQualityBlock __deprecated_msg(
"use delegate instead.");
3730 - (void)mediaEngineEventBlock:(
void(^ _Nullable)(NSInteger code))mediaEngineEventBlock __deprecated_msg(
"use delegate instead.");
3741 - (int)pauseAudio __deprecated_msg(
"use disableAudio instead.");
3752 - (int)resumeAudio __deprecated_msg(
"use enableAudio instead.");
3760 + (instancetype _Nonnull)sharedEngineWithAppId:(NSString * _Nonnull)AppId
3761 error:(void(^ _Nullable)(AgoraErrorCode errorCode))errorBlock __deprecated_msg(
"use sharedEngineWithAppId:delegate: instead.");
3768 - (int)setHighQualityAudioParametersWithFullband:(BOOL)fullband
3770 fullBitrate:(BOOL)fullBitrate __deprecated_msg(
"use setAudioProfile:scenario: instead.");
3791 - (int)setVideoProfile:(AgoraVideoProfile)profile
3792 swapWidthAndHeight:(BOOL)swapWidthAndHeight __deprecated_msg(
"use setVideoEncoderConfiguration: instead.");
3812 - (int)setVideoResolution:(CGSize)size andFrameRate:(NSInteger)frameRate bitrate:(NSInteger)bitrate __deprecated_msg(
"use setVideoEncoderConfiguration: instead.");
3841 - (NSString * _Nullable)getDeviceId:(AgoraMediaDeviceType)type __deprecated_msg(
"use getDeviceInfo: instead.");
3843 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
3853 - (int)setSpeakerphoneVolume:(NSUInteger)volume __deprecated_msg(
"use setDeviceVolume:volume: instead.");
3861 + (NSString * _Nonnull)getMediaEngineVersion __deprecated;
3863 - (int)setAudioOptionParams:(NSString * _Nonnull)params;
3864 - (NSString * _Nullable)getAudioOptionParams;
3865 - (int)setAudioSessionParams:(NSString * _Nonnull)params;
3866 - (NSString * _Nullable)getAudioSessionParams;
3870 - (int)sendCustomReportMessage:(NSString * _Nullable)messageId
3871 category:(NSString * _Nullable)category
3872 event:(NSString * _Nullable)
event
3873 label:(NSString * _Nullable)label
3874 value:(NSInteger)value;
3881 #pragma mark - String uid for AgoraRtcEngineKit
3883 @interface AgoraRtcEngineKit (StringUID)
3885 - (int)joinChannelByToken:(NSString * _Nullable)token
3886 channelId:(NSString * _Nonnull)channelId
3887 info:(NSString * _Nullable)info
3888 userId:(NSString * _Nullable)userId;
3890 - (int)setRemoteRenderMode2:(NSString * _Nonnull)userId
3893 - (int)switchView2:(NSString * _Nonnull)userId1
3894 andAnother:(NSString * _Nonnull)userId2 __deprecated;
3896 - (int)muteRemoteAudioStream2:(NSString * _Nonnull)userId mute:(BOOL)mute;
3898 - (int)setRemoteVideoStream2:(NSString * _Nonnull)userId
3901 - (int)muteRemoteVideoStream2:(NSString * _Nonnull)userId
3904 - (int)sendPublishingRequestToOwner2:(NSString * _Nonnull) userId;
3905 - (int)answerPublishingRequestOfUid2:(NSString * _Nonnull) userId accepted:(bool)accepted;
3906 - (int)sendUnpublishingRequestToUid2:(NSString * _Nonnull) userId;