NERTC iOS SDK V5.10.1
载入中...
搜索中...
未找到
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
21
22// channel
36
37// video
101
112NERTC_EXTERN_API NSString * const kNERtcKeyAutoSubscribeVideo; // BOOL -- 其他用户打开视频时,自动订阅。只支持在通话前设置,通话中设置无效。 默认值 NO。
113
114// audio
128
129// data channel
143
156
164
199
200
201// server record
238
239// live stream
251
252// log level
271
279
286
287
289
298NERTC_EXPORT @interface NERtcVideoCanvas : NSObject
299
308@property (nonatomic, assign) BOOL useExternalRender;
309
318@property (nonatomic, nullable, strong) VIEW_CLASS *container;
319
328@property (nonatomic, assign) NERtcVideoRenderScaleMode renderMode;
329
342@property (nonatomic, assign) NERtcVideoMirrorMode mirrorMode;
343
352@property (nonatomic, strong) id<NERtcEngineVideoRenderSink> externalVideoRender;
353
354// 背景颜色,格式为 0xRRGGBB,默认为黑色即 0x000000
355@property (nonatomic, assign) uint32_t backgroundColor;
356
357@end
358
368
377@property (nonatomic, assign) NERtcVideoProfileType maxProfile;
378
395@property (nonatomic, assign) NERtcVideoFrameRate frameRate;
396
405@property (nonatomic, assign) NSInteger minFrameRate;
406
468@property (nonatomic, assign) NSInteger bitrate;
469
478@property (nonatomic, assign) NSInteger minBitrate;
479
480@end
481
491
512@property (nonatomic, assign) int captureWidth;
533@property (nonatomic, assign) int captureHeight;
534
543@property(nonatomic, assign) NERtcVideoColorSpaceRange colorSpaceRange;
544
545@end
555
572@property (nonatomic, assign) int width;
573
590@property (nonatomic, assign) int height;
591
600@property (nonatomic, assign) NERtcVideoCropMode cropMode;
601
623
635@property (nonatomic, assign) NERtcVideoMirrorMode mirrorMode;
636
648
649
650@end
651
661
670@property (nonatomic, assign) NERtcSubStreamContentPrefer contentPrefer;
671
693
694@end
695
698
701
714@property (nonatomic, copy) NSString *path;
715
728@property (nonatomic, assign) int loopCount;
729
738@property (nonatomic, assign) BOOL sendEnabled;
739
748@property (nonatomic, assign) BOOL playbackEnabled;
749
760@property (nonatomic, assign) uint32_t sendVolume;
761
772@property (nonatomic, assign) uint32_t playbackVolume;
773
782@property (nonatomic, assign) int64_t startTimeStamp;
783
792@property (nonatomic, assign) NERtcAudioStreamType sendWithAudioType;
793
799@property (nonatomic, assign) uint64_t progressInterval;
800
813- (BOOL)isInvalid;
814
815@end
816
819
832@property (nonatomic, copy) NSString *path;
833
846@property (nonatomic, assign) int loopCount;
847
856@property (nonatomic, assign) BOOL sendEnabled;
857
866@property (nonatomic, assign) BOOL playbackEnabled;
867
878@property (nonatomic, assign) uint32_t sendVolume;
879
890@property (nonatomic, assign) uint32_t playbackVolume;
891
897@property (nonatomic, assign) int64_t startTimeStamp;
898
904@property (nonatomic, assign) NERtcAudioStreamType sendWithAudioType;
905
911@property (nonatomic, assign) uint64_t progressInterval;
912
913@end
914
916
917// 录音文件在本地保存的绝对路径,需要精确到文件名及格式。例如:sdcard/xxx/audio.aac。请确保指定的路径存在并且可写。目前仅支持 WAV 或 AAC 文件格式。
918@property (nonatomic, copy) NSString *filePath;
919
920// 录音采样率(Hz),可以设为 16000、32000(默认)、44100 或 48000。
921@property (nonatomic, assign) int sampleRate;
922
923// 录音音质,只在 AAC 格式下有效。详细信息请参考 {@link NERtcAudioRecordingQuality}。
924@property (nonatomic, assign) NERtcAudioRecordingQuality quality;
925
926// 录音文件所包含的内容。详细信息请参考 {@link NERtcAudioRecordingPosition}。
927@property (nonatomic, assign) NERtcAudioRecordingPosition position;
928
929// 录制过程中,循环缓存的最大时间长度,单位(s)。详细信息请参考 {@link NERtcAudioRecordingCycleTime}。
930@property (nonatomic, assign) NERtcAudioRecordingCycleTime cycleTime;
931
932@end
933
934#pragma mark - live stream
943NERTC_EXPORT @interface NERtcLiveConfig: NSObject
944
953@property (nonatomic, assign) BOOL interruptedPlaceImage;
954
967@property (nonatomic, assign) BOOL singleVideoPassthrough;
980@property (nonatomic, assign) NSInteger audioBitrate;
981
996@property (nonatomic, assign) NERtcLiveStreamAudioSampleRate sampleRate;
997
1010@property (nonatomic, assign) NSInteger channels;
1011
1025
1026@end
1027
1037
1046@property (nonatomic, assign) uint64_t uid;
1047
1062@property (nonatomic, assign) BOOL videoPush;
1063
1076@property (nonatomic, assign) NSInteger x;
1077
1090@property (nonatomic, assign) NSInteger y;
1091
1104@property (nonatomic, assign) NSInteger width;
1105
1118@property (nonatomic, assign) NSInteger height;
1119
1132@property (nonatomic, assign) BOOL audioPush;
1133
1142@property (nonatomic, assign) NSInteger zOrder;
1143
1152@property (nonatomic, assign) NERtcLiveStreamVideoScaleMode adaption;
1153
1169@property (nonatomic, assign) NERtcStreamChannelType videoStreamType;
1170
1171@end
1172
1182
1191@property (nonatomic, copy) NSString *url;
1192
1205@property (nonatomic, assign) NSInteger x;
1206
1219@property (nonatomic, assign) NSInteger y;
1220
1231@property (nonatomic, assign) NSInteger width;
1232
1243@property (nonatomic, assign) NSInteger height;
1244
1254@property (nonatomic, assign) int zorder;
1255
1256@end
1257
1267
1276@property (nonatomic, assign) NSInteger width;
1277
1286@property (nonatomic, assign) NSInteger height;
1287
1296@property (nonatomic, assign) NSUInteger backgroundColor;
1297
1306@property (nonatomic, strong) NSArray<NERtcLiveStreamUserTranscoding *> * users;
1307
1317@property (nonatomic, nullable, strong) NERtcLiveStreamImageInfo* bgImage;
1318
1325@property (nonatomic, nullable, strong) NSArray<NERtcLiveStreamImageInfo*> * bgImages;
1326
1327@end
1328
1338
1349@property (nonatomic, copy) NSString *taskID;
1350
1361@property (nonatomic, copy) NSString *streamURL;
1362
1371@property (nonatomic, assign) BOOL serverRecordEnabled;
1372
1381@property (nonatomic, assign) NERtcLiveStreamMode lsMode;
1382
1391@property (nonatomic, nullable, strong) NERtcLiveStreamLayout *layout;
1392
1401@property (nonatomic, nullable, strong) NERtcLiveConfig *config;
1402
1411@property (nonatomic, nullable, copy) NSString *extraInfo;
1412
1422
1423@end
1424
1425
1426#pragma mark - Audio Frame Observer
1436
1451@property (nonatomic, assign) uint32_t channels;
1452
1461@property (nonatomic, assign) uint32_t sampleRate;
1462
1471@property (nonatomic, assign) NERtcAudioFrameOpMode mode;
1472
1473@end
1474
1483NERTC_EXPORT @interface NERtcAudioFormat : NSObject
1484
1493@property (nonatomic, assign) NERtcAudioType type;
1506@property (nonatomic, assign) uint32_t channels;
1507
1516@property (nonatomic, assign) uint32_t sampleRate;
1517
1526@property (nonatomic, assign) uint32_t bytesPerSample;
1527
1536@property (nonatomic, assign) uint32_t samplesPerChannel;
1537
1538@end
1539
1548NERTC_EXPORT @interface NERtcAudioFrame : NSObject
1549
1558@property (nonatomic, strong) NERtcAudioFormat* format;
1559
1568@property (nonatomic, assign) void* data;
1569
1578@property (nonatomic, assign) int64_t syncTimestamp;
1579
1580@end
1581
1582
1583#pragma mark - Volume info
1584
1594
1603@property (nonatomic, assign) uint64_t uid;
1604
1613@property (nonatomic, assign) unsigned int volume;
1614
1624@property (nonatomic, assign) unsigned int subStreamVolume;
1625
1626@end
1627
1628#pragma mark - Video Frame
1629
1638NERTC_EXPORT @interface NERtcVideoFrame : NSObject
1639
1649@property(nonatomic, assign) NERtcVideoFormatType format;
1650
1659@property(nonatomic, assign) uint64_t timestamp;
1660
1669@property(nonatomic, assign) uint32_t width;
1670
1679@property(nonatomic, assign) uint32_t height;
1680
1689@property(nonatomic, assign) NERtcVideoRotationType rotation;
1690
1703@property(nonatomic) void * buffer;
1704
1712@property(nonatomic) void * uBuffer;
1713
1721@property(nonatomic) void * vBuffer;
1722
1732@property(nonatomic, strong) NSArray<NSNumber *> *strides;
1733
1734// Metal 纹理
1735// 目前该参数仅在外部渲染视频的场景下有实际意义。
1736@property(nonatomic, strong) id<MTLTexture> texture;
1737
1746@property(nonatomic, assign) NERtcVideoColorSpaceRange colorSpaceRange;
1747
1757
1767
1777
1778@end
1779
1780#pragma mark - MediaRelay
1781
1791
1800@property (nonatomic, copy)NSString *channelName;
1809@property (nonatomic, copy)NSString *token;
1818@property (nonatomic, assign)uint64_t uid;
1819
1820@end
1821
1823
1838@property(nonatomic, strong, readonly)NSDictionary<NSString *, NERtcChannelMediaRelayInfo *> * _Nullable destinationInfos;
1839
1854@property(nonatomic, strong)NERtcChannelMediaRelayInfo *sourceInfo;
1855
1872- (BOOL)setDestinationInfo:(NERtcChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName;
1873
1886- (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName;
1887
1888@end
1889
1890#pragma mark - watermark
1891
1909
1918@property (nonatomic, assign) CGFloat wmAlpha;
1919
1928@property (nonatomic, assign) NSUInteger wmWidth;
1929
1938@property (nonatomic, assign) NSUInteger wmHeight;
1939
1948@property (nonatomic, assign) NSUInteger offsetX;
1949
1958@property (nonatomic, assign) NSUInteger offsetY;
1959
1968@property (nonatomic, strong) NSArray<NSString *> *imagePaths;
1969
1980@property (nonatomic, assign) NSUInteger fps;
1981
1990@property (nonatomic, assign) BOOL loop;
1991
1992@end
1993
1995
2004@property (nonatomic, copy) NSString *content;
2005
2011@property (nonatomic, copy) NSString *fontName;
2012
2021@property (nonatomic, assign) NSUInteger fontColor;
2022
2031@property (nonatomic, assign) NSUInteger fontSize;
2032
2041@property (nonatomic, assign) CGFloat wmAlpha;
2042
2052@property (nonatomic, assign) NSUInteger wmColor;
2053
2062@property (nonatomic, assign) NSUInteger wmWidth;
2063
2072@property (nonatomic, assign) NSUInteger wmHeight;
2073
2082@property (nonatomic, assign) NSUInteger offsetX;
2083
2092@property (nonatomic, assign) NSUInteger offsetY;
2093
2094@end
2095
2097
2103@property (nonatomic, copy) NSString *fontName;
2104
2113@property (nonatomic, assign) NSUInteger fontColor;
2114
2123@property (nonatomic, assign) NSUInteger fontSize;
2124
2133@property (nonatomic, assign) CGFloat wmAlpha;
2134
2145@property (nonatomic, assign) NSUInteger wmColor;
2146
2155@property (nonatomic, assign) NSUInteger wmWidth;
2156
2165@property (nonatomic, assign) NSUInteger wmHeight;
2166
2175@property (nonatomic, assign) NSUInteger offsetX;
2176
2185@property (nonatomic, assign) NSUInteger offsetY;
2186
2187@end
2188
2198
2207@property (nonatomic, assign) NERtcVideoWatermarkType watermarkType;
2208
2217@property (nonatomic, strong) NERtcVideoWatermarkImageConfig *imageWatermark;
2218
2227@property (nonatomic, strong) NERtcVideoWatermarkTextConfig *textWatermark;
2228
2238
2239@end
2240
2241#pragma mark - Encryption
2242
2252
2261@property (nonatomic, assign) NERtcEncryptionMode mode;
2262
2271@property (nonatomic, copy, nullable) NSString *key;
2272
2278@property (nonatomic, weak, nullable) id<NERtcEnginePacketObserver> observer;
2279
2280@end
2281
2282#pragma mark - privatization
2283
2295
2304@property (nonatomic, copy, nullable) NSString* lbsServer;
2305
2314@property (nonatomic, copy, nullable) NSString *channelServer;
2315
2324@property (nonatomic, copy, nullable) NSString *statisticsServer;
2325
2334@property (nonatomic, copy, nullable) NSString *statisticsDispatchServer;
2335
2344@property (nonatomic, copy, nullable) NSString *statisticsBackupServer;
2345
2354@property (nonatomic, copy, nullable) NSString *roomServer;
2355
2364@property (nonatomic, copy, nullable) NSString *compatServer;
2365
2374@property (nonatomic, copy, nullable) NSString *nosLbsServer;
2375
2384@property (nonatomic, copy, nullable) NSString *nosUploadSever;
2385
2394@property (nonatomic, copy, nullable) NSString *nosTokenServer;
2395
2405@property (nonatomic, assign) BOOL useIPv6;
2406
2410@property (nonatomic, copy, nullable) NSString *cloudProxyServer;
2411
2415@property (nonatomic, copy, nullable) NSString *webSocketProxyServer;
2416
2420@property (nonatomic, copy, nullable) NSString *quicProxyServer;
2421
2425@property (nonatomic, copy, nullable) NSString *mediaProxyServer;
2426
2427@end
2428
2429#pragma mark - NERtcLastmileProbeConfig
2430
2440
2455@property(nonatomic, assign) BOOL probeUplink;
2456
2469@property(nonatomic, assign) BOOL probeDownlink;
2470
2483@property(nonatomic, assign) NSUInteger expectedUplinkBitrate;
2484
2494@property(nonatomic, assign) NSUInteger expectedDownlinkBitrate;
2495
2496@end
2497
2498#pragma mark - NERtcLastmileProbeOneWayResult
2499
2509
2518@property(nonatomic, assign) NSUInteger packetLossRate;
2519
2528@property(nonatomic, assign) NSUInteger jitter;
2529
2538@property(nonatomic, assign) NSUInteger availableBandwidth;
2539
2540@end
2541
2542#pragma mark - NERtcLastmileProbeResult
2543
2553
2562@property(nonatomic, assign) NERtcLastmileProbeResultState state;
2563
2572@property(nonatomic, assign) NSUInteger rtt;
2573
2582@property(nonatomic, strong) NERtcLastmileProbeOneWayResult *uplinkReport;
2583
2593
2594@end
2595
2596#pragma mark - Log setting
2597
2606NERTC_EXPORT @interface NERtcLogSetting : NSObject
2607
2616@property (nonatomic, copy) NSString *logDir;
2617
2626@property (nonatomic, assign) NERtcLogLevel logLevel;
2627
2628@end
2629
2630#pragma mark - Video Correction Config
2631
2641
2642// 矫正区域的左上顶点(x 和 y 的取值范围为 0 ~ 1 的浮点数)
2643@property (nonatomic, assign) CGPoint topLeft;
2644
2645// 矫正区域的右上顶点(x 和 y 的取值范围为 0 ~ 1 的浮点数)
2646@property (nonatomic, assign) CGPoint topRight;
2647
2648// 矫正区域的左下顶点(x 和 y 的取值范围为 0 ~ 1 的浮点数)
2649@property (nonatomic, assign) CGPoint bottomLeft;
2650
2651// 矫正区域的右下顶点(x 和 y 的取值范围为 0 ~ 1 的浮点数)
2652@property (nonatomic, assign) CGPoint bottomRight;
2653
2654// 画布宽度(单位 px,使用外部视频渲染时需要传递)
2655@property (nonatomic, assign) CGFloat canvasWidth;
2656
2657// 画布高度(单位 px,使用外部视频渲染时需要传递)
2658@property (nonatomic, assign) CGFloat canvasHeight;
2659
2660// 是否镜像显示(使用外部视频渲染时需要传递)
2661@property (nonatomic, assign) BOOL enableMirror;
2662
2663@end
2664
2665#pragma mark - NERtcVirtualBackgroundSource
2666
2678
2688
2703@property (nonatomic, assign) NSUInteger color;
2704
2715@property (nonatomic, copy) NSString *source;
2716
2727@property (nonatomic, assign) NERtcBlurDegree blur_degree;
2728
2729@end
2730
2731#pragma mark - Audio Effect
2732
2741NERTC_EXPORT @interface NERtcReverbParam : NSObject
2742
2751@property (nonatomic, assign) float wetGain;
2752
2761@property (nonatomic, assign) float dryGain;
2762
2771@property (nonatomic, assign) float damping;
2772
2781@property (nonatomic, assign) float roomSize;
2782
2791@property (nonatomic, assign) float decayTime;
2792
2801@property (nonatomic, assign) float preDelay;
2802
2803@end
2804
2805#pragma mark - extraInfo
2806
2811
2815@property (nonatomic, assign) BOOL enableLowLatency;
2819@property (nonatomic, assign) NSUInteger playTimeout;
2823@property (nonatomic, nullable, strong) NERtcVideoCanvas *playCanvas;
2824
2825@end
2826
2831
2835@property (nonatomic, nullable, copy) NSString *customInfo;
2836
2842@property (nonatomic, nullable, copy) NSString *permissionKey;
2843
2844@property (nonatomic, nullable, strong) NERtcLowLatencyOptions *lowLatencyOptions;
2845
2846@end
2847
2852
2856@property (nonatomic, copy) NSString *customInfo;
2857
2858
2859@end
2860
2865
2869@property (nonatomic, copy) NSString *customInfo;
2870
2871@end
2872
2877
2881@property (nonatomic, copy) NSString *customInfo;
2882
2883@end
2884
2885#pragma mark - preDecoder
2886
2894@property (nonatomic, assign) int width;
2895
2899@property (nonatomic, assign) int height;
2900
2904@property (nonatomic, assign) BOOL isKeyFrame;
2905
2906@end
2907
2908
2913
2917@property (nonatomic, assign) uint32_t perTimeMs;
2918
2922@property (nonatomic, assign) uint8_t toc;
2923
2924@end
2925
2926
2934@property (nonatomic, assign) NERtcPreDecoderMediaType mediaType;
2935
2939@property (nonatomic, assign) uint64_t uid;
2940
2944@property (nonatomic, assign) int64_t timestampMs;
2945
2949@property (nonatomic, assign) uint8_t *data;
2950
2954@property (nonatomic, assign) int length;
2955
2959@property (nonatomic, copy) NSString *codec;
2960
2964@property (nonatomic, assign) BOOL isMainStream;
2965
2969@property (nonatomic, strong) NERtcPreDecoderVideoInfo *videoInfo;
2970
2974@property (nonatomic, strong) NERtcPreDecoderAudioInfo *audioInfo;
2975
2976@end
2977
2979
2980/***
2981* 编码器类型
2982*/
2983@property (nonatomic, assign) NERtcVideoCodecType codecType;
2984
2988@property (nonatomic, assign) NERtcNalFrameType frameType;
2989
2993@property (nonatomic, copy) NSArray<NSNumber *> *nalLengths;
2994
2998@property (nonatomic, assign) unsigned char *nalData;
2999
3003@property (nonatomic, assign) int64_t timestampUs;
3004
3008@property (nonatomic, assign) int width;
3009
3013@property (nonatomic, assign) int height;
3014
3015@end
3016
3021
3025@property (nonatomic, assign) unsigned char *data;
3026
3030@property (nonatomic, assign) int64_t timeStampUs;
3031
3035@property (nonatomic, assign) int sampleRate;
3036
3040@property (nonatomic, assign) int channels;
3041
3045@property (nonatomic, assign) int samplesPerChannel;
3046
3050@property (nonatomic, assign) int encodedLen;
3051
3055@property (nonatomic, assign) uint32_t encodedTimestamp;
3056
3060@property (nonatomic, assign) NERtcPayLoadType payloadType;
3061
3065@property (nonatomic, assign) uint8_t rmsLevel;
3066
3067@end
3068
3070NERTC_EXPORT @interface NERtcPositionInfo : NSObject
3071
3075@property(nonatomic, assign) CGFloat speakerPositionX;
3076
3080@property(nonatomic, assign) CGFloat speakerPositionY;
3081
3085@property(nonatomic, assign) CGFloat speakerPositionZ;
3086
3090@property(nonatomic, assign) CGFloat speakerQuaternionX;
3091
3095@property(nonatomic, assign) CGFloat speakerQuaternionY;
3096
3100@property(nonatomic, assign) CGFloat speakerQuaternionZ;
3101
3105@property(nonatomic, assign) CGFloat speakerQuaternionW;
3106
3110@property(nonatomic, assign) CGFloat headPositionX;
3111
3115@property(nonatomic, assign) CGFloat headPositionY;
3116
3120@property(nonatomic, assign) CGFloat headPositionZ;
3121
3125@property(nonatomic, assign) CGFloat headQuaternionX;
3126
3130@property(nonatomic, assign) CGFloat headQuaternionY;
3131
3135@property(nonatomic, assign) CGFloat headQuaternionZ;
3136
3140@property(nonatomic, assign) CGFloat headQuaternionW;
3141
3142@end
3143
3147
3151@property (nonatomic, assign) NERtcSpatializerRoomCapacity roomCapacity;
3152
3156@property (nonatomic, assign) NERtcSpatializerMaterialName material;
3157
3161@property (nonatomic, assign) CGFloat reflectionScalar;
3162
3166@property (nonatomic, assign) CGFloat reverbGain;
3167
3171@property (nonatomic, assign) CGFloat reverbTime;
3172
3176@property (nonatomic, assign) CGFloat reverbBrightness;
3177
3178@end
3179
3180NERTC_EXPORT @interface NERtcPacket : NSObject
3181
3190@property (nonatomic, assign) const unsigned char* buffer;
3191
3200@property (nonatomic, assign) long size;
3201
3202@end
3203
3204#pragma mark - push stream params
3205
3207
3218@property (nonatomic, assign) uint64_t uId;
3219
3230@property (nonatomic, copy) NSString *channelName;
3241@property (nonatomic, copy) NSString *token;
3242
3243@end
3244
3246
3255@property (nonatomic, copy) NSString *streamingUrl;
3256
3265@property (nonatomic, strong, nullable) NERtcStreamingRoomInfo *streamingRoomInfo;
3266
3267@end
3268
3270
3281@property (nonatomic, copy) NSString *streamUrl;
3282
3291@property (nonatomic, assign) uint32_t playOutDelay;
3292
3302@property (nonatomic, assign) uint32_t reconnectTimeout;
3303
3312@property (nonatomic, assign) BOOL enableAudioPlay;
3313
3322@property (nonatomic, assign) BOOL enableVideoPlay;
3323
3332@property (nonatomic, assign) BOOL pausePlayStreaming;
3333@end
3334
3341
3348@property (nonatomic, copy, nullable) NSString *taskId;
3349
3355@property (nonatomic, copy, nullable) NSString *mediaContent;
3356
3362@property (nonatomic, copy, nullable) NSString *url;
3363
3369@property (nonatomic, copy, nullable) NSString *text;
3370
3379@property (nonatomic, assign) int interruptMode;
3380
3381@end
3382
3384
3400@property (nonatomic, copy) NSString *srcLanguage;
3401
3416@property(nonatomic, strong) NSArray<NSString *> *srcLanguages;
3417
3430@property (nonatomic, copy) NSString *dstLanguage;
3431
3444@property(nonatomic, strong) NSArray<NSString *> *dstLanguages;
3445
3446
3453@property (nonatomic, assign) BOOL needTranslateSameLanguage;
3454
3455@end
3456
3457
3459
3465@property (nonatomic, assign) uint64_t uid;
3471@property (nonatomic, assign) bool isLocalUser;
3477@property (nonatomic, assign) uint64_t timestamp;
3483@property (nonatomic, copy) NSString* content;
3489@property (nonatomic, copy) NSString* language;
3495@property (nonatomic, assign) bool haveTranslation;
3501@property (nonatomic, copy) NSString* translatedText;
3507@property (nonatomic, copy) NSString* translationLanguage;
3513@property (nonatomic, assign) bool isFinal;
3514
3515@end
3516
3523@property (nonatomic, assign) bool enableMultiPath;
3524
3530@property (nonatomic, assign) NERtcMultiPathMediaMode mediaMode;
3531
3537@property (nonatomic, assign) uint32_t badRttThreshold;
3538
3544@property (nonatomic, assign) bool redAudioPacket;
3545
3551@property (nonatomic, assign) bool redAudioRtxPacket;
3552
3558@property (nonatomic, assign) bool redVideoPacket;
3559
3565@property (nonatomic, assign) bool redVideoRtxPacket;
3566
3567@end
3568
3577
3585@property (nonatomic, assign) float x;
3586
3594@property (nonatomic, assign) float y;
3595
3603@property (nonatomic, assign) float w;
3604
3612@property (nonatomic, assign) float h;
3613
3614@end
3615
3625
3633@property (nonatomic, assign) float x;
3634
3642@property (nonatomic, assign) float y;
3643
3651@property (nonatomic, assign) float w;
3652
3660@property (nonatomic, assign) float h;
3661
3669@property (nonatomic, assign) BOOL mirror;
3670
3681@property (nonatomic, assign) NERtcVideoRenderScaleMode scaleMode;
3682
3692@property (nonatomic, assign) uint32_t backgroundColor;
3693
3703@property (nonatomic, assign) BOOL overlay;
3704
3705@end
3706
3707NS_ASSUME_NONNULL_END
NERTC_EXTERN_API uint32_t const NERtcAudioMixingMaxVolume
定义 NERtcEngineBase.h:696
NERTC_EXTERN_API NSString *const kNERtcKeyVideoStartWithBackCamera
第一次开启摄像头时,是否使用后摄像头。 布尔值,默认值 NO,即不使用后置摄像头。
定义 NERtcEngineBase.h:80
NERTC_EXTERN_API NSString *const KNERtcKeyDisableSWAECOnHeadset
设置耳机时不使用软件回声消除功能,默认值 NO。如设置 YES 则 SDK 在耳机模式下不使用软件回声消除功能,会对某些机型下 耳机的音质效果有影响
定义 NERtcEngineBase.h:185
NERTC_EXTERN_API NSString *const kNERtcKeyExtraInfo
Login 事件中的一个自定义字段,适用于标识一些额外信息,例如 App 版本。
定义 NERtcEngineBase.h:270
NERTC_EXTERN_API NSString *const KNERtcKeyAudioAINSEnable
设置 AI 降噪模式。已废弃,请使用 setAINSMode 接口代替。 NERTC SDK 自研 AI 降噪算法,开启 AI 降噪之后,在嘈杂的环境中可以针对背景人声、键盘声等非稳态噪声进行定向降噪...
定义 NERtcEngineBase.h:198
NERTC_EXTERN_API NSString *const kNERtcKeyLoginCustomData
登录扩展参数,string,默认不设置。
定义 NERtcEngineBase.h:285
NERTC_EXTERN_API NSString *const kNERtcKeyLogLevel
SDK 日志等级,默认为 kNERtcLogLevelInfo,详细信息请参考 NERtcLogLevel。
定义 NERtcEngineBase.h:261
NS_ASSUME_NONNULL_BEGIN NERTC_EXTERN_API NSString *const kNERtcKeyChannel1V1ModeEnabled
以下 key 用于 INERtcEngine::setParameters
定义 NERtcEngineBase.h:35
NERTC_EXTERN_API NSString *const kNERtcKeyPublishSelfStreamEnabled
在旁路推流场景中,是否允许推送本地媒体流到 CDN。默认值 YES。
定义 NERtcEngineBase.h:250
NERTC_EXTERN_API NSString *const kNERtcKeyVideoPreferMetalRender
是否优先使用 Metal 渲染。 布尔值,默认值 NO,即使用 OpenGL 渲染。
定义 NERtcEngineBase.h:90
NERTC_EXTERN_API NSString *const KNERtcKeyDisableOverrideSpeakerOnReceiver
当系统切换听筒或扬声器时,SDK 是否以系统设置为准。 布尔值,默认为 NO。
定义 NERtcEngineBase.h:155
NERTC_EXTERN_API NSString *const kNERtcKeyVideoPreferHWEncode
是否优先使用硬件编码视频数据。 布尔值,默认值 YES。 请在初始化(setupEngineWithContext)之前设置该参数,否则该参数会在下次初始化之后生效。
定义 NERtcEngineBase.h:48
NERTC_EXTERN_API NSString *const kNERtcKeyVideoSendOnPubType
通话开始时,默认发送的流类型,通话前设置有效。 int 类型,默认为 3,即大流。详细信息请参考 NERtcVideoPubMode。
定义 NERtcEngineBase.h:100
NERTC_EXTERN_API NSString *const kNERtcKeyRecordHostEnabled
是否云端录制主讲人,默认值 NO
定义 NERtcEngineBase.h:210
NERTC_EXTERN_API NSString *const kNERtcKeyAutoSubscribeAudio
是否自动订阅其他用户的音频流。 布尔值,默认为 YES,即自动订阅。
定义 NERtcEngineBase.h:127
NERTC_EXTERN_API NSString *const kNERtcKeyAutoSubscribeVideo
是否自动订阅其他用户的视频流。 布尔值,默认值 NO,即不自动订阅。
定义 NERtcEngineBase.h:112
NERTC_EXTERN_API NSString *const kNERtcKeyAutoSubscribeData
是否自动订阅其他用户的数据通道。 布尔值,默认为 NO,即非自动订阅。
定义 NERtcEngineBase.h:142
NERTC_EXTERN_API NSString *const kNERtcKeyRecordAudioEnabled
是否开启云端音频录制。默认值 NO,即关闭音频录制。
定义 NERtcEngineBase.h:219
NERTC_EXTERN_API NSString *const kNERtcKeySupportCallkit
是否需要支持 Callkit 框架。 布尔值,默认为 NO。
定义 NERtcEngineBase.h:163
NERTC_EXTERN_API NSString *const kNERtcKeyDisableFirstJoinUserCreateChannel
定义 NERtcEngineBase.h:288
NERTC_EXTERN_API NSString *const kNERtcKeyRecordVideoEnabled
是否开启云端视频录制,默认值 NO,即关闭视频录制。
定义 NERtcEngineBase.h:228
NERTC_EXTERN_API NSString *const kNERtcKeyRecordType
云端录制模式。详细信息请参考 NERtcRecordType。
定义 NERtcEngineBase.h:237
NERTC_EXTERN_API NSString *const kNERtcKeyVideoPreferHWDecode
是否优先使用硬件解码视频数据。 布尔值,默认值 YES。 请在初始化(setupEngineWithContext)之前设置该参数,否则该参数会在下次初始化之后生效。
定义 NERtcEngineBase.h:59
NERTC_EXTERN_API NSString *const KNERtcKeyEnableReportVolumeWhenMute
本地用户静音时是否返回原始音量。 布尔值,默认值为 false。
定义 NERtcEngineBase.h:176
NERTC_EXTERN_API NSString *const kNERtcKeyVideoCaptureObserverEnabled
是否需要开启视频数据采集回调,开启后开发者可以获取到原始视频数据。 布尔值,默认值 NO。 开启后如果需要关闭,需要通过调用 destroyEngine 来清除。
定义 NERtcEngineBase.h:70
NERTC_EXTERN_API NSString *const kNERtcKeyDisableVideoDecoder
是否关闭 sdk 视频解码(默认不关闭),关闭后 SDK 将不会解码远端视频,因此也无法渲染接收到的远端视频
定义 NERtcEngineBase.h:278
NERTC_EXTERN_API uint32_t const NERtcAudioMixingDefaultVolume
定义 NERtcEngineBase.h:697
NERtcPreDecoderMediaType
媒体类型。
定义 NERtcEngineEnum.h:2802
NERtcVideoColorSpacePrimary
视频颜色空间主色。
定义 NERtcEngineEnum.h:1680
NERtcLiveStreamMode
直播推流模式。
定义 NERtcEngineEnum.h:3540
NERtcVideoColorSpaceRange
视频颜色范围。
定义 NERtcEngineEnum.h:1499
NERtcVideoCropMode
视频裁剪模式
定义 NERtcEngineEnum.h:948
NERtcLastmileProbeResultState
Last mile 质量探测结果的状态。
定义 NERtcEngineEnum.h:4086
NERtcLogLevel
日志级别。
定义 NERtcEngineEnum.h:4179
NERtcVideoCodecType
定义 NERtcEngineEnum.h:2834
NERtcVideoFormatType
视频格式类型
定义 NERtcEngineEnum.h:1087
NERtcVirtualBackgroundSourceType
自定义背景图片的类型。
定义 NERtcEngineEnum.h:1242
NERtcVideoWatermarkType
视频水印类型。
定义 NERtcEngineEnum.h:1326
NERtcLiveStreamVideoScaleMode
直播推流模式。
定义 NERtcEngineEnum.h:3569
NERtcSubStreamContentPrefer
屏幕共享功能的编码策略倾向
定义 NERtcEngineEnum.h:672
NERtcLiveStreamAudioCodecProfile
直播推流音频编码规格。
定义 NERtcEngineEnum.h:3511
NERtcMultiPathMediaMode
定义 NERtcEngineEnum.h:4347
#define NERTC_EXTERN_API
定义 NERtcEngineEnum.h:18
NERtcAudioRecordingQuality
录音音质。
定义 NERtcEngineEnum.h:2682
NERtcAudioRecordingPosition
定义 NERtcEngineEnum.h:2772
NERtcPayLoadType
定义 NERtcEngineEnum.h:4166
NERtcVideoOutputOrientationMode
视频旋转方向模式。
定义 NERtcEngineEnum.h:900
NERtcVideoProfileType
视频 profile 类型。
定义 NERtcEngineEnum.h:447
NERtcVideoColorSpaceTransfer
视频颜色空间传输。
定义 NERtcEngineEnum.h:1808
NERtcNalFrameType
定义 NERtcEngineEnum.h:4149
NERtcVideoColorSpaceMatrix
视频颜色空间矩阵。
定义 NERtcEngineEnum.h:1534
NERtcBlurDegree
自定义背景图的虚化程度。
定义 NERtcEngineEnum.h:1285
NERtcAudioType
音频类型
定义 NERtcEngineEnum.h:3639
NERtcVideoMirrorMode
视频镜像模式。
定义 NERtcEngineEnum.h:862
NERtcAudioFrameOpMode
音频数据读写模式
定义 NERtcEngineEnum.h:3659
NERtcStreamChannelType
SEI 发送的流通道类型。
定义 NERtcEngineEnum.h:1135
NERtcEncryptionMode
加密模式
定义 NERtcEngineEnum.h:4055
NERtcAudioRecordingCycleTime
定义 NERtcEngineEnum.h:2781
NERtcSpatializerMaterialName
空间音效中房间材质名称
定义 NERtcEngineEnum.h:2449
NERtcDegradationPreference
带宽受限时视频编码适应性偏好
定义 NERtcEngineEnum.h:621
NERtcLiveStreamAudioSampleRate
直播推流音频采样率。
定义 NERtcEngineEnum.h:3473
#define NERTC_EXPORT
定义 NERtcEngineEnum.h:12
NERtcVideoFrameRate
视频帧率。
定义 NERtcEngineEnum.h:535
NERtcVideoRenderScaleMode
视频渲染缩放模式。
定义 NERtcEngineEnum.h:794
NERtcSpatializerRoomCapacity
空间音效房间大小
定义 NERtcEngineEnum.h:2419
NERtcAudioStreamType
音频流类型,目前同时支持音频两路流:主流和辅流
定义 NERtcEngineEnum.h:2348
NERtcVideoRotationType
视频数据的旋转方向
定义 NERtcEngineEnum.h:1033
定义 NERtcEngineBase.h:3384
NSString * srcLanguage
指定字幕的源语言。默认为AUTO
定义 NERtcEngineBase.h:3400
NSString * dstLanguage
指定字幕的目标语言。
定义 NERtcEngineBase.h:3430
NSArray< NSString * > * srcLanguages
指定字幕的多个源语言。默认为空
定义 NERtcEngineBase.h:3416
BOOL needTranslateSameLanguage
当源语言与设置的目标语言相同时,是否仍要翻译 默认为 false
定义 NERtcEngineBase.h:3453
NSArray< NSString * > * dstLanguages
指定字幕的目标语言。
定义 NERtcEngineBase.h:3444
定义 NERtcEngineBase.h:3459
uint64_t timestamp
实时字幕时间戳。
定义 NERtcEngineBase.h:3477
uint64_t uid
来源的用户 ID。
定义 NERtcEngineBase.h:3465
bool isLocalUser
是否为本地用户。
定义 NERtcEngineBase.h:3471
NSString * translationLanguage
翻译后的字幕语言。
定义 NERtcEngineBase.h:3507
NSString * content
实时字幕内容。
定义 NERtcEngineBase.h:3483
NSString * language
实时字幕语言。
定义 NERtcEngineBase.h:3489
bool haveTranslation
是否翻译。
定义 NERtcEngineBase.h:3495
bool isFinal
是否为最终结果。
定义 NERtcEngineBase.h:3513
NSString * translatedText
翻译后的字幕内容。
定义 NERtcEngineBase.h:3501
编码好的音频数据
定义 NERtcEngineBase.h:3021
NERtcPayLoadType payloadType
数据类型,opus
定义 NERtcEngineBase.h:3060
int sampleRate
音频采样率
定义 NERtcEngineBase.h:3035
unsigned char * data
编码好的数据
定义 NERtcEngineBase.h:3025
uint8_t rmsLevel
音频数据音量标记,有效值[0,100],用于后台 ASL 选路时参考。默认 100。
定义 NERtcEngineBase.h:3065
int channels
声道数
定义 NERtcEngineBase.h:3040
int samplesPerChannel
该编码片段中每个声道的样本数
定义 NERtcEngineBase.h:3045
int64_t timeStampUs
时间戳,微秒
定义 NERtcEngineBase.h:3030
uint32_t encodedTimestamp
编码时间, 单位为样本数, 如 0、960、1920...递增
定义 NERtcEngineBase.h:3055
int encodedLen
数据长度
定义 NERtcEngineBase.h:3050
音频格式。
定义 NERtcEngineBase.h:1484
NERtcAudioType type
音频 PCM 类型。详细信息请参考 NERtcAudioType。
定义 NERtcEngineBase.h:1493
uint32_t samplesPerChannel
每个声道的采样点数。
定义 NERtcEngineBase.h:1536
uint32_t bytesPerSample
每个采样点的字节数。
定义 NERtcEngineBase.h:1526
uint32_t sampleRate
音频采样率。
定义 NERtcEngineBase.h:1516
uint32_t channels
音频声道数。 1:单声道。 2:双声道。
定义 NERtcEngineBase.h:1506
音频帧。
定义 NERtcEngineBase.h:1549
void * data
音频裸数据。
定义 NERtcEngineBase.h:1568
int64_t syncTimestamp
同步音频主辅流的时间戳,一般只有在同时开启外部音频主流及辅流输入时用到。
定义 NERtcEngineBase.h:1578
NERtcAudioFormat * format
音频格式。详细信息请参考 NERtcAudioFormat。
定义 NERtcEngineBase.h:1558
音频原始数据回调格式(默认不设置)。
定义 NERtcEngineBase.h:1436
NERtcAudioFrameOpMode mode
音频数据读写权限。详细信息请参考 NERtcAudioFrameOpMode。
定义 NERtcEngineBase.h:1471
uint32_t channels
音频声道数量。如果是立体声,则数据是交叉的。 可设置为:。
定义 NERtcEngineBase.h:1451
uint32_t sampleRate
音频采样率。
定义 NERtcEngineBase.h:1461
定义 NERtcEngineBase.h:916
NSString * filePath
定义 NERtcEngineBase.h:918
NERtcAudioRecordingQuality quality
定义 NERtcEngineBase.h:924
int sampleRate
定义 NERtcEngineBase.h:921
NERtcAudioRecordingPosition position
定义 NERtcEngineBase.h:927
NERtcAudioRecordingCycleTime cycleTime
定义 NERtcEngineBase.h:930
声音音量信息。
定义 NERtcEngineBase.h:1594
unsigned int subStreamVolume
远端用户音频辅流的音量,取值范围为 [0,100]。 如果 subStreamVolume 为 0,表示该用户未发布音频辅流或音频辅流没有音量。
定义 NERtcEngineBase.h:1624
unsigned int volume
说话者的音量,范围为 0~100。
定义 NERtcEngineBase.h:1613
uint64_t uid
用户 ID,指定是哪个用户的音量。
定义 NERtcEngineBase.h:1603
本地视频基础发送配置。
定义 NERtcEngineBase.h:368
NSInteger bitrate
视频编码的码率,单位为 Kbps。 您可以根据场景需要,手动设置想要的码率。详细码表请参考 设置视频属性。
定义 NERtcEngineBase.h:468
NERtcVideoFrameRate frameRate
视频编码的帧率。详细信息请参考 NERtcVideoFrameRate。
定义 NERtcEngineBase.h:395
NERtcVideoProfileType maxProfile
视频编码的分辨率,用于衡量编码质量。详细信息请参考 NERtcVideoProfileType。
定义 NERtcEngineBase.h:377
NSInteger minFrameRate
视频编码的最小帧率。默认为 0,表示使用默认最小帧率。
定义 NERtcEngineBase.h:405
NSInteger minBitrate
视频编码的最小码率,单位为 Kbps。您可以根据场景需要,手动设置想要的最小码率,若设置为 0,SDK 将会自行计算处理。
定义 NERtcEngineBase.h:478
摄像头采集配置。
定义 NERtcEngineBase.h:491
int captureWidth
本地采集的视频宽度,单位为 px。 视频编码分辨率以宽 x 高表示,用于设置视频编码分辨率,以衡量编码质量。
定义 NERtcEngineBase.h:512
int captureHeight
本地采集的视频高度,单位为 px。 视频编码分辨率以宽 x 高表示,用于设置视频编码分辨率,以衡量编码质量。
定义 NERtcEngineBase.h:533
NERtcVideoColorSpaceRange colorSpaceRange
视频颜色范围。
定义 NERtcEngineBase.h:543
定义 NERtcEngineBase.h:1823
NERtcChannelMediaRelayInfo * sourceInfo
源房间的信息。详细信息请参考 NERtcChannelMediaRelayInfo。
定义 NERtcEngineBase.h:1854
NSDictionary< NSString *, NERtcChannelMediaRelayInfo * > *_Nullable destinationInfos
转发媒体流的目标房间配置信息。详细信息请参考 NERtcChannelMediaRelayInfo。
定义 NERtcEngineBase.h:1838
媒体流转发相关的数据结构。
定义 NERtcEngineBase.h:1791
uint64_t uid
用户 ID。
定义 NERtcEngineBase.h:1818
NSString * token
能加入房间的 Token。
定义 NERtcEngineBase.h:1809
NSString * channelName
房间名。
定义 NERtcEngineBase.h:1800
Options for creating audio effects
定义 NERtcEngineBase.h:819
int loopCount
音效循环播放的次数:
定义 NERtcEngineBase.h:846
BOOL playbackEnabled
是否本地播放该音效。默认为 YES,即本地用户可以听到该音效。
定义 NERtcEngineBase.h:866
uint64_t progressInterval
音效播放进度回调间隔,单位 ms,取值范围为 100~10000, 默认 1000ms
定义 NERtcEngineBase.h:911
BOOL sendEnabled
是否将音效发送远端。默认为 YES,即远端用户可以听到该音效。
定义 NERtcEngineBase.h:856
NSString * path
待播放的音效文件路径,支持本地绝对路径或 URL 地址。
定义 NERtcEngineBase.h:832
uint32_t playbackVolume
音效文件的播放音量,取值范围为 0~100。默认为 100,表示使用文件的原始音量。
定义 NERtcEngineBase.h:890
NERtcAudioStreamType sendWithAudioType
音效跟随音频主流还是辅流,默认跟随主流。
定义 NERtcEngineBase.h:904
int64_t startTimeStamp
音效文件开始播放的时间,UTC 时间戳,默认值为 0,表示立即播放。
定义 NERtcEngineBase.h:897
uint32_t sendVolume
音效文件的发送音量,取值范围为 0~100。默认为 100,表示使用文件的原始音量。
定义 NERtcEngineBase.h:878
Options for creating mixing audios
定义 NERtcEngineBase.h:701
NSString * path
待播放的音乐文件的绝对路径或 URL 地址,支持本地绝对路径或 URL 地址。
定义 NERtcEngineBase.h:714
int64_t startTimeStamp
音乐文件开始播放的时间,UTC 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的毫秒数。默认值为 0,表示立即播放。
定义 NERtcEngineBase.h:782
BOOL sendEnabled
是否将伴音发送远端,默认为 YES,即远端用户订阅本端音频流后可听到该伴音。
定义 NERtcEngineBase.h:738
uint32_t playbackVolume
音乐文件的播放音量,取值范围为 0~200。默认为 100,表示使用文件的原始音量。
定义 NERtcEngineBase.h:772
uint32_t sendVolume
音乐文件的发送音量,取值范围为 0~200。默认为 100,表示使用文件的原始音量。
定义 NERtcEngineBase.h:760
NERtcAudioStreamType sendWithAudioType
伴音跟随音频主流还是辅流,默认跟随主流。
定义 NERtcEngineBase.h:792
BOOL isInvalid()
检查 option 参数值的合法性。
int loopCount
伴音循环播放的次数: 1:(默认)播放一次。 ≤ 0:无限循环播放,直至调用 pauseAudioMixing 后暂停,或调用 stopAudioMixing 后停止。
定义 NERtcEngineBase.h:728
BOOL playbackEnabled
是否本地播放伴音。默认为 YES,即本地用户可以听到该伴音。
定义 NERtcEngineBase.h:748
uint64_t progressInterval
伴音播放进度回调间隔,单位 ms,取值范围为 100~10000, 默认 1000ms
定义 NERtcEngineBase.h:799
配置媒体流加密模式和密钥。
定义 NERtcEngineBase.h:2252
NERtcEncryptionMode mode
媒体流加密模式。
定义 NERtcEngineBase.h:2261
id< NERtcEnginePacketObserver > observer
自定义加密回调 observer, mode 为自定义加密时需要设置
定义 NERtcEngineBase.h:2278
NSString * key
媒体流加密密钥。字符串类型,推荐设置为英文字符串。
定义 NERtcEngineBase.h:2271
需要应用马赛克效果的归一化区域(0~1)。
定义 NERtcEngineBase.h:3577
float y
需要应用马赛克效果的归一化区域(0~1)。
定义 NERtcEngineBase.h:3594
float h
需要应用马赛克效果的归一化区域(0~1)。
定义 NERtcEngineBase.h:3612
float x
需要应用马赛克效果的归一化区域(0~1)。
定义 NERtcEngineBase.h:3585
float w
需要应用马赛克效果的归一化区域(0~1)。
定义 NERtcEngineBase.h:3603
joinChannel 回调时的一些可选信息
定义 NERtcEngineBase.h:2852
NSString * customInfo
自定义信息,最长支持 127 个字符
定义 NERtcEngineBase.h:2856
joinChannel 时的一些可选信息
定义 NERtcEngineBase.h:2831
NSString * permissionKey
权限密钥。能控制通话时长及媒体权限能力。如果是高级 Token 鉴权场景,用户加入时需要设置权限密钥,该参数的值由您的业务服务器提供。
定义 NERtcEngineBase.h:2842
NSString * customInfo
自定义信息,最长支持 127 个字符, 若超过 127 个字符,该参数无效。
定义 NERtcEngineBase.h:2835
NERtcLowLatencyOptions * lowLatencyOptions
定义 NERtcEngineBase.h:2844
LLM 请求参数。
定义 NERtcEngineBase.h:3341
NSString * url
请求 LLM 的 url 地址。
定义 NERtcEngineBase.h:3362
int interruptMode
传入文本信息或外部问题时,处理的优先级, 默认为 1 1:高优先级。传入信息直接打断交互,进行处理。 2:中优先级。等待当前交互结束后,进行处理。 3:低优先级。如当前正在发生交互,直接丢弃。
定义 NERtcEngineBase.h:3379
NSString * taskId
自定义的 LLM 任务 ID。字母、数字、下划线组成的 64 位以内的字符串。请保证此 ID 唯一。 该字段为可选,支持不设置或设置为空。在这种情况下,LLM 任务 ID 由 SDK 生成并管理,并将在...
定义 NERtcEngineBase.h:3348
NSString * mediaContent
请求LLM的图片数据(base64编码 格式:data:image/{format};base64,{base64_image})。
定义 NERtcEngineBase.h:3355
NSString * text
请求 LLM 的文本描述。
定义 NERtcEngineBase.h:3369
Last mile 网络探测配置。
定义 NERtcEngineBase.h:2440
NSUInteger expectedDownlinkBitrate
本端期望的最高接收码率。 单位为 bps,范围为 [100000, 5000000]。
定义 NERtcEngineBase.h:2494
BOOL probeDownlink
是否探测下行网络。
定义 NERtcEngineBase.h:2469
NSUInteger expectedUplinkBitrate
本端期望的最高发送码率。 单位为 bps,范围为 [100000, 5000000]。 推荐参考 setLocalVideoConfig 中的码率值设置该参数的值。
定义 NERtcEngineBase.h:2483
BOOL probeUplink
是否探测上行网络。 不发流的用户,例如直播房间中的普通观众,无需进行上行网络探测。
定义 NERtcEngineBase.h:2455
单向 Last mile 网络质量探测结果报告。
定义 NERtcEngineBase.h:2509
NSUInteger availableBandwidth
可用网络带宽预估,单位为 bps。
定义 NERtcEngineBase.h:2538
NSUInteger packetLossRate
丢包率()。
定义 NERtcEngineBase.h:2518
NSUInteger jitter
网络抖动,单位为毫秒 (ms)。
定义 NERtcEngineBase.h:2528
上下行 Last mile 网络质量探测结果。
定义 NERtcEngineBase.h:2553
NERtcLastmileProbeOneWayResult * downlinkReport
下行网络质量报告。
定义 NERtcEngineBase.h:2592
NERtcLastmileProbeResultState state
Last mile 质量探测结果的状态。
定义 NERtcEngineBase.h:2562
NSUInteger rtt
往返时延,单位为毫秒(ms)。
定义 NERtcEngineBase.h:2572
NERtcLastmileProbeOneWayResult * uplinkReport
上行网络质量报告。
定义 NERtcEngineBase.h:2582
音视频流编码参数等设置
定义 NERtcEngineBase.h:944
NSInteger channels
音频推流声道数。
定义 NERtcEngineBase.h:1010
NERtcLiveStreamAudioCodecProfile audioCodecProfile
音频编码规格。
定义 NERtcEngineBase.h:1024
NSInteger audioBitrate
音频推流码率。 单位为 kbps,取值范围为 10~192。 语音场景建议设置为 64 及以上码率,音乐场景建议设置为 128 及以上码率。
定义 NERtcEngineBase.h:980
BOOL singleVideoPassthrough
单路视频透传开关,默认为关闭状态。 开启后,如果房间中只有一路视频流输入, 则不对输入视频流进行转码,不遵循转码布局,直接推流 CDN。 如果有多个房间成员视频流混合为一路流,则该设置失效,并在恢复...
定义 NERtcEngineBase.h:967
BOOL interruptedPlaceImage
设置是否开启主播占位图模式。 开启后会在主播离线的时候用占位图填补主播位置。
定义 NERtcEngineBase.h:953
NERtcLiveStreamAudioSampleRate sampleRate
音频推流采样率。单位为 Hz,可设置为:
定义 NERtcEngineBase.h:996
图片布局。
定义 NERtcEngineBase.h:1182
NSString * url
占位图片的 URL。
定义 NERtcEngineBase.h:1191
NSInteger x
X 参数用于设置画布的横轴坐标值。 通过 x 和 y 指定画布坐标中的一个点,该点将作为占位图片的左上角。 取值范围为 0~1920,若设置为奇数值,会自动向下取偶。
定义 NERtcEngineBase.h:1205
NSInteger width
该占位图片在画布中的宽度。 取值范围为 0~1920,若设置为奇数值,会自动向下取偶。
定义 NERtcEngineBase.h:1231
NSInteger height
该占位图片在画布中的高度。 取值范围为 0~1920,若设置为奇数值,会自动向下取偶。
定义 NERtcEngineBase.h:1243
int zorder
占位图的图层编号,用来决定渲染层级。 取值范围为 0~100,默认为 0。
定义 NERtcEngineBase.h:1254
NSInteger y
Y 参数用于设置画布的纵轴坐标值。 通过 x 和 y 指定画布坐标中的一个点,该点将作为占位图片的左上角。 取值范围为 0~1920,若设置为奇数值,会自动向下取偶。
定义 NERtcEngineBase.h:1219
直播布局。
定义 NERtcEngineBase.h:1267
NERtcLiveStreamImageInfo * bgImage
占位图片。详细信息请参考 NERtcLiveStreamImageInfo。
定义 NERtcEngineBase.h:1317
NSArray< NERtcLiveStreamUserTranscoding * > * users
成员布局数组,详细信息请参考 NERtcLiveStreamUserTranscoding。
定义 NERtcEngineBase.h:1306
NSInteger width
整体画布的宽度,单位为 px。取值范围为 0~1920,若设置为奇数值,会自动向下取偶。
定义 NERtcEngineBase.h:1276
NSArray< NERtcLiveStreamImageInfo * > * bgImages
占位图片列表。详细信息请参考 NERtcLiveStreamImageInfo。
定义 NERtcEngineBase.h:1325
NSInteger height
整体画布的高度,单位为 px。取值范围为 0~1920,若设置为奇数值,会自动向下取偶。
定义 NERtcEngineBase.h:1286
NSUInteger backgroundColor
画面背景颜色,格式为 256 ✖ 256 ✖ R + 256 ✖ G + B 的和。请将对应 RGB 的值分别带入此公式计算即可。若未设置,则默认为 0。
定义 NERtcEngineBase.h:1296
直播推流任务的配置。
定义 NERtcEngineBase.h:1338
NERtcLiveConfig * config
音视频流编码参数等设置。详细信息请参考 NERtcLiveConfig。
定义 NERtcEngineBase.h:1401
NSString * taskID
自定义的推流任务 ID。字母、数字、下划线组成的 64 位以内的字符串。请保证此 ID 唯一。 该字段为可选,支持不设置或设置为空。在这种情况下,推流任务 ID 由 SDK 生成并管理,并将在用户离开时...
定义 NERtcEngineBase.h:1349
NERtcLiveStreamMode lsMode
直播推流模式。默认为 kNERtcLsModeVideo。详细信息请参考 NERtcLiveStreamMode。
定义 NERtcEngineBase.h:1381
NSString * extraInfo
预留参数,用户自定义的发送到旁路推流客户端的信息,用于填充 H264/H265 视频中 SEI 帧内容。长度限制:4096 字节。
定义 NERtcEngineBase.h:1411
NERtcLiveStreamLayout * layout
设置互动直播的画面布局。详细信息请参考 NERtcLiveStreamLayout。
定义 NERtcEngineBase.h:1391
BOOL serverRecordEnabled
旁路推流是否需要进行音视频录制。默认为关闭状态。
定义 NERtcEngineBase.h:1371
NSString * streamURL
推流地址,例如 rtmp://test.url。 此处的推流地址可设置为网易云信直播产品中服务端 API 创建房间的返回参数 pushUrl。
定义 NERtcEngineBase.h:1361
BOOL isInvalid()
配置的选项是不是合法。
直播成员布局。
定义 NERtcEngineBase.h:1037
NSInteger zOrder
图层编号,用来决定渲染层级, 取值 0-100 , 0 位于最底层,100 位于最顶层,相同层级的渲染区域按照现有的覆盖逻辑实现(按照数组中顺序进行渲染,index 递增依次往上叠加)。
定义 NERtcEngineBase.h:1142
uint64_t uid
将指定 uid 对应用户的视频流拉入直播。如果添加多个 users,则 uid 不能重复。
定义 NERtcEngineBase.h:1046
NERtcStreamChannelType videoStreamType
视频流类型,用于指定该布局条目引用用户的主流还是辅流。仅支持主流和辅流。
定义 NERtcEngineBase.h:1169
BOOL videoPush
是否在直播中向观看者播放该用户的对应视频流。可设置为:
定义 NERtcEngineBase.h:1062
NSInteger height
该用户图像在画布中的高度。 取值范围为 0~1920,默认为 0。若设置为奇数值,会自动向下取偶。 用户图像范围如果超出超出画布,调用方法时会报错。
定义 NERtcEngineBase.h:1118
BOOL audioPush
是否在直播中混流该用户的对应音频流。可设置为:
定义 NERtcEngineBase.h:1132
NSInteger y
Y 参数用于设置用户图像的纵轴坐标值。通过 x 和 y 指定画布坐标中的一个点,该点将作为用户图像的左上角。 取值范围为 0~1920,若设置为奇数值,会自动向下取偶。 用户图像范围如果超出超出画布...
定义 NERtcEngineBase.h:1090
NERtcLiveStreamVideoScaleMode adaption
直播推流视频和画布的适应属性。详细信息请参考 NERtcLiveStreamVideoScaleMode。
定义 NERtcEngineBase.h:1152
NSInteger width
该用户图像在画布中的宽度。 取值范围为 0~1920,默认为 0。若设置为奇数值,会自动向下取偶。 用户图像范围如果超出超出画布,调用方法时会报错。
定义 NERtcEngineBase.h:1104
NSInteger x
x 参数用于设置用户图像的横轴坐标值。通过 x 和 y 指定画布坐标中的一个点,该点将作为用户图像的左上角。 取值范围为 0~1920,若设置为奇数值,会自动向下取偶。 用户图像范围如果超出超出画布...
定义 NERtcEngineBase.h:1076
日志相关设置。
定义 NERtcEngineBase.h:2607
NSString * logDir
日志目录的完整路径,采用 UTF-8 编码。
定义 NERtcEngineBase.h:2616
NERtcLogLevel logLevel
打印的日志级别。默认为 info 级别。详细信息请参考 NERtcLogLevel。
定义 NERtcEngineBase.h:2626
低延时直播参数
定义 NERtcEngineBase.h:2811
NERtcVideoCanvas * playCanvas
直播视频流画布
定义 NERtcEngineBase.h:2823
BOOL enableLowLatency
是否开启低延时直播
定义 NERtcEngineBase.h:2815
NSUInteger playTimeout
直播的超时时间,单位:秒,默认值 60,最小值 30
定义 NERtcEngineBase.h:2819
定义 NERtcEngineBase.h:3518
bool redAudioPacket
是否开启音频 RED 包
定义 NERtcEngineBase.h:3544
bool enableMultiPath
是否开启多路径
定义 NERtcEngineBase.h:3523
NERtcMultiPathMediaMode mediaMode
多路径模式
定义 NERtcEngineBase.h:3530
bool redAudioRtxPacket
是否开启音频重传包RED
定义 NERtcEngineBase.h:3551
uint32_t badRttThreshold
RTT 阈值,单位 ms
定义 NERtcEngineBase.h:3537
bool redVideoRtxPacket
是否开启视频重传包RED
定义 NERtcEngineBase.h:3565
bool redVideoPacket
是否开启视频 RED 包
定义 NERtcEngineBase.h:3558
定义 NERtcEngineBase.h:3181
const unsigned char * buffer
需要发送或接收的数据。
定义 NERtcEngineBase.h:3190
long size
需要发送或接收的数据大小。
定义 NERtcEngineBase.h:3200
定义 NERtcEngineBase.h:3270
NSString * streamUrl
直播拉流地址,例如 rtmp://test.url。 此处的拉流地址可设置为网易云信直播产品中服务端 API 创建房间的返回参数 playUrl。
定义 NERtcEngineBase.h:3281
uint32_t playOutDelay
播放延时,单位为毫秒。默认值为 2000。
定义 NERtcEngineBase.h:3291
BOOL pausePlayStreaming
是否暂停拉流。
定义 NERtcEngineBase.h:3332
BOOL enableAudioPlay
是否启用音频播放。
定义 NERtcEngineBase.h:3312
BOOL enableVideoPlay
是否启用视频播放。
定义 NERtcEngineBase.h:3322
uint32_t reconnectTimeout
重连超时时间,单位为毫秒。默认为30000毫秒。
定义 NERtcEngineBase.h:3302
3D 音效算法中坐标信息。
定义 NERtcEngineBase.h:3071
CGFloat headQuaternionY
听觉旋转角度,4 元素。
定义 NERtcEngineBase.h:3130
CGFloat speakerQuaternionY
发声旋转角度,4 元素。
定义 NERtcEngineBase.h:3095
CGFloat speakerQuaternionZ
发声旋转角度,4 元素。
定义 NERtcEngineBase.h:3100
CGFloat headQuaternionX
听觉旋转角度,4 元素。
定义 NERtcEngineBase.h:3125
CGFloat speakerQuaternionW
发声旋转角度,4 元素。
定义 NERtcEngineBase.h:3105
CGFloat headQuaternionW
听觉旋转角度,4 元素。
定义 NERtcEngineBase.h:3140
CGFloat speakerPositionY
发声坐标,表示上下。
定义 NERtcEngineBase.h:3080
CGFloat headQuaternionZ
听觉旋转角度,4 元素。
定义 NERtcEngineBase.h:3135
CGFloat speakerPositionX
发声坐标,表示左右。
定义 NERtcEngineBase.h:3075
CGFloat speakerPositionZ
发声坐标,表示前后。
定义 NERtcEngineBase.h:3085
CGFloat speakerQuaternionX
发声旋转角度,4 元素。
定义 NERtcEngineBase.h:3090
CGFloat headPositionY
听觉坐标,表示上下。
定义 NERtcEngineBase.h:3115
CGFloat headPositionX
听觉坐标,表示左右。
定义 NERtcEngineBase.h:3110
CGFloat headPositionZ
听觉坐标,表示前后。
定义 NERtcEngineBase.h:3120
编码完的视频帧数据
定义 NERtcEngineBase.h:2913
uint8_t toc
Opus TOC Byte
定义 NERtcEngineBase.h:2922
uint32_t perTimeMs
每帧音频数据时间间隔:ms
定义 NERtcEngineBase.h:2917
编码完的媒体数据帧
定义 NERtcEngineBase.h:2931
NSString * codec
编码器名称
定义 NERtcEngineBase.h:2959
uint8_t * data
编码后的媒体数据
定义 NERtcEngineBase.h:2949
int64_t timestampMs
时间戳:ms
定义 NERtcEngineBase.h:2944
NERtcPreDecoderVideoInfo * videoInfo
视频相关信息,仅 mediaType 为 video\screenshare\之一时有效,其他情况为 nil
定义 NERtcEngineBase.h:2969
NERtcPreDecoderAudioInfo * audioInfo
音频相关信息,仅 mediaType 为 audio 时有效,其他情况为 nil
定义 NERtcEngineBase.h:2974
int length
有效数据长度
定义 NERtcEngineBase.h:2954
BOOL isMainStream
数据是否为主流或辅流数据
定义 NERtcEngineBase.h:2964
NERtcPreDecoderMediaType mediaType
媒体数据类型
定义 NERtcEngineBase.h:2934
uint64_t uid
用户 uid
定义 NERtcEngineBase.h:2939
编码完的音频帧数据
定义 NERtcEngineBase.h:2891
int width
视频帧宽
定义 NERtcEngineBase.h:2894
BOOL isKeyFrame
是否为关键帧
定义 NERtcEngineBase.h:2904
int height
视频帧高
定义 NERtcEngineBase.h:2899
定义 NERtcEngineBase.h:3246
NERtcStreamingRoomInfo * streamingRoomInfo
推流的房间信息。
定义 NERtcEngineBase.h:3265
NSString * streamingUrl
指定该音视频流的 CDN 推流地址,即直播 CDN 上的播放地址。
定义 NERtcEngineBase.h:3255
混响参数
定义 NERtcEngineBase.h:2742
float damping
混响阻尼,取值范围为 0 ~ 1,默认值为 0.0f。
定义 NERtcEngineBase.h:2771
float preDelay
延迟长度,取值范围为 0 ~ 1,默认值为 0.0f。
定义 NERtcEngineBase.h:2801
float decayTime
持续强度(余响),取值范围为 0.1 ~ 20,默认值为 0.1f。
定义 NERtcEngineBase.h:2791
float roomSize
房间大小,取值范围为 0.1 ~ 2,默认值为 0.1f。
定义 NERtcEngineBase.h:2781
float wetGain
湿信号,取值范围为 0 ~ 1,默认值为 0.0f。
定义 NERtcEngineBase.h:2751
float dryGain
干信号,取值范围为 0 ~ 1,默认值为 1.0f。
定义 NERtcEngineBase.h:2761
私有化服务器配置项
定义 NERtcEngineBase.h:2295
BOOL useIPv6
是否使用 ipv6 地址(默认为 NO)。
定义 NERtcEngineBase.h:2405
NSString * nosUploadSever
默认 nos 上传服务器
定义 NERtcEngineBase.h:2384
NSString * nosLbsServer
nos 域名解析服务器
定义 NERtcEngineBase.h:2374
NSString * lbsServer
lbs 服务请求地址
定义 NERtcEngineBase.h:2304
NSString * channelServer
获取通道信息服务器
定义 NERtcEngineBase.h:2314
NSString * cloudProxyServer
Cloud proxy server
定义 NERtcEngineBase.h:2410
NSString * webSocketProxyServer
WebSocket proxy server
定义 NERtcEngineBase.h:2415
NSString * mediaProxyServer
Media proxy server
定义 NERtcEngineBase.h:2425
NSString * quicProxyServer
Quic proxy server
定义 NERtcEngineBase.h:2420
NSString * compatServer
兼容性配置服务器
定义 NERtcEngineBase.h:2364
NSString * statisticsServer
统计上报服务器
定义 NERtcEngineBase.h:2324
NSString * statisticsBackupServer
统计备份服务器
定义 NERtcEngineBase.h:2344
NSString * nosTokenServer
获取 NOS token 服务器
定义 NERtcEngineBase.h:2394
NSString * roomServer
roomServer 服务器
定义 NERtcEngineBase.h:2354
NSString * statisticsDispatchServer
统计调度服务器
定义 NERtcEngineBase.h:2334
3D 音效房间属性设置。
定义 NERtcEngineBase.h:3147
CGFloat reverbGain
混响增益比例因子,默认值 1.0
定义 NERtcEngineBase.h:3166
CGFloat reverbBrightness
混响亮度,默认值 1.0
定义 NERtcEngineBase.h:3176
CGFloat reflectionScalar
反射比例,默认值 1.0
定义 NERtcEngineBase.h:3161
NERtcSpatializerMaterialName material
房间材质 NERtcSpatializerMaterialName,默认值 kNERtcSpatializerMaterialTransparent
定义 NERtcEngineBase.h:3156
CGFloat reverbTime
混响时间比例因子,默认值 1.0
定义 NERtcEngineBase.h:3171
NERtcSpatializerRoomCapacity roomCapacity
房间大小 NERtcSpatializerRoomCapacity,默认值 kNERtcSpatializerRoomCapacitySmall
定义 NERtcEngineBase.h:3151
定义 NERtcEngineBase.h:3207
uint64_t uId
用户的唯一标识 ID,为数字串,房间内每个用户的 uid 必须是唯一的。 此 uid 为用户在您应用中的 ID,请在您的业务服务器上自行管理并维护。
定义 NERtcEngineBase.h:3218
NSString * channelName
房间名
定义 NERtcEngineBase.h:3230
NSString * token
安全认证签名(NERTC Token),可以设置为:
定义 NERtcEngineBase.h:3241
onUserJoined 回调时的一些可选信息
定义 NERtcEngineBase.h:2865
NSString * customInfo
自定义信息,最长支持 127 个字符
定义 NERtcEngineBase.h:2869
onUserLeave 回调时的一些可选信息
定义 NERtcEngineBase.h:2877
NSString * customInfo
自定义信息,最长支持 127 个字符
定义 NERtcEngineBase.h:2881
视频画布设置。
定义 NERtcEngineBase.h:299
uint32_t backgroundColor
定义 NERtcEngineBase.h:355
id< NERtcEngineVideoRenderSink > externalVideoRender
外部渲染器。
定义 NERtcEngineBase.h:352
BOOL useExternalRender
是否使用外部渲染器,默认 NO 不使用,若使用 SDK 内部会根据 externalVideoRender 来进行绑定,若不使用 SDK 内部根据 container 来进行绑定。暂不支持在通话中切换内...
定义 NERtcEngineBase.h:308
NERtcVideoRenderScaleMode renderMode
视频渲染模式。
定义 NERtcEngineBase.h:328
VIEW_CLASS * container
视频窗口容器(SDK 内部渲染)。
定义 NERtcEngineBase.h:318
NERtcVideoMirrorMode mirrorMode
视频镜像模式。
定义 NERtcEngineBase.h:342
视频图像畸变矫正相关设置。
定义 NERtcEngineBase.h:2641
CGPoint topRight
定义 NERtcEngineBase.h:2646
CGFloat canvasHeight
定义 NERtcEngineBase.h:2658
CGFloat canvasWidth
定义 NERtcEngineBase.h:2655
CGPoint bottomLeft
定义 NERtcEngineBase.h:2649
BOOL enableMirror
定义 NERtcEngineBase.h:2661
CGPoint topLeft
定义 NERtcEngineBase.h:2643
CGPoint bottomRight
定义 NERtcEngineBase.h:2652
本地视频发送配置
定义 NERtcEngineBase.h:555
int width
视频编码分辨率,衡量编码质量,以宽 x 高表示。与 maxProfile 属性二选一。推荐优先使用自定义宽高设置。 width 表示视频帧在横轴上的像素,即自定义宽。
定义 NERtcEngineBase.h:572
NERtcVideoCropMode cropMode
视频画面裁剪模式,默认为 kNERtcVideoCropDefault。自定义视频输入不支持设置裁剪模式。
定义 NERtcEngineBase.h:600
NERtcVideoMirrorMode mirrorMode
设置本地视频编码的镜像模式,即本地发送视频的镜像模式,只影响远端用户看到的视频画面。
定义 NERtcEngineBase.h:635
NERtcVideoOutputOrientationMode orientationMode
设置本地视频编码的方向模式,即本地发送视频的方向模式,同时影响本端用户的预览画面和远端用户看到的视频画面。 详细信息请参考 NERtcVideoOutputOrientationMode。
定义 NERtcEngineBase.h:647
NERtcDegradationPreference degradationPreference
带宽受限时的视频编码降级偏好。详细信息请参考 NERtcDegradationPreference。
定义 NERtcEngineBase.h:622
int height
视频编码分辨率,衡量编码质量,以宽 x 高表示。与 maxProfile 属性二选一。推荐优先使用自定义宽高设置。 height 表示视频帧在纵轴上的像素,即自定义高。
定义 NERtcEngineBase.h:590
定义 NERtcEngineBase.h:2979
NERtcNalFrameType frameType
帧类型
定义 NERtcEngineBase.h:2988
int height
视频高
定义 NERtcEngineBase.h:3013
int64_t timestampUs
时间戳, 单位微秒
定义 NERtcEngineBase.h:3003
NERtcVideoCodecType codecType
定义 NERtcEngineBase.h:2983
int width
视频宽
定义 NERtcEngineBase.h:3008
NSArray< NSNumber * > * nalLengths
每一个 nal 长度,按顺序记录每一个 nal 的数据长度,长度之和不能超过 nalData 的长度
定义 NERtcEngineBase.h:2993
unsigned char * nalData
所有 nal 的数据
定义 NERtcEngineBase.h:2998
外部视频混合配置。
定义 NERtcEngineBase.h:3625
float x
需要应用马赛克效果的归一化区域(0~1)。
定义 NERtcEngineBase.h:3633
float w
需要应用马赛克效果的归一化区域(0~1)。
定义 NERtcEngineBase.h:3651
BOOL overlay
是否叠加在原有视频上。 默认值为 NO。
定义 NERtcEngineBase.h:3703
float y
需要应用马赛克效果的归一化区域(0~1)。
定义 NERtcEngineBase.h:3642
float h
需要应用马赛克效果的归一化区域(0~1)。
定义 NERtcEngineBase.h:3660
NERtcVideoRenderScaleMode scaleMode
视频缩放模式。 kNERtcVideoRenderScaleFit: 缩放模式,保持原始比例 kNERtcVideoRenderScaleFullFill: 填充模式,...
定义 NERtcEngineBase.h:3681
BOOL mirror
是否镜像。
定义 NERtcEngineBase.h:3669
uint32_t backgroundColor
视频背景颜色。 默认值为 0
定义 NERtcEngineBase.h:3692
视频帧信息。
定义 NERtcEngineBase.h:1639
NERtcVideoRotationType rotation
视频顺时针旋转角度。详细信息请参考 NERtcVideoRotationType。
定义 NERtcEngineBase.h:1689
uint32_t width
视频高,即视频帧在横轴上的像素。
定义 NERtcEngineBase.h:1669
id< MTLTexture > texture
定义 NERtcEngineBase.h:1736
void * uBuffer
视频数据指针。 目前该参数仅在外部渲染视频的场景下有实际意义。 视频外部渲染场景下,代表 I420 数据中 U 分量的指针。
定义 NERtcEngineBase.h:1712
NERtcVideoFormatType format
视频帧格式,详细信息请参考 NERtcVideoFormatType。 视频外部渲染场景下,仅支持 kNERtcVideoFormatI420。
定义 NERtcEngineBase.h:1649
uint64_t timestamp
视频时间戳,单位为毫秒。
定义 NERtcEngineBase.h:1659
NERtcVideoColorSpaceTransfer colorSpaceTransfer
视频颜色空间传输。
定义 NERtcEngineBase.h:1776
void * buffer
视频数据指针。 视频外部输入场景下,按照不同的格式,可支持 CVPixelBuffer、NSData 的 bytes; 对于 I420 格式,代表 Y 分量的指针; 对于 NV12 和 BGRA 格式,...
定义 NERtcEngineBase.h:1703
NERtcVideoColorSpacePrimary colorSpacePrimary
视频颜色空间主色。
定义 NERtcEngineBase.h:1766
NSArray< NSNumber * > * strides
视频帧各平面的行间距。 目前该参数仅在外部渲染视频的场景下有实际意义。
定义 NERtcEngineBase.h:1732
NERtcVideoColorSpaceRange colorSpaceRange
视频颜色范围。
定义 NERtcEngineBase.h:1746
void * vBuffer
视频数据指针。 目前该参数仅在外部渲染视频的场景下有实际意义。 视频外部渲染场景下,代表 I420 数据中 V 分量的指针。
定义 NERtcEngineBase.h:1721
uint32_t height
视频宽,即视频帧在纵轴上的像素。
定义 NERtcEngineBase.h:1679
NERtcVideoColorSpaceMatrix colorSpaceMatrix
视频颜色空间矩阵。
定义 NERtcEngineBase.h:1756
本地辅流发送配置。
定义 NERtcEngineBase.h:661
NERtcDegradationPreference degradationPreference
带宽受限时的视频编码降级偏好。详细信息请参考 NERtcDegradationPreference。
定义 NERtcEngineBase.h:692
NERtcSubStreamContentPrefer contentPrefer
屏幕共享功能的编码策略倾向,默认为 kNERtcSubStreamContentPreferMotion。详细信息请参考 NERtcSubStreamContentPrefer。
定义 NERtcEngineBase.h:670
视频水印设置,目前支持三种类型的水印,但只能其中选择一种水印生效。
定义 NERtcEngineBase.h:2198
NERtcVideoWatermarkTimestampConfig * timestampWatermark
时间戳水印配置,watermarkType = kNERtcVideoWatermarkTypeTimeStamp 时生效。
定义 NERtcEngineBase.h:2237
NERtcVideoWatermarkType watermarkType
视频水印类型。
定义 NERtcEngineBase.h:2207
NERtcVideoWatermarkImageConfig * imageWatermark
图片水印配置,watermarkType = kNERtcVideoWatermarkTypeImage 时生效。
定义 NERtcEngineBase.h:2217
NERtcVideoWatermarkTextConfig * textWatermark
文字水印配置,watermarkType = kNERtcVideoWatermarkTypeText 时生效。
定义 NERtcEngineBase.h:2227
视频图片水印配置。
定义 NERtcEngineBase.h:1909
NSUInteger offsetX
水平左上角与视频图像左上角的水平距离,单位为像素,默认值为 0。
定义 NERtcEngineBase.h:1948
NSUInteger offsetY
水平左上角与视频图像左上角的垂直距离,单位为像素,默认值为 0。
定义 NERtcEngineBase.h:1958
NSUInteger fps
播放帧率,默认值为 0,表示不自动切换图片,图片单帧静态展示。 帧率最高不超过 30fps,如果设置帧率高于视频流帧率,则按照视频流帧率展示。
定义 NERtcEngineBase.h:1980
BOOL loop
是否设置循环,默认值为 true,设置为 false 时图像组播放完毕后水印消失。
定义 NERtcEngineBase.h:1990
NSArray< NSString * > * imagePaths
图片绝对路径,支持多个图片路径。
定义 NERtcEngineBase.h:1968
NSUInteger wmHeight
水印框的高度,单位为像素,默认值为 0,表示按原始图高。
定义 NERtcEngineBase.h:1938
NSUInteger wmWidth
水印框的宽度,单位为像素,默认值为 0,表示按原始图宽。
定义 NERtcEngineBase.h:1928
CGFloat wmAlpha
整体水印透明度,取值范围为 0.0 ~ 1.0,默认值为 1.0,表示不透明。
定义 NERtcEngineBase.h:1918
定义 NERtcEngineBase.h:1995
NSUInteger offsetX
水平左上角与视频图像左上角的水平距离,单位为像素,默认值为 0。
定义 NERtcEngineBase.h:2082
CGFloat wmAlpha
整体水印透明度,取值范围为 0.0 ~ 1.0,默认值为 1.0,表示不透明。
定义 NERtcEngineBase.h:2041
NSUInteger fontColor
字体颜色。ARGB 格式。默认值为 0xFFFFFFFF,即白色。
定义 NERtcEngineBase.h:2021
NSUInteger fontSize
字体大小。默认值为 15,单位为像素(px)。
定义 NERtcEngineBase.h:2031
NSString * fontName
字体名称。
定义 NERtcEngineBase.h:2011
NSString * content
文字内容,设置为空时,表示不添加文字水印。
定义 NERtcEngineBase.h:2004
NSUInteger offsetY
水平左上角与视频图像左上角的垂直距离,单位为像素,默认值为 0。
定义 NERtcEngineBase.h:2092
NSUInteger wmColor
水印框内背景颜色。ARGB 格式,默认值为 0x88888888,即灰色。 支持透明度设置。
定义 NERtcEngineBase.h:2052
NSUInteger wmWidth
水印框宽度,单位为像素(px),默认值为 0,表示没有水印框。
定义 NERtcEngineBase.h:2062
NSUInteger wmHeight
水印框高度,单位为像素(px),默认值为 0,表示没有水印框。
定义 NERtcEngineBase.h:2072
定义 NERtcEngineBase.h:2097
NSUInteger wmHeight
水印框高度,单位为像素(px),默认值为 0,表示没有水印框。
定义 NERtcEngineBase.h:2165
NSUInteger offsetY
水平左上角与视频图像左上角的垂直距离,单位为像素,默认值为 0。
定义 NERtcEngineBase.h:2185
NSUInteger fontColor
字体颜色。ARGB 格式。默认为 0xFFFFFFFF,即白色。
定义 NERtcEngineBase.h:2113
NSString * fontName
字体名称。
定义 NERtcEngineBase.h:2103
NSUInteger offsetX
水平左上角与视频图像左上角的水平距离,单位为像素,默认值为 0。
定义 NERtcEngineBase.h:2175
NSUInteger wmWidth
水印框宽度,单位为像素(px),默认值为 0,表示没有水印框。
定义 NERtcEngineBase.h:2155
CGFloat wmAlpha
整体水印透明度,取值范围为 0.0 ~ 1.0,默认值为 1.0,表示不透明。
定义 NERtcEngineBase.h:2133
NSUInteger wmColor
水印框内背景颜色。ARGB 格式,默认为 0x88888888,即灰色。 支持透明度设置。
定义 NERtcEngineBase.h:2145
NSUInteger fontSize
字体大小。默认值为 15,单位为像素(px)。
定义 NERtcEngineBase.h:2123
自定义背景图像。
定义 NERtcEngineBase.h:2678
NSUInteger color
自定义背景图像的颜色。格式为 RGB 定义的十六进制整数,不带 # 号。 例如 0xFFB6C1 代表浅粉色。默认值为 0xFFFFFF,表示白色。取值范围是 [0x000000,...
定义 NERtcEngineBase.h:2703
NERtcVirtualBackgroundSourceType backgroundSourceType
自定义背景图片的类型。 请参阅::NERtcVirtualBackgroundSourceType。
定义 NERtcEngineBase.h:2687
NSString * source
自定义背景图片的本地绝对路径。支持 PNG 和 JPG 格式。
定义 NERtcEngineBase.h:2715
NERtcBlurDegree blur_degree
自定义背景图的虚化程度。
定义 NERtcEngineBase.h:2727