NERtc iOS SDK V5.6.30
载入中...
搜索中...
未找到
NERtcEngineBase.h
浏览该文件的文档.
1/*
2 * Copyright (c) 2021 NetEase, Inc. All rights reserved.
3 */
4
5#import <Foundation/Foundation.h>
6#import "NERtcEngineEnum.h"
7
8@protocol NERtcEngineVideoRenderSink;
9@protocol NERtcEnginePacketObserver;
10
11NS_ASSUME_NONNULL_BEGIN
12
22// channel
36
37// video
101
112NERTC_EXTERN_API NSString * const kNERtcKeyAutoSubscribeVideo; // BOOL -- 其他用户打开视频时,自动订阅。只支持在通话前设置,通话中设置无效。 默认值 NO。
113
114// audio
128
129// data channel
143
156
164
196
197
198// server record
235
236// live stream
248
249// log level
268
276
283
284
286
295NERTC_EXPORT @interface NERtcVideoCanvas : NSObject
296
305@property (nonatomic, assign) BOOL useExternalRender;
306
315@property (nonatomic, nullable, strong) VIEW_CLASS *container;
316
325@property (nonatomic, assign) NERtcVideoRenderScaleMode renderMode;
326
339@property (nonatomic, assign) NERtcVideoMirrorMode mirrorMode;
340
349@property (nonatomic, strong) id<NERtcEngineVideoRenderSink> externalVideoRender;
350
351// 背景颜色,格式为 0xRRGGBB,默认为黑色即 0x000000
352@property (nonatomic, assign) uint32_t backgroundColor;
353
354@end
355
365
374@property (nonatomic, assign) NERtcVideoProfileType maxProfile;
375
392@property (nonatomic, assign) NERtcVideoFrameRate frameRate;
393
402@property (nonatomic, assign) NSInteger minFrameRate;
403
465@property (nonatomic, assign) NSInteger bitrate;
466
475@property (nonatomic, assign) NSInteger minBitrate;
476
477@end
478
488
509@property (nonatomic, assign) int captureWidth;
530@property (nonatomic, assign) int captureHeight;
531
532@end
542
559@property (nonatomic, assign) int width;
560
577@property (nonatomic, assign) int height;
578
587@property (nonatomic, assign) NERtcVideoCropMode cropMode;
588
609@property (nonatomic, assign) NERtcDegradationPreference degradationPreference;
610
622@property (nonatomic, assign) NERtcVideoMirrorMode mirrorMode;
623
634@property (nonatomic, assign) NERtcVideoOutputOrientationMode orientationMode;
635
636
637@end
638
648
657@property (nonatomic, assign) NERtcSubStreamContentPrefer contentPrefer;
658
679@property (nonatomic, assign) NERtcDegradationPreference degradationPreference;
680
681@end
682
685
688
701@property (nonatomic, copy) NSString *path;
702
715@property (nonatomic, assign) int loopCount;
716
725@property (nonatomic, assign) BOOL sendEnabled;
726
735@property (nonatomic, assign) BOOL playbackEnabled;
736
747@property (nonatomic, assign) uint32_t sendVolume;
748
759@property (nonatomic, assign) uint32_t playbackVolume;
760
769@property (nonatomic, assign) int64_t startTimeStamp;
770
779@property (nonatomic, assign) NERtcAudioStreamType sendWithAudioType;
780
786@property (nonatomic, assign) uint64_t progressInterval;
787
800- (BOOL)isInvalid;
801
802@end
803
806
819@property (nonatomic, copy) NSString *path;
820
833@property (nonatomic, assign) int loopCount;
834
843@property (nonatomic, assign) BOOL sendEnabled;
844
853@property (nonatomic, assign) BOOL playbackEnabled;
854
865@property (nonatomic, assign) uint32_t sendVolume;
866
877@property (nonatomic, assign) uint32_t playbackVolume;
878
884@property (nonatomic, assign) int64_t startTimeStamp;
885
891@property (nonatomic, assign) NERtcAudioStreamType sendWithAudioType;
892
898@property (nonatomic, assign) uint64_t progressInterval;
899
900@end
901
903
904// 录音文件在本地保存的绝对路径,需要精确到文件名及格式。例如:sdcard/xxx/audio.aac。请确保指定的路径存在并且可写。目前仅支持 WAV 或 AAC 文件格式。
905@property (nonatomic, copy) NSString *filePath;
906
907// 录音采样率(Hz),可以设为 16000、32000(默认)、44100 或 48000。
908@property (nonatomic, assign) int sampleRate;
909
910// 录音音质,只在 AAC 格式下有效。详细信息请参考 {@link NERtcAudioRecordingQuality}。
911@property (nonatomic, assign) NERtcAudioRecordingQuality quality;
912
913// 录音文件所包含的内容。详细信息请参考 {@link NERtcAudioRecordingPosition}。
914@property (nonatomic, assign) NERtcAudioRecordingPosition position;
915
916// 录制过程中,循环缓存的最大时间长度,单位(s)。详细信息请参考 {@link NERtcAudioRecordingCycleTime}。
917@property (nonatomic, assign) NERtcAudioRecordingCycleTime cycleTime;
918
919@end
920
921#pragma mark - live stream
930NERTC_EXPORT @interface NERtcLiveConfig: NSObject
931
940@property (nonatomic, assign) BOOL interruptedPlaceImage;
941
954@property (nonatomic, assign) BOOL singleVideoPassthrough;
967@property (nonatomic, assign) NSInteger audioBitrate;
968
983@property (nonatomic, assign) NERtcLiveStreamAudioSampleRate sampleRate;
984
997@property (nonatomic, assign) NSInteger channels;
998
1011@property (nonatomic, assign) NERtcLiveStreamAudioCodecProfile audioCodecProfile;
1012
1013@end
1014
1024
1033@property (nonatomic, assign) uint64_t uid;
1034
1049@property (nonatomic, assign) BOOL videoPush;
1050
1063@property (nonatomic, assign) NSInteger x;
1064
1077@property (nonatomic, assign) NSInteger y;
1078
1091@property (nonatomic, assign) NSInteger width;
1092
1105@property (nonatomic, assign) NSInteger height;
1106
1119@property (nonatomic, assign) BOOL audioPush;
1120
1129@property (nonatomic, assign) NSInteger zOrder;
1130
1139@property (nonatomic, assign) NERtcLiveStreamVideoScaleMode adaption;
1140
1141@end
1142
1152
1161@property (nonatomic, copy) NSString *url;
1162
1175@property (nonatomic, assign) NSInteger x;
1176
1189@property (nonatomic, assign) NSInteger y;
1190
1201@property (nonatomic, assign) NSInteger width;
1202
1213@property (nonatomic, assign) NSInteger height;
1214
1224@property (nonatomic, assign) int zorder;
1225
1226@end
1227
1237
1246@property (nonatomic, assign) NSInteger width;
1247
1256@property (nonatomic, assign) NSInteger height;
1257
1266@property (nonatomic, assign) NSUInteger backgroundColor;
1267
1276@property (nonatomic, strong) NSArray<NERtcLiveStreamUserTranscoding *> * users;
1277
1287@property (nonatomic, nullable, strong) NERtcLiveStreamImageInfo* bgImage;
1288
1295@property (nonatomic, nullable, strong) NSArray<NERtcLiveStreamImageInfo*> * bgImages;
1296
1297@end
1298
1308
1319@property (nonatomic, copy) NSString *taskID;
1320
1331@property (nonatomic, copy) NSString *streamURL;
1332
1341@property (nonatomic, assign) BOOL serverRecordEnabled;
1342
1351@property (nonatomic, assign) NERtcLiveStreamMode lsMode;
1352
1361@property (nonatomic, nullable, strong) NERtcLiveStreamLayout *layout;
1362
1371@property (nonatomic, nullable, strong) NERtcLiveConfig *config;
1372
1381@property (nonatomic, nullable, copy) NSString *extraInfo;
1382
1391- (BOOL)isInvalid;
1392
1393@end
1394
1395
1396#pragma mark -- Audio Frame Observer
1406
1421@property (nonatomic, assign) uint32_t channels;
1422
1431@property (nonatomic, assign) uint32_t sampleRate;
1432
1441@property (nonatomic, assign) NERtcAudioFrameOpMode mode;
1442
1443@end
1444
1453NERTC_EXPORT @interface NERtcAudioFormat : NSObject
1454
1463@property (nonatomic, assign) NERtcAudioType type;
1476@property (nonatomic, assign) uint32_t channels;
1477
1486@property (nonatomic, assign) uint32_t sampleRate;
1487
1496@property (nonatomic, assign) uint32_t bytesPerSample;
1497
1506@property (nonatomic, assign) uint32_t samplesPerChannel;
1507
1508@end
1509
1518NERTC_EXPORT @interface NERtcAudioFrame : NSObject
1519
1528@property (nonatomic, strong) NERtcAudioFormat* format;
1529
1538@property (nonatomic, assign) void* data;
1539
1548@property (nonatomic, assign) int64_t syncTimestamp;
1549
1550@end
1551
1552
1553#pragma mark - Volume info
1554
1564
1573@property (nonatomic, assign) uint64_t uid;
1574
1583@property (nonatomic, assign) unsigned int volume;
1584
1594@property (nonatomic, assign) unsigned int subStreamVolume;
1595
1596@end
1597
1598#pragma mark - Video Frame
1599
1608NERTC_EXPORT @interface NERtcVideoFrame : NSObject
1609
1619@property(nonatomic, assign) NERtcVideoFormatType format;
1620
1629@property(nonatomic, assign) uint64_t timestamp;
1630
1639@property(nonatomic, assign) uint32_t width;
1640
1649@property(nonatomic, assign) uint32_t height;
1650
1659@property(nonatomic, assign) NERtcVideoRotationType rotation;
1660
1673@property(nonatomic) void * buffer;
1674
1682@property(nonatomic) void * uBuffer;
1683
1691@property(nonatomic) void * vBuffer;
1692
1702@property(nonatomic, strong) NSArray<NSNumber *> *strides;
1703
1704// Metal 纹理
1705// 目前该参数仅在外部渲染视频的场景下有实际意义。
1706@property(nonatomic, strong) id<MTLTexture> texture;
1707
1708@end
1709
1710#pragma mark- MediaRelay
1711
1721
1730@property (nonatomic, copy)NSString *channelName;
1739@property (nonatomic, copy)NSString *token;
1748@property (nonatomic, assign)uint64_t uid;
1749
1750@end
1751
1753
1768@property(nonatomic, strong, readonly)NSDictionary<NSString *, NERtcChannelMediaRelayInfo *> * _Nullable destinationInfos;
1769
1784@property(nonatomic, strong)NERtcChannelMediaRelayInfo *sourceInfo;
1785
1802- (BOOL)setDestinationInfo:(NERtcChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName;
1803
1816- (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName;
1817
1818@end
1819
1820#pragma mark - watermark
1821
1839
1848@property (nonatomic, assign) CGFloat wmAlpha;
1849
1858@property (nonatomic, assign) NSUInteger wmWidth;
1859
1868@property (nonatomic, assign) NSUInteger wmHeight;
1869
1878@property (nonatomic, assign) NSUInteger offsetX;
1879
1888@property (nonatomic, assign) NSUInteger offsetY;
1889
1898@property (nonatomic, strong) NSArray<NSString *> *imagePaths;
1899
1910@property (nonatomic, assign) NSUInteger fps;
1911
1920@property (nonatomic, assign) BOOL loop;
1921
1922@end
1923
1925
1934@property (nonatomic, copy) NSString *content;
1935
1941@property (nonatomic, copy) NSString *fontName;
1942
1951@property (nonatomic, assign) NSUInteger fontColor;
1952
1961@property (nonatomic, assign) NSUInteger fontSize;
1962
1971@property (nonatomic, assign) CGFloat wmAlpha;
1972
1982@property (nonatomic, assign) NSUInteger wmColor;
1983
1992@property (nonatomic, assign) NSUInteger wmWidth;
1993
2002@property (nonatomic, assign) NSUInteger wmHeight;
2003
2012@property (nonatomic, assign) NSUInteger offsetX;
2013
2022@property (nonatomic, assign) NSUInteger offsetY;
2023
2024@end
2025
2027
2033@property (nonatomic, copy) NSString *fontName;
2034
2043@property (nonatomic, assign) NSUInteger fontColor;
2044
2053@property (nonatomic, assign) NSUInteger fontSize;
2054
2063@property (nonatomic, assign) CGFloat wmAlpha;
2064
2075@property (nonatomic, assign) NSUInteger wmColor;
2076
2085@property (nonatomic, assign) NSUInteger wmWidth;
2086
2095@property (nonatomic, assign) NSUInteger wmHeight;
2096
2105@property (nonatomic, assign) NSUInteger offsetX;
2106
2115@property (nonatomic, assign) NSUInteger offsetY;
2116
2117@end
2118
2128
2137@property (nonatomic, assign) NERtcVideoWatermarkType watermarkType;
2138
2147@property (nonatomic, strong) NERtcVideoWatermarkImageConfig *imageWatermark;
2148
2157@property (nonatomic, strong) NERtcVideoWatermarkTextConfig *textWatermark;
2158
2167@property (nonatomic, strong) NERtcVideoWatermarkTimestampConfig *timestampWatermark;
2168
2169@end
2170
2171#pragma mark - Encryption
2172
2182
2191@property (nonatomic, assign) NERtcEncryptionMode mode;
2192
2201@property (nonatomic, copy, nullable) NSString *key;
2202
2208@property (nonatomic, weak, nullable) id<NERtcEnginePacketObserver> observer;
2209
2210@end
2211
2212#pragma mark - privatization
2213
2225
2234@property (nonatomic, copy, nullable) NSString* lbsServer;
2235
2244@property (nonatomic, copy, nullable) NSString *channelServer;
2245
2254@property (nonatomic, copy, nullable) NSString *statisticsServer;
2255
2264@property (nonatomic, copy, nullable) NSString *statisticsDispatchServer;
2265
2274@property (nonatomic, copy, nullable) NSString *statisticsBackupServer;
2275
2284@property (nonatomic, copy, nullable) NSString *roomServer;
2285
2294@property (nonatomic, copy, nullable) NSString *compatServer;
2295
2304@property (nonatomic, copy, nullable) NSString *nosLbsServer;
2305
2314@property (nonatomic, copy, nullable) NSString *nosUploadSever;
2315
2324@property (nonatomic, copy, nullable) NSString *nosTokenServer;
2325
2334@property (nonatomic, assign) BOOL useIPv6;
2335
2339@property (nonatomic, copy, nullable) NSString *cloudProxyServer;
2340
2344@property (nonatomic, copy, nullable) NSString *webSocketProxyServer;
2345
2349@property (nonatomic, copy, nullable) NSString *quicProxyServer;
2350
2354@property (nonatomic, copy, nullable) NSString *mediaProxyServer;
2355
2356@end
2357
2358#pragma mark - NERtcLastmileProbeConfig
2359
2369
2384@property(nonatomic, assign) BOOL probeUplink;
2385
2398@property(nonatomic, assign) BOOL probeDownlink;
2399
2412@property(nonatomic, assign) NSUInteger expectedUplinkBitrate;
2413
2423@property(nonatomic, assign) NSUInteger expectedDownlinkBitrate;
2424
2425@end
2426
2427#pragma mark - NERtcLastmileProbeOneWayResult
2428
2438
2447@property(nonatomic, assign) NSUInteger packetLossRate;
2448
2457@property(nonatomic, assign) NSUInteger jitter;
2458
2467@property(nonatomic, assign) NSUInteger availableBandwidth;
2468
2469@end
2470
2471#pragma mark - NERtcLastmileProbeResult
2472
2482
2491@property(nonatomic, assign) NERtcLastmileProbeResultState state;
2492
2501@property(nonatomic, assign) NSUInteger rtt;
2502
2511@property(nonatomic, strong) NERtcLastmileProbeOneWayResult *uplinkReport;
2512
2521@property(nonatomic, strong) NERtcLastmileProbeOneWayResult *downlinkReport;
2522
2523@end
2524
2525#pragma mark -- Log setting
2526
2535NERTC_EXPORT @interface NERtcLogSetting : NSObject
2536
2545@property (nonatomic, copy) NSString *logDir;
2546
2555@property (nonatomic, assign) NERtcLogLevel logLevel;
2556
2557@end
2558
2559#pragma mark - Video Correction Config
2560
2570
2571// 矫正区域的左上顶点(x 和 y 的取值范围为 0 ~ 1 的浮点数)
2572@property (nonatomic, assign) CGPoint topLeft;
2573
2574// 矫正区域的右上顶点(x 和 y 的取值范围为 0 ~ 1 的浮点数)
2575@property (nonatomic, assign) CGPoint topRight;
2576
2577// 矫正区域的左下顶点(x 和 y 的取值范围为 0 ~ 1 的浮点数)
2578@property (nonatomic, assign) CGPoint bottomLeft;
2579
2580// 矫正区域的右下顶点(x 和 y 的取值范围为 0 ~ 1 的浮点数)
2581@property (nonatomic, assign) CGPoint bottomRight;
2582
2583// 画布宽度(单位 px,使用外部视频渲染时需要传递)
2584@property (nonatomic, assign) CGFloat canvasWidth;
2585
2586// 画布高度(单位 px,使用外部视频渲染时需要传递)
2587@property (nonatomic, assign) CGFloat canvasHeight;
2588
2589// 是否镜像显示(使用外部视频渲染时需要传递)
2590@property (nonatomic, assign) BOOL enableMirror;
2591
2592@end
2593
2594#pragma mark - NERtcVirtualBackgroundSource
2595
2607
2616@property (nonatomic, assign) NERtcVirtualBackgroundSourceType backgroundSourceType;
2617
2632@property (nonatomic, assign) NSUInteger color;
2633
2644@property (nonatomic, copy) NSString *source;
2645
2656@property (nonatomic, assign) NERtcBlurDegree blur_degree;
2657
2658@end
2659
2660#pragma mark - Audio Effect
2661
2670NERTC_EXPORT @interface NERtcReverbParam : NSObject
2671
2680@property (nonatomic, assign) float wetGain;
2681
2690@property (nonatomic, assign) float dryGain;
2691
2700@property (nonatomic, assign) float damping;
2701
2710@property (nonatomic, assign) float roomSize;
2711
2720@property (nonatomic, assign) float decayTime;
2721
2730@property (nonatomic, assign) float preDelay;
2731
2732@end
2733
2734#pragma mark - extraInfo
2735
2740
2744@property (nonatomic, assign) BOOL enableLowLatency;
2748@property (nonatomic, assign) NSUInteger playTimeout;
2752@property (nonatomic, nullable, strong) NERtcVideoCanvas *playCanvas;
2753
2754@end
2755
2760
2764@property (nonatomic, nullable, copy) NSString *customInfo;
2765
2771@property (nonatomic, nullable, copy) NSString *permissionKey;
2772
2773@property (nonatomic, nullable, strong) NERtcLowLatencyOptions *lowLatencyOptions;
2774
2775@end
2776
2781
2785@property (nonatomic, copy) NSString *customInfo;
2786
2787
2788@end
2789
2794
2798@property (nonatomic, copy) NSString *customInfo;
2799
2800@end
2801
2806
2810@property (nonatomic, copy) NSString *customInfo;
2811
2812@end
2813
2814#pragma mark - preDecoder
2815
2823@property (nonatomic, assign) int width;
2824
2828@property (nonatomic, assign) int height;
2829
2833@property (nonatomic, assign) BOOL isKeyFrame;
2834
2835@end
2836
2837
2842
2846@property (nonatomic, assign) uint32_t perTimeMs;
2847
2851@property (nonatomic, assign) uint8_t toc;
2852
2853@end
2854
2855
2863@property (nonatomic, assign) NERtcPreDecoderMediaType mediaType;
2864
2868@property (nonatomic, assign) uint64_t uid;
2869
2873@property (nonatomic, assign) int64_t timestampMs;
2874
2878@property (nonatomic, assign) uint8_t *data;
2879
2883@property (nonatomic, assign) int length;
2884
2888@property (nonatomic, copy) NSString *codec;
2889
2893@property (nonatomic, assign) BOOL isMainStream;
2894
2898@property (nonatomic, strong) NERtcPreDecoderVideoInfo *videoInfo;
2899
2903@property (nonatomic, strong) NERtcPreDecoderAudioInfo *audioInfo;
2904
2905@end
2906
2908
2909/***
2910* 编码器类型
2911*/
2912@property (nonatomic, assign) NERtcVideoCodecType codecType;
2913
2917@property (nonatomic, assign) NERtcNalFrameType frameType;
2918
2922@property (nonatomic, copy) NSArray<NSNumber *> *nalLengths;
2923
2927@property (nonatomic, assign) unsigned char *nalData;
2928
2932@property (nonatomic, assign) int64_t timestampUs;
2933
2937@property (nonatomic, assign) int width;
2938
2942@property (nonatomic, assign) int height;
2943
2944@end
2945
2950
2954@property (nonatomic, assign) unsigned char *data;
2955
2959@property (nonatomic, assign) int64_t timeStampUs;
2960
2964@property (nonatomic, assign) int sampleRate;
2965
2969@property (nonatomic, assign) int channels;
2970
2974@property (nonatomic, assign) int samplesPerChannel;
2975
2979@property (nonatomic, assign) int encodedLen;
2980
2984@property (nonatomic, assign) uint32_t encodedTimestamp;
2985
2989@property (nonatomic, assign) NERtcPayLoadType payloadType;
2990
2994@property (nonatomic, assign) uint8_t rmsLevel;
2995
2996@end
2997
2999NERTC_EXPORT @interface NERtcPositionInfo : NSObject
3000
3004@property(nonatomic, assign) CGFloat speakerPositionX;
3005
3009@property(nonatomic, assign) CGFloat speakerPositionY;
3010
3014@property(nonatomic, assign) CGFloat speakerPositionZ;
3015
3019@property(nonatomic, assign) CGFloat speakerQuaternionX;
3020
3024@property(nonatomic, assign) CGFloat speakerQuaternionY;
3025
3029@property(nonatomic, assign) CGFloat speakerQuaternionZ;
3030
3034@property(nonatomic, assign) CGFloat speakerQuaternionW;
3035
3039@property(nonatomic, assign) CGFloat headPositionX;
3040
3044@property(nonatomic, assign) CGFloat headPositionY;
3045
3049@property(nonatomic, assign) CGFloat headPositionZ;
3050
3054@property(nonatomic, assign) CGFloat headQuaternionX;
3055
3059@property(nonatomic, assign) CGFloat headQuaternionY;
3060
3064@property(nonatomic, assign) CGFloat headQuaternionZ;
3065
3069@property(nonatomic, assign) CGFloat headQuaternionW;
3070
3071@end
3072
3076
3080@property (nonatomic, assign) NERtcSpatializerRoomCapacity roomCapacity;
3081
3085@property (nonatomic, assign) NERtcSpatializerMaterialName material;
3086
3090@property (nonatomic, assign) CGFloat reflectionScalar;
3091
3095@property (nonatomic, assign) CGFloat reverbGain;
3096
3100@property (nonatomic, assign) CGFloat reverbTime;
3101
3105@property (nonatomic, assign) CGFloat reverbBrightness;
3106
3107@end
3108
3109NERTC_EXPORT @interface NERtcPacket : NSObject
3110
3119@property (nonatomic, assign) const unsigned char* buffer;
3120
3129@property (nonatomic, assign) long size;
3130
3131@end
3132
3133#pragma mark - push stream params
3134
3136
3147@property (nonatomic, assign) uint64_t uId;
3148
3159@property (nonatomic, copy) NSString *channelName;
3170@property (nonatomic, copy) NSString *token;
3171
3172@end
3173
3175
3184@property (nonatomic, copy) NSString *streamingUrl;
3185
3194@property (nonatomic, strong, nullable) NERtcStreamingRoomInfo *streamingRoomInfo;
3195
3196@end
3197
3198NS_ASSUME_NONNULL_END
NERTC_EXTERN_API uint32_t const NERtcAudioMixingMaxVolume
Definition NERtcEngineBase.h:683
NERTC_EXTERN_API NSString *const kNERtcKeyVideoStartWithBackCamera
第一次开启摄像头时,是否使用后摄像头。 布尔值,默认值 NO,即不使用后置摄像头。
Definition NERtcEngineBase.h:80
NERTC_EXTERN_API NSString *const KNERtcKeyDisableSWAECOnHeadset
设置耳机时不使用软件回声消除功能,默认值 NO。如设置 YES 则 SDK 在耳机模式下不使用软件回声消除功能,会对某些机型下 耳机的音质效果有影响
Definition NERtcEngineBase.h:185
NERTC_EXTERN_API NSString *const kNERtcKeyExtraInfo
Login 事件中的一个自定义字段,适用于标识一些额外信息,例如 App 版本。
Definition NERtcEngineBase.h:267
NERTC_EXTERN_API NSString *const KNERtcKeyAudioAINSEnable
是否开启 AI 降噪。 NERTC SDK 自研 AI 降噪算法,开启 AI 降噪之后,在嘈杂的环境中可以针对背景人声、键盘声等非稳态噪声进行定向降噪,同时也会提升对于环境稳态噪声的抑制,保留更纯粹的...
Definition NERtcEngineBase.h:195
NERTC_EXTERN_API NSString *const kNERtcKeyLoginCustomData
登录扩展参数,string,默认不设置。
Definition NERtcEngineBase.h:282
NERTC_EXTERN_API NSString *const kNERtcKeyLogLevel
SDK 日志等级,默认为 kNERtcLogLevelInfo,详细信息请参考 NERtcLogLevel。
Definition NERtcEngineBase.h:258
NS_ASSUME_NONNULL_BEGIN NERTC_EXTERN_API NSString *const kNERtcKeyChannel1V1ModeEnabled
以下 key 用于 INERtcEngine::setParameters
Definition NERtcEngineBase.h:35
NERTC_EXTERN_API NSString *const kNERtcKeyPublishSelfStreamEnabled
在旁路推流场景中,是否允许推送本地媒体流到 CDN。默认值 YES。
Definition NERtcEngineBase.h:247
NERTC_EXTERN_API NSString *const kNERtcKeyVideoPreferMetalRender
是否优先使用 Metal 渲染。 布尔值,默认值 NO,即使用 OpenGL 渲染。
Definition NERtcEngineBase.h:90
NERTC_EXTERN_API NSString *const KNERtcKeyDisableOverrideSpeakerOnReceiver
当系统切换听筒或扬声器时,SDK 是否以系统设置为准。 布尔值,默认为 NO。
Definition NERtcEngineBase.h:155
NERTC_EXTERN_API NSString *const kNERtcKeyVideoPreferHWEncode
是否优先使用硬件编码视频数据。 布尔值,默认值 YES。 请在初始化(setupEngineWithContext)之前设置该参数,否则该参数会在下次初始化之后生效。
Definition NERtcEngineBase.h:48
NERTC_EXTERN_API NSString *const kNERtcKeyVideoSendOnPubType
通话开始时,默认发送的流类型,通话前设置有效。 int 类型,默认为 3,即大流。详细信息请参考 NERtcVideoPubMode。
Definition NERtcEngineBase.h:100
NERTC_EXTERN_API NSString *const kNERtcKeyRecordHostEnabled
是否云端录制主讲人,默认值 NO
Definition NERtcEngineBase.h:207
NERTC_EXTERN_API NSString *const kNERtcKeyAutoSubscribeAudio
是否自动订阅其他用户的音频流。 布尔值,默认为 YES,即自动订阅。
Definition NERtcEngineBase.h:127
NERTC_EXTERN_API NSString *const kNERtcKeyAutoSubscribeVideo
是否自动订阅其他用户的视频流。 布尔值,默认值 NO,即不自动订阅。
Definition NERtcEngineBase.h:112
NERTC_EXTERN_API NSString *const kNERtcKeyAutoSubscribeData
是否自动订阅其他用户的数据通道。 布尔值,默认为 NO,即非自动订阅。
Definition NERtcEngineBase.h:142
NERTC_EXTERN_API NSString *const kNERtcKeyRecordAudioEnabled
是否开启云端音频录制。默认值 NO,即关闭音频录制。
Definition NERtcEngineBase.h:216
NERTC_EXTERN_API NSString *const kNERtcKeySupportCallkit
是否需要支持 Callkit 框架。 布尔值,默认为 NO。
Definition NERtcEngineBase.h:163
NERTC_EXTERN_API NSString *const kNERtcKeyDisableFirstJoinUserCreateChannel
Definition NERtcEngineBase.h:285
NERTC_EXTERN_API NSString *const kNERtcKeyRecordVideoEnabled
是否开启云端视频录制,默认值 NO,即关闭视频录制。
Definition NERtcEngineBase.h:225
NERTC_EXTERN_API NSString *const kNERtcKeyRecordType
云端录制模式。详细信息请参考 NERtcRecordType。
Definition NERtcEngineBase.h:234
NERTC_EXTERN_API NSString *const kNERtcKeyVideoPreferHWDecode
是否优先使用硬件解码视频数据。 布尔值,默认值 YES。 请在初始化(setupEngineWithContext)之前设置该参数,否则该参数会在下次初始化之后生效。
Definition NERtcEngineBase.h:59
NERTC_EXTERN_API NSString *const KNERtcKeyEnableReportVolumeWhenMute
本地用户静音时是否返回原始音量。 布尔值,默认值为 false。
Definition NERtcEngineBase.h:176
NERTC_EXTERN_API NSString *const kNERtcKeyVideoCaptureObserverEnabled
是否需要开启视频数据采集回调,开启后开发者可以获取到原始视频数据。 布尔值,默认值 NO。 开启后如果需要关闭,需要通过调用 destroyEngine 来清除。
Definition NERtcEngineBase.h:70
NERTC_EXTERN_API NSString *const kNERtcKeyDisableVideoDecoder
是否关闭 sdk 视频解码(默认不关闭),关闭后 SDK 将不会解码远端视频,因此也无法渲染接收到的远端视频
Definition NERtcEngineBase.h:275
NERTC_EXTERN_API uint32_t const NERtcAudioMixingDefaultVolume
Definition NERtcEngineBase.h:684
NERtcPreDecoderMediaType
媒体类型。
Definition NERtcEngineEnum.h:2179
NERtcLiveStreamMode
直播推流模式。
Definition NERtcEngineEnum.h:2917
NERtcVideoCropMode
视频裁剪模式
Definition NERtcEngineEnum.h:918
NERtcLastmileProbeResultState
Last mile 质量探测结果的状态。
Definition NERtcEngineEnum.h:3463
NERtcLogLevel
日志级别。
Definition NERtcEngineEnum.h:3556
NERtcVideoCodecType
Definition NERtcEngineEnum.h:2211
NERtcVideoFormatType
视频格式类型
Definition NERtcEngineEnum.h:1057
NERtcVirtualBackgroundSourceType
自定义背景图片的类型。
Definition NERtcEngineEnum.h:1184
NERtcVideoWatermarkType
视频水印类型。
Definition NERtcEngineEnum.h:1268
NERtcLiveStreamVideoScaleMode
直播推流模式。
Definition NERtcEngineEnum.h:2946
NERtcSubStreamContentPrefer
屏幕共享功能的编码策略倾向
Definition NERtcEngineEnum.h:651
NERtcLiveStreamAudioCodecProfile
直播推流音频编码规格。
Definition NERtcEngineEnum.h:2888
#define NERTC_EXTERN_API
Definition NERtcEngineEnum.h:18
NERtcAudioRecordingQuality
录音音质。
Definition NERtcEngineEnum.h:2059
NERtcAudioRecordingPosition
Definition NERtcEngineEnum.h:2149
NERtcPayLoadType
Definition NERtcEngineEnum.h:3543
NERtcVideoOutputOrientationMode
视频旋转方向模式。
Definition NERtcEngineEnum.h:870
NERtcVideoProfileType
视频 profile 类型。
Definition NERtcEngineEnum.h:447
NERtcNalFrameType
Definition NERtcEngineEnum.h:3526
NERtcBlurDegree
自定义背景图的虚化程度。
Definition NERtcEngineEnum.h:1227
NERtcAudioType
音频类型
Definition NERtcEngineEnum.h:3016
NERtcVideoMirrorMode
视频镜像模式。
Definition NERtcEngineEnum.h:832
NERtcAudioFrameOpMode
音频数据读写模式
Definition NERtcEngineEnum.h:3036
NERtcEncryptionMode
加密模式
Definition NERtcEngineEnum.h:3432
NERtcAudioRecordingCycleTime
Definition NERtcEngineEnum.h:2158
NERtcSpatializerMaterialName
空间音效中房间材质名称
Definition NERtcEngineEnum.h:1826
NERtcDegradationPreference
带宽受限时视频编码适应性偏好
Definition NERtcEngineEnum.h:600
NERtcLiveStreamAudioSampleRate
直播推流音频采样率。
Definition NERtcEngineEnum.h:2850
#define NERTC_EXPORT
Definition NERtcEngineEnum.h:12
NERtcVideoFrameRate
视频帧率。
Definition NERtcEngineEnum.h:514
NERtcVideoRenderScaleMode
视频渲染缩放模式。
Definition NERtcEngineEnum.h:764
NERtcSpatializerRoomCapacity
空间音效房间大小
Definition NERtcEngineEnum.h:1796
NERtcAudioStreamType
音频流类型,目前同时支持音频两路流:主流和辅流
Definition NERtcEngineEnum.h:1770
NERtcVideoRotationType
视频数据的旋转方向
Definition NERtcEngineEnum.h:1003
编码好的音频数据
Definition NERtcEngineBase.h:2950
音频格式。
Definition NERtcEngineBase.h:1454
音频帧。
Definition NERtcEngineBase.h:1519
音频原始数据回调格式(默认不设置)。
Definition NERtcEngineBase.h:1406
Definition NERtcEngineBase.h:903
声音音量信息。
Definition NERtcEngineBase.h:1564
本地视频基础发送配置。
Definition NERtcEngineBase.h:365
摄像头采集配置。
Definition NERtcEngineBase.h:488
Definition NERtcEngineBase.h:1753
媒体流转发相关的数据结构。
Definition NERtcEngineBase.h:1721
Options for creating audio effects
Definition NERtcEngineBase.h:806
Options for creating mixing audios
Definition NERtcEngineBase.h:688
配置媒体流加密模式和密钥。
Definition NERtcEngineBase.h:2182
joinChannel 回调时的一些可选信息
Definition NERtcEngineBase.h:2781
joinChannel 时的一些可选信息
Definition NERtcEngineBase.h:2760
Last mile 网络探测配置。
Definition NERtcEngineBase.h:2369
单向 Last mile 网络质量探测结果报告。
Definition NERtcEngineBase.h:2438
上下行 Last mile 网络质量探测结果。
Definition NERtcEngineBase.h:2482
音视频流编码参数等设置
Definition NERtcEngineBase.h:931
图片布局。
Definition NERtcEngineBase.h:1152
直播布局。
Definition NERtcEngineBase.h:1237
直播推流任务的配置。
Definition NERtcEngineBase.h:1308
直播成员布局。
Definition NERtcEngineBase.h:1024
日志相关设置。
Definition NERtcEngineBase.h:2536
低延时直播参数
Definition NERtcEngineBase.h:2740
Definition NERtcEngineBase.h:3110
3D 音效算法中坐标信息。
Definition NERtcEngineBase.h:3000
编码完的视频帧数据
Definition NERtcEngineBase.h:2842
编码完的媒体数据帧
Definition NERtcEngineBase.h:2860
编码完的音频帧数据
Definition NERtcEngineBase.h:2820
Definition NERtcEngineBase.h:3175
混响参数
Definition NERtcEngineBase.h:2671
私有化服务器配置项
Definition NERtcEngineBase.h:2225
3D 音效房间属性设置。
Definition NERtcEngineBase.h:3076
Definition NERtcEngineBase.h:3136
onUserJoined 回调时的一些可选信息
Definition NERtcEngineBase.h:2794
onUserLeave 回调时的一些可选信息
Definition NERtcEngineBase.h:2806
视频画布设置。
Definition NERtcEngineBase.h:296
uint32_t backgroundColor
Definition NERtcEngineBase.h:352
id< NERtcEngineVideoRenderSink > externalVideoRender
外部渲染器。
Definition NERtcEngineBase.h:349
BOOL useExternalRender
是否使用外部渲染器,默认 NO 不使用,若使用 SDK 内部会根据 externalVideoRender 来进行绑定,若不使用 SDK 内部根据 container 来进行绑定。暂不支持在通话中切换内...
Definition NERtcEngineBase.h:305
NERtcVideoRenderScaleMode renderMode
视频渲染模式。
Definition NERtcEngineBase.h:325
VIEW_CLASS * container
视频窗口容器(SDK 内部渲染)。
Definition NERtcEngineBase.h:315
NERtcVideoMirrorMode mirrorMode
视频镜像模式。
Definition NERtcEngineBase.h:339
视频图像畸变矫正相关设置。
Definition NERtcEngineBase.h:2570
本地视频发送配置
Definition NERtcEngineBase.h:542
Definition NERtcEngineBase.h:2908
视频帧信息。
Definition NERtcEngineBase.h:1609
本地辅流发送配置。
Definition NERtcEngineBase.h:648
视频水印设置,目前支持三种类型的水印,但只能其中选择一种水印生效。
Definition NERtcEngineBase.h:2128
视频图片水印配置。
Definition NERtcEngineBase.h:1839
Definition NERtcEngineBase.h:1925
Definition NERtcEngineBase.h:2027
自定义背景图像。
Definition NERtcEngineBase.h:2607