ByteRTCRenderMode

typedef NS_ENUM(NSUInteger, ByteRTCRenderMode)

视频渲染模式

枚举值

ByteRTCUserOfflineReason

typedef NS_ENUM(NSUInteger, ByteRTCUserOfflineReason)

用户离开房间的原因。

枚举值

ByteRTCStreamRemoveReason

typedef NS_ENUM(NSInteger, ByteRTCStreamRemoveReason)

房间内远端流移除原因。

枚举值

ByteRTCRoomProfile

typedef NS_ENUM(NSInteger, ByteRTCRoomProfile)

房间模式

枚举值

ByteRTCAudioScenarioType

typedef NS_ENUM(NSInteger, ByteRTCAudioScenarioType)

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

枚举值

ByteRTCVoiceChangerType

typedef NS_ENUM(NSInteger, ByteRTCVoiceChangerType)

变声特效类型

枚举值

ByteRTCVoiceReverbType

typedef NS_ENUM(NSInteger, ByteRTCVoiceReverbType)

混响特效类型

枚举值

ByteRTCAudioProfileType

typedef NS_ENUM(NSInteger, ByteRTCAudioProfileType)

音质档位 调用 setAudioProfile: 设置的音质档位

枚举值

ByteRTCConnectionState

typedef NS_ENUM(NSInteger, ByteRTCConnectionState)

SDK 与信令服务器连接状态。

枚举值

ByteRTCNetworkType

typedef NS_ENUM(NSInteger, ByteRTCNetworkType)

SDK 网络连接类型。

枚举值

ByteRTCNetworkDetectionStopReason

typedef NS_ENUM(NSUInteger, ByteRTCNetworkDetectionStopReason)

通话前探测的停止原因 rtcEngine:onNetworkDetectionStopped: 回调的参数类型

枚举值

ByteRTCNetworkDetectionLinkType

typedef NS_ENUM(NSUInteger, ByteRTCNetworkDetectionLinkType)

通话前探测链接的类型 rtcEngine:onNetworkDetectionResult:quality:rtt:lostRate:bitrate:jitter: 回调的参数类型

枚举值

ByteRTCVideoStreamType

typedef NS_ENUM(NSInteger, ByteRTCVideoStreamType)

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

枚举值

ByteRTCNetworkQuality

typedef NS_ENUM(NSUInteger, ByteRTCNetworkQuality)

媒体流网络质量。

枚举值

ByteRTCVideoStreamState

typedef NS_ENUM(NSInteger, ByteRTCVideoStreamState)

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

枚举值

ByteRTCPerformanceAlarmReason

typedef NS_ENUM(NSInteger, ByteRTCPerformanceAlarmReason)

性能回退或者恢复的原因

枚举值

ByteRTCPerformanceAlarmMode

typedef NS_ENUM(NSInteger, ByteRTCPerformanceAlarmMode)

性能回退的模式

枚举值

ByteRTCVideoOutputOrientationMode

typedef NS_ENUM(NSInteger, ByteRTCVideoOutputOrientationMode)

视频输出方向模式

枚举值

ByteRTCMirrorType

typedef NS_ENUM(NSUInteger, ByteRTCMirrorType)

镜像类型

枚举值

ByteRTCVideoRotation

typedef NS_ENUM(NSInteger, ByteRTCVideoRotation)

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

枚举值

ByteRTCVideoStreamScaleMode

typedef NS_ENUM(NSInteger, ByteRTCVideoStreamScaleMode)

视频帧缩放模式

枚举值

ByteRTCVideoCodecType

typedef NS_ENUM(NSInteger, ByteRTCVideoCodecType)

视频编码类型

枚举值

ByteRTCVideoPictureType

typedef NS_ENUM(NSInteger, ByteRTCVideoPictureType)

编码帧类型

枚举值

ByteRTCVideoEncoderPreference

typedef NS_ENUM(NSInteger, ByteRTCVideoEncoderPreference)

编码策略偏好

枚举值

ByteRTCUserMessageSendResult

typedef NS_ENUM(NSInteger, ByteRTCUserMessageSendResult)

消息发送结果。

枚举值

ByteRTCUserOnlineStatus

typedef NS_ENUM(NSInteger, ByteRTCUserOnlineStatus)

用户在线状态

枚举值

ByteRTCRoomMessageSendResult

typedef NS_ENUM(NSInteger, ByteRTCRoomMessageSendResult)

广播消息发送结果。

枚举值

ByteRTCPublishFallbackOption

typedef NS_ENUM(NSUInteger, ByteRTCPublishFallbackOption)

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

枚举值

ByteRTCSubscribeFallbackOption

typedef NS_ENUM(NSUInteger, ByteRTCSubscribeFallbackOption)

订阅回退选项

枚举值

ByteRTCRemoteUserPriority

typedef NS_ENUM(NSUInteger, ByteRTCRemoteUserPriority)

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

枚举值

ByteRTCFallbackOrRecoverReason

typedef NS_ENUM(NSInteger, ByteRTCFallbackOrRecoverReason)

本地用户订阅的远端流触发回退策略的原因。

枚举值

ByteRTCLocalAudioStreamState

typedef NS_ENUM(NSInteger, ByteRTCLocalAudioStreamState)

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

枚举值

ByteRTCLocalAudioStreamError

typedef NS_ENUM(NSInteger, ByteRTCLocalAudioStreamError)

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

枚举值

ByteRTCLocalVideoStreamState

typedef NS_ENUM(NSInteger, ByteRTCLocalVideoStreamState)

本地视频流状态

枚举值

ByteRTCLocalVideoStreamError

typedef NS_ENUM(NSInteger, ByteRTCLocalVideoStreamError)

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

枚举值

ByteRTCRemoteAudioState

typedef NS_ENUM(NSInteger, ByteRTCRemoteAudioState)

用户订阅的远端音频流状态。
SDK 通过 rtcEngine:onRemoteAudioStateChanged:state:reason: 回调该状态。

枚举值

ByteRTCRemoteAudioStateChangeReason

typedef NS_ENUM(NSInteger, ByteRTCRemoteAudioStateChangeReason)

接收远端音频流状态改变的原因。
用户可以通过 rtcEngine:onRemoteAudioStateChanged:state:reason: 了解该状态。

枚举值

ByteRTCRemoteVideoState

typedef NS_ENUM(NSInteger, ByteRTCRemoteVideoState)

远端视频流状态

枚举值

ByteRTCRemoteVideoStateChangeReason

