INERtcEngineEx.h

浏览该文件的文档.

/*
 * Copyright (c) 2021 NetEase, Inc. All rights reserved.
 */
 
#ifndef INERtcEngineEx_h
#define INERtcEngineEx_h
 
#import "INERtcEngine.h"
#import "NERtcEngineStatistics.h"
#import "NERtcEngineBase.h"
#import "NERtcEngineDelegate.h"
 
@class NERtcChannel;
 
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"
 
 
NS_ASSUME_NONNULL_BEGIN

@protocol INERtcEngineEx <INERtcEngine>

- (int)enableDualStreamMode:(BOOL)enable;

- (int)setVideoStreamLayerCount:(NERtcVideoStreamLayerCount)layerCount;
- (int)setLocalMediaPriority:(NERtcMediaPriorityType)priority preemptive:(BOOL)preemptive;
 

- (int)setLocalPublishFallbackOption:(NERtcStreamFallbackOptions)option;

- (int)setRemoteSubscribeFallbackOption:(NERtcStreamFallbackOptions)option;

- (int)muteLocalAudio:(BOOL)muted;

- (int)subscribeRemoteAudio:(BOOL)subscribe forUserID:(uint64_t)userID;

- (int)subscribeAllRemoteAudio:(BOOL)subscribe;

- (int)setAudioSubscribeOnlyBy:(NSArray<NSNumber*> *)uidArray;

- (int)enableLocalSubStreamAudio:(BOOL)enabled;

- (int)subscribeRemoteSubStreamAudio:(BOOL)subscribe forUserID:(uint64_t)userID;

- (int)muteLocalSubStreamAudio:(BOOL)muted;
 

- (int)setExternalSubStreamAudioSource:(BOOL)enabled sampleRate:(int32_t)sampleRate channels:(int32_t)channels;

- (int)pushExternalSubStreamAudioFrame:(NERtcAudioFrame *)frame;

 - (int)subscribeRemoteVideo:(BOOL)subscribe forUserID:(uint64_t)userID streamType:(NERtcRemoteVideoStreamType)streamType;

- (int)startPreview;

- (int)startPreview:(NERtcStreamChannelType)streamType;

- (int)stopPreview;

- (int)stopPreview:(NERtcStreamChannelType)streamType;

- (int)setLocalRenderScaleMode:(NERtcVideoRenderScaleMode)mode;

- (int)setLocalRenderScaleMode:(NERtcVideoRenderScaleMode)mode streamType:(NERtcStreamChannelType)streamType;

- (int)setRemoteRenderScaleMode:(NERtcVideoRenderScaleMode)mode forUserID:(uint64_t)userID;

- (int)setRemoteRenderScaleMode:(NERtcVideoRenderScaleMode)mode forUserID:(uint64_t)userID streamType:(NERtcStreamChannelType)streamType;

 - (int)setVideoRotationMode:(NERtcVideoRotationMode)rotationMode;

 - (int)muteLocalVideo:(BOOL)muted;

 - (int)muteLocalVideo:(BOOL)muted streamType:(NERtcStreamChannelType)streamType;

- (int)setLoudspeakerMode:(bool)enable;

- (int)getLoudspeakerMode:(bool *)enabled;
 

- (int)startAudioDump;

- (int)startAudioDumpWithType:(NERtcAudioDumpType)type;

- (int)stopAudioDump;
 

- (int)setVideoDump:(NERtcVideoDumpType)type;

- (int)setRemoteHighPriorityAudioStream:(BOOL)enable forUserID:(uint64_t)userID streamType:(NERtcAudioStreamType)streamType;

- (int)clearRemoteHighPriorityAudioStream;

- (int)switchCameraWithPosition:(NERtcCameraPosition)position;
 

- (int)updatePermissionKey:(NSString *)key;

- (BOOL)isFeatureSupportedWithType:(NERtcFeatureType)featureType;

- (NERtcFeatureSupportType)getFeatureSupportedType:(NERtcFeatureType)featureType;

- (NERtcNetworkConnectionType)getNetworkType;

- (int)setMultiPathOption:(NERtcMultiPathOption *)multiPathOption;
 
#pragma mark - External Video Input

