NERtcEngineBase.h

浏览该文件的文档.

/*
 * Copyright (c) 2021 NetEase, Inc. All rights reserved.
 */
 
#import <Foundation/Foundation.h>
#import "NERtcEngineEnum.h"
 
@protocol NERtcEngineVideoRenderSink;
 
NS_ASSUME_NONNULL_BEGIN
 
// channel
extern NSString * const kNERtcKeyChannel1V1ModeEnabled; 
 
// video
extern NSString * const kNERtcKeyVideoPreferHWEncode; 
extern NSString * const kNERtcKeyVideoPreferHWDecode; 
extern NSString * const kNERtcKeyVideoCaptureObserverEnabled; 
extern NSString * const kNERtcKeyVideoStartWithBackCamera; 
extern NSString * const kNERtcKeyVideoPreferMetalRender; 
extern NSString * const kNERtcKeyVideoSendOnPubType; 
extern NSString * const kNERtcKeyAutoSubscribeVideo;    // BOOL -- 其他用户打开视频时，自动订阅。只支持在通话前设置，通话中设置无效。 默认值 NO 。
 
// audio
extern NSString * const kNERtcKeyAutoSubscribeAudio; 
extern NSString * const KNERtcKeyDisableOverrideSpeakerOnReceiver; 
extern NSString * const KNERtcKeyEnableReportVolumeWhenMute; 
extern NSString * const KNERtcKeyDisableSWAECOnHeadset; 
extern NSString * const KNERtcKeyAudioAINSEnable;
 
 
// server record
extern NSString * const kNERtcKeyRecordHostEnabled; 
extern NSString * const kNERtcKeyRecordAudioEnabled; 
extern NSString * const kNERtcKeyRecordVideoEnabled; 
extern NSString * const kNERtcKeyRecordType; 
 
// live stream
extern NSString * const kNERtcKeyPublishSelfStreamEnabled; 
 
// log level
extern NSString * const kNERtcKeyLogLevel; 
extern NSString * const kNERtcKeyExtraInfo; 
 
@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
 
@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
 
@interface NERtcCameraCaptureConfiguration : NSObject
@property (nonatomic, assign) NERtcCameraPreference preference;
 
@property (nonatomic, assign) int captureWidth;
@property (nonatomic, assign) int captureHeight;
 
@end
@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
 
@interface NERtcVideoSubStreamEncodeConfiguration : NERtcBaseVideoEncodeConfiguration
 
@property (nonatomic, assign) NERtcSubStreamContentPrefer contentPrefer;
 
@end
 
FOUNDATION_EXPORT uint32_t const NERtcAudioMixingMaxVolume;
FOUNDATION_EXPORT uint32_t const NERtcAudioMixingDefaultVolume;
 
@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;
 
- (BOOL)isInvalid;
 
@end
 
@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
 
@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
@interface NERtcLiveConfig: NSObject
 
@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
 
@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
 
@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;
 
@end
 
@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;
 
@end
 
@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
@interface NERtcAudioFrameRequestFormat : NSObject
 
@property (nonatomic, assign) uint32_t channels;
 
@property (nonatomic, assign) uint32_t sampleRate;
 
@property (nonatomic, assign) NERtcAudioFrameOpMode mode;
 
@end
 
@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
 
@interface NERtcAudioFrame : NSObject
 
@property (nonatomic, strong) NERtcAudioFormat* format;
 
@property (nonatomic, assign) void* data;
 
@end
 
 
#pragma mark - Volume info
 
@interface NERtcAudioVolumeInfo : NSObject
 
@property (nonatomic, assign) uint64_t uid;
 
@property (nonatomic, assign) unsigned int volume;
 
@end
 
#pragma mark - Video Frame
 
@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
 
@interface NERtcChannelMediaRelayInfo : NSObject
 
@property (nonatomic, copy)NSString *channelName;
@property (nonatomic, copy)NSString *token;
@property (nonatomic, assign)uint64_t uid;
 
@end
 
@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
 
@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
 
@interface NERtcTimestampWatermarkConfig : NSObject
 
@property (nonatomic, assign) CGFloat fontSize;
 
@property (nonatomic, strong) UIColor *fontColor;
 
@property (nonatomic, assign) CGRect frame;
 
@property (nonatomic, strong) UIColor *wmColor;
 
@end
 
@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
 
@interface NERtcCanvasWatermarkConfig : NSObject
 
@property (nonatomic, strong, nullable) NSArray<NERtcTextWatermarkConfig *> *textWatermarks;
 
@property (nonatomic, strong, nullable) NERtcTimestampWatermarkConfig *timestampWatermark;
 
@property (nonatomic, strong, nullable) NSArray<NERtcImageWatermarkConfig *> *imageWaterMarks;
 
@end
 
@interface NERtcEncryptionConfig : NSObject
 
@property (nonatomic, assign) NERtcEncryptionMode mode;
 
@property (nonatomic, copy, nullable) NSString *key;
 
@end
#pragma mark - privatization
 
@interface NERtcServerAddresses : NSObject
 
@property (nonatomic, copy, nullable) NSString *channelServer;
 
@property (nonatomic, copy, nullable) NSString *statisticsServer;
 
@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
 
@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
 
@interface NERtcLastmileProbeOneWayResult : NSObject
 
@property(nonatomic, assign) NSUInteger packetLossRate;
 
@property(nonatomic, assign) NSUInteger jitter;
 
@property(nonatomic, assign) NSUInteger availableBandwidth;
 
@end
 
#pragma mark - NERtcLastmileProbeResult
 
@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
 
@interface NERtcLogSetting : NSObject
 
@property (nonatomic, copy) NSString *logDir;
 
@property (nonatomic, assign) NERtcLogLevel logLevel;
 
@end
 
#pragma mark - Video Correction Config
 
@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
 
NS_ASSUME_NONNULL_END