NERtcEngineBase.h

浏览该文件的文档.

/*
 * Copyright (c) 2021 NetEase, Inc. All rights reserved.
 */
 
#import <Foundation/Foundation.h>
#import "NERtcEngineEnum.h"
 
@protocol NERtcEngineVideoRenderSink;
 
NS_ASSUME_NONNULL_BEGIN
 
// channel
NERTC_EXTERN_API NSString * const kNERtcKeyChannel1V1ModeEnabled;
 
// video
NERTC_EXTERN_API NSString * const kNERtcKeyVideoPreferHWEncode;
NERTC_EXTERN_API NSString * const kNERtcKeyVideoPreferHWDecode;
NERTC_EXTERN_API NSString * const kNERtcKeyVideoCaptureObserverEnabled;
NERTC_EXTERN_API NSString * const kNERtcKeyVideoStartWithBackCamera;
NERTC_EXTERN_API NSString * const kNERtcKeyVideoPreferMetalRender;
NERTC_EXTERN_API NSString * const kNERtcKeyVideoSendOnPubType;
 
NERTC_EXTERN_API NSString * const kNERtcKeyAutoSubscribeVideo;    // BOOL -- 其他用户打开视频时，自动订阅。只支持在通话前设置，通话中设置无效。 默认值 NO 。
 
// audio
NERTC_EXTERN_API NSString * const kNERtcKeyAutoSubscribeAudio;
NERTC_EXTERN_API NSString * const KNERtcKeyDisableOverrideSpeakerOnReceiver;
 
NERTC_EXTERN_API NSString * const kNERtcKeySupportCallkit;
 
NERTC_EXTERN_API NSString * const KNERtcKeyEnableReportVolumeWhenMute;
NERTC_EXTERN_API NSString * const KNERtcKeyDisableSWAECOnHeadset;
NERTC_EXTERN_API NSString * const KNERtcKeyAudioAINSEnable;
 
 
// server record
NERTC_EXTERN_API NSString * const kNERtcKeyRecordHostEnabled;
NERTC_EXTERN_API NSString * const kNERtcKeyRecordAudioEnabled;
NERTC_EXTERN_API NSString * const kNERtcKeyRecordVideoEnabled;
NERTC_EXTERN_API NSString * const kNERtcKeyRecordType;
 
// live stream
NERTC_EXTERN_API NSString * const kNERtcKeyPublishSelfStreamEnabled;
 
// log level
NERTC_EXTERN_API NSString * const kNERtcKeyLogLevel;
NERTC_EXTERN_API NSString * const kNERtcKeyExtraInfo;
 
NERTC_EXPORT  @interface NERtcVideoCanvas : NSObject
 
@property (nonatomic, assign) BOOL useExternalRender;
 
@property (nonatomic, nullable, strong) VIEW_CLASS *container;
 
@property (nonatomic, assign) NERtcVideoRenderScaleMode renderMode;
 
@property (nonatomic, assign) NERtcVideoMirrorMode mirrorMode;
 
@property (nonatomic, strong) id<NERtcEngineVideoRenderSink> externalVideoRender;
@end
 
NERTC_EXPORT  @interface NERtcBaseVideoEncodeConfiguration : NSObject
 
@property (nonatomic, assign) NERtcVideoProfileType maxProfile;
 
@property (nonatomic, assign) NERtcVideoFrameRate frameRate;
 
@property (nonatomic, assign) NSInteger minFrameRate;
 
@property (nonatomic, assign) NSInteger bitrate;
 
@property (nonatomic, assign) NSInteger minBitrate;
 
@end
 
NERTC_EXPORT  @interface NERtcCameraCaptureConfiguration : NSObject
 
@property (nonatomic, assign) int captureWidth;
@property (nonatomic, assign) int captureHeight;
 
@end
NERTC_EXPORT  @interface NERtcVideoEncodeConfiguration : NERtcBaseVideoEncodeConfiguration
 
@property (nonatomic, assign) int width;
 
@property (nonatomic, assign) int height;
 
@property (nonatomic, assign) NERtcVideoCropMode cropMode;
 
@property (nonatomic, assign) NERtcDegradationPreference degradationPreference;
 
@property (nonatomic, assign) NERtcVideoMirrorMode mirrorMode;
 
@property (nonatomic, assign) NERtcVideoOutputOrientationMode orientationMode;
 
 
@end
 
NERTC_EXPORT  @interface NERtcVideoSubStreamEncodeConfiguration : NERtcBaseVideoEncodeConfiguration
 