typedef NS_ENUM(NSInteger, ByteRTCRemoteVideoStateChangeReason)

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

枚举值

ByteRTCMediaDeviceType

typedef NS_ENUM(NSInteger, ByteRTCMediaDeviceType)

当前媒体设备类型

枚举值

ByteRTCMediaDeviceState

typedef NS_ENUM(NSInteger, ByteRTCMediaDeviceState)

媒体设备状态

枚举值

ByteRTCMediaDeviceError

typedef NS_ENUM(NSInteger, ByteRTCMediaDeviceError)

媒体设备错误类型

枚举值

ByteRTCMediaDeviceWarning

typedef NS_ENUM(NSInteger, ByteRTCMediaDeviceWarning)

媒体设备警告

枚举值

ByteRTCProblemFeedbackOption

typedef NS_OPTIONS(NSUInteger, ByteRTCProblemFeedbackOption)

音视频质量反馈问题类型

枚举值

ByteRTCFirstFrameSendState

typedef NS_ENUM(NSUInteger, ByteRTCFirstFrameSendState)

首帧发送状态

枚举值

ByteRTCFirstFramePlayState

typedef NS_ENUM(NSUInteger, ByteRTCFirstFramePlayState)

首帧播放状态

枚举值

ByteRTCEncryptType

typedef NS_OPTIONS(NSUInteger, ByteRTCEncryptType)

自定义加密类型

枚举值

ByteRTCDataFrameType

typedef NS_ENUM(NSUInteger, ByteRTCDataFrameType)

数据类型

枚举值

ByteRTCVideoCanvas

@interface ByteRTCVideoCanvas : NSObject

画布信息和渲染模式。

成员变量

变量说明

view

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

本地视图句柄

renderMode

@property (assign, nonatomic) ByteRTCRenderMode renderMode;

渲染模式，参看 ByteRTCRenderMode

roomId

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

视图所在的房间 ID

uid

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

视图对应的用户 ID

ByteRTCFrameExtendedData

@interface ByteRTCFrameExtendedData : NSObject

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

成员变量

变量说明

frameType

@property (assign, nonatomic) ByteRTCDataFrameType frameType;

数据类型，详见 ByteRTCDataFrameType。

extendedData

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

附加数据

extendedDataLen

@property (assign, nonatomic) NSInteger extendedDataLen;

附加数据长度

ByteRTCVideoSolution

@interface ByteRTCVideoSolution: NSObject

视频流参数

成员变量

变量说明

videoSize

@property (nonatomic, assign) CGSize videoSize;

视频分辨率

frameRate

@property (nonatomic, assign) NSInteger frameRate;

视频预设帧率

maxKbps

@property (nonatomic, assign) NSInteger maxKbps;

最高编码码率（千比特每秒）
建议使用预估值。

mode

@property (nonatomic, assign) ByteRTCVideoStreamScaleMode mode;

视频帧缩放模式。你可以设置缩放以适应视窗，参见 ByteRTCVideoStreamScaleMode

encoderPreference

@property (nonatomic, assign) ByteRTCVideoEncoderPreference encoderPreference;

视频编码质量策略，参见 ByteRTCVideoEncoderPreference

ByteRTCVideoCapturePreference

typedef NS_ENUM(NSInteger, ByteRTCVideoCapturePreference)

视频采集模式

枚举值

ByteRTCVideoCaptureConfig

@interface ByteRTCVideoCaptureConfig: NSObject

视频采集参数

成员变量

变量说明

preference

@property(nonatomic, assign) ByteRTCVideoCapturePreference preference;

视频采集模式，参看 ByteRTCVideoCapturePreference

videoSize

@property (nonatomic, assign) CGSize videoSize;

视频采集分辨率

frameRate

@property (nonatomic, assign) NSInteger frameRate;

视频采集帧率，单位：fps。

ByteRTCStream

@protocol ByteRTCStream <NSObject>

流属性。

成员变量

变量说明

userId

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

发布此流的用户 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<ByteRTCVideoSolution *> * videoStreamDescriptions;

视频流的分辨率信息。
当远端用户调用 setVideoEncoderConfig:config: 方法发布多个配置的视频流时，此处会包含该用户发布的所有视频流的属性信息。
参看 ByteRTCVideoSolution。

ByteRTCSubscribeConfig

@interface ByteRTCSubscribeConfig: NSObject

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

成员变量

变量说明

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;

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

ByteRTCVideoFrameType

typedef NS_ENUM(NSInteger, ByteRTCVideoFrameType)

视频帧类型

枚举值

ByteRTCVideoPixelFormat

typedef NS_ENUM(NSInteger, ByteRTCVideoPixelFormat)

视频帧格式

枚举值

ByteRTCVideoSinkPixelFormat

typedef NS_ENUM(NSInteger, ByteRTCVideoSinkPixelFormat)

视频帧编码格式

枚举值

ByteRTCStreamMixingType

typedef NS_ENUM(NSUInteger, ByteRTCStreamMixingType)

枚举值

ByteRTCStreamMixingEvent

typedef NS_ENUM(NSUInteger, ByteRTCStreamMixingEvent)

枚举值

ByteRTCVideoFrame

@interface ByteRTCVideoFrame : NSObject

待 SDK 编码的视频数据

成员变量

变量说明

format

@property (assign, nonatomic) int format;

视频帧格式，参考 ByteRTCVideoPixelFormat

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) ByteRTCVideoRotation rotation;

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

extendedData

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

视频帧附加的数据

ByteRTCEncodedVideoFrame

@interface ByteRTCEncodedVideoFrame : NSObject

视频帧信息

成员变量

变量说明

codecType

@property (assign, nonatomic) ByteRTCVideoCodecType codecType;

视频编码类型。参看 ByteRTCVideoCodecType

pictureType

@property (assign, nonatomic) ByteRTCVideoPictureType pictureType;

视频帧类型。参看 ByteRTCVideoPictureType

timestampUs

@property (assign, nonatomic) SInt64 timestampUs;

视频采集时间戳，单位：微秒

timestampDtsUs

@property (assign, nonatomic) SInt64 timestampDtsUs;

视频编码时间戳，单位：微秒

width

@property (assign, nonatomic) int width;

视频帧宽，单位：px

height

@property (assign, nonatomic) int height;

视频帧高，单位：px

rotation

@property (nonatomic, assign) ByteRTCVideoRotation rotation;

视频帧旋转角度。参看 ByteRTCVideoRotation

