ByteRtcRenderMode

typedef NS_ENUM(NSUInteger, ByteRtcRenderMode)

视频显示模式

枚举值

ByteRtcUserOfflineReason

typedef NS_ENUM(NSUInteger, ByteRtcUserOfflineReason)

用户离线原因。
房间内的远端用户离开房间时，本地用户会收到 rtcEngine:didOfflineOfUid:reason: 回调通知，此枚举类型为回调的用户离线原因。

枚举值

RtcStreamRemoveReason

typedef NS_ENUM(NSInteger, RtcStreamRemoveReason)

房间内远端流移除原因。
房间内远端音视频流移除时，SDK 会通过 rtcEngine:didStreamRemoved:stream:reason: 回调通知用户。此枚举类型即为通知的远端流移除的原因。

枚举值

ByteChannelProfile

typedef NS_ENUM(NSInteger, ByteChannelProfile)

房间模式。房间使用的场景模式。
通过设置房间模式，用户可以选择应用 SDK 针对不同房间模式场景的优化策略。设置房间模式参考 setChannelProfile: 方法。

枚举值

ByteRtcClientRole

typedef NS_ENUM(NSInteger, ByteRtcClientRole)

用户角色。房间模式为直播、游戏、云游戏模式时的可选用户角色。
用户可通过设置用户角色控制：1.发布/取消发布音视频流；2.用户自身是否在房间中隐身。设置用户角色参考 setClientRole: 方法。

枚举值

ByteRtcAudioScenarioType

typedef NS_ENUM(NSInteger, ByteRtcAudioScenarioType)

音频场景类型。
选择音频场景后，RTC 会自动根据客户端音频路由和发布订阅状态，适用通话音量/媒体音量。
你可以调用 setAudioScenario: 设置音频场景。
如果以下音频场景类型无法满足你的业务需要，请联系技术支持同学进行定制。

枚举值

ByteRtcConnectionState

typedef NS_ENUM(NSInteger, ByteRtcConnectionState)

SDK 与 RTC 服务器连接状态。

枚举值

ByteRtcNetworkType

typedef NS_ENUM(NSInteger, ByteRtcNetworkType)

SDK 网络连接类型。

枚举值

ByteRtcVideoStreamType

typedef NS_ENUM(NSInteger, ByteRtcVideoStreamType)

视频流类型 目前C++ SDK 只支持 ByteRtc_VideoStream_High 类型

枚举值

ByteNetworkQuality

typedef NS_ENUM(NSUInteger, ByteNetworkQuality)

媒体流网络质量。

枚举值

ByteVideoRemoteState

typedef NS_ENUM(NSUInteger, ByteVideoRemoteState)

远端视频流状态

枚举值

VideoStreamState

typedef NS_ENUM(NSInteger, VideoStreamState)

设置本地视频属性的返回状态。

枚举值

ByteVideoOutputOrientationMode

typedef NS_ENUM(NSInteger, ByteVideoOutputOrientationMode)

视频输出方向模式

枚举值

ByteVideoMirrorMode

typedef NS_ENUM(NSUInteger, ByteVideoMirrorMode)

视频镜像模式。

枚举值

RtcLogType

typedef enum

日志类型。

枚举值

ByteAudioOutputRouting

typedef NS_ENUM(NSInteger, ByteAudioOutputRouting)

音频输出路由 音频路由变化时 SDK 通过 rtcEngine:didAudioRouteChanged: 回调该错误码

枚举值

ByteVideoRotation

typedef NS_ENUM(NSInteger, ByteVideoRotation)

视频旋转信息，枚举类型，定义了90度为间隔的四种旋转模式。

枚举值

ByteVideoStreamScaleMode

typedef NS_ENUM(NSInteger, ByteVideoStreamScaleMode)

视频缩放模式

枚举值

ByteVideoCodecName

typedef NS_ENUM(NSInteger, ByteVideoCodecName)

视频编码算法

枚举值

ByteVideoCodecMode

typedef NS_ENUM(NSInteger, ByteVideoCodecMode)

视频编码模式

枚举值

ByteVideoEncoderPreference

typedef NS_ENUM(NSInteger, ByteVideoEncoderPreference)

编码质量偏好

枚举值

UserMessageCode

typedef NS_ENUM(NSInteger, UserMessageCode)

消息发送结果。

枚举值

RoomMessageCode