@property (nonatomic, assign) NERtcSubStreamContentPrefer contentPrefer;
 
@end
 
NERTC_EXTERN_API uint32_t const NERtcAudioMixingMaxVolume;
NERTC_EXTERN_API uint32_t const NERtcAudioMixingDefaultVolume;
 
NERTC_EXPORT  @interface NERtcCreateAudioMixingOption : NSObject
 
@property (nonatomic, copy) NSString *path;
 
@property (nonatomic, assign) int loopCount;
 
@property (nonatomic, assign) BOOL sendEnabled;
 
@property (nonatomic, assign) BOOL playbackEnabled;
 
@property (nonatomic, assign) uint32_t sendVolume;
 
@property (nonatomic, assign) uint32_t playbackVolume;
 
@property (nonatomic, assign) int64_t startTimeStamp;
 
@property (nonatomic, assign) NERtcAudioStreamType sendWithAudioType;
 
- (BOOL)isInvalid;
 
@end
 
NERTC_EXPORT  @interface NERtcCreateAudioEffectOption : NSObject
 
@property (nonatomic, copy) NSString *path;
 
@property (nonatomic, assign) int loopCount;
 
@property (nonatomic, assign) BOOL sendEnabled;
 
@property (nonatomic, assign) BOOL playbackEnabled;
 
@property (nonatomic, assign) uint32_t sendVolume;
 
@property (nonatomic, assign) uint32_t playbackVolume;
 
@end
 
NERTC_EXPORT  @interface NERtcAudioRecordingConfiguration : NSObject
 
// 录音文件在本地保存的绝对路径，需要精确到文件名及格式。例如：sdcard/xxx/audio.aac。请确保指定的路径存在并且可写。目前仅支持 WAV 或 AAC 文件格式。
@property (nonatomic, copy) NSString *filePath;
 
// 录音采样率（Hz），可以设为 16000、32000（默认）、44100 或 48000。
@property (nonatomic, assign) int sampleRate;
 
// 录音音质，只在 AAC 格式下有效。详细信息请参考 {@link NERtcAudioRecordingQuality}。
@property (nonatomic, assign) NERtcAudioRecordingQuality quality;
 
// 录音文件所包含的内容。详细信息请参考 {@link NERtcAudioRecordingPosition}。
@property (nonatomic, assign) NERtcAudioRecordingPosition position;
 
// 录制过程中，循环缓存的最大时间长度，单位(s)。详细信息请参考 {@link NERtcAudioRecordingCycleTime}。
@property (nonatomic, assign) NERtcAudioRecordingCycleTime cycleTime;
 
@end
 
#pragma mark - live stream
NERTC_EXPORT  @interface NERtcLiveConfig: NSObject
 
@property (nonatomic, assign) BOOL interruptedPlaceImage;
 
@property (nonatomic, assign) BOOL singleVideoPassthrough;
@property (nonatomic, assign) NSInteger audioBitrate;
 
@property (nonatomic, assign) NERtcLiveStreamAudioSampleRate sampleRate;
 
@property (nonatomic, assign) NSInteger channels;
 
@property (nonatomic, assign) NERtcLiveStreamAudioCodecProfile audioCodecProfile;
 
@end
 
NERTC_EXPORT  @interface NERtcLiveStreamUserTranscoding: NSObject
 
@property (nonatomic, assign) uint64_t uid;
 
@property (nonatomic, assign) BOOL videoPush;
 
@property (nonatomic, assign) NSInteger x;
 
@property (nonatomic, assign) NSInteger y;
 
@property (nonatomic, assign) NSInteger width;
 
@property (nonatomic, assign) NSInteger height;
 
@property (nonatomic, assign) BOOL audioPush;
 
@property (nonatomic, assign) NSInteger zOrder;
 
@property (nonatomic, assign) NERtcLiveStreamVideoScaleMode adaption; 
 
@end
 
NERTC_EXPORT  @interface NERtcLiveStreamImageInfo: NSObject
 
@property (nonatomic, copy) NSString *url;
 
@property (nonatomic, assign) NSInteger x;
 
@property (nonatomic, assign) NSInteger y;
 
@property (nonatomic, assign) NSInteger width;
 
@property (nonatomic, assign) NSInteger height;
 
@property (nonatomic, assign) int zorder;
 
@end
 
NERTC_EXPORT  @interface NERtcLiveStreamLayout: NSObject
 