data

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

视频帧数据指针地址

ByteRTCVideoCompositingRegion

@interface ByteRTCVideoCompositingRegion : NSObject

单个视频流在合流中的布局信息。
开启转推直播功能后，在多路视频流合流时，你可以设置其中一路视频流在合流中的预设布局信息。

成员变量

变量说明

uid

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

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

roomId

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

视频流发布用户的房间 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]。

localUser

@property (assign, nonatomic) BOOL localUser;

是否为本地用户

screenStream

@property (assign, nonatomic) BOOL screenStream;

是否为屏幕流，默认为NO

alpha

@property (assign, nonatomic) CGFloat alpha;

透明度。范围为 [0.0, 1.0]。

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;

画布的背景颜色。格式为 RGB 定义下的 Hex 值，如 #FFB6C1 表示浅粉色。默认值 #000000，表示为黑色

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;

视频编码格式。H264 编码格式或自定义编码格式

width

@property (assign, nonatomic) NSInteger width;

合流视频宽度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 640。

height

@property (assign, nonatomic) NSInteger height;

合流视频高度。单位为 px，范围为 [2, 1080]，必须是偶数。默认值为 480。

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;

是否使用低延时特性。

ByteRTCAACProfile

typedef NS_ENUM(NSInteger, ByteRTCAACProfile)

AAC 编码类型。

枚举值

ByteRTCTranscodingAudioConfig

@interface ByteRTCTranscodingAudioConfig : NSObject

音频转码配置参数。

成员变量

变量说明

codec

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

音频编码格式。使用 AAC 编码格式。

sampleRate

@property (assign, nonatomic) NSInteger sampleRate;

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

channels

@property (assign, nonatomic) NSInteger channels;

声道数，可取 1 或 2。

kBitRate

@property (assign, nonatomic) NSInteger kBitRate;

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

profile

@property (assign, nonatomic) ByteRTCAACProfile profile;

AAC 等级，详见 ByteRTCAACProfile

ByteRTCLiveTranscoding

@interface ByteRTCLiveTranscoding : NSObject

转推直播配置参数。

成员变量

静态函数

变量说明

expectedMixingType

@property (assign, nonatomic) ByteRTCStreamMixingType expectedMixingType;

合流类型，详见 ByteRTCStreamMixingType 数据类型。

layout

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

视频流合流整体布局信息。
开启转推直播功能后，你可以设置参与合流的每路视频流的预设布局信息和合流背景信息等。详见 ByteRTCVideoCompositingLayout 数据类型。

video

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

视频转码配置参数。详见 ByteRTCTranscodingVideoConfig 数据类型。

audio

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

音频转码配置参数。详见 ByteRTCTranscodingAudioConfig 数据类型。

authInfo

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

业务透传鉴权信息

url

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

推流 CDN 地址。

roomId

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

推流房间 ID。

userId

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

推流用户 ID。

函数说明

defaultTranscoding

+ (instancetype _Nonnull)defaultTranscoding;

获取默认合流参数。

ByteRTCUserInfo

@interface ByteRTCUserInfo : NSObject

用户信息。

成员变量

变量说明

userId

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

用户 ID。该字符串符合正则表达式：[a-zA-Z0-9_@\-]{1,128}。

extraInfo

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

用户需要透传的额外的信息，字符长度限制为 200 字节。会在 rtcEngine:onUserJoined:elapsed: 中回调给远端用户。

ByteRTCRoomConfig

@interface ByteRTCRoomConfig : NSObject

房间参数配置

成员变量

变量说明

profile

@property(nonatomic) ByteRTCRoomProfile profile;

房间模式，参看 ByteRTCRoomProfile，默认为普通音视频通话模式，进房后不可更改。

isAutoPublish

@property (assign, nonatomic) BOOL isAutoPublish;

是否自动发布音视频流，默认为自动发布。
若调用 setUserVisibility: 将自身可见性设为 false，无论是默认的自动发布流还是手动设置的自动发布流都不会进行发布，你需要将自身可见性设为 true 后方可发布。

isAutoSubscribeAudio

@property (assign, nonatomic) BOOL isAutoSubscribeAudio;

是否自动订阅音频流，默认为自动订阅。
进房后，你可以调用 subscribeUserStream:streamType:mediaType:videoConfig: 修改订阅设置。

isAutoSubscribeVideo

@property (assign, nonatomic) BOOL isAutoSubscribeVideo;

是否自动订阅主视频流，默认为自动订阅。
进房后，你可以调用 subscribeUserStream:streamType:mediaType:videoConfig: 修改订阅设置。
屏幕流始终自动订阅，不受该方法影响。

ByteRTCMultiRoomConfig

@interface ByteRTCMultiRoomConfig : NSObject

多房间参数配置

成员变量

变量说明

profile

@property(nonatomic) ByteRTCRoomProfile profile;

房间模式，参看 ByteRTCRoomProfile，默认为普通音视频通话模式，进房后不可更改。

isAutoSubscribeAudio

@property (assign, nonatomic) BOOL isAutoSubscribeAudio;

是否自动订阅音频流。
进房后，你可以调用 subscribeUserStream:streamType:mediaType:videoConfig: 修改订阅设置。

isAutoSubscribeVideo

@property (assign, nonatomic) BOOL isAutoSubscribeVideo;

是否自动订阅主视频流。
进房后，你可以调用 subscribeUserStream:streamType:mediaType:videoConfig: 修改订阅设置。
屏幕流始终自动订阅，不受该方法影响。

ByteRTCSubscribeVideoConfig

@interface ByteRTCSubscribeVideoConfig : NSObject

视频订阅配置信息

成员变量

变量说明

videoIndex

@property (assign, nonatomic) NSInteger videoIndex;

订阅的视频流分辨率下标。
当远端用户通过调用 setVideoEncoderConfig:config: 方法启动发布多路不同分辨率的视频流时，本地用户需通过此参数指定希望订阅的流。
默认值为 0，即订阅第一路流。
如果不想更改之前的设置，可以输入 -1。

priority

@property (assign, nonatomic) NSInteger priority;

远端用户优先级，参看 ByteRTCRemoteUserPriority，默认值为 0。

ByteRTCRoomStats

@interface ByteRTCRoomStats : NSObject

房间通话统计数据，统计周期为 2s 。
用户进房成功后，SDK 会周期性地通过 rtcEngine:onRoomStats: 通知用户当前房间内的汇总统计信息。此数据结构即为回调给用户的参数类型。