typedef NS_ENUM(NSInteger, RoomMessageCode)

消息发送结果。

枚举值

AudioPerfProfile

typedef NS_ENUM(NSUInteger, AudioPerfProfile)

用户机型等级信息。 在部分应用场景下，需要关注用户机型的配置高低，根据不同的配置，选择不同复杂度的音频处理算法，在能耗、用户体验上进行折中。

枚举值

BytePublishFallbackOption

typedef NS_ENUM(NSUInteger, BytePublishFallbackOption)

本地发布的音视频流回退选项

枚举值

ByteSubscribeMode

typedef NS_ENUM(NSUInteger, ByteSubscribeMode)

订阅模式选项。业务方在加入房间前，调用 enableAutoSubscribe:videoMode: 接口设置订阅模式。

枚举值

ByteSubscribeFallbackOption

typedef NS_ENUM(NSUInteger, ByteSubscribeFallbackOption)

订阅回退选项

枚举值

ByteUserPriority

typedef NS_ENUM(NSUInteger, ByteUserPriority)

远端用户优先级，在性能不足需要回退时，会优先回退优先级低的用户的音视频流

枚举值

ByteFallbackOrRecoverReason

typedef NS_ENUM(NSInteger, ByteFallbackOrRecoverReason)

远端订阅流发生回退或恢复的原因

枚举值

ByteLocalAudioStreamState

typedef NS_ENUM(NSInteger, ByteLocalAudioStreamState)

本地音频流状态。 SDK 通过 rtcEngine:localAudioStateChanged:error: 回调本地音频流状态

枚举值

ByteLocalAudioStreamError

typedef NS_ENUM(NSInteger, ByteLocalAudioStreamError)

本地音频流状态改变时的错误码 SDK 通过 rtcEngine:localAudioStateChanged:error: 回调该错误码

枚举值

ByteLocalVideoStreamState

typedef NS_ENUM(NSInteger, ByteLocalVideoStreamState)

本地视频流状态

枚举值

ByteLocalVideoStreamError

typedef NS_ENUM(NSInteger, ByteLocalVideoStreamError)

本地视频状态改变时的错误码

枚举值

ByteRemoteAudioState

typedef NS_ENUM(NSInteger, ByteRemoteAudioState)

远端音频流状态 SDK 通过 rtcEngine:remoteAudioStateChanged:state:reason:elapsed: 回调该状态

枚举值

ByteRemoteAudioReason

typedef NS_ENUM(NSInteger, ByteRemoteAudioReason)

远端音频流状态改变的原因。 SDK 通过 rtcEngine:remoteAudioStateChanged:state:reason:elapsed: 回调该错误码

枚举值

ByteRemoteVideoState

typedef NS_ENUM(NSInteger, ByteRemoteVideoState)

远端视频流状态

枚举值

ByteRemoteVideoReason

typedef NS_ENUM(NSInteger, ByteRemoteVideoReason)

远端视频流状态改变的原因

枚举值

ByteVideoCodecType

typedef NS_ENUM(NSInteger, ByteVideoCodecType)

编码类型

枚举值

ByteMediaDeviceType

typedef NS_ENUM(NSInteger, ByteMediaDeviceType)

设备类型

枚举值

ByteMediaDeviceState

typedef NS_ENUM(NSInteger, ByteMediaDeviceState)

设备状态

枚举值

ProblemFeedback

typedef NS_OPTIONS(NSUInteger, ProblemFeedback)

音视频质量反馈问题类型

枚举值

BackgroundMode

typedef NS_ENUM(NSUInteger, BackgroundMode)

背景模式 开启背景替换功能时生效，详见 replaceBackground:withDivideModel:。

枚举值

DivideModel

typedef NS_ENUM(NSUInteger, DivideModel)

分割模型 开启背景替换功能时生效，详见 replaceBackground:withDivideModel:。

枚举值

FirstFrameSendState

typedef NS_ENUM(NSUInteger, FirstFrameSendState)

首帧发送状态

枚举值

FirstFramePlayState

typedef NS_ENUM(NSUInteger, FirstFramePlayState)

首帧播放状态

枚举值

ByteEncryptType

typedef NS_OPTIONS(NSUInteger, ByteEncryptType)

加密类型

枚举值

ByteRtcVideoCanvas

@interface ByteRtcVideoCanvas : NSObject

视频渲染图层结构。app 通过该结构将要渲染的窗口和视频流进行绑定

