// // ARObjects.h // ARtcKit // // Created by 余生丶 on 2020/3/20. // Copyright © 2020 zjq. All rights reserved. // #import #import #import "AREnumerates.h" #if TARGET_OS_IPHONE #import typedef UIView VIEW_CLASS; typedef UIColor COLOR_CLASS; typedef CGSize SIZE_CLASS; typedef CGPoint POINT_CLASS; #elif TARGET_OS_MAC #import typedef NSView VIEW_CLASS; typedef NSColor COLOR_CLASS; typedef NSSize SIZE_CLASS; typedef NSPoint POINT_CLASS; #endif /** 视频画布对象的属性 */ __attribute__((visibility("default"))) @interface ARtcVideoCanvas : NSObject /** 视频显示视窗 VIEW_CLASS 为统称，具体为： - iOS: UIView - MacOS: NSView */ @property (strong, nonatomic) VIEW_CLASS* _Nullable view; /** 视频显示模式*/ @property (assign, nonatomic) ARVideoRenderMode renderMode; /** * 频道id * 0 ~ 9 * a ~ z A ~Z * "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ",". ** Note ** * 该参数默认值为空字符 ""。如果用户是通过 ARtcEngineKit 类的 joinChannelByToken 方法加入频道的，则将参数设为默认值，表示该用户在频道内的渲染视图。 * 如果用户是通过 ARtcChannel 类的 joinChannelByToken 方法加入频道的，则将该参数设为该 ARtcChannel 类对应的 channelId，表示该用户在该 channelId 对应频道内的渲染视图。 */ @property (copy, nonatomic) NSString * _Nullable channelId; /** 用户id */ @property (copy, nonatomic) NSString * _Nonnull uid; /** 视图镜像模式，详见 ARVideoMirrorMode **Note**: * 本地视图镜像模式：如果你使用前置摄像头，默认启动本地视图镜像模式；如果你使用后置摄像头，默认关闭本地视图镜像模式。 * 远端用户视图镜像模式：默认关闭远端用户的镜像模式。 */ @property (assign, nonatomic) ARVideoMirrorMode mirrorMode; @end /** 通话相关的统计信息 */ __attribute__((visibility("default"))) @interface ARChannelStats : NSObject /** 通话时长，单位为秒，累计值 */ @property (assign, nonatomic) NSInteger duration; /** 音视频总发送字节数 (bytes)，累计值 */ @property (assign, nonatomic) NSInteger txBytes; /** 音视频总接收字节数 (bytes)，累计值 */ @property (assign, nonatomic) NSInteger rxBytes; /** 音频发送字节数（bytes），累计值 */ @property (assign, nonatomic) NSInteger txAudioBytes; /** 视频发送字节数（bytes），累计值 */ @property (assign, nonatomic) NSInteger txVideoBytes; /** 音频接收字节数（bytes），累计值 */ @property (assign, nonatomic) NSInteger rxAudioBytes; /** 视频接收字节数（bytes），累计值 */ @property (assign, nonatomic) NSInteger rxVideoBytes; /** 音视频总发送码率（Kbps），瞬时值 */ @property (assign, nonatomic) NSInteger txKBitrate; /** 音视频总接收码率（Kbps），瞬时值 */ @property (assign, nonatomic) NSInteger rxKBitrate; /** 音频发送码率 (Kbps)，瞬时值 */ @property (assign, nonatomic) NSInteger txAudioKBitrate; /** 音频接收码率 (Kbps)，瞬时值 */ @property (assign, nonatomic) NSInteger rxAudioKBitrate; /** 视频发送码率 (Kbps)，瞬时值 */ @property (assign, nonatomic) NSInteger txVideoKBitrate; /** 视频接收码率 (Kbps)，瞬时值 */ @property (assign, nonatomic) NSInteger rxVideoKBitrate; /** Last mile 的延迟（ms） */ @property (assign, nonatomic) NSInteger lastmileDelay; /** 使用抗丢包技术前，本地客户端到边缘服务器的丢包率，单位为 % */ @property (assign, nonatomic) NSInteger txPacketLossRate; /** 使用抗丢包技术前，边缘服务器到本地客户端的丢包率，单位为 % */ @property (assign, nonatomic) NSInteger rxPacketLossRate; /** 当前频道内的用户人数 * 通信场景下，当前频道内的用户人数。 * 直播场景下，如果本地用户为观众，为频道内的主播人数 + 1；如果本地用户为主播，为频道内的主播人数。 */ @property (assign, nonatomic) NSInteger userCount; /** 当前 App 的 CPU 使用率 (%) */ @property (assign, nonatomic) double cpuAppUsage; /** 当前系统的 CPU 使用率 (%) */ @property (assign, nonatomic) double cpuTotalUsage; /** 客户端到本地路由器的往返时延 (ms) */ @property (assign, nonatomic) NSInteger gatewayRtt; /** 当前 App 的内存占比 (%) **Note** 该值仅作参考。受系统限制可能无法获取。 */ @property (assign, nonatomic) double memoryAppUsageRatio; /** 当前系统的内存占比 (%) **Note** 该值仅作参考。受系统限制可能无法获取。 */ @property (assign, nonatomic) double memoryTotalUsageRatio; /** 当前 App 的内存大小 (KB) **Note** 该值仅作参考。受系统限制可能无法获取。 */ @property (assign, nonatomic) NSInteger memoryAppUsageInKbytes; @end /** 视频编码器配置的属性 */ __attribute__((visibility("default"))) @interface ARVideoEncoderConfiguration : NSObject /** 视频编码的分辨率 (px)，用于衡量编码质量，以长x宽表示，默认值为 640 x 480。 用户可以自行设置分辨率，也可以在如下列表中直接选择想要的分辨率： - ARVideoDimension120x120 - ARVideoDimension160x120 - ARVideoDimension180x180 - ARVideoDimension240x180 - ARVideoDimension320x180 - ARVideoDimension240x240 - ARVideoDimension320x240 - ARVideoDimension424x240 - ARVideoDimension360x360 - ARVideoDimension480x360 - ARVideoDimension640x360 - ARVideoDimension480x480 - ARVideoDimension640x480 - ARVideoDimension840x480 - ARVideoDimension960x720 - ARVideoDimension1280x720 - ARVideoDimension1920x1080 (macOS only) - ARVideoDimension2540x1440 (macOS only) - ARVideoDimension3840x2160 (macOS only) **Note** * 该值不代表最终视频输出的方向。请查阅 ARVideoOutputOrientationMode 了解设置视频方向 * 视频能否达到 720P 的分辨率取决于设备的性能，在性能配备较低的设备上有可能无法实现。如果采用 720P 分辨率而设备性能跟不上，则有可能出现帧率过低的情况。 * iPhone 不支持 720P 以上的分辨率。 */ @property (assign, nonatomic) CGSize dimensions; /** 视频编码的帧率（fps） 用户可以自行设置帧率，也可以在如下列表中直接选择想要的帧率。默认值为 15 帧。建议不要超过 30 帧。 * ARVideoFrameRateFps1(1): 1 fps * ARVideoFrameRateFps7(7): 7 fps * ARVideoFrameRateFps10(10): 10 fps * ARVideoFrameRateFps15(15): 15 fps * ARVideoFrameRateFps24(24): 24 fps * ARVideoFrameRateFps30(30): 30 fps * ARVideoFrameRateFps60(30): 60 fps (macOS only) */ @property (assign, nonatomic) NSInteger frameRate; /** 最低视频编码帧率（fps） 单位为 fps，默认值为 -1，表示使用系统默认的最低编码帧率。关于该参数的适用场景及注意事项，请参考 设置视频属性（iOS） 或 设置视频属性（macOS）。 */ @property (assign, nonatomic) NSInteger minFrameRate; /** 视频编码的码率 该参数设置视频编码码率，单位为 Kbps。你可以根据场景需要，参考下表，手动设置你想要的码率。若设置的视频码率超出合理范围，SDK 会自动按照合理区间处理码率。你也可以直接选择如下任意一种模式进行设置： ARVideoBitrateStandard: （推荐）标准码率模式。该模式下，视频在通信和直播场景下的码率有所不同：通信场景下，码率与基准码率一致；直播场景下，码率对照基准码率翻倍。 ARVideoBitrateCompatible: 适配码率模式。该模式下，视频在通信和直播场景下的码率均与基准码率一致。直播下如果选择该场景，视频帧率可能会低于设置的值。 在通信和直播场景下采用不同的编码方式，以提升不同场景下的用户体验。通信场景保证流畅，而直播场景则更注重画面质量，因此直播场景对码率的需求大于通信场景。所以推荐将该参数设置为 ARVideoBitrateStandard。 **视频码率参考表** | Resolution | Frame Rate (fps) | Base Bitrate (Kbps, for Communication) | Live Bitrate (Kbps, for Live Broadcast) | |------------------- |------------------ |---------------------------------------- |----------------------------------------- | | 160 × 120 | 15 | 65 | 130 | | 120 × 120 | 15 | 50 | 100 | | 320 × 180 | 15 | 140 | 280 | | 180 × 180 | 15 | 100 | 200 | | 240 × 180 | 15 | 120 | 240 | | 320 × 240 | 15 | 200 | 400 | | 240 × 240 | 15 | 140 | 280 | | 424 × 240 | 15 | 220 | 440 | | 640 × 360 | 15 | 400 | 800 | | 360 × 360 | 15 | 260 | 520 | | 640 × 360 | 30 | 600 | 1200 | | 360 × 360 | 30 | 400 | 800 | | 480 × 360 | 15 | 320 | 640 | | 480 × 360 | 30 | 490 | 980 | | 640 × 480 | 15 | 500 | 1000 | | 480 × 480 | 15 | 400 | 800 | | 640 × 480 | 30 | 750 | 1500 | | 480 × 480 | 30 | 600 | 1200 | | 848 × 480 | 15 | 610 | 1220 | | 848 × 480 | 30 | 930 | 1860 | | 640 × 480 | 10 | 400 | 800 | | 1280 × 720 | 15 | 1130 | 2260 | | 1280 × 720 | 30 | 1710 | 3420 | | 960 × 720 | 15 | 910 | 1820 | | 960 × 720 | 30 | 1380 | 2760 | | 1920 × 1080 | 15 | 2080 | 4160 | | 1920 × 1080 | 30 | 3150 | 6300 | | 1920 × 1080 | 60 | 4780 | 6500 | | 2560 × 1440 | 30 | 4850 | 6500 | | 2560 × 1440 | 60 | 6500 | 6500 | | 3840 × 2160 | 30 | 6500 | 6500 | | 3840 × 2160 | 60 | 6500 | 6500 | **Note** 该表中的基准码率适用于通信场景。直播场景下通常需要较大码率来提升视频质量。推荐通过设置 ARVideoBitrateStandard 模式来实现。你也可以直接将码率值设为基准码率值 x 2。 */ @property (assign, nonatomic) NSInteger bitrate; /** 最低编码码率 该参数设置最低编码码率，单位为 Kbps。 SDK会根据网络状况自动调整视频编码码率。将参数设为高于默认值可强制视频编码器输出高质量图片，但在网络状况不佳的情况下可能导致网络丢包并影响视频播放的流畅度造成卡顿。因此如非对画质有特殊需求，建议不要修改该参数的值。 **Note** 该参数仅适用于直播场景。 */ @property (assign, nonatomic) NSInteger minBitrate; /** 视频编码的方向模式 * ARVideoOutputOrientationModeAdaptative(0): （默认）该模式下 SDK 输出的视频方向与采集到的视频方向一致。接收端会根据收到的视频旋转信息对视频进行旋转。该模式适用于接收端可以调整视频方向的场景: - 如果采集的视频是横屏模式，则输出的视频也是横屏模式。 - 如果采集的视频是竖屏模式，则输出的视频也是竖屏模式。 * ARVideoOutputOrientationModeFixedLandscape(1): 该模式下 SDK 固定输出风景（横屏）模式的视频。如果采集到的视频是竖屏模式，则视频编码器会对其进行裁剪。该模式适用于当接收端无法调整视频方向时，如使用旁路推流场景下。 * ARVideoOutputOrientationModeFixedPortrait(2): 该模式下 SDK 固定输出人像（竖屏）模式的视频，如果采集到的视频是横屏模式，则视频编码器会对其进行裁剪。该模式适用于当接收端无法调整视频方向时，如使用旁路推流场景下。 */ @property (assign, nonatomic) ARVideoOutputOrientationMode orientationMode; /** 带宽受限时的视频编码降级偏好 ARDegradationPreference，有如下选项： * ARDegradationMaintainQuality(0)：（默认）降低编码帧率以保证视频质量 * ARDegradationMaintainFramerate(1)：降低视频质量以保证编码帧率 * ARDegradationMaintainFramerate(2)：（预留参数，暂不支持）在编码帧率和视频质量之间保持平衡。 */ @property (assign, nonatomic) ARDegradationPreference degradationPreference; /** 设置本地发送视频的镜像模式 * 只影响远端用户看到的视频画面。详见 ARVideoMirrorMode * 默认关闭镜像模式 */ @property (assign, nonatomic) ARVideoMirrorMode mirrorMode; /** 指定视频分辨率并初始化一个 ARVideoEncoderConfiguration 对象 @param size 视频分辨率 @param frameRate 视频帧率，详见 ARVideoFrameRate @param bitrate 视频码率 @param orientationMode 视频方向，详见 ARVideoOutputOrientationMode @return 初始化的 ARVideoEncoderConfiguration 对象 */ - (instancetype _Nonnull)initWithSize:(CGSize)size frameRate:(ARVideoFrameRate)frameRate bitrate:(NSInteger)bitrate orientationMode:(ARVideoOutputOrientationMode)orientationMode; /** 指定视频宽和高并初始化一个 ARVideoEncoderConfiguration 对象 @param width 视频宽度 @param height 视频高度 @param frameRate 视频帧率，详见 ARVideoFrameRate @param bitrate 视频码率 @param orientationMode 视频方向，详见 ARVideoOutputOrientationMode @return 初始化的 ARVideoEncoderConfiguration 对象 */ - (instancetype _Nonnull)initWithWidth:(NSInteger)width height:(NSInteger)height frameRate:(ARVideoFrameRate)frameRate bitrate:(NSInteger)bitrate orientationMode:(ARVideoOutputOrientationMode)orientationMode; @end /** 音量信息的属性 */ __attribute__((visibility("default"))) @interface ARtcAudioVolumeInfo : NSObject /** 说话者的用户 ID。 */ @property (copy, nonatomic) NSString * _Nonnull uid; /** 说话者各自混音后的音量，取值范围为 [0,255] */ @property (assign, nonatomic) NSUInteger volume; /** 本地用户的人声状态。 * 0: 本地用户不在说话。 * 1: 本地用户在说话。 **Note** * vad 无法报告远端用户的人声状态。对于远端用户，vad 的值始终为 0。 * 若需使用此参数，请在 enableAudioVolumeIndication 方法中设置 report_vad 为 YES。 */ @property (assign, nonatomic) NSUInteger vad; /** 频道 ID，表明当前说话者在哪个频道。*/ @property (copy, nonatomic) NSString * _Nonnull channelId; @end /** 摄像头采集偏好设置 */ __attribute__((visibility("default"))) @interface ARCameraCapturerConfiguration : NSObject /** 摄像头采集偏好，详见 ARCameraCaptureOutputPreference */ @property (assign, nonatomic) ARCameraCaptureOutputPreference preference; #if TARGET_OS_IOS /** 摄像头方向，详见 ARCameraDirection: * ARCameraDirectionRear: 使用后置摄像头 * ARCameraDirectionFront: 使用前置摄像头 */ @property (assign, nonatomic) ARCameraDirection cameraDirection; #endif @end /** 远端音频统计信息 */ __attribute__((visibility("default"))) @interface ARtcRemoteAudioStats : NSObject /** 用户 ID，指定是哪个用户/主播的音频流 */ @property (copy, nonatomic) NSString * _Nonnull uid; /** 远端用户发送的音频流质量： 0：质量未知 1：质量极好 2：用户主观感觉和极好差不多 ，但码率可能略低于极好 3：用户主观感受有瑕疵，但不影响沟通 4：勉强能沟通但不顺畅 5：网络质量非常差，基本不能沟通 6：网络连接已断开，完全无法沟通 7：网络质量探测功能不可使用 (目前没有使用) 8：网络质量探测中 */ @property (assign, nonatomic) ARNetworkQuality quality; /** 音频发送端到接收端的网络延迟（毫秒） */ @property (assign, nonatomic) NSUInteger networkTransportDelay; /** 接收端到网络抖动缓冲的网络延迟（毫秒） */ @property (assign, nonatomic) NSUInteger jitterBufferDelay; /** 统计周期内的远端音频流的丢帧率(%) */ @property (assign, nonatomic) NSUInteger audioLossRate; /** 声道数 */ @property (assign, nonatomic) NSUInteger numChannels; /** 统计周期内接收到的远端音频采样率（Hz） */ @property (assign, nonatomic) NSUInteger receivedSampleRate; /** 接收流在统计周期内的平均码率（Kbps） */ @property (assign, nonatomic) NSUInteger receivedBitrate; /** 远端用户在加入频道后发生音频卡顿的累计时长（ms） */ @property (assign, nonatomic) NSUInteger totalFrozenTime; /** 远端用户在加入频道后发生音频卡顿的累计时长占音频总有效时长的百分比（%）。音频有效时长是指远端用户加入频道后音频未被停止发送或禁用的时长。 */ @property (assign, nonatomic) NSUInteger frozenRate; @end /** 本地视频统计回调 */ __attribute__((visibility("default"))) @interface ARtcLocalVideoStats : NSObject /** 实际发送码率 (Kbps) : 不包含丢包后重传视频等的发送码率 */ @property (assign, nonatomic) NSUInteger sentBitrate; /** 实际发送帧率 (fps) : 不包含丢包后重传视频等的发送帧率 */ @property (assign, nonatomic) NSUInteger sentFrameRate; /** 本地视频编码器的输出帧率，单位为 fps */ @property (assign, nonatomic) NSUInteger encoderOutputFrameRate; /** 本地视频渲染器的输出帧率，单位为 fps */ @property (assign, nonatomic) NSUInteger rendererOutputFrameRate; /** 当前编码器的目标编码码率，单位为 Kbps，该码率为 SDK 根据当前网络状况预估的一个值。*/ @property (assign, nonatomic) NSUInteger sentTargetBitrate; /** 当前编码器的目标编码帧率，单位为 fps */ @property (assign, nonatomic) NSUInteger sentTargetFrameRate; /** 统计周期内本地视频质量（基于目标帧率和目标码率）的自适应情况，详见 ARVideoQualityAdaptIndication。 */ @property (assign, nonatomic) ARVideoQualityAdaptIndication qualityAdaptIndication; /** 视频编码码率（Kbps）。 */ @property (assign, nonatomic) NSUInteger encodedBitrate; /** 视频编码宽度（px）。 */ @property (assign, nonatomic) NSUInteger encodedFrameWidth; /** 视频编码高度（px）。 */ @property (assign, nonatomic) NSUInteger encodedFrameHeight; /** 视频发送的帧数，累计值。 */ @property (assign, nonatomic) NSUInteger encodedFrameCount; /** 视频的编码类型： * ARVideoCodecTypeVP8 = 1: VP8。 * ARVideoCodecTypeH264 = 2: （默认值）H.264。 */ @property (assign, nonatomic) ARVideoCodecType codecType; /** 弱网对抗前本端到边缘服务器的视频丢包率 (%)。 */ @property (assign, nonatomic) NSInteger txPacketLossRate; /** 本地视频采集帧率 (fps)。 */ @property (assign, nonatomic) NSInteger captureFrameRate; @end /** 本地音频统计信息 */ __attribute__((visibility("default"))) @interface ARtcLocalAudioStats : NSObject /** 声道数。 */ @property (assign, nonatomic) NSUInteger numChannels; /** 发送的采样率，单位为 Hz。 */ @property (assign, nonatomic) NSUInteger sentSampleRate; /** 发送码率的平均值，单位为 Kbps。 */ @property (assign, nonatomic) NSUInteger sentBitrate; /** 弱网对抗前本端到边缘服务器的音频丢包率 (%)。 */ @property (assign, nonatomic) NSUInteger txPacketLossRate; @end /** 远端视频统计回调。 */ __attribute__((visibility("default"))) @interface ARtcRemoteVideoStats : NSObject /** 用户 ID，指定远程视频来自哪个用户 */ @property (copy, nonatomic) NSString * _Nonnull uid; /** 延时(毫秒)，已废弃（Deprecated） */ @property (assign, nonatomic) NSUInteger delay; /** 视频流宽（像素） */ @property (assign, nonatomic) NSUInteger width; /** 视频流高（像素） */ @property (assign, nonatomic) NSUInteger height; /** 接收流的平均码率（Kbps） */ @property (assign, nonatomic) NSUInteger receivedBitrate; /** 远端视频解码器的输出帧率，单位为 fps */ @property (assign, nonatomic) NSUInteger decoderOutputFrameRate; /** 远端视频渲染器的输出帧率，单位为 fps */ @property (assign, nonatomic) NSUInteger rendererOutputFrameRate; /** 远端视频在使用抗丢包技术之后的丢包率(%)。 */ @property (assign, nonatomic) NSUInteger packetLossRate; /** 视频流类型，大流或小流: ARVideoStreamType */ @property (assign, nonatomic) ARVideoStreamType rxStreamType; /** 远端用户在加入频道后发生视频卡顿的累计时长（ms）。通话过程中，视频帧率设置不低于 5 fps 时，连续渲染的两帧视频之间间隔超过 500 ms，则计为一次视频卡顿。 */ @property (assign, nonatomic) NSUInteger totalFrozenTime; /** 远端用户在加入频道后发生视频卡顿的累计时长占视频总有效时长的百分比（%）。视频有效时长是指远端用户加入频道后视频未被停止发送或禁用的时长。 */ @property (assign, nonatomic) NSUInteger frozenRate; @end /** 用于封装视频帧数据传递给 SDK 的类 */ __attribute__((visibility("default"))) @interface ARVideoFrame : NSObject /** 传入的视频帧的格式 必须指定为下面的某一个值： * 1: I420 * 2: BGRA * 3: NV21 * 4: RGBA * 5: IMC2 * 7: ARGB * 8: NV12 * 12: iOS texture (CVPixelBufferRef) * 13: H264 extra data(sps,pps data) * 14: H264 nomal data * 15: H264 key frame data */ @property (assign, nonatomic) NSInteger format; /** 传入的视频帧的时间戳 (ms). 以毫秒为单位。不正确的时间戳会导致丢帧或者音视频不同步。 */ @property (assign, nonatomic) CMTime time; // Time for this frame. /** 传入视频帧的行间距。单位为像素而不是字节。如果视频帧格式设为 12，则不使用该字段。 */ @property (assign, nonatomic) int strideInPixels; /** 传入视频帧的高度。单位为像素而不是字节。如果视频帧格式设为 12，则不使用该字段。 */ @property (assign, nonatomic) int height; /** iOS 纹理的 Buffer */ @property (assign, nonatomic) CVPixelBufferRef _Nullable textureBuf; /** 裸数据格式的 Buffer。如果视频帧格式设为 12，则不使用该字段。 */ @property (strong, nonatomic) NSData * _Nullable dataBuf; /** 视频左边裁减掉的像素数量，默认为 0 */ @property (assign, nonatomic) int cropLeft; /** 视频顶部裁减掉的像素数量，默认为 0 */ @property (assign, nonatomic) int cropTop; /** 视频右边裁减掉的像素数量，默认为 0 */ @property (assign, nonatomic) int cropRight; /** 视频底部裁减掉的像素数量，默认为 0 */ @property (assign, nonatomic) int cropBottom; /** 是否对传入的视频做顺时针旋转操作 可选值为 0，90，180，270。默认为 0。 */ @property (assign, nonatomic) int rotation; /** 视频缓冲区的长度 */ @property (assign, nonatomic) int length; /* Note * 1. strideInPixels * Stride is in pixels, not bytes. * 2. About the frame width and height. * No field is defined for the width. However, it can be deduced by: * croppedWidth = (strideInPixels - cropLeft - cropRight) * And * croppedHeight = (height - cropTop - cropBottom) * 3. About crop. * _________________________________________________________________..... * | ^ | ^ * | | | | * | cropTop | | * | | | | * | v | | * | ________________________________ | | * | | | | | * | | | | | * |<-- cropLeft -->| valid region |<- cropRight ->| * | | | | height * | | | | * | |_____________________________ | | | * | ^ | | * | | | | * | cropBottom | | * | | | | * | v | v * _________________________________________________________________...... * | | * |<---------------- strideInPixels ----------------------------->| * * If your buffer contains garbage data, you can crop them. For example, if the frame size is * 360 × 640, often the buffer stride is 368, that is, the extra 8 pixels on the * right are for padding, and should be removed. In this case, you can set: * strideInPixels = 368; * height = 640; * cropRight = 8; * // cropLeft, cropTop, cropBottom are set to a default of 0 */ @end /** 检测到的人脸信息 */ __attribute__((visibility("default"))) @interface ARFacePositionInfo : NSObject /** 人脸在画面中的 x 坐标 (px)。以摄像头采集画面的左上角为原点，x 坐标为人脸左上角相对于原点的横向位移。 */ @property (assign, nonatomic) NSInteger x; /** 人脸在画面中的 y 坐标 (px)。以摄像头采集画面的左上角为原点，y 坐标为人脸左上角相对原点的纵向位移。 */ @property (assign, nonatomic) NSInteger y; /** 人脸在画面中的宽度 (px)。 */ @property (assign, nonatomic) NSInteger width; /** 人脸在画面中的高度 (px)。 */ @property (assign, nonatomic) NSInteger height; /** 人脸距设备屏幕的距离 (cm)。 */ @property (assign, nonatomic) NSInteger distance; @end /** 频道媒体设置选项 */ __attribute__((visibility("default"))) @interface ARtcChannelMediaOptions : NSObject /** 设置加入频道时是否自动订阅音频流： - YES: （默认）订阅 - NO: 不订阅 该成员功能与 muteAllRemoteAudioStreams 相同。加入频道后，你可以通过 muteAllRemoteAudioStreams 方法重新设置是否订阅频道内的远端音频流。 */ @property (nonatomic, assign) BOOL autoSubscribeAudio; /** 设置加入频道是是否自动订阅视频流： - YES: （默认）订阅 - NO: 不订阅 该成员功能与 muteAllRemoteVideoStreams 相同。加入频道后，你可以通过 muteAllRemoteVideoStreams 方法重新设置是否订阅频道内的远端视频流。 */ @property (nonatomic, assign) BOOL autoSubscribeVideo; @end /** 实况直播注入流配置 */ __attribute__((visibility("default"))) @interface ARLiveInjectStreamConfig: NSObject /** 添加进入直播的外部视频源尺寸。 默认值为 0，即保留视频导入前的尺寸 */ @property (assign, nonatomic) CGSize size; /** 添加进入直播的外部视频源的 GOP。 默认值为 30 帧 */ @property (assign, nonatomic) NSInteger videoGop; /** 添加进入直播的外部视频源的帧率。 默认值为 15 fps */ @property (assign, nonatomic) NSInteger videoFramerate; /** 添加进入直播的外部视频源的码率 默认值为 400 Kbps 视频码率的设置与分辨率相关。如果设置的视频码率超出合理范围，SDK 会按照合理区间自动设置码率。 */ @property (assign, nonatomic) NSInteger videoBitrate; /** 添加进入直播的外部音频采样率 默认值为 48000。详见 ARAudioSampleRateType。 **Note:** 建议目前采用默认值，不要自行设置。 */ @property (assign, nonatomic) ARAudioSampleRateType audioSampleRate; /** 添加进入直播的外部音频码率 默认值为 48 kbps。 **Note:** 建议目前采用默认值，不要自行设置。 */ @property (assign, nonatomic) NSInteger audioBitrate; /** 添加进入直播的外部音频频道数 取值范围 [1,2]，默认值为 1。 **Note:** 建议目前采用默认值，不要自行设置。 */ @property (assign, nonatomic) NSInteger audioChannels; /** 创建默认实况直播注入流配置 @return 默认配置 */ +(ARLiveInjectStreamConfig *_Nonnull) defaultConfig; @end /** 目标频道信息 */ __attribute__((visibility("default"))) @interface ARChannelMediaRelayInfo: NSObject /** 能加入频道的 Token。 */ @property (copy, nonatomic) NSString * _Nullable token; /** 频道名。 */ @property (copy, nonatomic) NSString * _Nullable channelName; /** 用户 ID。 */ @property (copy, nonatomic) NSString * _Nonnull uid; /** 初始化 ARChannelMediaRelayInfo 类 @param token 能加入频道的 Token。 */ - (instancetype _Nonnull)initWithToken:(NSString *_Nullable)token; @end /** 跨频道媒体流转发参数配置类 */ __attribute__((visibility("default"))) @interface ARChannelMediaRelayConfiguration: NSObject /** 目标频道信息 ARChannelMediaRelayInfo ，包含如下成员： - `channelName`: 目标频道的频道名。 - `uid`: 标识转发流到目标频道的主播 ID。取值范围为 0 到（232-1），请确保与目标频道中的所有 UID 不同。默认值为 0，表示 SDK 随机分配一个 UID。 - `token`: 能加入目标频道的 token。由你在 destinationInfos 中设置的 channelName 和 uid 生成。 - 如未启用 App Certificate，可直接将该参数设为默认值 nil，表示 SDK 填充 App ID。 - 如已启用 App Certificate，则务必填入使用 channelName 和 uid 生成的 token。 */ @property (strong, nonatomic, readonly) NSDictionary *_Nullable destinationInfos; /** 源频道信息 ARChannelMediaRelayInfo ，包含如下成员： - `channelName`: 源频道名。默认值为 nil，表示 SDK 填充当前的频道名。 - `uid`: 标识源频道中想要转发流的主播 ID。默认值为 0，表示 SDK 随机分配一个 uid。请确保设为 0。 - `token`: 能加入源频道的 token。由你在 sourceInfo 中设置的 channelName 和 uid 生成。 - 如未启用 App Certificate，可直接将该参数设为默认值 nil，表示 SDK 填充 App ID。 - 如已启用 App Certificate，则务必填入使用 channelName 和 uid 生成的 token，且其中的 uid 必须为 0。 */ @property (strong, nonatomic) ARChannelMediaRelayInfo *_Nonnull sourceInfo; /** 设置目标频道信息。 @param destinationInfo 目标频道信息 ARChannelMediaRelayInfo ，包含如下成员： - `channelName`: 目标频道的频道名。 - `uid`:标识转发流到目标频道的主播 ID。取值范围为 0 到（232-1），请确保与目标频道中的所有 UID 不同。默认值为 0，表示 SDK 随机分配一个 UID。 - `token`: 能加入目标频道的 token。由你在 destinationInfo 中设置的 channelName 和 uid 生成。 - 如未启用 App Certificate，可直接将该参数设为默认值 nil，表示 SDK 填充 App ID。 - 如已启用 App Certificate，则务必填入使用 channelName 和 uid 生成的 token。 @param channelName 目标频道名，该参数必填，且需与该方法 destinationInfo 参数中的 channelName 一致。 @return 0方法调用成功，<0方法调用失败 */ - (BOOL)setDestinationInfo:(ARChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName; /** 删除目标频道。 @param channelName 想要删除的目标频道名。 @return 0方法调用成功，<0方法调用失败 */ - (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName; @end /** 提供旁路推流时特定用户音频/视频转码设置的类 */ __attribute__((visibility("default"))) @interface ARLiveTranscodingUser: NSObject /** 旁路推流的用户 ID */ @property (copy, nonatomic) NSString *_Nonnull uid; /** 直播视频上用户视频在布局中相对左上角的位置和大小信息 */ @property (assign, nonatomic) CGRect rect; /** 直播视频上用户视频帧的图层编号 整数，取值范围为 0 到 100: - 最小值为 0（默认值），表示该区域图像位于最下层 - 最大值为 100，表示该区域图像位于最上层 Note: 如果取值小于 0 或大于 100，会返回错误 ARErrorCodeInvalidArgument。 */ @property (assign, nonatomic) NSInteger zOrder; /** 直播视频上用户视频的透明度。取值范围为 [0.0,1.0]。 * 0.0: 表示该区域图像完全透明 * 1.0: 表示该区域图像完全不透明。默认值为 1.0. */ @property (assign, nonatomic) double alpha; /** 直播音频所在声道 取值范围为 [0,5]，默认值为 0 ： - 0:(推荐) 默认混音设置，最多支持双声道，与主播端上行音频相关 - 1: 对应主播的音频，推流中位于 FL 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。 - 2: 对应主播的音频，推流中位于 FC 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。 - 3: 对应主播的音频，推流中位于 FR 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。 - 4: 对应主播的音频，推流中位于 BL 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。 - 5: 对应主播的音频，推流中位于 BR 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。 Note: 选项不为 0 时，需要特殊的播放器支持。 */ @property (assign, nonatomic) NSInteger audioChannel; @end /** 图像属性 用于设置直播视频的水印和背景图片的属性 */ __attribute__((visibility("default"))) @interface ARImage: NSObject /** 直播视频上图片的 HTTP/HTTPS 地址，字符长度不得超过 1024 字节。 */ @property (strong, nonatomic) NSURL *_Nonnull url; /** 图片在视频帧上的位置和大小，类型为 CGRect */ @property (assign, nonatomic) CGRect rect; @end /** 管理旁路推流转码的类 */ __attribute__((visibility("default"))) @interface ARLiveTranscoding: NSObject /** 推流视频的总尺寸（宽和高），单位为像素。 - 如果推视频流，宽和高的值均不得低于 64，否则 SDK 会调整为 64。 - 如果推音频流，请将宽和高都设为 0。 */ @property (assign, nonatomic) CGSize size; /** 用于旁路直播的输出视频的码率。单位为 Kbps。400 Kbps 为默认值。 用于旁路直播的输出视频的码率。单位为 Kbps。400 Kbps 为默认值。 你可以根据 Video Profile 参考表中的码率值进行设置；如果设置的码率超出合理范围，服务器会在合理区间内自动调整码率值。 */ @property (assign, nonatomic) NSInteger videoBitrate; /** 用于旁路直播的输出视频的帧率。取值范围是 (0,30]，单位为 fps。 @note 15 fps 为默认值。服务器会将高于 30 fps 的帧率设置改为 30 fps。 */ @property (assign, nonatomic) NSInteger videoFramerate; /** 用于旁路直播的输出视频的 GOP。单位为帧。默认值为 30 帧。*/ @property (assign, nonatomic) NSInteger videoGop; /** 用于旁路直播的输出视频的编码规格。 可以设置为 66、77 或 100，详见 ARVideoCodecProfileType。 如果设置其它值，服务器会统一设为默认值 100。 */ @property (assign, nonatomic) ARVideoCodecProfileType videoCodecProfile; /** 用于管理参与旁路直播的视频转码合图的用户。最多支持 17 人同时参与转码合图，详见 ARLiveTranscodingUser */ @property (copy, nonatomic) NSArray *_Nullable transcodingUsers; /** 预留参数：用户自定义的发送到旁路推流客户端的信息，用于填充 H264/H265 视频中 SEI 帧内容。长度限制：4096 字节。关于 SEI 的详细信息，详见SEI 帧相关问题。 */ @property (copy, nonatomic) NSString *_Nullable transcodingExtraInfo; /** 用于旁路直播的输出视频上的水印图片 仅支持 PNG 格式的图片。添加后所有旁路直播的观众都可以看到水印。水印图片的定义详见 ARImage */ @property (strong, nonatomic) ARImage *_Nullable watermark; /** 用于旁路直播的输出视频上的背景图片 添加后所有旁路直播的观众都可以看到背景图片。背景图片的定义详见 ARImage */ @property (strong, nonatomic) ARImage *_Nullable backgroundImage; /** 用于旁路直播的输出视频的背景色 格式为 RGB 定义下的十六进制整数，不要带 # 号，如 0xFFB6C1 表示浅粉色。默认 0x000000，黑色。 COLOR_CLASS 为类型统称，具体为： * iOS: UIColor * macOS: NSColor */ @property (strong, nonatomic) COLOR_CLASS *_Nullable backgroundColor; /** 用于旁路直播的输出音频的采样率，详见 ARAudioSampleRateType */ @property (assign, nonatomic) ARAudioSampleRateType audioSampleRate; /** 用于旁路直播的输出音频的码率。单位为 Kbps，默认值为 48，最大值为 128 */ @property (assign, nonatomic) NSInteger audioBitrate; /** 用于旁路直播的输出音频的声道数，默认值为 1。 取值范围为 [1,5] 中的整型，建议取 1 或 2。3、4、5需要特殊播放器支持： * 1: 单声道 * 2: 双声道 * 3: 三声道 * 4: 四声道 * 5: 五声道 */ @property (assign, nonatomic) NSInteger audioChannels; /** 用于旁路直播输出音频的编码规格，默认值为 ARAudioCodecProfileLCAAC(0)。详见 ARAudioCodecProfileType。 */ @property (assign, nonatomic) ARAudioCodecProfileType audioCodecProfile; /** 应用默认的转码设置 @return 应用默认设置的 ARLiveTranscoding 对象 */ +(ARLiveTranscoding *_Nonnull) defaultTranscoding; /** 添加一个用户到已有的用户中。 @param user 参数合图的用户，定义详见 ARLiveTranscodingUser 。 @return 0: 方法调用成功，< 0: 方法调用失败。 */ -(int)addUser:(ARLiveTranscodingUser * _Nonnull)user; /** 删除转码合图用户 @param uid 待删除的用户 ID @return 0: 方法调用成功，< 0: 方法调用失败。 */ -(int)removeUser:(NSString *_Nonnull)uid; @end /** Last mile 网络探测配置 */ __attribute__((visibility("default"))) @interface ARLastmileProbeConfig : NSObject /** 是否探测上行网络带宽。有些用户不需要进行网络探测，如直播频道中的普通观众。 - NO：不探测 - YES：探测 */ @property (assign, nonatomic) BOOL probeUplink; /** 是否探测下行网络带宽 - NO：不探测 - YES：探测 */ @property (assign, nonatomic) BOOL probeDownlink; /** 用户期望的最高发送码率 单位为 bps，范围为 [100000,5000000]。anyRTC 推荐参考 setVideoEncoderConfiguration 中的码率值设置该参数的值。 */ @property (assign, nonatomic) NSUInteger expectedUplinkBitrate; /** 用户期望的最高接收码率 单位为 bps，范围为 [100000,5000000]。 */ @property (assign, nonatomic) NSUInteger expectedDownlinkBitrate; @end /** 单向网络质量探测结果 */ __attribute__((visibility("default"))) @interface ARLastmileProbeOneWayResult : NSObject /** 网络丢包率，范围 [0,100]。 */ @property (assign, nonatomic) NSUInteger packetLossRate; /** 网络抖动，单位为毫秒。*/ @property (assign, nonatomic) NSUInteger jitter; /** 可用网络带宽预估，单位为 Kbps。*/ @property (assign, nonatomic) NSUInteger availableBandwidth; @end /** 上下行 last mile 质量探测结果 */ __attribute__((visibility("default"))) @interface ARLastmileProbeResult : NSObject /* Last mile 质量探测结果的状态 */ @property (assign, nonatomic) ARLastmileProbeResultState state; /** 往返时延，单位为毫秒 */ @property (assign, nonatomic) NSUInteger rtt; /** 上行网络质量报告 包含丢包率、网络抖动和可用带宽预估，详见 ARLastmileProbeOneWayResult。 */ @property (strong, nonatomic) ARLastmileProbeOneWayResult *_Nonnull uplinkReport; /** 下行网络质量报告 包含丢包率、网络抖动和可用带宽预估，详见 ARLastmileProbeOneWayResult。 */ @property (strong, nonatomic) ARLastmileProbeOneWayResult *_Nonnull downlinkReport; @end /** 设置屏幕共享编码配置的类 */ __attribute__((visibility("default"))) @interface ARScreenCaptureParameters: NSObject /** 屏幕共享视频发送的最大像素值 默认值为 1920 * 1080，即 2073600 像素。该像素值为计费标准。 当共享的屏幕分辨率宽高比与该值设置不一致时，SDK 按如下策略进行编码。假设 dimensions 为 1920 * 1080： - 如果屏幕分辨率小于 dimensions，如 1000 * 1000，SDK 直接按 1000 * 1000 进行编码。 - 如果屏幕分辨率大于 dimensions，如 2000 * 1500，SDK 按屏幕分辨率的宽高比，即 4：3，取 dimensions 以内的最大分辨率进行编码，即 1440 * 1080。 无论实际编码分辨率如何，均按 dimensions 设置的值计费。 */ @property (assign, nonatomic) CGSize dimensions; /** 共享视频的帧率，单位为 fps；默认值为 5，建议不要超过 15。 */ @property (assign, nonatomic) NSInteger frameRate; /** 共享视频的码率，单位为 Kbps；默认值为 0，表示由 SDK 根据当前共享的分辨率计算出一个合理的值。 */ @property (assign, nonatomic) NSInteger bitrate; /** 是否采集鼠标用于屏幕共享 - YES：（默认）采集鼠标 - NO：不采集鼠标 */ @property (assign, nonatomic) BOOL captureMouseCursor; /** 调用 startScreenCaptureByWindowId 方法共享窗口时，是否将该窗口前置。 - YES：前置窗口。 - NO: （默认）不前置窗口。 */ @property (assign, nonatomic) BOOL windowFocus; /** 待屏蔽窗口的 ID 列表。 调用 startScreenCaptureByDisplayId 开启主屏幕共享 （即屏幕 ID 为 0）时，你可以通过该参数屏蔽指定的窗口。开启主屏幕共享后，你可以在调用 updateScreenCaptureParameters 更新屏幕共享的配置参数时，通过该参数动态屏蔽指定的窗口。 */ @property (copy, nonatomic) NSArray * _Nullable excludeWindowList; @end #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC)) /** 提供设备信息的类 */ __attribute__((visibility("default"))) @interface ARtcDeviceInfo : NSObject /** 设备类型，详见 ARMediaDeviceType */ @property (assign, nonatomic) ARMediaDeviceType type; /** 设备 ID */ @property (copy, nonatomic) NSString * _Nullable deviceId; /** 设备名称 */ @property (copy, nonatomic) NSString * _Nullable deviceName; @end #endif /** 配置内置加密模式和密钥 */ __attribute__((visibility("default"))) @interface AREncryptionConfig: NSObject /** 内置加密模式，默认为 AREncryptionModeAES128XTS 加密模式。详见 AREncryptionMode 。 */ @property (assign, nonatomic) AREncryptionMode encryptionMode; /** 内置加密密钥，字符串类型。 **Note** 如果未指定该参数或将该参数设置为空，则无法启用内置加密，且 SDK 会返回错误码 -2 (ARErrorCodeInvalidArgument)。 */ @property (copy, nonatomic) NSString * _Nullable encryptionKey; @end