@property (nonatomic, assign) NSInteger width;
 
@property (nonatomic, assign) NSInteger height;
 
@property (nonatomic, assign) NSUInteger backgroundColor;
 
@property (nonatomic, strong) NSArray<NERtcLiveStreamUserTranscoding *> * users;
 
@property (nonatomic, nullable, strong) NERtcLiveStreamImageInfo* bgImage;
 
@property (nonatomic, nullable, strong) NSArray<NERtcLiveStreamImageInfo*> * bgImages;
 
@end
 
NERTC_EXPORT  @interface NERtcLiveStreamTaskInfo: NSObject
 
@property (nonatomic, copy) NSString *taskID;
 
@property (nonatomic, copy) NSString *streamURL;
 
@property (nonatomic, assign) BOOL serverRecordEnabled;
 
@property (nonatomic, assign) NERtcLiveStreamMode lsMode;
 
@property (nonatomic, nullable, strong) NERtcLiveStreamLayout *layout;
 
@property (nonatomic, nullable, strong) NERtcLiveConfig *config;
 
@property (nonatomic, nullable, copy) NSString *extraInfo;
 
- (BOOL)isInvalid;
 
@end
 
 
#pragma mark -- Audio Frame Observer
NERTC_EXPORT  @interface NERtcAudioFrameRequestFormat : NSObject
 
@property (nonatomic, assign) uint32_t channels;
 
@property (nonatomic, assign) uint32_t sampleRate;
 
@property (nonatomic, assign) NERtcAudioFrameOpMode mode;
 
@end
 
NERTC_EXPORT  @interface NERtcAudioFormat : NSObject
 
@property (nonatomic, assign) NERtcAudioType type;
@property (nonatomic, assign) uint32_t channels;
 
@property (nonatomic, assign) uint32_t sampleRate;
 
@property (nonatomic, assign) uint32_t bytesPerSample;
 
@property (nonatomic, assign) uint32_t samplesPerChannel;
 
@end
 
NERTC_EXPORT  @interface NERtcAudioFrame : NSObject
 
@property (nonatomic, strong) NERtcAudioFormat* format;
 
@property (nonatomic, assign) void* data;
 
@property (nonatomic, assign) int64_t syncTimestamp;
 
@end
 
 
#pragma mark - Volume info
 
NERTC_EXPORT  @interface NERtcAudioVolumeInfo : NSObject
 
@property (nonatomic, assign) uint64_t uid;
 
@property (nonatomic, assign) unsigned int volume;
 
@property (nonatomic, assign) unsigned int subStreamVolume;
 
@end
 
#pragma mark - Video Frame
 
NERTC_EXPORT  @interface NERtcVideoFrame : NSObject
 
@property(nonatomic, assign) NERtcVideoFormatType format;
 
@property(nonatomic, assign) uint64_t timestamp;
 
@property(nonatomic, assign) uint32_t width;
 
@property(nonatomic, assign) uint32_t height;
 
@property(nonatomic, assign) NERtcVideoRotationType rotation;
 
@property(nonatomic) void * buffer;
 
@property(nonatomic, strong) NSArray<NSNumber *> *strides;
 
@end
 
#pragma mark- MediaRelay
 
NERTC_EXPORT  @interface NERtcChannelMediaRelayInfo : NSObject
 
@property (nonatomic, copy)NSString *channelName;
@property (nonatomic, copy)NSString *token;
@property (nonatomic, assign)uint64_t uid;
 
@end
 
NERTC_EXPORT  @interface NERtcChannelMediaRelayConfiguration : NSObject
 
@property(nonatomic, strong, readonly)NSDictionary<NSString *, NERtcChannelMediaRelayInfo *> * _Nullable destinationInfos;
 
@property(nonatomic, strong)NERtcChannelMediaRelayInfo *sourceInfo;
 