成员变量

变量说明

view

@property (strong, nonatomic) UIView* _Nullable view;

渲染窗口句柄

renderMode

@property (assign, nonatomic) ByteRtcRenderMode renderMode;

设置渲染模式，暂时设置无效

roomId

@property (strong, nonatomic) NSString* _Nullable roomId;

房间ID

uid

@property (strong, nonatomic) NSString* _Nullable uid;

设置渲染流的用户标识

ByteRtcFrameExtendedData

@interface ByteRtcFrameExtendedData : NSObject

视频帧附加的数据,视频解码后获得的附加数据

成员变量

变量说明

extendedData

@property (strong, nonatomic) NSData * _Nullable extendedData;

附加数据

extendedDataLen

@property (assign, nonatomic) NSInteger extendedDataLen;

附加数据长度

VideoStreamDescription

@interface VideoStreamDescription: NSObject

视频流描述

成员变量

变量说明

videoSize

@property (nonatomic, assign) CGSize videoSize;

视频分辨率

frameRate

@property (nonatomic, assign) NSInteger frameRate;

视频预设帧率

maxKbps

@property (nonatomic, assign) NSInteger maxKbps;

视频预设最大码率(Kbps)

mode

@property (nonatomic, assign) ByteVideoStreamScaleMode mode;

视频拉伸模式，详见类型ByteVideoStreamScaleMode

encoderPreference

@property (nonatomic, assign) ByteVideoEncoderPreference encoderPreference;

视频编码质量偏好，详见类型ByteVideoEncoderPreference

ByteStream

@protocol ByteStream <NSObject>

流属性。房间中的远端流的流属性。
用户加入房间成功后，房间中所有已发布和未来发布的流和流的相关属性，都会通过 rtcEngine:onStreamAdd: 回调时间通知用户。此数据结构即为回调给用户的参数类型。

成员变量

变量说明

userId

@property (nonatomic, copy, readonly) NSString * userId;

用户ID 。此流的发布用户的用户ID 。

isScreen

@property (nonatomic, assign, readonly) BOOL isScreen;

此流是否为共享屏幕流。

hasVideo

@property (nonatomic, assign, readonly) BOOL hasVideo;

此流是否包括视频流。

hasAudio

@property (nonatomic, assign, readonly) BOOL hasAudio;

流是否包括音频流。

videoStreamDescriptions

@property (nonatomic, copy, readonly) NSArray<VideoStreamDescription *> * videoStreamDescriptions;

视频流的分辨率信息。
用户可以通过调用 setVideoProfilessetVideoProfiles: 方法在一路流中发布多个不同分辨率的视频。此参数即为流中所有视频的分辨率等相关信息。视频流的分辨率信息，详见 VideoStreamDescription 类型。

SubscribeConfig

@interface SubscribeConfig: NSObject

订阅流的参数配置。用户手动订阅一路音视频流所使用的订阅配置参数。
用户关闭自动订阅功能，使用手动订阅模式时，通过调用 subscribeStream:subscribeConfig: 方法订阅音视频流，调用时传入的参数即为此数据类型。

成员变量

变量说明

isScreen

@property (nonatomic, assign) BOOL isScreen;

是否是屏幕流。
用户通过设置此参数，订阅该远端用户发布的屏幕共享流或非屏幕共享流。 YES 为订阅屏幕共享流，NO 为订阅非屏幕共享流，默认值为 YES 。

subscribeVideo

@property (nonatomic, assign) BOOL subscribeVideo;

是否订阅视频。
用户通过设置此参数，选择是否订阅远端流中的视频。 YES 为订阅视频，NO 为不订阅视频，默认值为 YES 。

subscribeAudio

@property (nonatomic, assign) BOOL subscribeAudio;

是否订阅音频。
用户通过设置此参数，选择是否订阅远端流中的音频。YES 为订阅音频，NO 为不订阅音频，默认值为 YES 。

videoIndex

@property (nonatomic, assign) NSInteger videoIndex;

订阅的视频流分辨率下标。
用户可以通过调用 setVideoProfilessetVideoProfiles: 方法在一路流中发布多个不同分辨率的视频。因此订阅流时，需要指定订阅的具体分辨率。此参数即用于指定需订阅的分辨率的下标，默认值为 0 。

ByteAudioFrame

@interface ByteAudioFrame : NSObject