- (int)setExternalVideoSource:(BOOL)enable isScreen:(BOOL)isScreen;

- (int)setExternalVideoSource:(BOOL)enable streamType:(NERtcStreamChannelType)streamType;

- (int)pushExternalVideoFrame:(NERtcVideoFrame*)frame;

- (int)pushExternalVideoFrame:(NERtcVideoFrame*)frame streamType:(NERtcStreamChannelType)streamType;
 
#pragma mark - Sub Stream

- (int)setupLocalSubStreamVideoCanvas:(nullable NERtcVideoCanvas *)canvas;

- (int)setupLocalVideoCanvas:(nullable NERtcVideoCanvas *)canvas streamType:(NERtcStreamChannelType)streamType;

- (int)startScreenCapture:(NERtcVideoSubStreamEncodeConfiguration *)config;

- (int)stopScreenCapture;

- (int)setLocalRenderSubStreamScaleMode:(NERtcVideoRenderScaleMode)mode;

- (int)setupRemoteSubStreamVideoCanvas:(nullable NERtcVideoCanvas *)canvas forUserID:(uint64_t)userID;

- (int)setupRemoteVideoCanvas:(nullable NERtcVideoCanvas *)canvas forUserID:(uint64_t)userID streamType:(NERtcStreamChannelType)streamType;
- (int)subscribeRemoteSubStreamVideo:(BOOL)subscribe forUserID:(uint64_t)userID;
 

- (int)subscribeRemoteVideo:(BOOL)subscribe forUserID:(uint64_t)userID streamType:(NERtcStreamChannelType)streamType subscribeType:(NERtcRemoteVideoStreamType)subscribeType;

- (int)setRemoteRenderSubStreamVideoScaleMode:(NERtcVideoRenderScaleMode)mode forUserID:(uint64_t)userID;
 
#pragma mark - Audio Session

- (int)setAudioSessionOperationRestriction:(NERtcAudioSessionOperationRestriction)restriction;
 
#pragma mark - Audio Device Manager

- (int)setPlayoutDeviceMute:(bool)muted;
 

- (int)getPlayoutDeviceMute:(bool *)muted;
 

- (int)setRecordDeviceMute:(bool)muted;
 

- (int)getRecordDeviceMute:(bool *)muted;
 
 
#pragma mark - Camera & Torch Settings

- (BOOL)isCameraZoomSupported;

- (BOOL)isCameraTorchSupported;

- (BOOL)isCameraFocusSupported;

- (BOOL)isCameraExposurePositionSupported;

- (int)setCameraExposurePosition:(CGPoint)positionInView;

- (int)setCameraTorchOn:(BOOL)on;

- (BOOL)isCameraTorchOn;

- (int)setCameraZoomFactor:(float)factor;

 - (float)maxCameraZoomScale;

- (int)setCameraFocusPositionX:(float)focusX Y:(float)focusY;

 - (int)setCameraCaptureConfig:(NERtcCameraCaptureConfiguration *)config;

- (int)setCameraCaptureConfig:(NERtcCameraCaptureConfiguration *)config streamType:(NERtcStreamChannelType)streamType;
 
#pragma mark - Audio Mixing

- (int)startAudioMixingWithOption:(NERtcCreateAudioMixingOption *)option;

- (int)stopAudioMixing;

- (int)pauseAudioMixing;

- (int)resumeAudioMixing;

- (int)setAudioMixingSendVolume:(uint32_t)volume;

- (int)getAudioMixingSendVolume:(uint32_t *)volume;

- (int)setAudioMixingPlaybackVolume:(uint32_t)volume;

- (int)getAudioMixingPlaybackVolume:(uint32_t *)volume;

- (int)getAudioMixingDuration:(uint64_t *)duration;

- (int)getAudioMixingCurrentPosition:(uint64_t *)position;

- (int)setAudioMixingPosition:(uint64_t)position;

- (int)setAudioMixingPitch:(int32_t)pitch;

- (int)getAudioMixingPitch:(int32_t *)pitch;
 
#pragma mark - Audio Effect
- (int)playEffectWitdId:(uint32_t)effectId effectOption:(NERtcCreateAudioEffectOption *)option;