成员变量

变量说明

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;

当前房间内的用户人数，包括本地用户自身

rxLostrate

@property (assign, nonatomic) float rxLostrate;

App 现在的下行丢包率

txLostrate

@property (assign, nonatomic) float txLostrate;

App 现在的上行丢包率

rtt

@property (assign, nonatomic) NSInteger rtt;

客户端到服务端的往返时延

txJitter

@property (assign, nonatomic) NSInteger txJitter;

系统上行网络抖动（ms）

rxJitter

@property (assign, nonatomic) NSInteger rxJitter;

系统下行网络抖动（ms）

ByteRTCSysStats

@interface ByteRTCSysStats : NSObject

App 使用的 cpu 和 memory 信息
信息由 SDK 周期性（2s）地通过 rtcEngine:reportSysStats: 回调事件通知给用户。

成员变量

变量说明

cpu_cores

@property (assign, nonatomic) unsigned int cpu_cores;

当前系统 cpu 核数

cpu_app_usage

@property (assign, nonatomic) double cpu_app_usage;

当前应用的 CPU 使用率，取值范围为 [0, 1]。

cpu_total_usage

@property (assign, nonatomic) double cpu_total_usage;

当前系统的 CPU 使用率，取值范围为 [0, 1]。

memory_usage

@property (assign, nonatomic) double memory_usage;

当前App的内存使用（单位 MB）

full_memory

@property (assign, nonatomic) unsigned long long full_memory;

全量内存（单位字节）

total_memory_usage

@property (assign, nonatomic) unsigned long long total_memory_usage;

系统已使用内存（单位字节）

free_memory

@property (assign, nonatomic) unsigned long long free_memory;

空闲可分配内存（单位字节）

memory_ratio

@property (assign, nonatomic) double memory_ratio;

当前应用的内存使用率（单位 %）

total_memory_ratio

@property (assign, nonatomic) double total_memory_ratio;

系统内存使用率（单位 %）

ByteRTCLocalVideoStats

@interface ByteRTCLocalVideoStats : NSObject

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

成员变量

变量说明

sentKBitrate

@property (assign, nonatomic) float sentKBitrate;

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

inputFrameRate

@property (assign, nonatomic) NSInteger inputFrameRate;

采集帧率。此次统计周期内的视频采集帧率，单位为 fps 。

sentFrameRate

@property (assign, nonatomic) NSInteger sentFrameRate;

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

encoderOutputFrameRate

@property (assign, nonatomic) NSInteger encoderOutputFrameRate;

编码器输出帧率。当前编码器在此次统计周期内的输出帧率，单位为 fps 。

rendererOutputFrameRate

@property (assign, nonatomic) NSInteger rendererOutputFrameRate;

本地渲染帧率。此次统计周期内的本地视频渲染帧率，单位为 fps 。

sentTargetKBitrate

@property (assign, nonatomic) NSInteger sentTargetKBitrate;

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

sentTargetFrameRate

@property (assign, nonatomic) NSInteger sentTargetFrameRate;

目标发送帧率。当前编码器在此次统计周期内的目标发送帧率，单位为 fps 。

statsInterval

@property (assign, nonatomic) NSInteger statsInterval;

统计间隔，单位为 ms 。

注意: 此字段用于设置回调的统计周期，默认设置为 2s 。 此字段用于设置回调的统计周期，默认设置为 2s 。

videoLossRate

@property (assign, nonatomic) float videoLossRate;

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

rtt

@property (assign, nonatomic) NSInteger rtt;

往返时延。单位为 ms 。

encodedBitrate

@property(assign, nonatomic) NSInteger encodedBitrate;

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

encodedFrameWidth

@property(assign, nonatomic) NSInteger encodedFrameWidth;

视频编码宽度，单位为 px 。

encodedFrameHeight

@property(assign, nonatomic) NSInteger encodedFrameHeight;

视频编码高度，单位为 px 。

encodedFrameCount

@property(assign, nonatomic) NSInteger encodedFrameCount;

此次统计周期内发送的视频帧总数。

codecType

@property(nonatomic) ByteRTCVideoCodecType codecType;

编码类型。参看 ByteRTCVideoCodecType 类型。

isScreen

@property (assign, nonatomic) BOOL isScreen;

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

jitter

@property(assign, nonatomic) NSInteger jitter;

视频上行网络抖动，单位为 ms。

ByteRTCRemoteVideoStats

@interface ByteRTCRemoteVideoStats : NSObject

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

成员变量

变量说明

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 。

注意: 此字段用于设置回调的统计周期，目前设置为 2s 。 此字段用于设置回调的统计周期，目前设置为 2s 。

rtt

@property (assign, nonatomic) NSInteger rtt;

往返时延。单位为 ms 。

frozenRate

@property(assign, nonatomic) NSInteger frozenRate;

远端用户在进房后发生视频卡顿的累计时长占视频总有效时长的百分比（%）。视频有效时长是指远端用户进房发布视频流后，除停止发送视频流和禁用视频模块之外的视频时长。

videoIndex

@property (assign, nonatomic) NSInteger videoIndex;

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

jitter

@property(assign, nonatomic) NSInteger jitter;

视频下行网络抖动，单位为 ms。

ByteRTCLocalAudioStats

@interface ByteRTCLocalAudioStats : NSObject

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

成员变量

变量说明

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 。

注意: 此字段用于设置回调的统计周期，默认设置为 2s 。 此字段用于设置回调的统计周期，默认设置为 2s 。

rtt

@property (assign, nonatomic) NSInteger rtt;

往返时延。单位为 ms 。

numChannels

@property(assign, nonatomic) NSInteger numChannels;

音频声道数。

sentSampleRate

@property(assign, nonatomic) NSInteger sentSampleRate;

音频发送采样率。此次统计周期内的音频发送采样率信息，单位为 Hz 。

jitter

@property(assign, nonatomic) NSInteger jitter;

音频上行网络抖动，单位为 ms。

ByteRTCRemoteAudioStats

@interface ByteRTCRemoteAudioStats : NSObject

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

成员变量

变量说明

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。

total_rtt

@property (assign, nonatomic) NSInteger total_rtt;

发送端——服务端——接收端全链路数据传输往返时延。单位为 ms 。

quality

@property(assign, nonatomic) NSInteger quality;

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

jitterBufferDelay

@property(assign, nonatomic) NSInteger jitterBufferDelay;

因引入 jitter buffer 机制导致的延时。单位为 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 。