音频帧

成员变量

变量说明

samples

@property (strong, nonatomic) NSData * _Nonnull samples;

音频帧数据

numOfSamples

@property (assign, nonatomic) int numOfSamples;

此音频帧描述的样点数

bytesPerSample

@property (assign, nonatomic) int bytesPerSample;

每个采样点占据的内存大小，s16 为 2 byte

channels

@property (assign, nonatomic) int channels;

音频通道数

samplesPerSec

@property (assign, nonatomic) int samplesPerSec;

音频采样率

VideoFrameType

typedef NS_ENUM(NSInteger, VideoFrameType)

视频帧类型

枚举值

VideoPixelFormat

typedef NS_ENUM(NSInteger, VideoPixelFormat)

视频帧格式

枚举值

ByteVideoFrame

@interface ByteVideoFrame : NSObject

成员变量

变量说明

format

@property (assign, nonatomic) NSInteger format;

视频帧类型，参考 VideoPixelFormat

time

@property (assign, nonatomic) CMTime time;

当前帧的时间戳信息

strideInPixels

@property (assign, nonatomic) int strideInPixels;

每一行像素占用的字节数

width

@property (assign, nonatomic) int width;

视频帧宽度

height

@property (assign, nonatomic) int height;

视频帧高度

textureBuf

@property (assign, nonatomic) CVPixelBufferRef _Nullable textureBuf;

CVPixelBufferRef 类型的数据，当 format 为 kPixelFormatCVPixelBuffer 时有效

dataBuf

@property (strong, nonatomic) NSData * _Nullable dataBuf;

视频帧内存块首地址

cropLeft

@property (assign, nonatomic) int cropLeft;

视频帧左边裁剪的尺寸（像素）

cropTop

@property (assign, nonatomic) int cropTop;

视频帧上部裁剪的尺寸（像素）

cropRight

@property (assign, nonatomic) int cropRight;

视频帧右边裁剪的尺寸（像素）

cropBottom

@property (assign, nonatomic) int cropBottom;

视频帧底部裁剪的尺寸（像素）

rotation

@property (assign, nonatomic) ByteVideoRotation rotation;

视频帧旋转角度：0, 90, 180, 270

extendedData

@property (strong, nonatomic) ByteRtcFrameExtendedData *extendedData;

视频帧附加的数据

ByteRtcVideoCompositingRegion

@interface ByteRtcVideoCompositingRegion : NSObject

单个视频流在合流中的布局信息。
此数据类型为，开启直播推流转码功能，多路视频流合流时，其中一路视频流在合流中的预设布局信息。

成员变量

变量说明

uid

@property (copy, nonatomic) NSString * _Nonnull uid;

用户ID 。视频流发布用户的用户ID 。

x

@property (assign, nonatomic) CGFloat x;

用户视频布局相对画布左侧的偏移量。相对值，范围为[0.0 - 1.0]。

y

@property (assign, nonatomic) CGFloat y;

用户视频布局相对画布顶端的偏移量。相对值，范围为[0.0 - 1.0]。

width

@property (assign, nonatomic) CGFloat width;

用户视频宽度相对用户原始视频宽度的比例。相对值，范围为[0.0 - 1.0]。

height

@property (assign, nonatomic) CGFloat height;

用户视频高度相对用户原始视频高度的比例。相对值，范围为[0.0 - 1.0]。

zOrder

@property (assign, nonatomic) NSInteger zOrder;

用户视频布局在画布中的层级。0为底层，值越大越上层，范围为[0 - 100]。

alpha

@property (assign, nonatomic) CGFloat alpha;

透明度。范围为[0 - 255]。

contentControl

@property (assign, nonatomic) NSInteger contentControl;

合流内容控制。默认值为 0 ，取值范围及含义如下:
+ 0: 输出的混流包含音视频
+ 1: 只包含音频
+ 2: 表示只包含视频

renderMode

@property (assign, nonatomic) ByteRtcRenderMode renderMode;

视频显示模式。详见 ByteRtcRenderMode 数据类型。

ByteRtcVideoCompositingLayout

@interface ByteRtcVideoCompositingLayout : NSObject

视频流合流整体布局信息。
此数据类型为，开启直播推流转码功能，视频合流的完整信息。包括了参与合流的每路视频流的预设布局信息和合流背景信息等。

成员变量

变量说明

backgroundColor