- (int)stopEffectWitdId:(uint32_t)effectId;

- (int)stopAllEffects;

- (int)pauseEffectWitdId:(uint32_t)effectId;

- (int)resumeEffectWitdId:(uint32_t)effectId;

- (int)pauseAllEffects;

- (int)resumeAllEffects;

- (int)setEffectSendVolumeWithId:(uint32_t)effectId volume:(uint32_t)volume;

- (int)getEffectSendVolumeWithId:(uint32_t)effectId volume:(uint32_t *)volume;

- (int)setEffectPlaybackVolumeWithId:(uint32_t)effectId volume:(uint32_t)volume;

- (int)getEffectPlaybackVolumeWithId:(uint32_t)effectId volume:(uint32_t *)volume;

- (int)getEffectDurationWithId:(uint32_t)effectId duration:(uint64_t *)duration;

- (int)getEffectCurrentPositionWithId:(uint32_t)effectId position:(uint64_t *)position;

- (int)setEffectPositionWithId:(uint32_t)effectId position:(uint64_t)position;

- (int)setEffectPitchWithId:(uint32_t)effectId pitch:(int32_t)pitch;

- (int)getEffectPitchWithId:(uint32_t)effectId pitch:(int32_t *)pitch;
 
#pragma mark - In-ear monitoring
- (int)enableEarback:(BOOL)enabled volume:(uint32_t)volume;

- (int)setEarbackVolume:(uint32_t)volume;
 
#pragma mark - Audio Recording
- (int)startAudioRecording:(NSString *)filePath sampleRate:(int)sampleRate quality:(NERtcAudioRecordingQuality)quality;

- (int)startAudioRecordingWithConfig:(NERtcAudioRecordingConfiguration *_Nonnull)config;

- (int)stopAudioRecording;
 
#pragma mark - External Audio
- (int)setExternalAudioSource:(BOOL)enabled sampleRate:(int32_t)sampleRate channels:(int32_t)channels;

 
- (int)pushExternalAudioFrame:(NERtcAudioFrame *)frame;
 

 - (int)setExternalAudioRender:(BOOL)enabled sampleRate:(int32_t)sampleRate channels:(int32_t)channels;

- (int)pullExternalAudioFrame:(void *_Nonnull)data length:(int)len;
 
#pragma mark - 3D Audio

- (int)setRangeAudioMode:(NERtcRangeAudioMode)mode;

-(int)setRangeAudioTeamID:(int32_t)teamId;

- (int)setAudioRecvRange:(int)audibleDistance conversationalDistance:(int)conversationalDistance rollOff:(NERtcDistanceRolloffModel)rollOff;

- (int)updateSelfPosition:(NERtcPositionInfo *)info;

- (int)enableSpatializerRoomEffects:(BOOL)enabled;

- (int)setSpatializerRoomProperty:(NERtcSpatializerRoomProperty *)roomProperty;

- (int)setSpatializerRenderMode:(NERtcSpatializerRenderMode)mode;

- (int)initSpatializer;

- (int)enableSpatializer:(BOOL)enabled applyToTeam:(BOOL)applyToTeam;
 
#pragma mark - ASL black and white list
- (int)setSubscribeAudioBlocklist:(NERtcAudioStreamType)type uidArray:(NSArray<NSNumber*> *)uidArray;

- (int)setSubscribeAudioAllowlist:(NSArray<NSNumber*> *)uidArray;
 
#pragma mark - Data Channel

- (int)enableLocalData:(BOOL)enabled;

- (int)subscribeRemoteData:(BOOL)subscribe forUserID:(uint64_t)userID;

- (int)sendData:(NSData *)data;
 
#pragma mark - Media Statistic Observer

- (int)addEngineMediaStatsObserver:(id<NERtcEngineMediaStatsObserver>)observer;

- (int)removeEngineMediaStatsObserver:(id<NERtcEngineMediaStatsObserver>)observer;

- (int)cleanupEngineMediaStatsObserver;
 
 
#pragma mark - Live Stream
- (int)addLiveStreamTask:(NERtcLiveStreamTaskInfo *)taskInfo compeltion:(NERtcLiveStreamCompletion)completion;