jitter

@property(assign, nonatomic) NSInteger jitter;

视频下行网络抖动，单位为 ms。

ByteRTCAudioVolumeInfo

@interface ByteRTCAudioVolumeInfo : NSObject

音频流来源的用户 ID, 及对应的音量。

成员变量

变量说明

uid

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

音频流来源的用户 ID

volume

@property (assign, nonatomic) NSUInteger volume;

音量，取值范围为：[0,255]

ByteRTCSourceWantedData

@interface ByteRTCSourceWantedData : NSObject

性能回退相关数据

成员变量

变量说明

width

@property (nonatomic, assign) NSInteger width;

推荐视频输入宽

height

@property (nonatomic, assign) NSInteger height;

推荐视频输入高

frameRate

@property (nonatomic, assign) NSInteger frameRate;

推荐视频输入帧率

ByteRTCRemoteStreamSwitchEvent

@interface ByteRTCRemoteStreamSwitchEvent : NSObject

流切换信息。本地用户订阅的远端流触发回退策略时的流切换信息。

成员变量

变量说明

uid

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

订阅的音视频流的发布者的用户 ID。

isScreen

@property (nonatomic, assign) BOOL isScreen;

流是否是屏幕流

beforeVideoIndex

@property (nonatomic, assign) NSInteger beforeVideoIndex;

流切换前订阅视频流的分辨率对应的索引

afterVideoIndex

@property (nonatomic, assign) NSInteger afterVideoIndex;

流切换后订阅视频流的分辨率对应的索引

beforeVideoEnabled

@property (nonatomic, assign) BOOL beforeVideoEnabled;

流切换前是否有视频流

afterVideoEnabled

@property (nonatomic, assign) BOOL afterVideoEnabled;

流切换后是否有视频流

reason

@property (nonatomic, assign) ByteRTCFallbackOrRecoverReason reason;

流切换原因，详见 ByteRTCFallbackOrRecoverReason。

ByteRTCVideoSinkDelegate

@protocol ByteRTCVideoSinkDelegate <NSObject>

自定义视频渲染器

成员函数

函数说明

renderPixelBuffer:rotation:extendedData:

- (void)renderPixelBuffer:(CVPixelBufferRef _Nonnull)pixelBuffer rotation:(ByteRTCVideoRotation)rotation extendedData:(NSData * _Nullable)extendedData;

输出视频的 PixelBuffer

传入参数

ByteRTCVideoPreprocessorConfig

@interface ByteRTCVideoPreprocessorConfig : NSObject

视频处理配置参数

成员变量

变量说明

required_pixel_format

@property (nonatomic, assign) ByteRTCVideoPixelFormat required_pixel_format;

视频帧的像素格式，参看 ByteRTCVideoPixelFormat。

ByteRTCStreamEx

@interface ByteRTCStreamEx : NSObject <ByteRTCStream>

流信息

成员变量

变量说明

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<ByteRTCVideoSolution *> *videoStreamDescriptions;

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

ByteRTCScreenCaptureParam

@interface ByteRTCScreenCaptureParam : 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;

是否采集鼠标

ByteRTCScreenParam

@interface ByteRTCScreenParam : 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;

元信息

ByteRTCLocalStreamStats

@interface ByteRTCLocalStreamStats : NSObject

本地音/视频流统计信息以及网络状况，统计周期为 2s 。
本地用户发布音/视频流成功后，SDK 会周期性地通过 rtcEngine:onLocalStreamStats: 通知本地用户发布的音/视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。

成员变量

变量说明

audio_stats

@property (strong, nonatomic) ByteRTCLocalAudioStats *_Nonnull audio_stats;

本地设备发送音频流的统计信息，详见 ByteRTCLocalAudioStats

video_stats

@property (strong, nonatomic) ByteRTCLocalVideoStats *_Nonnull video_stats;

本地设备发送视频流的统计信息，详见 ByteRTCLocalVideoStats

tx_quality

@property (assign, nonatomic) ByteRTCNetworkQuality tx_quality;

所属用户的媒体流上行网络质量，详见 ByteRTCNetworkQuality

rx_quality

@property (assign, nonatomic) ByteRTCNetworkQuality rx_quality;

所属用户的媒体流下行网络质量，详见 ByteRTCNetworkQuality

is_screen

@property (nonatomic, assign) BOOL is_screen;

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

ByteRTCRemoteStreamStats

@interface ByteRTCRemoteStreamStats : NSObject

用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s 。
订阅远端用户发布音/视频流成功后，SDK 会周期性地通过 rtcEngine:onRemoteStreamStats: 通知本地用户订阅的远端音/视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。

成员变量

变量说明

uid

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

用户 ID 。音频来源的用户 ID 。

audio_stats

@property (strong, nonatomic) ByteRTCRemoteAudioStats *_Nonnull audio_stats;

远端音频流的统计信息，详见 ByteRTCRemoteAudioStats

video_stats

@property (strong, nonatomic) ByteRTCRemoteVideoStats *_Nonnull video_stats;

远端视频流的统计信息，详见 ByteRTCRemoteVideoStats

tx_quality

@property (assign, nonatomic) ByteRTCNetworkQuality tx_quality;

所属用户的媒体流上行网络质量，详见 ByteRTCNetworkQuality

rx_quality

@property (assign, nonatomic) ByteRTCNetworkQuality rx_quality;

所属用户的媒体流下行网络质量，详见 ByteRTCNetworkQuality

is_screen

@property (nonatomic, assign) BOOL is_screen;

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

ByteRTCMuteState

typedef NS_ENUM(NSInteger, ByteRTCMuteState)

音视频流的发送/播放状态

枚举值

ByteRTCSubscribeMediaType

typedef NS_ENUM(NSInteger, ByteRTCSubscribeMediaType)

订阅媒体的类型

枚举值

ByteRTCPauseResumControlMediaType

typedef NS_ENUM(NSInteger, ByteRTCPauseResumControlMediaType)

暂停/恢复接收远端的媒体流类型。

枚举值

ByteRTCStreamIndex

typedef NS_ENUM(NSInteger, ByteRTCStreamIndex)

流属性

枚举值

ByteRTCVideoSourceType

typedef NS_ENUM(NSInteger, ByteRTCVideoSourceType)

视频输入源类型

枚举值

ByteRTCVideoDecoderConfig

typedef NS_ENUM(NSInteger, ByteRTCVideoDecoderConfig)

视频解码方式