@property (copy, nonatomic) NSString *_Nonnull backgroundColor;

画布的背景颜色。

regions

@property (copy, nonatomic) NSArray<ByteRtcVideoCompositingRegion *> * _Nonnull regions;

用户布局信息列表。每条流的具体布局详见 ByteRtcVideoCompositingRegion 数据类型。

appData

@property (copy, nonatomic) NSString *_Nonnull appData;

透传的 App 数据。

ByteRtcTranscodingVideoConfig

@interface ByteRtcTranscodingVideoConfig : NSObject

视频转码配置参数。

成员变量

变量说明

codec

@property (copy, nonatomic) NSString * _Nonnull codec;

视频编码格式。

width

@property (assign, nonatomic) NSInteger width;

合流视频宽度。

height

@property (assign, nonatomic) NSInteger height;

合流视频高度。

fps

@property (assign, nonatomic) NSInteger fps;

合流视频帧率信息。

gop

@property (assign, nonatomic) NSInteger gop;

视频I帧间隔。

kBitRate

@property (assign, nonatomic) NSInteger kBitRate;

合流视频码率，单位为 kbps 。

lowLatency

@property (assign, nonatomic) BOOL lowLatency;

是否使用低延时特性。

ByteAACProfile

typedef NS_ENUM(NSInteger, ByteAACProfile)

AAC编码类型。

枚举值

ByteRtcTranscodingAudioConfig

@interface ByteRtcTranscodingAudioConfig : NSObject

音频转码配置参数。

成员变量

变量说明

codec

@property (copy, nonatomic) NSString * _Nonnull codec;

音频编码格式。

sampleRate

@property (assign, nonatomic) NSInteger sampleRate;

音频采样率。单位为 kHz。可选取值：16, 32, 44.1, 48。

channels

@property (assign, nonatomic) NSInteger channels;

声道数。

kBitRate

@property (assign, nonatomic) NSInteger kBitRate;

音频码率。单位为 kbps。可选取值：16, 32, 64。

profile

@property (assign, nonatomic) ByteAACProfile profile;

AAC 等级。

ByteRtcLiveTranscoding

@interface ByteRtcLiveTranscoding : NSObject

直播推流转码配置参数。
用户调用 enableLiveTranscoding: 方法开启直播推流转码功能时，传入的合流转码配置参数。

成员变量

静态函数

变量说明

layout

@property (strong, nonatomic) ByteRtcVideoCompositingLayout * _Nonnull layout;

视频合流布局信息。详见 ByteRtcVideoCompositingLayout 数据类型。

video

@property (strong, nonatomic) ByteRtcTranscodingVideoConfig * _Nonnull video;

视频转码参数。详见 ByteRtcTranscodingVideoConfig 数据类型。

audio

@property (strong, nonatomic) ByteRtcTranscodingAudioConfig * _Nonnull audio;

音频转码参数。详见 ByteRtcTranscodingAudioConfig 数据类型。

advancedConfig

@property (strong, nonatomic) NSMutableDictionary *  _Nullable advancedConfig;

动态扩展自定义参数。

url

@property (copy, nonatomic) NSString * _Nullable url;

推流 CDN 地址。

函数说明

defaultTranscoding

+ (instancetype _Nonnull)defaultTranscoding;

获取默认合流参数。

ByteRtcStats

@interface ByteRtcStats : NSObject

房间通话统计数据。
用户加入当前房间成功后，SDK 会周期性（2s）的通过rtcEngine:reportRtcStats:回调事件通知用户当前房间内的汇总统计信息。回调的统计信息即为此数据类型。

成员变量

变量说明

duration

@property (assign, nonatomic) NSInteger duration;

用户在房间中的总时长。单位为 s 。

txBytes

@property (assign, nonatomic) NSInteger txBytes;

用户在通话过程中发送媒体数据总量。单位为 bytes 。

rxBytes

@property (assign, nonatomic) NSInteger rxBytes;

用户在通话过程中接收媒体数据总量。单位为 bytes 。

txAudioKBitrate

@property (assign, nonatomic) NSInteger txAudioKBitrate;

发送音频码率。此次统计周期内总发送音频码率，单位为 kbps 。

rxAudioKBitrate

@property (assign, nonatomic) NSInteger rxAudioKBitrate;

接收音频码率。此次统计周期内总接收音频码率，单位为 kbps 。

txVideoKBitrate