- (int)updateLiveStreamTask:(NERtcLiveStreamTaskInfo *)taskInfo compeltion:(NERtcLiveStreamCompletion)completion;

- (int)removeLiveStreamTask:(NSString *)taskId compeltion:(NERtcLiveStreamCompletion)completion;
 
#pragma mark - Audio Frame Observer
- (int)setRecordingAudioFrameParameters:(nullable NERtcAudioFrameRequestFormat *)format;
 
  
- (int)setPlaybackAudioFrameParameters:(nullable NERtcAudioFrameRequestFormat *)format;

- (int)setMixedAudioFrameParameters:(nullable NERtcAudioFrameRequestFormat *)format;
 

- (int)setPlaybackBeforeMixingAudioFrameParameters:(nullable NERtcAudioFrameRequestFormat *)format;

- (int)setAudioFrameObserver:(nullable id<NERtcEngineAudioFrameObserver>)observer;
 

- (int)setVideoFrameObserver:(nullable id<NERtcEngineVideoFrameObserver>)videoframeObserver;
 

- (int)addRemoteVideoFrameObserver:(nullable id<NERtcEngineVideoFrameObserver>)videoframeObserver;
 
 
#pragma mark - Volume Indication
- (int)enableAudioVolumeIndication:(BOOL)enable interval:(uint64_t)interval;

- (int)enableAudioVolumeIndication:(BOOL)enable interval:(uint64_t)interval vad:(BOOL)enableVad;
 
 
#pragma mark - Signal Volume
- (int)adjustRecordingSignalVolume:(uint32_t)volume;

- (int)adjustPlaybackSignalVolume:(uint32_t)volume;

- (int)adjustUserPlaybackSignalVolume:(uint32_t)volume forUserID:(uint64_t)userID;

- (int)adjustChannelPlaybackSignalVolume:(uint32_t)volume;
 
#pragma mark - Voice Effect

- (int)setLocalVoicePitch:(double)pitch;

- (int)setLocalVoiceEqualizationOfBandFrequency:(NERtcAudioEqualizationBandFrequency)bandFrequency withGain:(NSInteger)gain;

- (int)setVoiceBeautifierPreset:(NERtcVoiceBeautifierType)type;

- (int)setAudioEffectPreset:(NERtcVoiceChangerType)type;

- (int)setLocalVoiceReverbParam:(NERtcReverbParam *)param;
 
#pragma mark - WaterMark
- (int)setLocalVideoWatermarkConfigs:(nullable NERtcVideoWatermarkConfig *)config 
                      withStreamType:(NERtcStreamChannelType)type;
 
#pragma mark - Snapshot
- (int)takeLocalSnapshot:(NERtcStreamChannelType)streamType callback:(NERtcTakeSnapshotCallback)callback;

- (int)takeRemoteSnapshot:(NERtcStreamChannelType)streamType forUserID:(uint64_t)userID callback:(NERtcTakeSnapshotCallback)callback;
 
#pragma mark - Other
- (int)uploadSdkInfo;

- (int)reportCustomEvent:(NSString *)eventName
          customIdentify:(NSString *)customIdentify
                   param:(NSDictionary *)param;
 
#pragma mark - SEI

- (int)sendSEIMsg:(NSData *)data streamChannelType:(NERtcStreamChannelType)type;

- (int)sendSEIMsg:(NSData *)data;
 
#pragma mark - MediaRelay

- (int)startChannelMediaRelay:(NERtcChannelMediaRelayConfiguration *_Nonnull)config;

- (int)updateChannelMediaRelay:(NERtcChannelMediaRelayConfiguration *_Nonnull)config;

- (int)stopChannelMediaRelay;

- (int)pauseChannelMediaRelay;

- (int)resumeChannelMediaRelay;

- (int)enableSuperResolution:(BOOL)enabled;

- (int)enableEncryption:(BOOL)enable config:(NERtcEncryptionConfig *)config;
 
#pragma mark - NetworkQualiityTest

- (int)startLastmileProbeTest:(NERtcLastmileProbeConfig *_Nullable)config;

- (int)stopLastmileProbeTest;
 
#pragma mark - Channel
- (nullable NERtcChannel *)createChannel:(NSString *)channelName;
 