枚举值

ByteRTCRemoteStreamKey

@interface ByteRTCRemoteStreamKey : NSObject

用户信息

成员变量

变量说明

userId

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

用户 ID

roomId

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

房间 ID

streamIndex

@property (nonatomic, assign) ByteRTCStreamIndex streamIndex;

流属性，包括主流、屏幕流。参看 ByteRTCStreamIndex

ByteRTCVirtualBackgroundSourceType

typedef NS_ENUM(NSInteger, ByteRTCVirtualBackgroundSourceType)

虚拟背景类型。

枚举值

ByteRTCVirtualBackgroundSource

@interface ByteRTCVirtualBackgroundSource: NSObject

虚拟背景对象。

成员变量

变量说明

sourceType

@property (nonatomic, assign) ByteRTCVirtualBackgroundSourceType sourceType;

虚拟背景类型，详见 ByteRTCVirtualBackgroundSourceType 。

sourceColor

@property int sourceColor;

纯色背景使用的颜色。
格式为 0xAARRGGBB 。

sourcePath

@property (nonatomic) NSString* sourcePath;

自定义图片背景使用的图片的绝对路径。

注意:

• 支持的格式为 jpg、jpeg、和 png。

• 分辨率超过 1080P 时，图片会被等比缩放。背景图片和视频分辨率不一致时，图片会被裁剪缩放。

• 支持的格式为 jpg、jpeg、和 png。

• 分辨率超过 1080P 时，图片会被等比缩放。背景图片和视频分辨率不一致时，图片会被裁剪缩放。

ByteRTCAudioSampleRate

typedef NS_ENUM(NSInteger, ByteRTCAudioSampleRate)

音频采样率，单位为 Hz。

枚举值

ByteRTCAudioChannel

typedef NS_ENUM(NSInteger, ByteRTCAudioChannel)

音频声道。

枚举值

ByteRTCAudioPlaybackDevice

typedef NS_ENUM(NSInteger, ByteRTCAudioPlaybackDevice)

音频播放设备
音频设备变化时 SDK 通过 rtcEngine:onAudioPlaybackDeviceChanged: 回调当前音频播放设备。

枚举值

ByteRTCAudioFormat

@interface ByteRTCAudioFormat : NSObject

音频参数格式

成员变量

变量说明

sampleRate

@property (nonatomic, assign) ByteRTCAudioSampleRate sampleRate;

音频采样率，详见 ByteRTCAudioSampleRate

channel

@property (nonatomic, assign) ByteRTCAudioChannel channel;

音频声道，详见 ByteRTCAudioChannel

ByteRTCAudioFrame

@interface ByteRTCAudioFrame : NSObject

PCM 音频帧

成员变量

变量说明

buffer

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

PCM 数据

samples

@property (assign, nonatomic) int samples;

采样点个数

channel

@property (assign, nonatomic) ByteRTCAudioChannel channel;

音频声道，参看 ByteRTCAudioChannel。

sampleRate

@property (assign, nonatomic) ByteRTCAudioSampleRate sampleRate;

采样率，参看 ByteRTCAudioSampleRate。

ByteRTCVideoFrameInfo

@interface ByteRTCVideoFrameInfo : NSObject

视频帧基础信息

成员变量

变量说明

width

@property (nonatomic, assign) NSInteger width;

视频帧的宽度（像素）

height

@property (nonatomic, assign) NSInteger height;

视频帧的高度（像素）

rotation

@property (nonatomic, assign) ByteRTCVideoRotation rotation;

视频帧顺时针旋转角度。参看 ByteRTCVideoRotation。

ByteRTCCameraID

typedef NS_ENUM(NSInteger, ByteRTCCameraID)

移动端摄像头

枚举值

ByteRTCASRAuthorizationType

typedef NS_ENUM(NSInteger, ByteRTCASRAuthorizationType)

语音识别服务鉴权方式，详情请咨询语音识别服务服务相关同学

枚举值

ByteRTCASRErrorCode

typedef NS_ENUM(NSInteger, ByteRTCASRErrorCode)

语音识别服务错误码。
除网络原因导致的错误，语音识别服务内部会自行重试之外，其他错误都会停止服务，此时建议再次调用 startASR:handler: 重启语音识别功能。

枚举值

ByteRTCASRConfig

@interface ByteRTCASRConfig : NSObject

使用自动语音识别服务所需校验信息

成员变量

变量说明

appId

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

应用 ID

userId

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

用户 ID

accessToken

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

访问令牌

secretKey

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

私钥。Signature 鉴权模式下不能为空，token 鉴权模式下为空。参看关于鉴权

cluster

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

场景信息，参看业务集群

authorizationType

@property (assign, nonatomic) ByteRTCASRAuthorizationType authorizationType;

鉴权模式，参看 ByteRTCASRAuthorizationType

ByteRTCRecordingState

typedef NS_ENUM(NSInteger, ByteRTCRecordingState)

本地录制的状态

枚举值

ByteRTCRecordingErrorCode

typedef NS_ENUM(NSInteger, ByteRTCRecordingErrorCode)

本地录制错误码

枚举值

ByteRTCRecordingFileType

typedef NS_ENUM(NSInteger, ByteRTCRecordingFileType)

本地录制文件的存储格式

枚举值

ByteRTCRecordingType

typedef NS_ENUM(NSInteger, ByteRTCRecordingType)

本地录制的媒体类型

枚举值

ByteRTCRecordingProgress

@interface ByteRTCRecordingProgress : NSObject

本地录制进度

成员变量

变量说明

duration

@property (assign, nonatomic) unsigned long long duration;

当前文件的累计录制时长，单位：毫秒

fileSize

@property (assign, nonatomic) unsigned long long fileSize;

当前录制文件的大小，单位：byte

ByteRTCRecordingInfo

@interface ByteRTCRecordingInfo : NSObject

本地录制的详细信息

成员变量

变量说明

filePath

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

录制文件的绝对路径，包含文件名和文件后缀

codecType

@property (assign, nonatomic) ByteRTCVideoCodecType codecType;

录制文件的视频编码类型，参看 ByteRTCVideoCodecType

width

@property (nonatomic, assign) NSInteger width;

录制视频的宽，单位：像素。纯音频录制请忽略该字段

height

@property (nonatomic, assign) NSInteger height;

录制视频的高，单位：像素。纯音频录制请忽略该字段

ByteRTCRecordingConfig

@interface ByteRTCRecordingConfig : NSObject