@property (assign, nonatomic) NSInteger txVideoKBitrate;

发送视频码率。此次统计周期内总发送视频码率，单位为 kbps 。

rxVideoKBitrate

@property (assign, nonatomic) NSInteger rxVideoKBitrate;

接收视频码率。此次统计周期内总接收视频码率，单位为 kbps 。

userCount

@property (assign, nonatomic) NSInteger userCount;

当前房间内用户总数。回调时房间内的用户总数，包括本地用户自身。

ByteRtcSysStats

@interface ByteRtcSysStats : NSObject

App使用的cpu和memory信息
SDK 周期性（2s）的通过rtcEngine:reportSysStats:回调事件通知用户当前App的cpu与memory使用信息。回调的统计信息即为此数据类型。

成员变量

变量说明

cpu_app_usage

@property (assign, nonatomic) double cpu_app_usage;

当前App的CPU 使用率

cpu_total_usage

@property (assign, nonatomic) double cpu_total_usage;

当前设备的总CPU使用率

memory_usage

@property (assign, nonatomic) double memory_usage;

当前App的CPU使用率

ByteRtcLocalVideoStats

@interface ByteRtcLocalVideoStats : NSObject

本地视频流统计信息。
本地用户发布视频流成功后，SDK 会周期性（2s）的通过 rtcEngine:localVideoStats: 回调事件通知用户发布的视频流在此次统计周期内的状况。此数据结构即为回调给用户的参数类型。

成员变量

变量说明

sentKBitrate

@property (assign, nonatomic) float sentKBitrate;

发送的码率。此次统计周期内的视频发送码率，单位为 kbps 。

inputFrameRate

@property (assign, nonatomic) NSInteger inputFrameRate;

输入帧率。此次统计周期内的本地视频输入帧率 。

sentFrameRate

@property (assign, nonatomic) NSInteger sentFrameRate;

发送帧率。此次统计周期内的本地视频发送帧率 。

encoderOutputFrameRate

@property (assign, nonatomic) NSInteger encoderOutputFrameRate;

本地视频目标编码帧率。

rendererOutputFrameRate

@property (assign, nonatomic) NSInteger rendererOutputFrameRate;

本地视频目标渲染输出帧率。

sentTargetKBitrate

@property (assign, nonatomic) NSInteger sentTargetKBitrate;

本地视频目标发送码率。单位为 kbps 。

sentTargetFrameRate

@property (assign, nonatomic) NSInteger sentTargetFrameRate;

本地视频目标发送帧率。

statsInterval

@property (assign, nonatomic) NSInteger statsInterval;

统计间隔。此次统计周期的间隔，单位为 ms 。

videoLossRate

@property (assign, nonatomic) float videoLossRate;

音频丢包率。统计周期内的视频上行丢包率，取值范围为 [0, 1] 。

rtt

@property (assign, nonatomic) NSInteger rtt;

往返时延。单位为 ms 。

encodedBitrate

@property(assign, nonatomic) NSInteger encodedBitrate;

编码率。

encodedFrameWidth

@property(assign, nonatomic) NSInteger encodedFrameWidth;

编码帧宽度。

encodedFrameHeight

@property(assign, nonatomic) NSInteger encodedFrameHeight;

编码帧高度。

encodedFrameCount

@property(assign, nonatomic) NSInteger encodedFrameCount;

编码帧数。此次统计周期内编码的帧数。

codecType

@property(nonatomic) ByteVideoCodecType codecType;

编码类型。详见 ByteVideoCodecType 类型。

isScreen

@property (assign, nonatomic) BOOL isScreen;

是否是屏幕流。

ByteRtcRemoteVideoStats

@interface ByteRtcRemoteVideoStats : NSObject

远端视频流统计信息。
本地用户订阅远端视频流成功后，SDK 会周期性（2s）的通过 rtcEngine:remoteVideoStats: 回调事件通知用户订阅的视频流在此次统计周期内的状况。此数据结构即为回调给用户的参数类型。

成员变量

变量说明

uid

@property (copy, nonatomic) NSString * _Nonnull uid;

用户ID 。远端视频流发布用户的用户ID 。

width

@property (assign, nonatomic) NSInteger width;

远端视频宽度。

height

@property (assign, nonatomic) NSInteger height;

远端视频高度。

videoLossRate

@property (assign, nonatomic) float videoLossRate;

