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; // BOOL -- Specifies whether to enable 1V1 mode. The default value is NO.
 
// video
extern NSString * const kNERtcKeyVideoPreferHWEncode; // BOOL - Specifies whether to prefer using hardware to encode video data. The default value is YES. We recommend that you set this value before you call setupEngineWithContext to initialize the INERtcEngine instance. Otherwise, the setting is applied the next time.
extern NSString * const kNERtcKeyVideoPreferHWDecode; // BOOL - Specifies whether to prefer using hardware to decode video data. The default value is YES. We recommend that you set this value before you call setupEngineWithContext to initialize the INERtcEngine instance. Otherwise, the setting is applied the next time.
extern NSString * const kNERtcKeyVideoCaptureObserverEnabled; // BOOL - Specifies whether to enable the callback to return captured video data. This enables developers to get the raw video data. You can clear the video data by calling destroyEngine. The default value is NO.
extern NSString * const kNERtcKeyVideoStartWithBackCamera; // BOOL - Specifies whether to turn on the rear camera if the camera is enabled for the first time. The default value is NO.
extern NSString * const kNERtcKeyVideoPreferMetalRender; // BOOL - Specifies whether to use metal rendering first. Otherwise, OpenGL rendering is applied. The default value is NO.
extern NSString * const kNERtcKeyVideoSendOnPubType; // int, the setting is valid before you make a call. The default value is 3, which indicates that a bigstream is published at the beginning.
 
// audio
extern NSString * const kNERtcKeyAutoSubscribeAudio; // BOOL - Specifies whether to automatically subscribe to audio streams when other users turn on audio. The setting is applied before you make a call. The setting is invalid If you specify the value during the call. The default value is YES. Note: The key of subscribeRemoteAudio must be set to NO if you use the method to control the audio in your business.
extern NSString * const KNERtcKeyDisableOverrideSpeakerOnReceiver; //BOOL -- Specifies whether to disable switching to the speakerphone when the system switches to the earpieces. The default value is NO. If the value is set to YES, the SDK is not allowed to switch to the speakerphone when the system switches to earpieces. Users need to handle the earpieces switching event.
extern NSString * const KNERtcKeyEnableReportVolumeWhenMute; //Whether to return original volume when the local user is muted.  Boolean value, default: false. true：Return the original volume in `onLocalAudioVolumeIndication`. false：Return the recording volume(0) in `onLocalAudioVolumeIndication`. 
extern NSString * const KNERtcKeyDisableSWAECOnHeadset; //BOOL - Specifies whether to use echo reduction when the system sets the headset. The default value is NO. If the value is set to YES, the SDK does not use the echo reduction in headset mode. The setting affects the audio quality of the headset in some mobile models.
extern NSString * const KNERtcKeyAudioAINSEnable;//BOOL - Specifies whether to enable AI-powered noise reduction. If you enable AI-powered noise reduction, the peer can hear your voice in a noisy environment.
 
 
// server record
extern NSString * const kNERtcKeyRecordHostEnabled; // BOOL - Specifies whether to record the audio of the host in the server. The default value is NO.
extern NSString * const kNERtcKeyRecordAudioEnabled; // BOOL - Specifies whether to enable the call server to record audio. The default value is NO
extern NSString * const kNERtcKeyRecordVideoEnabled; // BOOL - Specifies whether to enable the call server to record video. The default value is NO
extern NSString * const kNERtcKeyRecordType; // int - The server recording mode. For more information, see the definition of NERtcRecordType.
 
// live stream
extern NSString * const kNERtcKeyPublishSelfStreamEnabled; // BOOL - Specifies whether to publish the media stream to the room. The default value is NO.
 
// log level
extern NSString * const kNERtcKeyLogLevel; // int - The SDK log level. For more information, see the definition of NERtcLogLevel. The default value is kNERtcLogLevelInfo.
 
extern NSString * const kNERtcKeyExtraInfo; //NSString - Identifies the app version that is used for reporting.
 
@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 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
 
 
#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;
 
@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 -- Log setting
 
@interface NERtcLogSetting : NSObject
 
@property (nonatomic, copy) NSString *logDir;
 
@property (nonatomic, assign) NERtcLogLevel logLevel;
 
@end
NS_ASSUME_NONNULL_END