本地录制参数配置

成员变量

变量说明

dirPath

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

录制文件保存的绝对路径。你需要指定一个有读写权限的合法路径。

recordingFileType

@property (assign, nonatomic) ByteRTCRecordingFileType recordingFileType;

录制存储文件格式，参看 ByteRTCRecordingFileType

recordingType

@property (assign, nonatomic) ByteRTCRecordingType recordingType;

录制媒体类型，参看 ByteRTCRecordingType

ByteRTCAudioMixingType

typedef NS_ENUM(NSInteger, ByteRTCAudioMixingType)

混音播放类型

枚举值

ByteRTCAudioMixingDualMonoMode

typedef NS_ENUM(NSInteger, ByteRTCAudioMixingDualMonoMode)

混音播放声道类型

枚举值

ByteRTCAudioMixingState

typedef NS_ENUM(NSInteger, ByteRTCAudioMixingState)

音频混音文件播放状态。

枚举值

ByteRTCAudioMixingError

typedef NS_ENUM(NSInteger, ByteRTCAudioMixingError)

音频混音文件播放错误码。

枚举值

ByteRTCAudioSourceType

typedef NS_ENUM(NSInteger, ByteRTCAudioSourceType)

音频输入源类型

枚举值

ByteRTCEarMonitorMode

typedef NS_ENUM(NSInteger, ByteRTCEarMonitorMode)

开启/关闭耳返功能

枚举值

ByteRTCAudioMixingConfig

@interface ByteRTCAudioMixingConfig : NSObject

混音配置

成员变量

变量说明

type

@property (assign, nonatomic) ByteRTCAudioMixingType type;

混音播放类型，详见 ByteRTCAudioMixingType

playCount

@property (assign, nonatomic) NSInteger playCount;

混音播放次数

注意:

• play_count <= 0: 无限循环
• play_count == 1: 播放一次（默认）

• play_count > 1: 播放 play_count 次

• play_count <= 0: 无限循环

• play_count == 1: 播放一次（默认）
• play_count > 1: 播放 play_count 次

position

@property (assign, nonatomic) NSInteger position;

混音时音频文件播放进度条位置，参数为整数，单位为毫秒

callbackOnProgressInterval

@property (assign, nonatomic) NSInteger callbackOnProgressInterval;

设置音频文件播放进度回调的时间间隔，单位毫秒，并按照设置的值触发 rtcEngine:onAudioMixingPlayingProgress:progress: 回调，默认不回调。

• 该值应为大于 0 的 10 的倍数，当传入的值不能被 10 整除时，则默认向上取整 10，如设为 52ms 时会默认调整为 60ms。
  
• 传入的值小于等于 0 时，不会触发进度回调。
  

ByteRTCAudioPropertiesConfig

@interface ByteRTCAudioPropertiesConfig : NSObject

音频属性信息提示的相关配置

成员变量

变量说明

interval

@property (assign, nonatomic) NSInteger interval;

信息提示间隔，单位：ms

注意:

• <= 0: 关闭信息提示

• 0 && <=100: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms

• 100: 开启信息提示，并将信息提示间隔设置为此值

• <= 0: 关闭信息提示

• 0 && <=100: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms

• 100: 开启信息提示，并将信息提示间隔设置为此值

enable_spectrum

@property (assign, nonatomic) BOOL enable_spectrum;

是否开启音频频谱检测

enable_vad

@property (assign, nonatomic) BOOL enable_vad;

是否开启人声检测 (VAD)

ByteRTCAudioPropertiesInfo

@interface ByteRTCAudioPropertiesInfo : NSObject

音频属性信息

成员变量

变量说明

volume

@property (assign, nonatomic) NSInteger volume;

音量，取值范围为：[0,255]

vad

@property (assign, nonatomic) NSInteger vad;

人声检测（VAD）结果

注意:

• 1: 检测到人声。
• 0: 未检测到人声。

• -1: 未开启 VAD。

• 1: 检测到人声。

• 0: 未检测到人声。
• -1: 未开启 VAD。

spectrum

@property (copy, nonatomic) NSArray<NSNumber*> * _Nonnull spectrum;

频谱数组。默认长度为 257。

ByteRTCLocalAudioPropertiesInfo

@interface ByteRTCLocalAudioPropertiesInfo : NSObject

本地音频属性信息

成员变量

变量说明

streamIndex

@property (assign, nonatomic) ByteRTCStreamIndex streamIndex;

流属性，包括主流、屏幕流。参看 ByteRTCStreamIndex

audioPropertiesInfo

@property (strong, nonatomic) ByteRTCAudioPropertiesInfo *_Nonnull audioPropertiesInfo;

音频属性信息，详见 ByteRTCAudioPropertiesInfo

ByteRTCRemoteAudioPropertiesInfo

@interface ByteRTCRemoteAudioPropertiesInfo : NSObject

远端音频属性信息

成员变量

变量说明

streamKey

@property (strong, nonatomic) ByteRTCRemoteStreamKey *_Nonnull streamKey;

远端流信息，详见 ByteRTCRemoteStreamKey

audioPropertiesInfo

@property (strong, nonatomic) ByteRTCAudioPropertiesInfo *_Nonnull audioPropertiesInfo;

音频属性信息，详见 ByteRTCAudioPropertiesInfo

ReceiveRange

@interface ReceiveRange : NSObject

使用范围语音功能时，语音的接收范围

成员变量

变量说明

min

@property (nonatomic, assign) int min;

收听声音无衰减的最小范围值。
当收听者和声源距离小于 min 的时候，收听到的声音完全无衰减。

max

@property (nonatomic, assign) int max;

能够收听到声音的最大范围。
当收听者和声源距离大于 max 的时候，无法收听到声音。
当收听者和声源距离处于 [min, max) 之间时，收听到的音量根据距离有衰减。

Position

@interface Position : NSObject

用户的位置信息

成员变量

变量说明

x

@property (nonatomic, assign) int x;

x 坐标

y

@property (nonatomic, assign) int y;

y 坐标

z

@property (nonatomic, assign) int z;

z 坐标

Orientation

@interface Orientation : NSObject

方向朝向信息

成员变量

变量说明

x

@property (nonatomic, assign) float x;

x 方向向量

y

@property (nonatomic, assign) float y;

y 方向向量

z

@property (nonatomic, assign) float z;

z 方向向量

HumanOrientation

@interface HumanOrientation : NSObject

用户的三维方向朝向信息，三个向量需要两两垂直