远端视频丢包率。统计周期内的视频下行丢包率，取值范围为 [0, 1] 。

receivedKBitrate

@property (assign, nonatomic) float receivedKBitrate;

接收码率。统计周期内的视频接收码率，单位为 kbps 。

receivedFrameRate

@property (assign, nonatomic) NSInteger receivedFrameRate;

远端视频接收帧率。

decoderOutputFrameRate

@property (assign, nonatomic) NSInteger decoderOutputFrameRate;

远端视频解码输出帧率。

renderOutputFrameRate

@property (assign, nonatomic) NSInteger renderOutputFrameRate;

远端视频渲染输出帧率。

stallCount

@property (assign, nonatomic) NSInteger stallCount;

远端视频卡顿次数。

stallDuration

@property (assign, nonatomic) NSInteger stallDuration;

远端视频卡顿时长，单位为 ms 。

e2eDelay

@property (assign, nonatomic) NSInteger e2eDelay;

用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为 ms 。

isScreen

@property (assign, nonatomic) BOOL isScreen;

远端视频流是否是屏幕共享流。

statsInterval

@property (assign, nonatomic) NSInteger statsInterval;

统计间隔。此次统计周期的间隔，单位为 ms 。

rtt

@property (assign, nonatomic) NSInteger rtt;

往返时延。单位为 ms 。

frozenRate

@property(assign, nonatomic) NSInteger frozenRate;

远端用户在加入房间后发生视频卡顿的累计时长占音频总有效时长的百分比。

videoIndex

@property (assign, nonatomic) NSInteger videoIndex;

SDK 订阅的远端视频流的分辨率下标。

ByteRtcLocalAudioStats

@interface ByteRtcLocalAudioStats : NSObject

本地音频流统计信息。
本地用户发布音频流成功后，SDK 会周期性（2s）的通过 rtcEngine:localAudioStats: 回调事件通知用户发布的音频流在此次统计周期内的状况。此数据结构即为回调给用户的参数类型。

成员变量

变量说明

audioLossRate

@property (assign, nonatomic) float audioLossRate;

音频丢包率。此次统计周期内的音频上行丢包率，取值范围为 [0, 1] 。

sentKBitrate

@property (assign, nonatomic) float sentKBitrate;

发送的码率。此次统计周期内的音频发送码率，单位为 kbps 。

recordSampleRate

@property (assign, nonatomic) NSInteger recordSampleRate;

采集采样率。音频采集采样率信息，单位为 Hz 。

statsInterval

@property (assign, nonatomic) NSInteger statsInterval;

统计间隔。此次统计周期的间隔，单位为 ms 。

rtt

@property (assign, nonatomic) NSInteger rtt;

往返时延。单位为 ms 。

numChannels

@property(assign, nonatomic) NSInteger numChannels;

音频声道数。

sentSampleRate

@property(assign, nonatomic) NSInteger sentSampleRate;

发送采样率。音频发送采样率信息，单位为 Hz 。

ByteRtcRemoteAudioStats

@interface ByteRtcRemoteAudioStats : NSObject

远端音频流统计信息。
本地用户订阅远端音频流成功后，SDK 会周期性（2s）的通过 rtcEngine:remoteAudioStats: 回调事件通知用户订阅的音频流在此次统计周期内的状况。此数据结构即为回调给用户的参数类型。

成员变量

变量说明

uid

@property (copy, nonatomic) NSString * _Nonnull uid;

用户ID 。远端音频流发布用户的用户ID 。

audioLossRate

@property (assign, nonatomic) float audioLossRate;

音频丢包率。统计周期内的音频下行丢包率，取值范围为 [0, 1] 。

receivedKBitrate

@property (assign, nonatomic) float receivedKBitrate;

接收码率。统计周期内的音频接收码率，单位为 kbps 。

stallCount

@property (assign, nonatomic) NSInteger stallCount;

音频卡顿次数。统计周期内的卡顿次数。

stallDuration

@property (assign, nonatomic) NSInteger stallDuration;

音频卡顿时长。统计周期内的卡顿时长，单位为 ms 。

playoutSampleRate

@property (assign, nonatomic) NSInteger playoutSampleRate;

播放采样率。统计周期内的音频播放采样率信息，单位为 Hz 。

e2eDelay

@property (assign, nonatomic) NSInteger e2eDelay;

用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为 ms 。

statsInterval