#pragma mark - Video Effect

- (int)enableVideoCorrection:(BOOL)enable;

- (int)setVideoCorrectionConfig:(nullable NERtcVideoCorrectionConfiguration *)config;

- (int)enableVirtualBackground:(BOOL)enable backData:(NERtcVirtualBackgroundSource *_Nullable)backData;

- (int)enableVirtualBackground:(BOOL)enable backData:(NERtcVirtualBackgroundSource *_Nullable)backData force:(BOOL)force;
 
#pragma mark - Cloud Proxy

- (int)setCloudProxy:(NERtcTransportType)proxyType;

- (void)setStreamAlignmentProperty:(BOOL)enable;

- (int64_t)getNtpTimeOffset;
 
#pragma mark - Encoder & Decoder

- (int)setPreDecodeObserver:(nullable id<NERtcEnginePreDecodeObserver>)observer;
 

- (int)setVideoEncoderQosObserver:(nullable id<NERtcEngineVideoEncoderQosObserver>)encoderQosObserver;

- (int)pushExternalAudioEncodedFrame:(NERtcAudioEncodedFrame *)encodedAudioFrame;

- (int)pushExternalSubStreamAudioEncodedFrame:(NERtcAudioEncodedFrame *)encodedAudioFrame;

- (int)pushExternalVideoEncodedFrame:(NERtcVideoEncodedFrame *)encodedVideoFrame;

- (int)pushExternalSubStreamVideoEncodedFrame:(NERtcVideoEncodedFrame *)encodedVideoFrame;
 
#pragma mark - Push Streaming

- (int)startPushStreaming:(NERtcPushStreamingConfig *)config;

- (int)stopPushStreaming;
 
#pragma mark - Play Streaming
 
// 添加注释
- (int)setupPlayStreamingCanvas:(NSString *)streamId canvas:(NERtcVideoCanvas *)canvas;

- (int)startPlayStreaming:(NSString *)streamId playConfig:(NERtcPlayStreamingConfig*)config;

- (int)stopPlayStreaming:(NSString *)streamId;
        
- (int)pausePlayStreaming:(NSString *)streamId;

- (int)resumePlayStreaming:(NSString *)streamId;
 

- (int)muteVideoForPlayStreaming:(NSString *)streamId mute:(BOOL)mute;

- (int)muteAudioForPlayStreaming:(NSString *)streamId mute:(BOOL)mute;
 

- (int)seekPlayStreaming:(NSString *)streamId positionMs:(int64_t)positionMs;
 
#pragma mark - AI Relate

- (int)startASRCaption:(NERtcASRCaptionConfig *)config;

- (int)stopASRCaption;

- (int)aiManualInterrupt:(uint64_t)dstUserId;

- (int)requestLLM:(uint64_t)dstUid params:(NERtcLLMRequestParams *)params compeltion:(NERtcLLMRequestCompletion)compeltion;
 
#pragma mark - Video Mosaic

- (int)setLocalVideoMosaic:(BOOL)enabled streamType:(NERtcStreamChannelType)streamType rect:(NERtcFrameNormalizedRect *)rect;

- (int)setRemoteVideoMosaic:(BOOL)enabled userId:(uint64_t)userId streamType:(NERtcStreamChannelType)streamType rect:(NERtcFrameNormalizedRect *)rect;
 
#pragma mark - Video Blend

- (int)startBlendExternalVideo:(NERtcStreamChannelType)streamType
                   blendConfig:(NERtcVideoExternalBlendConfig *)blendConfig;

- (int)stopBlendExternalVideo:(NERtcStreamChannelType)streamType;

- (int)pushBlendExternalVideoFrame:(NERtcStreamChannelType)streamType
                             frame:(NERtcVideoFrame *)frame;

- (int)enableVideoDenoise:(BOOL)enabled streamType:(NERtcStreamChannelType)streamType;

- (int)enableVideoLowlightEnhance:(BOOL)enabled level:(NERtcVideoLowlightEnhanceLevel)level streamType:(NERtcStreamChannelType)streamType;
 
@end
 
NS_ASSUME_NONNULL_END
 
#pragma clang diagnostic pop
 
#endif /* INERtcEngineEx_h */