- (BOOL)setDestinationInfo:(NERtcChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName;
 
- (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName;
 
@end
 
#pragma mark - watermark
 
NERTC_EXPORT  @interface NERtcTextWatermarkConfig : NSObject
@property (nonatomic, copy, nullable) NSString *content;
 
@property (nonatomic, assign) CGFloat fontSize;
 
@property (nonatomic, strong, nullable) UIColor *fontColor;
 
@property (nonatomic, strong, nullable) UIColor *wmColor;
 
@property (nonatomic, assign) CGRect frame;
 
@end
 
NERTC_EXPORT  @interface NERtcTimestampWatermarkConfig : NSObject
 
@property (nonatomic, assign) CGFloat fontSize;
 
@property (nonatomic, strong) UIColor *fontColor;
 
@property (nonatomic, assign) CGRect frame;
 
@property (nonatomic, strong) UIColor *wmColor;
 
@end
 
NERTC_EXPORT  @interface NERtcImageWatermarkConfig : NSObject
 
@property (nonatomic, strong, nullable) NSArray<UIImage *> *images;
 
@property (nonatomic, assign) NSUInteger fps;
 
@property (nonatomic, assign) BOOL loop;
 
@property (nonatomic, assign) CGRect frame;
 
@end
 
NERTC_EXPORT  @interface NERtcCanvasWatermarkConfig : NSObject
 
@property (nonatomic, strong, nullable) NSArray<NERtcTextWatermarkConfig *> *textWatermarks;
 
@property (nonatomic, strong, nullable) NERtcTimestampWatermarkConfig *timestampWatermark;
 
@property (nonatomic, strong, nullable) NSArray<NERtcImageWatermarkConfig *> *imageWaterMarks;
 
@end
 
NERTC_EXPORT @interface NERtcVideoWatermarkImageConfig : NSObject
 
@property (nonatomic, assign) CGFloat wmAlpha;
 
@property (nonatomic, assign) NSUInteger wmWidth;
 
@property (nonatomic, assign) NSUInteger wmHeight;
 
@property (nonatomic, assign) NSUInteger offsetX;
 
@property (nonatomic, assign) NSUInteger offsetY;
 
@property (nonatomic, strong) NSArray<NSString *> *imagePaths;
 
@property (nonatomic, assign) NSUInteger fps;
 
@property (nonatomic, assign) BOOL loop;
 
@end
 
NERTC_EXPORT @interface NERtcVideoWatermarkTextConfig : NSObject
 
@property (nonatomic, copy) NSString *content;
 
@property (nonatomic, copy) NSString *fontPath;
 
@property (nonatomic, assign) NSUInteger fontColor;
 
@property (nonatomic, assign) NSUInteger fontSize;
 
@property (nonatomic, assign) CGFloat wmAlpha;
 
@property (nonatomic, assign) NSUInteger wmColor;
 
@property (nonatomic, assign) NSUInteger wmWidth;
 
@property (nonatomic, assign) NSUInteger wmHeight;
 
@property (nonatomic, assign) NSUInteger offsetX;
 
@property (nonatomic, assign) NSUInteger offsetY;
 
@end
 
NERTC_EXPORT @interface NERtcVideoWatermarkTimestampConfig : NSObject
 
@property (nonatomic, copy) NSString *fontPath;
 
@property (nonatomic, assign) NSUInteger fontColor;
 
@property (nonatomic, assign) NSUInteger fontSize;
 
@property (nonatomic, assign) CGFloat wmAlpha;
 
@property (nonatomic, assign) NSUInteger wmColor;
 
@property (nonatomic, assign) NSUInteger wmWidth;
 
@property (nonatomic, assign) NSUInteger wmHeight;
 
@property (nonatomic, assign) NSUInteger offsetX;
 
@property (nonatomic, assign) NSUInteger offsetY;
 
@end
 
NERTC_EXPORT @interface NERtcVideoWatermarkConfig : NSObject
 
@property (nonatomic, assign) NERtcVideoWatermarkType watermarkType;
 
@property (nonatomic, strong) NERtcVideoWatermarkImageConfig *imageWatermark;
 
@property (nonatomic, strong) NERtcVideoWatermarkTextConfig *textWatermark;
 
@property (nonatomic, strong) NERtcVideoWatermarkTimestampConfig *timestampWatermark;
 
@end
 
#pragma mark - Encryption
 
NERTC_EXPORT  @interface NERtcEncryptionConfig : NSObject
 
@property (nonatomic, assign) NERtcEncryptionMode mode;
 
@property (nonatomic, copy, nullable) NSString *key;
 
@end
 
#pragma mark - privatization
 
NERTC_EXPORT  @interface NERtcServerAddresses : NSObject
 
@property (nonatomic, copy, nullable) NSString *channelServer;
 
@property (nonatomic, copy, nullable) NSString *statisticsServer;
 
@property (nonatomic, copy, nullable) NSString *statisticsDispatchServer;
 
@property (nonatomic, copy, nullable) NSString *statisticsBackupServer;
 
@property (nonatomic, copy, nullable) NSString *roomServer;
 
@property (nonatomic, copy, nullable) NSString *compatServer;
 
@property (nonatomic, copy, nullable) NSString *nosLbsServer;
 
@property (nonatomic, copy, nullable) NSString *nosUploadSever;
 
@property (nonatomic, copy, nullable) NSString *nosTokenServer;
 
@property (nonatomic, assign) BOOL useIPv6;
 
@property (nonatomic, copy, nullable) NSString *cloudProxyServer;
 
@property (nonatomic, copy, nullable) NSString *webSocketProxyServer;
 
@property (nonatomic, copy, nullable) NSString *quicProxyServer;
 
@property (nonatomic, copy, nullable) NSString *mediaProxyServer;
 
@end
 
#pragma mark - NERtcLastmileProbeConfig
 
NERTC_EXPORT  @interface NERtcLastmileProbeConfig : NSObject
 
@property(nonatomic, assign) BOOL probeUplink;
 
@property(nonatomic, assign) BOOL probeDownlink;
 
@property(nonatomic, assign) NSUInteger expectedUplinkBitrate;
 
@property(nonatomic, assign) NSUInteger expectedDownlinkBitrate;
 
@end
 
#pragma mark - NERtcLastmileProbeOneWayResult
 
NERTC_EXPORT  @interface NERtcLastmileProbeOneWayResult : NSObject
 
@property(nonatomic, assign) NSUInteger packetLossRate;
 
@property(nonatomic, assign) NSUInteger jitter;
 
@property(nonatomic, assign) NSUInteger availableBandwidth;
 
@end
 
#pragma mark - NERtcLastmileProbeResult
 
NERTC_EXPORT  @interface NERtcLastmileProbeResult : NSObject
 
@property(nonatomic, assign) NERtcLastmileProbeResultState state;
 
@property(nonatomic, assign) NSUInteger rtt;
 
@property(nonatomic, strong) NERtcLastmileProbeOneWayResult *uplinkReport;
 
@property(nonatomic, strong) NERtcLastmileProbeOneWayResult *downlinkReport;
 
@end
 
#pragma mark -- Log setting
 
NERTC_EXPORT  @interface NERtcLogSetting : NSObject
 
@property (nonatomic, copy) NSString *logDir;
 
@property (nonatomic, assign) NERtcLogLevel logLevel;
 
@end
 
#pragma mark - Video Correction Config
 
NERTC_EXPORT  @interface NERtcVideoCorrectionConfiguration : NSObject
 
// 矫正区域的左上顶点（x 和 y 的取值范围为 0 ~ 1 的浮点数）
@property (nonatomic, assign) CGPoint topLeft;
 
// 矫正区域的右上顶点（x 和 y 的取值范围为 0 ~ 1 的浮点数）
@property (nonatomic, assign) CGPoint topRight;
 
// 矫正区域的左下顶点（x 和 y 的取值范围为 0 ~ 1 的浮点数）
@property (nonatomic, assign) CGPoint bottomLeft;
 
// 矫正区域的右下顶点（x 和 y 的取值范围为 0 ~ 1 的浮点数）
@property (nonatomic, assign) CGPoint bottomRight;
 
// 画布宽度（单位 px，使用外部视频渲染时需要传递）
@property (nonatomic, assign) CGFloat canvasWidth;
 
// 画布高度（单位 px，使用外部视频渲染时需要传递）
@property (nonatomic, assign) CGFloat canvasHeight;
 
// 是否镜像显示（使用外部视频渲染时需要传递）
@property (nonatomic, assign) BOOL enableMirror;
 
@end
 
#pragma mark - NERtcVirtualBackgroundSource
 
NERTC_EXPORT @interface NERtcVirtualBackgroundSource : NSObject
 
@property (nonatomic, assign) NERtcVirtualBackgroundSourceType backgroundSourceType;
 
@property (nonatomic, assign) NSUInteger color;
 
@property (nonatomic, copy) NSString *source;
 
@property (nonatomic, assign) NERtcBlurDegree blur_degree;
 
@end
 
#pragma mark - Audio Effect
 
NERTC_EXPORT @interface NERtcReverbParam : NSObject
 
@property (nonatomic, assign) float wetGain;
 
@property (nonatomic, assign) float dryGain;
 
@property (nonatomic, assign) float damping;
 
@property (nonatomic, assign) float roomSize;
 
@property (nonatomic, assign) float decayTime;
 
@property (nonatomic, assign) float preDelay;
 
@end
 
NS_ASSUME_NONNULL_END