成员变量

变量说明

forward

@property (nonatomic, strong) Orientation* _Nonnull forward;

正前方朝向向量

right

@property (nonatomic, strong) Orientation* _Nonnull right;

正右方朝向向量

up

@property (nonatomic, strong) Orientation* _Nonnull up;

正上方朝向向量

ByteRTCSyncInfoStreamType

typedef NS_ENUM(NSInteger, ByteRTCSyncInfoStreamType)

媒体流信息同步的流类型

枚举值

ByteRTCTorchState

typedef NS_ENUM(NSInteger, ByteRTCTorchState)

相机补光灯状态

枚举值

ByteRTCStreamSycnInfoConfig

@interface ByteRTCStreamSycnInfoConfig : NSObject

媒体流信息同步的相关配置

成员变量

变量说明

streamIndex

@property (assign, nonatomic) ByteRTCStreamIndex streamIndex;

流属性，主流或屏幕流。见 ByteRTCStreamIndex 。

repeatCount

@property (assign, nonatomic) int repeatCount;

消息发送的重复次数，取值范围是 [0,25]，建议设置为 [3,5]。

streamType

@property (assign, nonatomic) ByteRTCSyncInfoStreamType streamType;

媒体流信息同步的流类型，见 ByteRTCSyncInfoStreamType 。

ByteRTCForwardStreamState

typedef NS_ENUM(NSInteger, ByteRTCForwardStreamState)

媒体流跨房间转发状态

枚举值

ByteRTCForwardStreamError

typedef NS_ENUM(NSInteger, ByteRTCForwardStreamError)

媒体流跨房间转发过程中抛出的错误码

枚举值

ByteRTCForwardStreamEvent

typedef NS_ENUM(NSInteger, ByteRTCForwardStreamEvent)

媒体流跨房间转发事件

枚举值

ForwardStreamConfiguration

@interface ForwardStreamConfiguration: NSObject

媒体流跨房间转发的目标房间的相关信息

成员变量

变量说明

roomId

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

跨间转发媒体流过程中目标房间 ID

token

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

用于向该房间转发媒体流的 Token。
如果 Token 无效，转发失败。

ForwardStreamStateInfo

@interface ForwardStreamStateInfo: NSObject

跨房间转发媒体流过程中的不同目标房间的状态和错误信息

成员变量

变量说明

roomId

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

跨房间转发媒体流过程中目标房间 ID
空字符串代表所有目标房间

state

@property (assign, nonatomic) ByteRTCForwardStreamState state;

跨房间转发媒体流过程中该目标房间的状态，参看 ByteRTCForwardStreamState

error

@property (assign, nonatomic) ByteRTCForwardStreamError error;

跨房间转发媒体流过程中该目标房间抛出的错误码，参看 ByteRTCForwardStreamError

ForwardStreamEventInfo

@interface ForwardStreamEventInfo: NSObject

跨房间转发媒体流过程中的不同目标房间发生的事件

成员变量

变量说明

roomId

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

跨房间转发媒体流过程中的发生该事件的目标房间 ID
空字符串代表所有目标房间

event

@property (assign, nonatomic) ByteRTCForwardStreamEvent event;

跨房间转发媒体流过程中该目标房间发生的事件，参看 ByteRTCForwardStreamEvent

ByteRTCAudioProcessor

@protocol ByteRTCAudioProcessor <NSObject>

自定义音频处理器

成员函数

函数说明

processAudioFrame:

- (int)processAudioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;

获取 RTC SDK 采集得到的音频帧，并进行自定义处理，最终将处理后的音频帧给到 RTC SDK 用于编码传输。

传入参数

返回值

0: 未处理
>0: 处理成功
< 0: 处理失败

注意 在进行音频自定义处理前，你需要调用 registerLocalAudioProcessor:format: 设置音频自定义处理器。

ByteRTCASREngineEventHandler

@protocol ByteRTCASREngineEventHandler<NSObject>

语音识别服务使用状态回调

成员函数

函数说明

onSuccess

- (void)onSuccess;

语音识别服务开启成功回调

onMessage:

- (void)onMessage:(NSString *_Nonnull)message;

语音转文字成功回调，该回调返回识别后的全量消息。

传入参数

注意 若识别过程中发生了网络连接中断，则重连后回调的信息中只包含重连后识别的文字消息，不再包含上一次连接后识别的消息。

onError:withErrorMessage:

- (void)onError:(NSInteger)errorCode withErrorMessage:(NSString *_Nonnull)errorMessage;

当语音识别服务内部发生错误事件时触发该回调。

传入参数

ByteRtcScreenCapturerExtDelegate

@protocol ByteRtcScreenCapturerExtDelegate <NSObject>

Screen capture related extension delegate, used for SDK internal capture only.
The SampleHandler generated after the user creates the extesion needs to inherit this delegate to implement screen sharing related capabilities.

成员函数

函数说明

quit

- (void)quit;

Notify Broadcast Upload Extension to stop capturing and exit.

注意 After the user calls stopScreenSharing, this method will be triggered to notify the SDK on the Extension side to stop the screen capture.

onReceiveMessageFromApp:

- (void)onReceiveMessageFromApp:(NSData *)message;

The callback is triggered when the socket receives a message from the App side

传入参数

onSocketDesconnect

- (void)onSocketDesconnect;

This callback is triggered when the socket is disconnected

onSocketConnect

- (void)onSocketConnect;

This callback is triggered when the socket is successfully connected

onNotifyAppRunning

- (void)onNotifyAppRunning;

This callback is triggered when the App is detected to be making an audio/video call.

ByteRtcScreenCapturerExt

@interface ByteRtcScreenCapturerExt : NSObject

Screen capture related extension examples, for SDK internal capture only.
The SampleHandler generated by the user after creating the extesion needs to implement screen sharing related capabilities through this instance.

成员函数

函数说明

startWithDelegate:groupId:

- (void)startWithDelegate:(NSObject<ByteRtcScreenCapturerExtDelegate> *)delegate groupId:(NSString *)groupId;

Start screen capture
After the Extension is started, the system will automatically call this method to enable screen capture.

传入参数

stop

- (void)stop;

Stop screen capture
After the Extension is closed, the system will automatically call this method to stop screen capture.

processSampleBuffer:withType:

- (void)processSampleBuffer:(CMSampleBufferRef)sampleBuffer withType:(RPSampleBufferType)sampleBufferType;

Push data captured by Extension

传入参数