@property (assign, nonatomic) NSInteger statsInterval;

统计间隔。此次统计周期的间隔，单位为 ms 。

rtt

@property (assign, nonatomic) NSInteger rtt;

往返时延。单位为 ms 。

quality

@property(assign, nonatomic) NSInteger quality;

远端用户发送的音频流质量。值含义参考 ByteNetworkQuality 。

jitterBufferDelay

@property(assign, nonatomic) NSInteger jitterBufferDelay;

音频发送端到接收端的网络延迟。单位为 ms 。

numChannels

@property(assign, nonatomic) NSInteger numChannels;

音频声道数。

receivedSampleRate

@property(assign, nonatomic) NSInteger receivedSampleRate;

音频接收采样率。统计周期内接收到的远端音频采样率信息，单位为 Hz 。

frozenRate

@property(assign, nonatomic) NSInteger frozenRate;

远端用户在加入房间后发生音频卡顿的累计时长占音频总有效时长的百分比。

concealedSamples

@property(assign, nonatomic) NSInteger concealedSamples;

音频 PLC 样点总个数。

concealmentEvent

@property(assign, nonatomic) NSInteger concealmentEvent;

PLC 累计次数。

decSampleRate

@property(assign, nonatomic) NSInteger decSampleRate;

音频解码采样率。统计周期内的音频解码采样率信息，单位为 Hz 。

decDuration

@property(assign, nonatomic) NSInteger decDuration;

解码时长。单位为 s 。

ByteRtcAudioVolumeInfo

@interface ByteRtcAudioVolumeInfo : NSObject

音量信息

成员变量

变量说明

uid

@property (copy, nonatomic) NSString * _Nonnull uid;

音量信息所属用户的用户ID

volume

@property (assign, nonatomic) NSUInteger volume;

用户音量大小信息，音量取值范围为 [0, 255]

ByteSourceWantedData

@interface ByteSourceWantedData : NSObject

性能回退相关数据

成员变量

变量说明

width

@property (nonatomic, assign) NSInteger width;

推荐视频输入宽

height

@property (nonatomic, assign) NSInteger height;

推荐视频输入高

frameRate

@property (nonatomic, assign) NSInteger frameRate;

推荐视频输入帧率

ByteRtcStreamOC

@interface ByteRtcStreamOC : NSObject <ByteStream>

流信息

成员变量

变量说明

userId

@property (nonatomic, copy, nullable) NSString *userId;

用户ID

isScreen

@property (nonatomic, assign) BOOL isScreen;

流是否为共享屏幕流。

hasVideo

@property (nonatomic, assign) BOOL hasVideo;

该路流中是否包含视频

hasAudio

@property (nonatomic, assign) BOOL hasAudio;

该路流中是否包含音频

videoStreamDescriptions

@property (nonatomic, copy, nullable) NSArray<VideoStreamDescription *> *videoStreamDescriptions/;

视频流的分辨率信息，详见 VideoStreamDescription 类。 用户可以通过调用 setVideoProfilessetVideoProfiles: 方法在一路流中发布多个不同的视频分辨率。此参数即为流中所有分辨率的相关信息。

ScreenCaptureParam

@interface ScreenCaptureParam : NSObject

屏幕采集设置参数

成员变量

变量说明

width

@property (nonatomic, assign) NSInteger width;

屏幕采集宽度

height

@property (nonatomic, assign) NSInteger height;

屏幕采集高度

frameRate

@property (nonatomic, assign) NSInteger frameRate;

屏幕采集帧率，单位 fps

bitrate

@property (nonatomic, assign) NSInteger bitrate;

发送屏幕采集码率，单位 kbps

captureMouseCursor

@property (nonatomic, assign) BOOL captureMouseCursor;

是否采集鼠标

ScreenParam

@interface ScreenParam : NSObject

屏幕采集设置参数

成员变量

变量说明

frameRate

@property (nonatomic, assign) NSInteger frameRate;

编码帧率,单位为 fps

bitrate

@property (nonatomic, assign) NSInteger bitrate;

编码码率，小于 0 时 SDK 会根据高宽自适应码率, 单位 kbps

ByteRtcUser

@interface ByteRtcUser : NSObject

用户信息

成员变量

变量说明

userId

@property (nonatomic, copy, nullable) NSString *userId;

用户 id

metaData

@property (nonatomic, copy, nullable) NSString *metaData;

元信息