# ByteRTCASRAuthorizationType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCASRAuthorizationType ) ``` 语音识别服务鉴权方式，详情请咨询语音识别服务相关人员 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCASRAuthorizationTypeToken | 0 | 使用 token 不设置加密形式。 | | ByteRTCASRAuthorizationTypeSignature | 1 | 带有 token 额外使用 signature 加密，此种加密形式需要额外传递 secret token 。 | # ByteRTCLiveTranscoding ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCLiveTranscoding : NSObject ``` > Deprecated since 3.52, use [ByteRTCMixedStreamConfig](#ByteRTCMixedStreamConfig) instead. 转推直播配置参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCStreamMixingType | [expectedMixingType](#ByteRTCLiveTranscoding-expectedmixingtype) | | ByteRTCVideoCompositingLayout* | [layout](#ByteRTCLiveTranscoding-layout) | | ByteRTCTranscodingVideoConfig* | [video](#ByteRTCLiveTranscoding-video) | | ByteRTCTranscodingAudioConfig* | [audio](#ByteRTCLiveTranscoding-audio) | | ByteRTCTranscodingClientMixParam*_Nullable | [clientMixParam](#ByteRTCLiveTranscoding-clientmixparam) | | NSString*_Nullable | [url](#ByteRTCLiveTranscoding-url) | | NSString* | [roomId](#ByteRTCLiveTranscoding-roomid) | | NSString* | [userId](#ByteRTCLiveTranscoding-userid) | ## 静态函数 | 返回 | 名称 | | --- | --- | | instancetype | [defaultTranscoding](#ByteRTCLiveTranscoding-defaulttranscoding) | ## 变量说明 ### expectedMixingType ```objectivec @property(assign, nonatomic) ByteRTCStreamMixingType expectedMixingType; ``` 合流类型，详见 [ByteRTCStreamMixingType](#ByteRTCStreamMixingType) 数据类型。本参数不支持过程中更新。 ### layout ```objectivec @property(strong, nonatomic) ByteRTCVideoCompositingLayout * _Nonnull layout; ``` 视频流合流整体布局信息。开启转推直播功能后，你可以设置参与合流的每路视频流的预设布局信息和合流背景信息等。详见 [ByteRTCVideoCompositingLayout](#ByteRTCVideoCompositingLayout) 数据类型。 ### video ```objectivec @property(strong, nonatomic) ByteRTCTranscodingVideoConfig * _Nonnull video; ``` 视频转码配置参数。详见 [ByteRTCTranscodingVideoConfig](#ByteRTCTranscodingVideoConfig) 数据类型。 ### audio ```objectivec @property(strong, nonatomic) ByteRTCTranscodingAudioConfig * _Nonnull audio; ``` 音频转码配置参数，参看 [ByteRTCTranscodingAudioConfig](#ByteRTCTranscodingAudioConfig)。 ### clientMixParam ```objectivec @property(strong, nonatomic) ByteRTCTranscodingClientMixParam * _Nullable clientMixParam; ``` 客户端合流配置。详见 [ByteRTCTranscodingClientMixParam](#ByteRTCTranscodingClientMixParam) 。 ### url ```objectivec @property(copy, nonatomic) NSString * _Nullable url; ``` 推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 `/^rtmps?:\/\//`。本参数不支持过程中更新。 ### roomId ```objectivec @property(copy, nonatomic) NSString * _Nonnull roomId; ``` 推流房间 ID。`roomId` 和 `userId` 长度相加不得超过 126 字节。本参数不支持过程中更新。 ### userId ```objectivec @property(copy, nonatomic) NSString * _Nonnull userId; ``` 推流用户 ID。`roomId` 和 `userId` 长度相加不得超过 126 字节。本参数不支持过程中更新。 ## 函数说明 ### defaultTranscoding ```objectivec + (instancetype _Nonnull)defaultTranscoding; ``` 获取默认转推直播配置参数。 **返回值** 转推直播配置参数，参看 [ByteRTCLiveTranscoding](#ByteRTCLiveTranscoding)。 # ByteRTCAudioEffectPlayerConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCAudioEffectPlayerConfig : NSObject ``` 混音配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCAudioMixingType | [type](#ByteRTCAudioEffectPlayerConfig-type) | | NSInteger | [pitch](#ByteRTCAudioEffectPlayerConfig-pitch) | | NSInteger | [playCount](#ByteRTCAudioEffectPlayerConfig-playcount) | | NSInteger | [startPos](#ByteRTCAudioEffectPlayerConfig-startpos) | ## 变量说明 ### type ```objectivec @property(assign, nonatomic) ByteRTCAudioMixingType type; ``` 混音播放类型，详见 [ByteRTCAudioMixingType](#ByteRTCAudioMixingType) ### pitch ```objectivec @property(assign, nonatomic) NSInteger pitch; ``` 与音乐文件原始音调相比的升高/降低值，取值范围为 `[-12，12]`，默认值为 0。每相邻两个值的音高距离相差半音，正值表示升调，负值表示降调。 ### playCount ```objectivec @property(assign, nonatomic) NSInteger playCount; ``` 混音播放次数 - play_count <= 0: 无限循环 - play_count == 1: 播放一次（默认） - play_count \> 1: 播放 play_count 次 ### startPos ```objectivec @property(assign, nonatomic) NSInteger startPos; ``` 混音起始位置。默认值为 0，单位为毫秒。 # ByteRTCRecordingInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRecordingInfo : NSObject ``` 本地录制的详细信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString*_Nullable | [filePath](#ByteRTCRecordingInfo-filepath) | | ByteRTCVideoCodecType | [codecType](#ByteRTCRecordingInfo-codectype) | | NSInteger | [width](#ByteRTCRecordingInfo-width) | | NSInteger | [height](#ByteRTCRecordingInfo-height) | ## 变量说明 ### filePath ```objectivec @property(strong, nonatomic) NSString* _Nullable filePath; ``` 录制文件的绝对路径，包含文件名和文件后缀 ### codecType ```objectivec @property(assign, nonatomic) ByteRTCVideoCodecType codecType; ``` 录制文件的视频编码类型，参看 [ByteRTCVideoCodecType](#ByteRTCVideoCodecType) ### width ```objectivec @property(nonatomic, assign) NSInteger width; ``` 录制视频的宽，单位：像素。纯音频录制请忽略该字段 ### height ```objectivec @property(nonatomic, assign) NSInteger height; ``` 录制视频的高，单位：像素。纯音频录制请忽略该字段 # ByteRTCSubscribeConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCSubscribeConfig: NSObject ``` 订阅流的参数配置。用户手动订阅一路音视频流所使用的订阅配置参数。用户关闭自动订阅功能，使用手动订阅模式时，通过调用 `subscribeStream` 方法订阅音视频流，调用时传入的参数即为此数据类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [isScreen](#ByteRTCSubscribeConfig-isscreen) | | BOOL | [subscribeVideo](#ByteRTCSubscribeConfig-subscribevideo) | | BOOL | [subscribeAudio](#ByteRTCSubscribeConfig-subscribeaudio) | | NSInteger | [videoIndex](#ByteRTCSubscribeConfig-videoindex) | | NSInteger | [svcLayer](#ByteRTCSubscribeConfig-svclayer) | | NSInteger | [width](#ByteRTCSubscribeConfig-width) | | NSInteger | [height](#ByteRTCSubscribeConfig-height) | | NSInteger | [framerate](#ByteRTCSubscribeConfig-framerate) | ## 变量说明 ### isScreen ```objectivec @property(nonatomic, assign) BOOL isScreen; ``` 是否是屏幕流。用户通过设置此参数，订阅该远端用户发布的屏幕共享流或非屏幕共享流。 YES 为订阅屏幕共享流，NO 为订阅非屏幕共享流，默认值为 YES 。 ### subscribeVideo ```objectivec @property(nonatomic, assign) BOOL subscribeVideo; ``` 是否订阅视频。用户通过设置此参数，选择是否订阅远端流中的视频。 YES 为订阅视频，NO 为不订阅视频，默认值为 YES 。 ### subscribeAudio ```objectivec @property(nonatomic, assign) BOOL subscribeAudio; ``` 是否订阅音频。用户通过设置此参数，选择是否订阅远端流中的音频。YES 为订阅音频，NO 为不订阅音频，默认值为 YES 。 ### videoIndex ```objectivec @property(nonatomic, assign) NSInteger videoIndex; ``` 订阅的视频流分辨率下标。用户可以通过调用 [setVideoEncoderConfig:](70092#ByteRTCVideo-setvideoencoderconfig) 方法发布多个不同分辨率的视频。因此订阅流时，需要指定订阅的具体分辨率。此参数即用于指定需订阅的分辨率的下标，默认值为 0 。 ### svcLayer ```objectivec @property(nonatomic, assign) NSInteger svcLayer; ``` 订阅的视频流时域分层，默认值为 0。 ### width ```objectivec @property(nonatomic, assign) NSInteger width; ``` 订阅的宽度信息，单位：px，默认值为 0。 ### height ```objectivec @property(nonatomic, assign) NSInteger height; ``` 订阅的高度信息，单位：px，默认值为 0。 ### framerate ```objectivec @property (nonatomic, assign) NSInteger framerate; ``` 期望订阅的最高帧率，单位：fps，默认值为 0，设为大于 0 的值时开始生效。如果发布端发布帧率 > 订阅端订阅的帧率，下行媒体服务器 SVC 丢帧，订阅端收到通过此接口设置的帧率；如果发布端发布帧率 < 订阅端订阅的帧率，则订阅端只能收到发布的帧率仅码流支持 SVC 分级编码特性时方可生效。 # ByteRTCUserInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCUserInfo : NSObject ``` 用户信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [userId](#ByteRTCUserInfo-userid) | | NSString* | [extraInfo](#ByteRTCUserInfo-extrainfo) | ## 变量说明 ### userId ```objectivec @property(copy, nonatomic) NSString *_Nonnull userId; ``` 用户 ID。该字符串符合正则表达式：`[a-zA-Z0-9_@-.]{1,128}`。 ### extraInfo ```objectivec @property(copy, nonatomic) NSString *_Nonnull extraInfo; ``` 用户需要透传的额外的信息，字符长度限制为 200 字节。会在 `rtcEngine:onUserJoined:elapsed:` 中回调给远端用户。 # ByteRTCAudioPlaybackDevice ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioPlaybackDevice ) ``` 音频播放设备音频设备变化时 SDK 通过 `rtcEngine:onAudioPlaybackDeviceChanged:` 回调当前音频播放设备。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioPlaybackDeviceHeadset | 1 | 有线耳机 | | ByteRTCAudioPlaybackDeviceEarpiece | 2 | 听筒 | | ByteRTCAudioPlaybackDeviceSpeakerphone | 3 | 扬声器 | | ByteRTCAudioPlaybackDeviceHeadsetBluetooth | 4 | 蓝牙耳机 | | ByteRTCAudioPlaybackDeviceHeadsetUSB | 5 | USB 设备 | # ByteRTCMessageConfig ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMessageConfig ) ``` 发送消息的可靠有序类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMessageConfigReliableOrdered | 0 | 低延时可靠有序消息 | | ByteRTCMessageConfigUnreliableOrdered | 1 | 超低延时有序消息 | | ByteRTCMessageConfigUnreliableUnordered | 2 | 超低延时无序消息 | # ByteRTCVideoSinkDelegate ```objectivec BYTERTC_APPLE_EXPORT @protocol ByteRTCVideoSinkDelegate ``` 自定义视频渲染器 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onFrame:](#ByteRTCVideoSinkDelegate-onframe) | | void | [deprecated] [renderPixelBuffer:rotation:contentType:extendedData:](#ByteRTCVideoSinkDelegate-renderpixelbuffer-rotation-contenttype-extendeddata) | ## 函数说明 ### onFrame: ```objectivec - (void)onFrame:(ByteRTCVideoFrame * _Nonnull)videoFrame; ``` 输出视频的 PixelBuffer **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoFrame | ByteRTCVideoFrame * | 视频帧 | ### renderPixelBuffer:rotation:contentType:extendedData: ```objectivec - (void)renderPixelBuffer:(CVPixelBufferRef _Nonnull)pixelBuffer rotation:(ByteRTCVideoRotation)rotation contentType:(ByteRTCVideoContentType)contentType extendedData:(NSData * _Nullable)extendedData; ``` > Deprecated since 3.54, use onFrame: instead 输出视频的 PixelBuffer **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | pixelBuffer | CVPixelBufferRef | 视频的 PixelBuffer | | rotation | ByteRTCVideoRotation | 视频旋转角度，参看 [ByteRTCVideoRotation](#ByteRTCVideoRotation) | | contentType | ByteRTCVideoContentType | 视频内部类型参看 [ByteRTCVideoContentType](#ByteRTCVideoContentType) | | extendedData | NSData *_Nullable | 视频解码后获得的附加数据 | # ByteRTCMixedStreamConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMixedStreamConfig : NSObject ``` 转推直播配置参数。(新) ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCMixedStreamType | [expectedMixingType](#ByteRTCMixedStreamConfig-expectedmixingtype) | | ByteRTCMixedStreamLayoutConfig* | [layoutConfig](#ByteRTCMixedStreamConfig-layoutconfig) | | ByteRTCMixedStreamVideoConfig* | [videoConfig](#ByteRTCMixedStreamConfig-videoconfig) | | ByteRTCMixedStreamAudioConfig* | [audioConfig](#ByteRTCMixedStreamConfig-audioconfig) | | ByteRTCMixedStreamClientMixConfig*_Nullable | [clientMixConfig](#ByteRTCMixedStreamConfig-clientmixconfig) | | ByteRTCMixedStreamServerControlConfig* | [serverControlConfig](#ByteRTCMixedStreamConfig-servercontrolconfig) | | NSString*_Nullable | [pushURL](#ByteRTCMixedStreamConfig-pushurl) | | NSString* | [roomID](#ByteRTCMixedStreamConfig-roomid) | | NSString* | [userID](#ByteRTCMixedStreamConfig-userid) | ## 静态函数 | 返回 | 名称 | | --- | --- | | instancetype | [defaultMixedStreamConfig](#ByteRTCMixedStreamConfig-defaultmixedstreamconfig) | ## 变量说明 ### expectedMixingType ```objectivec @property(assign, nonatomic) ByteRTCMixedStreamType expectedMixingType; ``` 合流类型，详见 [ByteRTCMixedStreamType](#ByteRTCMixedStreamType) 数据类型。建议设置。 ### layoutConfig ```objectivec @property(strong, nonatomic) ByteRTCMixedStreamLayoutConfig * _Nonnull layoutConfig; ``` 视频流合流整体布局信息。建议设置。开启转推直播功能后，你可以设置参与合流的每路视频流的预设布局信息和合流背景信息等。详见 [ByteRTCMixedStreamLayoutConfig](#ByteRTCMixedStreamLayoutConfig) 数据类型。 ### videoConfig ```objectivec @property(strong, nonatomic) ByteRTCMixedStreamVideoConfig * _Nonnull videoConfig; ``` 视频转码配置参数。详见 [ByteRTCMixedStreamVideoConfig](#ByteRTCMixedStreamVideoConfig) 数据类型。建议设置。 ### audioConfig ```objectivec @property(strong, nonatomic) ByteRTCMixedStreamAudioConfig * _Nonnull audioConfig; ``` 音频合流配置参数，参看 [ByteRTCMixedStreamAudioConfig](#ByteRTCMixedStreamAudioConfig)。建议设置。 ### clientMixConfig ```objectivec @property(strong, nonatomic) ByteRTCMixedStreamClientMixConfig * _Nullable clientMixConfig; ``` 客户端合流配置。详见 [ByteRTCMixedStreamClientMixConfig](#ByteRTCMixedStreamClientMixConfig) 。建议设置。 ### serverControlConfig ```objectivec @property(strong, nonatomic) ByteRTCMixedStreamServerControlConfig * _Nonnull serverControlConfig; ``` 服务端合流控制参数。详见 [ByteRTCMixedStreamServerControlConfig](#ByteRTCMixedStreamServerControlConfig) 。 ### pushURL ```objectivec @property(copy, nonatomic) NSString * _Nullable pushURL; ``` 推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 `/^rtmps?:\/\//`。建议设置。本参数不支持过程中更新。 ### roomID ```objectivec @property(copy, nonatomic) NSString * _Nonnull roomID; ``` 推流房间 ID。`roomID` 和 `userID` 长度相加不得超过 126 字节。建议设置。本参数不支持过程中更新。 ### userID ```objectivec @property(copy, nonatomic) NSString * _Nonnull userID; ``` 推流用户 ID。`roomID` 和 `userID` 长度相加不得超过 126 字节。建议设置。本参数不支持过程中更新。 ## 函数说明 ### defaultMixedStreamConfig ```objectivec + (instancetype _Nonnull)defaultMixedStreamConfig; ``` 获取默认转推直播配置参数。 **返回值** 转推直播配置参数，参看 [ByteRTCMixedStreamConfig](#ByteRTCMixedStreamConfig)。 # ByteRTCNetworkDetectionLinkType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCNetworkDetectionLinkType ) ``` 通话前探测链接的类型 `rtcEngine:onNetworkDetectionResult:quality:rtt:lostRate:bitrate:jitter:` 回调的参数类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCNetworkDetectionLinkTypeUp | 0 | 上行网络探测。 | | ByteRTCNetworkDetectionLinkTypeDown | 1 | 下行网络探测。 | # ByteRTCVirtualBackgroundSource ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVirtualBackgroundSource: NSObject ``` 虚拟背景对象。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCVirtualBackgroundSourceType | [sourceType](#ByteRTCVirtualBackgroundSource-sourcetype) | | int | [sourceColor](#ByteRTCVirtualBackgroundSource-sourcecolor) | | NSString*_Nullable | [sourcePath](#ByteRTCVirtualBackgroundSource-sourcepath) | ## 变量说明 ### sourceType ```objectivec @property(nonatomic, assign) ByteRTCVirtualBackgroundSourceType sourceType; ``` 虚拟背景类型，详见 [ByteRTCVirtualBackgroundSourceType](#ByteRTCVirtualBackgroundSourceType)。 ### sourceColor ```objectivec @property int sourceColor; ``` 纯色背景使用的颜色。格式为 0xAARRGGBB 。 ### sourcePath ```objectivec @property(nonatomic) NSString* _Nullable sourcePath; ``` 自定义背景图片的绝对路径。 - 支持的格式为 jpg、jpeg、png。 - 图片分辨率超过 1080P 时，图片会被等比缩放至和视频一致。 - 图片和视频宽高比一致时，图片会被直接缩放至和视频一致。 - 图片和视频长宽比不一致时，为保证图片内容不变形，图片按短边缩放至与视频帧一致，使图片填满视频帧，对多出的高或宽进行剪裁。 - 自定义图片带有局部透明效果时，透明部分由黑色代替。 # ByteRTCLocalVideoSinkConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCLocalVideoSinkConfig : NSObject ``` 本地视频帧回调配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCLocalVideoRenderPosition | [position](#ByteRTCLocalVideoSinkConfig-position) | | ByteRTCVideoSinkPixelFormat | [requiredPixelFormat](#ByteRTCLocalVideoSinkConfig-requiredpixelformat) | ## 变量说明 ### position ```objectivec @property(nonatomic, assign) ByteRTCLocalVideoRenderPosition position; ``` 本地视频帧回调位置，参看 [ByteRTCLocalVideoRenderPosition](#ByteRTCLocalVideoRenderPosition)，默认回调前处理后的视频帧。 ### requiredPixelFormat ```objectivec @property(nonatomic, assign) ByteRTCVideoSinkPixelFormat requiredPixelFormat; ``` 本地视频帧回调格式，参看 [ByteRTCVideoSinkPixelFormat](#ByteRTCVideoSinkPixelFormat)，默认值为 0。 # ByteRTCDataMessageSourceType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCDataMessageSourceType ) ``` 数据消息来源 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCDataMessageSourceTypeDefault | 0 | 通过客户端或服务端的插入的自定义消息。 | | ByteRTCDataMessageSourceTypeSystem | 1 | 系统数据，包含音量指示信息。 | # ByteRTCVideoCapturePreference ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoCapturePreference ) ``` 视频采集模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoCapturePreferenceAuto | 0 | （默认）自动设置采集参数。
SDK 在开启采集时根据服务端下发的采集配置结合编码参数设置最佳采集参数。 | | ByteRTCVideoCapturePreferenceMannal | 1 | 手动设置采集参数，包括采集分辨率、帧率。 | | ByteRTCVideoCapturePreferenceAutoPerformance | 2 | 采集参数与编码参数一致 | # ByteRTCProblemFeedbackOption ```objectivec typedef NS_ENUM( uint64_t, ByteRTCProblemFeedbackOption ) ``` 音视频质量反馈问题类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCProblemFeedbackOptionNone | 0 | 没有问题 | | ByteRTCProblemFeedbackOptionOtherMessage | 1ULL << 0 | 其他问题 | | ByteRTCProblemFeedbackOptionDisconnected | 1ULL << 1 | 连接失败 | | ByteRTCProblemFeedbackOptionEarBackDelay | 1ULL << 2 | 耳返延迟大 | | ByteRTCProblemFeedbackOptionLocalNoise | 1ULL << 10 | 本端有杂音 | | ByteRTCProblemFeedbackOptionLocalAudioLagging | 1ULL << 11 | 本端声音卡顿 | | ByteRTCProblemFeedbackOptionLocalNoAudio | 1ULL << 12 | 本端无声音 | | ByteRTCProblemFeedbackOptionLocalAudioStrength | 1ULL << 13 | 本端声音大/小 | | ByteRTCProblemFeedbackOptionLocalEcho | 1ULL << 14 | 本端有回声 | | ByteRTCProblemFeedbackOptionLocalVideoFuzzy | 1ULL << 24 | 本端视频模糊 | | ByteRTCProblemFeedbackOptionLocalNotSync | 1ULL << 25 | 本端音视频不同步 | | ByteRTCProblemFeedbackOptionLocalVideoLagging | 1ULL << 26 | 本端视频卡顿 | | ByteRTCProblemFeedbackOptionLocalNoVideo | 1ULL << 27 | 本端无画面 | | ByteRTCProblemFeedbackOptionRemoteNoise | 1ULL << 37 | 远端有杂音 | | ByteRTCProblemFeedbackOptionRemoteAudioLagging | 1ULL << 38 | 远端声音卡顿 | | ByteRTCProblemFeedbackOptionRemoteNoAudio | 1ULL << 39 | 远端无声音 | | ByteRTCProblemFeedbackOptionRemoteAudioStrength | 1ULL << 40 | 远端声音大/小 | | ByteRTCProblemFeedbackOptionRemoteEcho | 1ULL << 41 | 远端有回声 | | ByteRTCProblemFeedbackOptionRemoteVideoFuzzy | 1ULL << 51 | 远端视频模糊 | | ByteRTCProblemFeedbackOptionRemoteNotSync | 1ULL << 52 | 远端音视频不同步 | | ByteRTCProblemFeedbackOptionRemoteVideoLagging | 1ULL << 53 | 远端视频卡顿 | | ByteRTCProblemFeedbackOptionRemoteNoVideo | 1ULL << 54 | 远端无画面 | # ByteRTCAudioFormat ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCAudioFormat : NSObject ``` 音频参数格式 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCAudioSampleRate | [sampleRate](#ByteRTCAudioFormat-samplerate) | | ByteRTCAudioChannel | [channel](#ByteRTCAudioFormat-channel) | | int | [samplesPerCall](#ByteRTCAudioFormat-samplespercall) | ## 变量说明 ### sampleRate ```objectivec @property(nonatomic, assign) ByteRTCAudioSampleRate sampleRate; ``` 音频采样率，详见 [ByteRTCAudioSampleRate](#ByteRTCAudioSampleRate) ### channel ```objectivec @property(nonatomic, assign) ByteRTCAudioChannel channel; ``` 音频声道，详见 [ByteRTCAudioChannel](#ByteRTCAudioChannel) ### samplesPerCall ```objectivec @property(nonatomic, assign) int samplesPerCall; ``` 单次回调的音频帧中包含的采样点数。你可以通过设置 `samplesPerCall`，`sampleRate` 和 `channel`，设置音频帧长。默认值为 `0`，此时，采样点数取最小值。最小值为帧长间隔是 0.01s 时的值，即 `sampleRate * channel * 0.01s`。最大值是 `2048`。超出取值范围时，采样点数取默认值。该参数仅在设置读写回调时生效，调用 [enableAudioFrameCallback:format:](70092#ByteRTCVideo-enableaudioframecallback-format) 开启只读模式回调时设置该参数不生效。 # ByteRTCNetworkType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCNetworkType ) ``` SDK 网络连接类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCNetworkTypeUnknown | -1 | 网络连接类型未知。 | | ByteRTCNetworkTypeDisconnected | 0 | 网络连接已断开。 | | ByteRTCNetworkTypeLAN | 1 | 网络连接类型为 LAN 。 | | ByteRTCNetworkTypeWIFI | 2 | 网络连接类型为 Wi-Fi（包含热点）。 | | ByteRTCNetworkTypeMobile2G | 3 | 网络连接类型为 2G 移动网络。 | | ByteRTCNetworkTypeMobile3G | 4 | 网络连接类型为 3G 移动网络。 | | ByteRTCNetworkTypeMobile4G | 5 | 网络连接类型为 4G 移动网络。 | | ByteRTCNetworkTypeMobile5G | 6 | 网络连接类型为 5G 移动网络。 | # ByteRTCVideoFrame ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoFrame : NSObject ``` 待 SDK 编码的视频数据 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [format](#ByteRTCVideoFrame-format) | | ByteRTCVideoContentType | [contentType](#ByteRTCVideoFrame-contenttype) | | CMTime | [time](#ByteRTCVideoFrame-time) | | int | [strideInPixels](#ByteRTCVideoFrame-strideinpixels) | | int | [width](#ByteRTCVideoFrame-width) | | int | [height](#ByteRTCVideoFrame-height) | | CVPixelBufferRef_Nullable | [textureBuf](#ByteRTCVideoFrame-texturebuf) | | NSData*_Nullable | [dataBuf](#ByteRTCVideoFrame-databuf) | | ByteRTCVideoRotation | [rotation](#ByteRTCVideoFrame-rotation) | | ByteRTCColorSpace | [colorSpace](#ByteRTCVideoFrame-colorspace) | | ByteRTCCameraID | [cameraId](#ByteRTCVideoFrame-cameraid) | | NSData*_Nullable | [extendedData](#ByteRTCVideoFrame-extendeddata) | | NSData* | [supplementaryInfo](#ByteRTCVideoFrame-supplementaryinfo) | | int | [numberOfPlanes](#ByteRTCVideoFrame-numberofplanes) | | NSArray*_Nullable | [planeDatas](#ByteRTCVideoFrame-planedatas) | | NSArray*_Nullable | [planeStrides](#ByteRTCVideoFrame-planestrides) | | int | [deprecated] [stride](#ByteRTCVideoFrame-stride) | ## 变量说明 ### format ```objectivec @property(assign, nonatomic) int format; ``` 视频帧格式，参考 [ByteRTCVideoPixelFormat](#ByteRTCVideoPixelFormat) ### contentType ```objectivec @property(assign, nonatomic) ByteRTCVideoContentType contentType; ``` 获取视频内容类型，参看 [ByteRTCVideoContentType](#ByteRTCVideoContentType) ### time ```objectivec @property(assign, nonatomic) CMTime time; ``` 当前帧的时间戳信息 ### strideInPixels ```objectivec @property(assign, nonatomic) int strideInPixels; ``` 每一行像素占用的字节数 ### width ```objectivec @property(assign, nonatomic) int width; ``` 视频帧宽度 ### height ```objectivec @property(assign, nonatomic) int height; ``` 视频帧高度 ### textureBuf ```objectivec @property(assign, nonatomic) CVPixelBufferRef _Nullable textureBuf; ``` CVPixelBufferRef 类型的数据，当 format 为 kPixelFormatCVPixelBuffer 时有效 ### dataBuf ```objectivec @property(strong, nonatomic) NSData * _Nullable dataBuf; ``` 视频帧内存块首地址 ### rotation ```objectivec @property(assign, nonatomic) ByteRTCVideoRotation rotation; ``` 视频帧旋转角度：0, 90, 180, 270 ### colorSpace ```objectivec @property(assign, nonatomic) ByteRTCColorSpace colorSpace; ``` 颜色空间 ### cameraId ```objectivec @property(assign, nonatomic) ByteRTCCameraID cameraId; ``` 视频帧的摄像头信息，参考 [ByteRTCCameraID](#ByteRTCCameraID) ### extendedData ```objectivec @property(strong, nonatomic) NSData * _Nullable extendedData; ``` 视频帧附加的 sei 数据 ### supplementaryInfo ```objectivec @property(strong, nonatomic) NSData * _Nonnull supplementaryInfo; ``` 视频帧附加的 roi 数据 ### numberOfPlanes ```objectivec @property (assign, nonatomic) int numberOfPlanes; ``` 视频帧颜色 plane 数量; 当 textureBuf 有值时, 该值无意义。 yuv 数据存储格式分为打包（packed）存储格式和平面（planar）存储格式，planar 格式中 Y、U、V 分平面存储，packed 格式中 Y、U、V 交叉存储 ### planeDatas ```objectivec @property (strong, nonatomic) NSArray * _Nullable planeDatas; ``` 获取 plane 数据指针, 数组长度与 numberOfPlanes 一致, 元素类型为 NSData*; 当 textureBuf 有值时, 该值无意义 ### planeStrides ```objectivec @property (strong, nonatomic) NSArray * _Nullable planeStrides; ``` 获取 plane 中数据行的长度, 数组长度与 numberOfPlanes 一致, 元素类型为 NSNumber*; 当 textureBuf 有值时, 该值无意义 ### stride ```objectivec @property(assign, nonatomic) int stride DEPRECATED_MSG_ATTRIBUTE("use strideInPixels instead"); ``` > Deprecated since 3.45 and will be deleted in 3.51, use strideInPixels instead. # ByteRTCPlayerError ```objectivec typedef NS_ENUM( NSInteger, ByteRTCPlayerError ) ``` 播放错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCPlayerErrorOK | 0 | 正常 | | ByteRTCPlayerErrorFormatNotSupport | 1 | 不支持此类型 | | ByteRTCPlayerErrorInvalidPath | 2 | 无效的播放路径 | | ByteRTCPlayerErrorInvalidState | 3 | 未满足前序接口调用的要求。请查看具体接口文档。 | | ByteRTCPlayerErrorInvalidPosition | 4 | 设置播放位置出错。 | | ByteRTCPlayerErrorInvalidVolume | 5 | 音量参数不合法。 | | ByteRTCPlayerErrorInvalidPitch | 6 | 音调参数设置不合法。 | | ByteRTCPlayerErrorInvalidAudioTrackIndex | 7 | 音轨参数设置不合法。 | | ByteRTCPlayerErrorInvalidPlaybackSpeed | 8 | 播放速度参数设置不合法 | | ByteRTCPlayerErrorInvalidEffectId | 9 | 音效 ID 异常。还未加载或播放文件，就调用其他 API。 | # ByteRTCAudioEnhancementConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCAudioEnhancementConfig: NSObject ``` 蜂窝网络辅助增强应用的媒体模式 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [enhanceSignaling](#ByteRTCAudioEnhancementConfig-enhancesignaling) | | BOOL | [enhanceAudio](#ByteRTCAudioEnhancementConfig-enhanceaudio) | ## 变量说明 ### enhanceSignaling ```objectivec @property (assign, nonatomic) BOOL enhanceSignaling; ``` 对信令消息，是否启用蜂窝网络辅助增强。默认不启用。 ### enhanceAudio ```objectivec @property (assign, nonatomic) BOOL enhanceAudio; ``` 对音频，是否启用蜂窝网络辅助增强。默认不启用。 # ByteRTCLocalAudioStreamState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCLocalAudioStreamState ) ``` 本地音频流状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLocalAudioStreamStateStopped | 0 | 本地音频默认初始状态。
麦克风停止工作时回调该状态，对应错误码 [ByteRTCLocalAudioStreamError](#ByteRTCLocalAudioStreamError) 中的 ByteRTCLocalAudioStreamErrorOk | | ByteRTCLocalAudioStreamStateRecording | 1 | 本地音频录制设备启动成功。
采集到音频首帧时回调该状态，对应错误码 [ByteRTCLocalAudioStreamError](#ByteRTCLocalAudioStreamError) 中的 ByteRTCLocalAudioStreamErrorOk | | ByteRTCLocalAudioStreamStateEncoding | 2 | 本地音频首帧编码成功。
音频首帧编码成功时回调该状态，对应错误码 [ByteRTCLocalAudioStreamError](#ByteRTCLocalAudioStreamError) 中的 ByteRTCLocalAudioStreamErrorOk | | ByteRTCLocalAudioStreamStateFailed | 3 | 本地音频启动失败，在以下时机回调该状态：

本地录音设备启动失败，对应错误码 [ByteRTCLocalAudioStreamError](#ByteRTCLocalAudioStreamError) 中的 ByteRTCLocalAudioStreamErrorRecordFailure

检测到没有录音设备权限，对应错误码 [ByteRTCLocalAudioStreamError](#ByteRTCLocalAudioStreamError) 中的 ByteRTCLocalAudioStreamErrorDeviceNoPermission

音频编码失败，对应错误码 [ByteRTCLocalAudioStreamError](#ByteRTCLocalAudioStreamError) 中的 ByteRTCLocalAudioStreamError

| # ByteRTCMixedStreamVideoType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMixedStreamVideoType ) ``` region 中流的类型属性 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamVideoTypeMain | 0 | 主流。包括：

由摄像头/麦克风通过内部采集机制，采集到的流

通过自定义采集，采集到的流。

| | ByteRTCMixedStreamVideoTypeScreen | 1 | 屏幕流。 | # ByteRTCVoiceReverbType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVoiceReverbType ) ``` 混响特效类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVoiceReverbOriginal | 0 | 原声，不含特效 | | ByteRTCVoiceReverbEcho | 1 | 回声 | | ByteRTCVoiceReverbConcert | 2 | 演唱会 | | ByteRTCVoiceReverbEthereal | 3 | 空灵 | | ByteRTCVoiceReverbKTV | 4 | KTV | | ByteRTCVoiceReverbStudio | 5 | 录音棚 | | ByteRTCVoiceReverbVirtualStereo | 6 | 虚拟立体声 | | ByteRTCVoiceReverbSpacious | 7 | 空旷 | | ByteRTCVoiceReverb3D | 8 | 3D 人声 | # ByteRTCAudioFrameSource ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioFrameSource ) ``` 音频文件录制内容来源。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioFrameSourceTypeMic | 0 | 本地麦克风采集的音频数据。 | | ByteRTCAudioFrameSourceTypePlayback | 1 | 远端所有用户混音后的数据{en} | | ByteRTCAudioFrameSourceTypeMixed | 2 | 本地麦克风和所有远端用户音频流的混音后的数据 | # ByteRTCLocalAudioStreamError ```objectivec typedef NS_ENUM( NSInteger, ByteRTCLocalAudioStreamError ) ``` 本地音频流状态改变时的错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLocalAudioStreamErrorOk | 0 | 本地音频状态正常 | | ByteRTCLocalAudioStreamErrorFailure | 1 | 本地音频出错原因未知 | | ByteRTCLocalAudioStreamErrorDeviceNoPermission | 2 | 没有权限启动本地音频录制设备 | | ByteRTCLocalAudioStreamErrorRecordFailure | 4 | 本地音频录制失败，建议你检查录制设备是否正常工作 | | ByteRTCLocalAudioStreamErrorEncodeFailure | 5 | 本地音频编码失败 | | ByteRTCLocalAudioStreamErrorNoRecordingDevice | 6 | 没有可用的音频录制设备 | # ByteRTCUserOfflineReason ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCUserOfflineReason ) ``` 远端用户离开房间的原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCUserOfflineReasonQuit | 0 | 远端用户调用 `leaveRoom` 方法主动退出房间。 | | ByteRTCUserOfflineReasonDropped | 1 | 远端用户因网络等原因掉线。 | | ByteRTCUserOfflineReasonSwitchToInvisible | 2 | 远端用户切换至隐身状态。 | | ByteRTCUserOfflineReasonKickedByAdmin | 3 | 远端用户被踢出出房间。
因调用踢出用户的 OpenAPI，远端用户被踢出房间。 | # ByteRTCExpressionDetectInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCExpressionDetectInfo : NSObject ``` 人像属性检测信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [age](#ByteRTCExpressionDetectInfo-age) | | float | [boyProb](#ByteRTCExpressionDetectInfo-boyprob) | | float | [attractive](#ByteRTCExpressionDetectInfo-attractive) | | float | [happyScore](#ByteRTCExpressionDetectInfo-happyscore) | | float | [sadScore](#ByteRTCExpressionDetectInfo-sadscore) | | float | [angryScore](#ByteRTCExpressionDetectInfo-angryscore) | | float | [surpriseScore](#ByteRTCExpressionDetectInfo-surprisescore) | | float | [arousal](#ByteRTCExpressionDetectInfo-arousal) | | float | [valence](#ByteRTCExpressionDetectInfo-valence) | ## 变量说明 ### age ```objectivec @property (assign, nonatomic) float age; ``` 预测年龄，取值范围 (0, 100)。 ### boyProb ```objectivec @property (assign, nonatomic) float boyProb; ``` 预测为男性的概率，取值范围 (0.0, 1.0)。 ### attractive ```objectivec @property (assign, nonatomic) float attractive; ``` 预测的吸引力分数，取值范围 (0, 100)。 ### happyScore ```objectivec @property (assign, nonatomic) float happyScore; ``` 预测的微笑程度，取值范围 (0, 100)。 ### sadScore ```objectivec @property (assign, nonatomic) float sadScore; ``` 预测的伤心程度，取值范围 (0, 100)。 ### angryScore ```objectivec @property (assign, nonatomic) float angryScore; ``` 预测的生气程度，取值范围 (0, 100)。 ### surpriseScore ```objectivec @property (assign, nonatomic) float surpriseScore; ``` 预测的吃惊程度，取值范围 (0, 100)。 ### arousal ```objectivec @property (assign, nonatomic) float arousal; ``` 预测的情绪激动程度，取值范围 (0, 100)。 ### valence ```objectivec @property (assign, nonatomic) float valence; ``` 预测的情绪正负程度，取值范围 (-100, 100)。 # ByteRTCForwardStreamConfiguration ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCForwardStreamConfiguration: NSObject ``` 媒体流跨房间转发的目标房间的相关信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString*_Nullable | [roomId](#ByteRTCForwardStreamConfiguration-roomid) | | NSString*_Nullable | [token](#ByteRTCForwardStreamConfiguration-token) | ## 变量说明 ### roomId ```objectivec @property(strong, nonatomic) NSString* _Nullable roomId; ``` 跨房间转发媒体流过程中目标房间 ID ### token ```objectivec @property(strong, nonatomic) NSString* _Nullable token; ``` 使用转发目标房间 RoomID 和 UserID 生成 Token。测试时可使用控制台生成临时 Token，正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。如果 Token 无效，转发失败。 # ByteRTCVideoEncoderConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoEncoderConfig: NSObject ``` 视频编码配置。参考 [设置视频发布参数](https://www.volcengine.com/docs/6348/70122) ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [width](#ByteRTCVideoEncoderConfig-width) | | NSInteger | [height](#ByteRTCVideoEncoderConfig-height) | | NSInteger | [frameRate](#ByteRTCVideoEncoderConfig-framerate) | | NSInteger | [maxBitrate](#ByteRTCVideoEncoderConfig-maxbitrate) | | NSInteger | [minBitrate](#ByteRTCVideoEncoderConfig-minbitrate) | | ByteRTCVideoEncoderPreference | [encoderPreference](#ByteRTCVideoEncoderConfig-encoderpreference) | ## 变量说明 ### width ```objectivec @property(nonatomic, assign) NSInteger width; ``` 视频宽度，单位：px ### height ```objectivec @property(nonatomic, assign) NSInteger height; ``` 视频高度，单位：px ### frameRate ```objectivec @property(nonatomic, assign) NSInteger frameRate; ``` 视频帧率，单位：fps ### maxBitrate ```objectivec @property(nonatomic, assign) NSInteger maxBitrate; ``` 最大编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。设为 -1 即适配码率模式，系统将根据输入的分辨率和帧率自动计算适用的码率。设为 0 则不对视频流进行编码发送。 344 及以上版本，内部采集时默认值为 -1，344 以前版本无默认值，需手动设置。 ### minBitrate ```objectivec @property(nonatomic, assign) NSInteger minBitrate; ``` 视频最小编码码率, 单位 kbps。编码码率不会低于 `minBitrate`。默认值为 `0`。范围：[0, maxBitrate)，当 `maxBitrate` < `minBitrate` 时，为适配码率模式。以下情况，设置本参数无效： - 当 `maxBitrate` 为 `0` 时，不对视频流进行编码发送。 - 当 `maxBitrate` < `0` 时，适配码率模式。 ### encoderPreference ```objectivec @property(nonatomic, assign) ByteRTCVideoEncoderPreference encoderPreference; ``` 编码策略偏好，默认为帧率优先。参看 [ByteRTCVideoEncoderPreference](#ByteRTCVideoEncoderPreference)。 # ByteRTCUserVisibilityChangeError ```objectivec typedef NS_ENUM( NSInteger, ByteRTCUserVisibilityChangeError ) ``` 用户可见性状态改变错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCUserVisibilityChangeErrorOk | 0 | 成功。 | | ByteRTCUserVisibilityChangeErrorUnknown | 1 | 未知错误。 | | ByteRTCUserVisibilityChangeErrorTooManyVisibleUser | 2 | 房间内可见用户达到上限。 | # ByteRTCLocalProxyType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCLocalProxyType ) ``` 本地代理的类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLocalProxyTypeSocks5 | 1 | Socks5 代理。选用此代理服务器，需满足 Socks5 协议标准文档的要求。 | | ByteRTCLocalProxyTypeHttpTunnel | 2 | Http 隧道代理。 | # ByteRTCForwardStreamEventInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCForwardStreamEventInfo: NSObject ``` 跨房间转发媒体流过程中的不同目标房间发生的事件 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString*_Nullable | [roomId](#ByteRTCForwardStreamEventInfo-roomid) | | ByteRTCForwardStreamEvent | [event](#ByteRTCForwardStreamEventInfo-event) | ## 变量说明 ### roomId ```objectivec @property(strong, nonatomic) NSString* _Nullable roomId; ``` 跨房间转发媒体流过程中的发生该事件的目标房间 ID 空字符串代表所有目标房间 ### event ```objectivec @property(assign, nonatomic) ByteRTCForwardStreamEvent event; ``` 跨房间转发媒体流过程中该目标房间发生的事件，参看 [ByteRTCForwardStreamEvent](#ByteRTCForwardStreamEvent) # ByteRTCMixedStreamClientMixVideoFormat ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMixedStreamClientMixVideoFormat ) ``` 客户端合流回调视频格式。(新) 设置为系统不支持的格式时，自动回调系统默认格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamClientMixVideoFormatI420 | 0 | YUV I420。Android、Windows 默认回调格式。支持系统：Android、Windows。 | | ByteRTCMixedStreamClientMixVideoFormatTexture2D | 1 | OpenGL GL_TEXTURE_2D 格式纹理。支持系统：安卓。 | | ByteRTCMixedStreamClientMixVideoFormatCVPixelBufferBGRA | 2 | CVPixelBuffer BGRA。iOS 默认回调格式。支持系统: iOS。 | | ByteRTCMixedStreamClientMixVideoFormatNV12 | 3 | YUV NV12。macOS 默认回调格式。支持系统: macOS。{en} | # ByteRTCLocalLogLevel ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCLocalLogLevel ) ``` 日志输出等级。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLocalLogLevelInfo | 0 | 输出 `INFO`、`WARNING`、`ERROR` 级别的日志。 | | ByteRTCLocalLogLevelWarning | 1 | （默认值）仅输出 `WARNING`、`ERROR` 级别的日志。 | | ByteRTCLocalLogLevelError | 2 | 仅输出 `ERROR` 级别的日志。 | | ByteRTCLocalLogLevelNone | 3 | 不输出日志。 | # ByteRTCLocalProxyState ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCLocalProxyState ) ``` 本地代理连接状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLocalProxyStateInited | 0 | TCP 代理服务器连接成功。 | | ByteRTCLocalProxyStateConnected | 1 | 本地代理连接成功。 | | ByteRTCLocalProxyStateError | 2 | 本地代理连接出现错误。 | # ByteRTCStreamIndex ```objectivec typedef NS_ENUM( NSInteger, ByteRTCStreamIndex ) ``` 流属性 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCStreamIndexMain | 0 | 主流。包括：

由摄像头/麦克风通过内部采集机制，采集到的视频/音频;

通过自定义采集，采集到的视频/音频。

| | ByteRTCStreamIndexScreen | 1 | 屏幕流。屏幕共享时共享的视频流，或来自声卡的本地播放音频流。 | # ByteRTCScreenVideoEncoderConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCScreenVideoEncoderConfig: NSObject ``` 屏幕流编码配置。参考 [屏幕共享](https://www.volcengine.com/docs/6348/70144)。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [width](#ByteRTCScreenVideoEncoderConfig-width) | | NSInteger | [height](#ByteRTCScreenVideoEncoderConfig-height) | | NSInteger | [frameRate](#ByteRTCScreenVideoEncoderConfig-framerate) | | NSInteger | [maxBitrate](#ByteRTCScreenVideoEncoderConfig-maxbitrate) | | NSInteger | [minBitrate](#ByteRTCScreenVideoEncoderConfig-minbitrate) | | ByteRTCScreenVideoEncoderPreference | [encoderPreference](#ByteRTCScreenVideoEncoderConfig-encoderpreference) | ## 变量说明 ### width ```objectivec @property(nonatomic, assign) NSInteger width; ``` 屏幕帧最大宽度，单位：px。 ### height ```objectivec @property(nonatomic, assign) NSInteger height; ``` 屏幕帧最大高度，单位：px。 ### frameRate ```objectivec @property(nonatomic, assign) NSInteger frameRate; ``` 屏幕流编码帧率，单位：fps。建议和采集帧率保持一致。 ### maxBitrate ```objectivec @property(nonatomic, assign) NSInteger maxBitrate; ``` 最大编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。设为 -1 即适配码率模式，系统将根据输入的分辨率和帧率自动计算适用的码率。设为 0 则不对视频流进行编码发送。 3.44 及以上版本，内部采集时默认值为 -1，3.44 以前版本无默认值，需手动设置。 ### minBitrate ```objectivec @property(nonatomic, assign) NSInteger minBitrate; ``` 最小编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。最小编码码率必须小于或等于最大编码，否则不对视频流进行编码发送。 ### encoderPreference ```objectivec @property(nonatomic, assign) ByteRTCScreenVideoEncoderPreference encoderPreference; ``` 屏幕流编码模式。默认为流畅模式。参见 [ByteRTCScreenVideoEncoderPreference](#ByteRTCScreenVideoEncoderPreference)。 # ByteRTCSysStats ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCSysStats : NSObject ``` App 使用的 cpu 和 memory 信息信息由 SDK 周期性（2s）地通过 `reportSysStats` 回调事件通知给用户。 ## 成员变量 | 类型 | 名称 | | --- | --- | | unsignedint | [cpuCores](#ByteRTCSysStats-cpucores) | | double | [cpuAppUsage](#ByteRTCSysStats-cpuappusage) | | double | [memoryUsage](#ByteRTCSysStats-memoryusage) | | unsignedlonglong | [fullMemory](#ByteRTCSysStats-fullmemory) | | unsignedlonglong | [totalMemoryUsage](#ByteRTCSysStats-totalmemoryusage) | | unsignedlonglong | [freeMemory](#ByteRTCSysStats-freememory) | | double | [memoryRatio](#ByteRTCSysStats-memoryratio) | | double | [totalMemoryRatio](#ByteRTCSysStats-totalmemoryratio) | ## 变量说明 ### cpuCores ```objectivec @property(assign, nonatomic) unsigned int cpuCores; ``` 当前系统 cpu 核数 ### cpuAppUsage ```objectivec @property(assign, nonatomic) double cpuAppUsage; ``` 当前应用的 CPU 使用率，取值范围为 [0, 1]。 ### memoryUsage ```objectivec @property(assign, nonatomic) double memoryUsage; ``` 当前 App 的内存使用（单位 MB） ### fullMemory ```objectivec @property(assign, nonatomic) unsigned long long fullMemory; ``` 全量内存（单位 MB） ### totalMemoryUsage ```objectivec @property(assign, nonatomic) unsigned long long totalMemoryUsage; ``` 系统已使用内存（单位 MB） ### freeMemory ```objectivec @property(assign, nonatomic) unsigned long long freeMemory; ``` 空闲可分配内存（单位 MB） ### memoryRatio ```objectivec @property(assign, nonatomic) double memoryRatio; ``` 当前应用的内存使用率（单位 %） ### totalMemoryRatio ```objectivec @property(assign, nonatomic) double totalMemoryRatio; ``` 系统内存使用率（单位 %） # ByteRTCVideoStreamState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoStreamState ) ``` 设置本地视频属性的返回状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoStreamStateSuccess | 0 | 设置本地视频属性成功 | | ByteRTCVideoStreamStateInvalid | -2 | 本地视频属性参数不合法 | # ByteRTCMixedStreamVideoConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMixedStreamVideoConfig : NSObject ``` 视频转码配置参数。(新) 值不合法或未设置时，自动使用默认值。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCMixedStreamVideoCodecType | [videoCodec](#ByteRTCMixedStreamVideoConfig-videocodec) | | NSInteger | [width](#ByteRTCMixedStreamVideoConfig-width) | | NSInteger | [height](#ByteRTCMixedStreamVideoConfig-height) | | NSInteger | [fps](#ByteRTCMixedStreamVideoConfig-fps) | | NSInteger | [gop](#ByteRTCMixedStreamVideoConfig-gop) | | NSInteger | [bitrate](#ByteRTCMixedStreamVideoConfig-bitrate) | | BOOL | [enableBFrame](#ByteRTCMixedStreamVideoConfig-enablebframe) | ## 变量说明 ### videoCodec ```objectivec @property(assign, nonatomic) ByteRTCMixedStreamVideoCodecType videoCodec; ``` 视频编码格式，参看 [ByteRTCMixedStreamVideoCodecType](#ByteRTCMixedStreamVideoCodecType)。默认值为 `0`。建议设置。本参数不支持过程中更新。 ### width ```objectivec @property(assign, nonatomic) NSInteger width; ``` 合流视频宽度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 640 px。建议设置。设置值为非偶数时，自动向上取偶数。 ### height ```objectivec @property(assign, nonatomic) NSInteger height; ``` 合流视频高度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 360 px。建议设置。设置值为非偶数时，自动向上取偶数。 ### fps ```objectivec @property(assign, nonatomic) NSInteger fps; ``` 合流视频帧率。单位为 FPS，取值范围为 [1,60]，默认值为 15 FPS。建议设置。 ### gop ```objectivec @property(assign, nonatomic) NSInteger gop; ``` 视频 I 帧时间间隔。单位为秒，取值范围为 [1, 5]，默认值为 2 秒。建议设置。本参数不支持过程中更新。 ### bitrate ```objectivec @property(assign, nonatomic) NSInteger bitrate; ``` 合流视频码率。单位为 Kbps，取值范围为 [1,10000]，默认值为自适应模式。建议设置。 ### enableBFrame ```objectivec @property(assign, nonatomic) BOOL enableBFrame; ``` 是否在合流中开启 B 帧，仅服务端合流支持. # ByteRTCVideoRenderMirrorType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoRenderMirrorType ) ``` 是否将视频帧镜像。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoRenderMirrorTypeOn | 1 | 开启镜像。 | | ByteRTCVideoRenderMirrorTypeOff | 2 | （默认值）不开启镜像。 | # ByteRTCVideoSourceType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoSourceType ) ``` 视频输入源类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoSourceTypeExternal | 0 | 自定义采集视频源 | | ByteRTCVideoSourceTypeInternal | 1 | 内部采集视频源 | | ByteRTCVideoSourceTypeEncodedAutoSimulcast | 2 | 自定义编码视频源。
你仅需推送分辨率最大的一路编码后视频流，SDK 将自动转码生成多路小流 | | ByteRTCVideoSourceTypeEncodedManualSimulcast | 3 | 自定义编码视频源。
SDK 不会自动生成多路流，你需要自行生成并推送多路流 | # ByteRTCUserOnlineStatus ```objectivec typedef NS_ENUM( NSInteger, ByteRTCUserOnlineStatus ) ``` 用户在线状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCUserOnlineStatusOffline | 0 | 对端用户离线
对端用户已经调用 `logout`，或者没有调用 `login:uid:` 进行登录 | | ByteRTCUserOnlineStatusOnline | 1 | 对端用户在线
对端用户调用 `login:uid:` 登录，并且连接状态正常 | | ByteRTCUserOnlineStatusUnreachable | 2 | 无法获取对端用户在线状态
发生级联错误、对端用户在线状态异常时返回 | # ByteRTCMixedStreamLayoutRegionConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMixedStreamLayoutRegionConfig : NSObject ``` 单个图片或视频流在合流中的布局信息。(新) 开启合流功能后，在多路图片或视频流合流时，你可以设置其中一路流在合流中的预设布局信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [userID](#ByteRTCMixedStreamLayoutRegionConfig-userid) | | NSString* | [roomID](#ByteRTCMixedStreamLayoutRegionConfig-roomid) | | NSInteger | [locationX](#ByteRTCMixedStreamLayoutRegionConfig-locationx) | | NSInteger | [locationY](#ByteRTCMixedStreamLayoutRegionConfig-locationy) | | NSInteger | [width](#ByteRTCMixedStreamLayoutRegionConfig-width) | | NSInteger | [height](#ByteRTCMixedStreamLayoutRegionConfig-height) | | NSInteger | [zOrder](#ByteRTCMixedStreamLayoutRegionConfig-zorder) | | BOOL | [isLocalUser](#ByteRTCMixedStreamLayoutRegionConfig-islocaluser) | | ByteRTCMixedStreamVideoType | [streamType](#ByteRTCMixedStreamLayoutRegionConfig-streamtype) | | CGFloat | [alpha](#ByteRTCMixedStreamLayoutRegionConfig-alpha) | | CGFloat | [cornerRadius](#ByteRTCMixedStreamLayoutRegionConfig-cornerradius) | | ByteRTCMixedStreamMediaType | [mediaType](#ByteRTCMixedStreamLayoutRegionConfig-mediatype) | | ByteRTCMixedStreamRenderMode | [renderMode](#ByteRTCMixedStreamLayoutRegionConfig-rendermode) | | ByteRTCMixedStreamLayoutRegionType | [regionContentType](#ByteRTCMixedStreamLayoutRegionConfig-regioncontenttype) | | NSData*_Nullable | [imageWaterMark](#ByteRTCMixedStreamLayoutRegionConfig-imagewatermark) | | ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig*_Nullable | [imageWaterMarkConfig](#ByteRTCMixedStreamLayoutRegionConfig-imagewatermarkconfig) | | ByteRTCPosition*_Nullable | [spatialPosition](#ByteRTCMixedStreamLayoutRegionConfig-spatialposition) | | BOOL | [applySpatialAudio](#ByteRTCMixedStreamLayoutRegionConfig-applyspatialaudio) | | ByteRTCMixedStreamAlternateImageFillMode | [alternateImageFillMode](#ByteRTCMixedStreamLayoutRegionConfig-alternateimagefillmode) | | NSString* | [alternateImageUrl](#ByteRTCMixedStreamLayoutRegionConfig-alternateimageurl) | ## 变量说明 ### userID ```objectivec @property(copy, nonatomic) NSString * _Nonnull userID; ``` 视频流发布用户的用户 ID 。建议设置。 ### roomID ```objectivec @property(copy, nonatomic) NSString * _Nonnull roomID; ``` 图片或视频流所在房间的房间 ID。建议设置。如果此图片或视频流是通过 [startForwardStreamToRooms:](70092#ByteRTCRoom-startforwardstreamtorooms) 转发到你所在房间的媒体流时，你应将房间 ID 设置为你所在的房间 ID。 ### locationX ```objectivec @property(assign, nonatomic) NSInteger locationX; ``` 单个用户画面左上角在整个画布坐标系中的 X 坐标（pixel），即以画布左上角为原点，用户画面左上角相对于原点的横向位移。取值范围为 [0, 整体画布宽度)。默认值为 0。 ### locationY ```objectivec @property(assign, nonatomic) NSInteger locationY; ``` 单个用户画面左上角在整个画布坐标系中的 Y 坐标（pixel），即以画布左上角为原点，用户画面左上角相对于原点的纵向位移。取值范围为 [0, 整体画布高度)。默认值为 0。 ### width ```objectivec @property(assign, nonatomic) NSInteger width; ``` 单个用户画面的宽度。取值范围为 [0, 整体画布宽度]，默认值为 360。 ### height ```objectivec @property(assign, nonatomic) NSInteger height; ``` 单个用户画面的高度。取值范围为 [0, 整体画布高度]，默认值为 640。 ### zOrder ```objectivec @property(assign, nonatomic) NSInteger zOrder; ``` 用户视频布局在画布中的层级。取值范围为 [0 - 100]，0 为底层，值越大越上层。默认值为 0。建议设置。 ### isLocalUser ```objectivec @property(assign, nonatomic) BOOL isLocalUser; ``` 是否为本地用户 ### streamType ```objectivec @property(assign, nonatomic) ByteRTCMixedStreamVideoType streamType; ``` 流类型，默认为主流 ### alpha ```objectivec @property(assign, nonatomic) CGFloat alpha; ``` 透明度，可选范围为 (0.0, 1.0]，0.0 为全透明。默认值为 1.0。 ### cornerRadius ```objectivec @property(assign, nonatomic) CGFloat cornerRadius; ``` 圆角半径相对画布宽度的比例。默认值为 `0.0`。做范围判定时，首先根据画布的宽高，将 `width`，`height`，和 `cornerRadius` 分别转换为像素值：`width_px`，`height_px`，和 `cornerRadius_px`。然后判定是否满足 `cornerRadius_px < min(width_px/2, height_px/2)`：若满足，则设置成功；若不满足，则将 `cornerRadius_px` 设定为 `min(width_px/2, height_px/2)`，然后将 `cornerRadius` 设定为 `cornerRadius_px` 相对画布宽度的比例值。 ### mediaType ```objectivec @property (assign, nonatomic) ByteRTCMixedStreamMediaType mediaType; ``` 合流内容控制。默认值为 `ByteRTCTranscoderContentControlTypeHasAudioAndVideo`，参看 [ByteRTCMixedStreamMediaType](#ByteRTCMixedStreamMediaType)。 ### renderMode ```objectivec @property(assign, nonatomic) ByteRTCMixedStreamRenderMode renderMode; ``` 图片或视频流的缩放模式，参看 [ByteRTCMixedStreamRenderMode](#ByteRTCMixedStreamRenderMode)。默认值为 1。建议设置。 ### regionContentType ```objectivec @property (assign, nonatomic) ByteRTCMixedStreamLayoutRegionType regionContentType; ``` 合流布局区域类型。参看 [ByteRTCMixedStreamLayoutRegionType](#ByteRTCMixedStreamLayoutRegionType)。建议设置。 ### imageWaterMark ```objectivec @property (strong, nonatomic) NSData * _Nullable imageWaterMark; ``` 图片合流布局区域类型对应的数据。类型为图片时传入图片 RGBA 数据，当类型为视频流时传空。 ### imageWaterMarkConfig ```objectivec @property (strong, nonatomic) ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig * _Nullable imageWaterMarkConfig; ``` 合流布局区域数据的对应参数。当类型为视频流时传空，类型为图片时传入对应图片的参数，参看 [ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig](#ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig)。 ### spatialPosition ```objectivec @property (strong, nonatomic) ByteRTCPosition * _Nullable spatialPosition; ``` 空间位置。参看 [ByteRTCPosition](#ByteRTCPosition)。 ### applySpatialAudio ```objectivec @property(assign, nonatomic) BOOL applySpatialAudio; ``` 设置某用户是否应用空间音频效果： - Yes：启用（默认值） - No：禁用 ### alternateImageFillMode ```objectivec @property (assign, nonatomic)ByteRTCMixedStreamAlternateImageFillMode alternateImageFillMode; ``` > Available since 3.57 设置占位图的填充模式。该参数用来控制当用户停止发布视频流，画面恢复为占位图后，此时占位图的填充模式。参看 [ByteRTCMixedStreamAlternateImageFillMode](#ByteRTCMixedStreamAlternateImageFillMode)。 ### alternateImageUrl ```objectivec @property(copy, nonatomic)NSString * alternateImageUrl; ``` > Available since 3.57 设置占位图的 URL，长度小于 1024 字符. # ByteRTCRoomStats ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRoomStats : NSObject ``` 房间通话统计数据，统计周期为 2s 。用户进房成功后，SDK 会周期性地通过 `onRoomStats` 回调通知用户当前房间内的汇总统计信息。此数据结构即为回调给用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [duration](#ByteRTCRoomStats-duration) | | NSInteger | [txBytes](#ByteRTCRoomStats-txbytes) | | NSInteger | [rxBytes](#ByteRTCRoomStats-rxbytes) | | NSInteger | [txKbitrate](#ByteRTCRoomStats-txkbitrate) | | NSInteger | [rxKbitrate](#ByteRTCRoomStats-rxkbitrate) | | NSInteger | [txAudioKBitrate](#ByteRTCRoomStats-txaudiokbitrate) | | NSInteger | [rxAudioKBitrate](#ByteRTCRoomStats-rxaudiokbitrate) | | NSInteger | [txVideoKBitrate](#ByteRTCRoomStats-txvideokbitrate) | | NSInteger | [rxVideoKBitrate](#ByteRTCRoomStats-rxvideokbitrate) | | NSInteger | [txScreenKBitrate](#ByteRTCRoomStats-txscreenkbitrate) | | NSInteger | [rxScreenKBitrate](#ByteRTCRoomStats-rxscreenkbitrate) | | NSInteger | [userCount](#ByteRTCRoomStats-usercount) | | float | [rxLostrate](#ByteRTCRoomStats-rxlostrate) | | float | [txLostrate](#ByteRTCRoomStats-txlostrate) | | NSInteger | [rtt](#ByteRTCRoomStats-rtt) | | NSInteger | [txCellularKBitrate](#ByteRTCRoomStats-txcellularkbitrate) | | NSInteger | [rxCellularKBitrate](#ByteRTCRoomStats-rxcellularkbitrate) | ## 变量说明 ### duration ```objectivec @property(assign, nonatomic) NSInteger duration; ``` 本地用户在本次通话中的参与时长，单位为 s ### txBytes ```objectivec @property(assign, nonatomic) NSInteger txBytes; ``` 本地用户的总发送字节数 (bytes)，累计值 ### rxBytes ```objectivec @property(assign, nonatomic) NSInteger rxBytes; ``` 本地用户的总接收字节数 (bytes)，累计值 ### txKbitrate ```objectivec @property(assign, nonatomic) NSInteger txKbitrate; ``` 发送码率（kbps），获取该数据时的瞬时值 ### rxKbitrate ```objectivec @property(assign, nonatomic) NSInteger rxKbitrate; ``` 接收码率（kbps），获取该数据时的瞬时值 ### txAudioKBitrate ```objectivec @property(assign, nonatomic) NSInteger txAudioKBitrate; ``` 本地用户的音频发送码率 (kbps)，瞬时值 ### rxAudioKBitrate ```objectivec @property(assign, nonatomic) NSInteger rxAudioKBitrate; ``` 本地用户的音频接收码率 (kbps)，瞬时值 ### txVideoKBitrate ```objectivec @property(assign, nonatomic) NSInteger txVideoKBitrate; ``` 本地用户的视频发送码率 (kbps)，瞬时值 ### rxVideoKBitrate ```objectivec @property(assign, nonatomic) NSInteger rxVideoKBitrate; ``` 本地用户的视频接收码率 (kbps)，瞬时值 ### txScreenKBitrate ```objectivec @property(assign, nonatomic) NSInteger txScreenKBitrate; ``` 屏幕接收码率，获取该数据时的瞬时值，单位为 Kbps ### rxScreenKBitrate ```objectivec @property(assign, nonatomic) NSInteger rxScreenKBitrate; ``` 屏幕发送码率，获取该数据时的瞬时值，单位为 Kbps ### userCount ```objectivec @property(assign, nonatomic) NSInteger userCount; ``` 当前房间内的可见用户人数，包括本地用户自身 ### rxLostrate ```objectivec @property(assign, nonatomic) float rxLostrate; ``` App 现在的下行丢包率 ### txLostrate ```objectivec @property(assign, nonatomic) float txLostrate; ``` App 现在的上行丢包率 ### rtt ```objectivec @property(assign, nonatomic) NSInteger rtt; //** //** //** //** ``` 客户端到服务端的往返时延 ### txCellularKBitrate ```objectivec @property(assign, nonatomic) NSInteger txCellularKBitrate; ``` 蜂窝路径发送的码率 (kbps)，为获取该数据时的瞬时值 ### rxCellularKBitrate ```objectivec @property(assign, nonatomic) NSInteger rxCellularKBitrate; ``` 蜂窝路径接收码率 (kbps)，为获取该数据时的瞬时值 # ByteRTCAudioRecordingState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioRecordingState ) ``` 录音配置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioRecordingStateError | 0 | 录制异常 | | ByteRTCAudioRecordingStateProcessing | 1 | 录制进行中 | | ByteRTCAudioRecordingStateSuccess | 2 | 已结束录制，并且录制文件保存成功。 | # ByteRTCMediaDeviceState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMediaDeviceState ) ``` 媒体设备状态通过 `rtcEngine:onAudioDeviceStateChanged:device_type:device_state:device_error:` 或 `rtcEngine:onVideoDeviceStateChanged:device_type:device_state:device_error:` 回调设备状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMediaDeviceStateStarted | 1 | 设备开启。 | | ByteRTCMediaDeviceStateStopped | 2 | 设备停止。 | | ByteRTCMediaDeviceStateRuntimeError | 3 | 设备运行时错误。
例如，当媒体设备的预期行为是正常采集，但没有收到采集数据时，将回调该状态。 | | ByteRTCMediaDeviceStateAdded | 10 | 设备连接。
你可以调用获取设备接口更新设备列表。 | | ByteRTCMediaDeviceStateRemoved | 11 | 设备移除。
你可以调用获取设备接口更新设备列表。 | | ByteRTCMediaDeviceStateInterruptionBegan | 12 | 系统通话，锁屏或第三方应用打断了音视频通话。将在通话结束或第三方应用结束占用后自动恢复。 | | ByteRTCMediaDeviceStateInterruptionEnded | 13 | 音视频通话已从系统电话或第三方应用打断中恢复。 | | ByteRTCMediaDeviceListUpdated | 16 | 获取设备列表超时后，收到设备列表通知。
再次调用获取设备接口更新设备列表。 | # ByteRTCAudioRoute ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioRoute ) ``` 音频播放路由 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioRouteDefault | -1 | 通过 `setDefaultAudioRoute:` 设置的音频路由 | | ByteRTCAudioRouteHeadset | 1 | 有线耳机 | | ByteRTCAudioRouteEarpiece | 2 | 听筒。设备自带的，一般用于通话的播放硬件。 | | ByteRTCAudioRouteSpeakerphone | 3 | 扬声器。设备自带的，一般用于免提播放的硬件。 | | ByteRTCAudioRouteHeadsetBluetooth | 4 | 蓝牙耳机 | | ByteRTCAudioRouteHeadsetUSB | 5 | USB 设备 | # ByteRtcScreenCapturerExt ```objectivec BYTE_RTC_EXPORT @interface ByteRtcScreenCapturerExt : NSObject ``` 屏幕采集相关扩展实例，仅适用于 SDK 内部采集。用户创建 extesion 后生成的 SampleHandler 需通过此实例实现屏幕共享相关能力。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRtcScreenCapturerExt* | [shared](#ByteRtcScreenCapturerExt-shared) | | NSObject* | [delegate](#ByteRtcScreenCapturerExt-delegate) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [startWithDelegate:groupId:](#ByteRtcScreenCapturerExt-startwithdelegate-groupid) | | void | [stop](#ByteRtcScreenCapturerExt-stop) | | void | [processSampleBuffer:withType:](#ByteRtcScreenCapturerExt-processsamplebuffer-withtype) | ## 变量说明 ### shared ```objectivec ByteRtcScreenCapturerExt* ByteRtcScreenCapturerExt::shared ``` ### delegate ```objectivec NSObject* ByteRtcScreenCapturerExt::delegate ``` ## 函数说明 ### startWithDelegate:groupId: ```objectivec - (void)startWithDelegate:(NSObject *)delegate groupId:(NSString *)groupId; ``` 开始屏幕采集 Extension 启动后，系统将自动调用该方法开启屏幕采集。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | delegate | NSObject * | 回调代理，参看 [ByteRtcScreenCapturerExtDelegate](70093#ByteRtcScreenCapturerExtDelegate) | | groupId | NSString * | App groups 中配置的 group ID | ### stop ```objectivec - (void)stop; ``` 结束屏幕采集 Extension 关闭后，系统将自动调用该方法停止屏幕采集。 ### processSampleBuffer:withType: ```objectivec - (void)processSampleBuffer:(CMSampleBufferRef)sampleBuffer withType:(RPSampleBufferType)sampleBufferType API_AVAILABLE(ios(10)); ``` 推送 Extension 采集的数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | sampleBuffer | CMSampleBufferRef | 采集到的数据 | | sampleBufferType | RPSampleBufferType | 数据类型 | # ByteRTCVideoDecoderConfig ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoDecoderConfig ) ``` 视频解码方式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoDecoderConfigRaw | 0 | 开启 SDK 内部解码，只回调解码后的数据。回调为 [renderPixelBuffer:rotation:contentType:extendedData:](#ByteRTCVideoSinkDelegate-renderpixelbuffer-rotation-contenttype-extendeddata) | | ByteRTCVideoDecoderConfigEncode | 1 | 开启自定义解码，只回调解码前数据。回调为 [onRemoteEncodedVideoFrame:withEncodedVideoFrame:](70093#ByteRTCRemoteEncodedVideoFrameObserver-onremoteencodedvideoframe-withencodedvideoframe)。 | | ByteRTCVideoDecoderConfigBoth | 2 | 开启 SDK 内部解码，同时回调解码前和解码后的数据 | # ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig : NSObject ``` 图片合流相关参数。(新) ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [imageWidth](#ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig-imagewidth) | | NSInteger | [imageHeight](#ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig-imageheight) | ## 变量说明 ### imageWidth ```objectivec @property (assign, nonatomic) NSInteger imageWidth; ``` 原始图片的宽度，单位为 px。 ### imageHeight ```objectivec @property (assign, nonatomic) NSInteger imageHeight; ``` 原始图片的高度，单位为 px。 # ByteRTCVideoPixelFormat ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoPixelFormat ) ``` 视频帧格式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoPixelFormatUnknown | 0 | 未知格式 | | ByteRTCVideoPixelFormatI420 | 1 | I420 | | ByteRTCVideoPixelFormatBGRA | 2 | BGRA | | ByteRTCVideoPixelFormatNV21 | 3 | NV21 | | ByteRTCVideoPixelFormatRGBA | 4 | RGBA | | ByteRTCVideoPixelFormatIMC2 | 5 | IMC2 | | ByteRTCVideoPixelFormatARGB | 7 | ARGB | | ByteRTCVideoPixelFormatNV12 | 8 | NV12 | | ByteRTCVideoPixelFormatGLTexture2D | 10 | Opengl Texture2D 纹理 | | ByteRTCVideoPixelFormatGLTextureOES | 11 | Opengl OES 纹理 | | ByteRTCVideoPixelFormatCVPixelBuffer | 12 | CVPixelBuffer | # ByteRTCEncryptType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCEncryptType ) ``` 自定义加密类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCEncryptTypeCustomize | 0 | 不使用内置加密。默认值。 | | ByteRTCEncryptTypeAES128CBC | 1 | AES-128-CBC 加密算法 | | ByteRTCEncryptTypeAES256CBC | 2 | AES-256-CBC 加密算法 | | ByteRTCEncryptTypeAES128ECB | 3 | AES-128-ECB 加密算法 | | ByteRTCEncryptTypeAES256ECB | 4 | AES-256-ECB 加密算法 | # ByteRTCMixedStreamSyncStrategy ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMixedStreamSyncStrategy ) ``` 合流同步策略 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamSyncStrategyNoSync | 0 | 不使用同步策略 | | ByteRTCMixedStreamSyncStrategyAudioPreciseSync | 1 | 使用音频精准同步策略 | | ByteRTCMixedStreamSyncStrategySimplexModeSync | 2 | 使用单通模式同步策略 | # ByteRTCVideoCompositingRegion ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoCompositingRegion : NSObject ``` > Deprecated since 3.52, use [ByteRTCMixedStreamLayoutRegionConfig](#ByteRTCMixedStreamLayoutRegionConfig) instead. 单个图片或视频流在合流中的布局信息。开启转推直播功能后，在多路图片或视频流合流时，你可以设置其中一路流在合流中的预设布局信息。 **注意** - 视频流对应区域左上角的实际坐标是通过画面尺寸和归一化比例相乘，并四舍五入取整得到的。假如：Canvas.Width = 1920, Region.LocationX = 0.33，那么该画布左上角的横坐标为 634（1920×0.33=633.6，四舍五入取整）。 - 视频流对应区域宽度和高度的像素值是通过画面尺寸和归一化比例相乘，四舍五入取整，并向上转换为偶数得到的。假如：Canvas.Width = 1920, Region.WidthProportion = 0.21，那么该画布横向宽度为 404px（1920x0.21=403.2，四舍五入取整后，再向上转换为偶数）。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [uid](#ByteRTCVideoCompositingRegion-uid) | | NSString* | [roomId](#ByteRTCVideoCompositingRegion-roomid) | | CGFloat | [x](#ByteRTCVideoCompositingRegion-x) | | CGFloat | [y](#ByteRTCVideoCompositingRegion-y) | | CGFloat | [width](#ByteRTCVideoCompositingRegion-width) | | CGFloat | [height](#ByteRTCVideoCompositingRegion-height) | | NSInteger | [zOrder](#ByteRTCVideoCompositingRegion-zorder) | | BOOL | [localUser](#ByteRTCVideoCompositingRegion-localuser) | | BOOL | [screenStream](#ByteRTCVideoCompositingRegion-screenstream) | | CGFloat | [alpha](#ByteRTCVideoCompositingRegion-alpha) | | CGFloat | [cornerRadius](#ByteRTCVideoCompositingRegion-cornerradius) | | ByteRTCTranscoderContentControlType | [contentControl](#ByteRTCVideoCompositingRegion-contentcontrol) | | ByteRTCRenderMode | [renderMode](#ByteRTCVideoCompositingRegion-rendermode) | | ByteRTCTranscoderLayoutRegionType | [type](#ByteRTCVideoCompositingRegion-type) | | NSData*_Nullable | [data](#ByteRTCVideoCompositingRegion-data) | | ByteRTCTranscoderLayoutRegionDataParam*_Nullable | [dataParam](#ByteRTCVideoCompositingRegion-dataparam) | | ByteRTCPosition*_Nullable | [spatialPosition](#ByteRTCVideoCompositingRegion-spatialposition) | | BOOL | [applySpatialAudio](#ByteRTCVideoCompositingRegion-applyspatialaudio) | ## 变量说明 ### uid ```objectivec @property(copy, nonatomic) NSString * _Nonnull uid; ``` 视频流发布用户的用户 ID 。必填。 ### roomId ```objectivec @property(copy, nonatomic) NSString * _Nonnull roomId; ``` 图片或视频流所在房间的房间 ID。必填。如果此图片或视频流是通过 [startForwardStreamToRooms:](70092#ByteRTCRoom-startforwardstreamtorooms) 转发到你所在房间的媒体流时，你应将房间 ID 设置为你所在的房间 ID。 ### x ```objectivec @property(assign, nonatomic) CGFloat x; ``` 视频流对应区域左上角的横坐标相对整体画面的归一化比例，取值的范围为 [0.0, 1.0)。默认值为 0.0。 ### y ```objectivec @property(assign, nonatomic) CGFloat y; ``` 视频流对应区域左上角的纵坐标相对整体画面的归一化比例，取值的范围为 [0.0, 1.0)。默认值为 0.0。 ### width ```objectivec @property(assign, nonatomic) CGFloat width; ``` 视频流对应区域宽度相对整体画面的归一化比例，取值的范围为 [0.0, 1.0]。默认值为 1.0。 ### height ```objectivec @property(assign, nonatomic) CGFloat height; ``` 视频流对应区域高度相对整体画面的归一化比例，取值的范围为 [0.0, 1.0]。默认值为 1.0。 ### zOrder ```objectivec @property(assign, nonatomic) NSInteger zOrder; ``` 用户视频布局在画布中的层级。取值范围为 [0 - 100]，0 为底层，值越大越上层。默认值为 0。 ### localUser ```objectivec @property(assign, nonatomic) BOOL localUser; ``` 是否为本地用户 ### screenStream ```objectivec @property(assign, nonatomic) BOOL screenStream; ``` （仅服务端合流支持合屏幕流）是否为屏幕流，默认为 NO ### alpha ```objectivec @property(assign, nonatomic) CGFloat alpha; ``` （仅服务端合流支持设置）透明度，可选范围为 (0.0, 1.0]，0.0 为全透明。默认值为 1.0。 ### cornerRadius ```objectivec @property(assign, nonatomic) CGFloat cornerRadius; ``` （仅服务端合流支持设置）圆角半径相对画布宽度的比例。默认值为 `0.0`。做范围判定时，首先根据画布的宽高，将 `width`，`height`，和 `cornerRadius` 分别转换为像素值：`width_px`，`height_px`，和 `cornerRadius_px`。然后判定是否满足 `cornerRadius_px < min(width_px/2, height_px/2)`：若满足，则设置成功；若不满足，则将 `cornerRadius_px` 设定为 `min(width_px/2, height_px/2)`，然后将 `cornerRadius` 设定为 `cornerRadius_px` 相对画布宽度的比例值。 ### contentControl ```objectivec @property (assign, nonatomic) ByteRTCTranscoderContentControlType contentControl; ``` （仅服务端合流支持设置）合流内容控制。默认值为 `ByteRTCTranscoderContentControlTypeHasAudioAndVideo`，参看 [ByteRTCTranscoderContentControlType](#ByteRTCTranscoderContentControlType)。 ### renderMode ```objectivec @property(assign, nonatomic) ByteRTCRenderMode renderMode; ``` 图片或视频流的缩放模式，参看 [ByteRTCRenderMode](#ByteRTCRenderMode)。默认值为 1。 ### type ```objectivec @property (assign, nonatomic) ByteRTCTranscoderLayoutRegionType type; ``` 合流布局区域类型。参看 [ByteRTCTranscoderLayoutRegionType](#ByteRTCTranscoderLayoutRegionType)。 ### data ```objectivec @property (strong, nonatomic) NSData * _Nullable data; ``` 图片合流布局区域类型对应的数据。类型为图片时传入图片 RGBA 数据，当类型为视频流时传空。 ### dataParam ```objectivec @property (strong, nonatomic) ByteRTCTranscoderLayoutRegionDataParam * _Nullable dataParam; ``` 合流布局区域数据的对应参数。当类型为视频流时传空，类型为图片时传入对应图片的参数，参看 [ByteRTCTranscoderLayoutRegionDataParam](#ByteRTCTranscoderLayoutRegionDataParam)。 ### spatialPosition ```objectivec @property (strong, nonatomic) ByteRTCPosition * _Nullable spatialPosition; ``` 空间位置。参看 [ByteRTCPosition](#ByteRTCPosition)。 ### applySpatialAudio ```objectivec @property(assign, nonatomic) BOOL applySpatialAudio; ``` 设置某用户是否应用空间音频效果： - Yes：启用（默认值） - No：禁用 # ByteRTCLocalProxyError ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCLocalProxyError ) ``` 本地代理错误。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLocalProxyErrorOK | 0 | 本地代理服务器无错误。 | | ByteRTCLocalProxyErrorSocks5VersionError | 1 | 代理服务器回复的版本号不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。 | | ByteRTCLocalProxyErrorSocks5FormatError | 2 | 代理服务器回复的格式错误不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。 | | ByteRTCLocalProxyErrorSocks5InvalidValue | 3 | 代理服务器回复的字段值不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。 | | ByteRTCLocalProxyErrorSocks5UserPassNotGiven | 4 | 未提供代理服务器的用户名及密码，导致 Socks5 代理连接失败。请重新调用 `setLocalProxy`，在设置本地代理时填入用户名和密码。 | | ByteRTCLocalProxyErrorSocks5TcpClosed | 5 | TCP 关闭，导致 Socks5 代理连接失败。请检查网络或者代理服务器是否存在异常。 | | ByteRTCLocalProxyErrorHttpTunnelFailed | 6 | Http 隧道代理错误。请检查 Http 隧道代理服务器或者网络是否存在异常。 | # ByteRTCBluetoothMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCBluetoothMode ) ``` 蓝牙传输协议。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCBluetoothModeAuto | 0 | 默认采用 auto 模式，具体如下：

场景	HFP	A2DP
纯通话场景	蓝牙设备支持 HFP	蓝牙设备不支持 HFP
纯媒体场景	使用蓝牙设备采集播放音频	使用 iOS 设备采集音频，蓝牙设备播放音频

| | ByteRTCBluetoothModeA2DP | 1 | 高级音频分配配置文件（A2DP）。立体声、高音质。采用 iOS 设备进行音频采集，蓝牙设备进行播放。 | | ByteRTCBluetoothModeHFP | 2 | 免提配置文件（HFP）。单声道、普通音质。音频采集和播放设备都使用蓝牙设备。 | # ByteRTCVideoContentType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoContentType ) ``` 视频内容类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoContentTypeNormalFrame | 0 | 普通视频 | | ByteRTCVideoContentTypeBlackFrame | 1 | 黑帧视频 | # ByteRTCRemoteVideoStats ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRemoteVideoStats : NSObject ``` 远端视频流统计信息，统计周期为 2s 。本地用户订阅远端视频流成功后，SDK 会周期性地通过 `onRemoteStreamStats` 通知本地用户订阅的远端视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [width](#ByteRTCRemoteVideoStats-width) | | NSInteger | [height](#ByteRTCRemoteVideoStats-height) | | float | [videoLossRate](#ByteRTCRemoteVideoStats-videolossrate) | | float | [receivedKBitrate](#ByteRTCRemoteVideoStats-receivedkbitrate) | | NSInteger | [receivedFrameRate](#ByteRTCRemoteVideoStats-receivedframerate) | | NSInteger | [decoderOutputFrameRate](#ByteRTCRemoteVideoStats-decoderoutputframerate) | | NSInteger | [renderOutputFrameRate](#ByteRTCRemoteVideoStats-renderoutputframerate) | | NSInteger | [stallCount](#ByteRTCRemoteVideoStats-stallcount) | | NSInteger | [stallDuration](#ByteRTCRemoteVideoStats-stallduration) | | NSInteger | [e2eDelay](#ByteRTCRemoteVideoStats-e2edelay) | | BOOL | [isScreen](#ByteRTCRemoteVideoStats-isscreen) | | NSInteger | [statsInterval](#ByteRTCRemoteVideoStats-statsinterval) | | NSInteger | [rtt](#ByteRTCRemoteVideoStats-rtt) | | NSInteger | [frozenRate](#ByteRTCRemoteVideoStats-frozenrate) | | ByteRTCVideoCodecType | [codecType](#ByteRTCRemoteVideoStats-codectype) | | NSInteger | [videoIndex](#ByteRTCRemoteVideoStats-videoindex) | | NSInteger | [jitter](#ByteRTCRemoteVideoStats-jitter) | ## 变量说明 ### width ```objectivec @property(assign, nonatomic) NSInteger width; ``` 远端视频宽度。 ### height ```objectivec @property(assign, nonatomic) NSInteger height; ``` 远端视频高度。 ### videoLossRate ```objectivec @property(assign, nonatomic) float videoLossRate; ``` 远端视频丢包率。统计周期内的视频下行丢包率，取值范围为 [0, 1] 。 ### receivedKBitrate ```objectivec @property(assign, nonatomic) float receivedKBitrate; ``` 接收码率。统计周期内的视频接收码率，单位为 kbps 。 ### receivedFrameRate ```objectivec @property(assign, nonatomic) NSInteger receivedFrameRate; ``` 远端视频接收帧率。 ### decoderOutputFrameRate ```objectivec @property(assign, nonatomic) NSInteger decoderOutputFrameRate; ``` 远端视频解码输出帧率。 ### renderOutputFrameRate ```objectivec @property(assign, nonatomic) NSInteger renderOutputFrameRate; ``` 远端视频渲染输出帧率。 ### stallCount ```objectivec @property(assign, nonatomic) NSInteger stallCount; ``` 远端视频卡顿次数。 ### stallDuration ```objectivec @property(assign, nonatomic) NSInteger stallDuration; ``` 远端视频卡顿时长，单位为 ms 。 ### e2eDelay ```objectivec @property(assign, nonatomic) NSInteger e2eDelay; ``` 用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为 ms 。 ### isScreen ```objectivec @property(assign, nonatomic) BOOL isScreen; ``` 远端视频流是否是屏幕共享流。你可以知道当前数据来自主流还是屏幕流。 ### statsInterval ```objectivec @property(assign, nonatomic) NSInteger statsInterval; ``` 统计间隔，此次统计周期的间隔，单位为 ms 。此字段用于设置回调的统计周期，目前设置为 2s 。 ### rtt ```objectivec @property(assign, nonatomic) NSInteger rtt; ``` 往返时延。单位为 ms 。 ### frozenRate ```objectivec @property(assign, nonatomic) NSInteger frozenRate; ``` 远端用户在进房后发生视频卡顿的累计时长占视频总有效时长的百分比（%）。视频有效时长是指远端用户进房发布视频流后，除停止发送视频流和禁用视频模块之外的视频时长。 ### codecType ```objectivec @property(nonatomic) ByteRTCVideoCodecType codecType; ``` 编码类型。参看 [ByteRTCVideoCodecType](#ByteRTCVideoCodecType) 类型。 ### videoIndex ```objectivec @property(assign, nonatomic) NSInteger videoIndex; ``` SDK 订阅的远端视频流的分辨率下标。 ### jitter ```objectivec @property(assign, nonatomic) NSInteger jitter; ``` 视频下行网络抖动，单位为 ms。 # ByteRTCFrameExtendedData ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCFrameExtendedData : NSObject ``` 视频帧附加的数据,视频解码后获得的附加数据 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCDataFrameType | [frameType](#ByteRTCFrameExtendedData-frametype) | | NSData*_Nullable | [extendedData](#ByteRTCFrameExtendedData-extendeddata) | | NSInteger | [extendedDataLen](#ByteRTCFrameExtendedData-extendeddatalen) | ## 变量说明 ### frameType ```objectivec @property(assign, nonatomic) ByteRTCDataFrameType frameType; ``` 数据类型，详见 [ByteRTCDataFrameType](#ByteRTCDataFrameType)。 ### extendedData ```objectivec @property(strong, nonatomic) NSData * _Nullable extendedData; ``` 附加数据 ### extendedDataLen ```objectivec @property(assign, nonatomic) NSInteger extendedDataLen; ``` 附加数据长度 # ByteRTCRoomConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRoomConfig : NSObject ``` 房间参数配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCRoomProfile | [profile](#ByteRTCRoomConfig-profile) | | BOOL | [isAutoPublish](#ByteRTCRoomConfig-isautopublish) | | BOOL | [isAutoSubscribeAudio](#ByteRTCRoomConfig-isautosubscribeaudio) | | BOOL | [isAutoSubscribeVideo](#ByteRTCRoomConfig-isautosubscribevideo) | | ByteRTCRemoteVideoConfig* | [remoteVideoConfig](#ByteRTCRoomConfig-remotevideoconfig) | ## 变量说明 ### profile ```objectivec @property(nonatomic) ByteRTCRoomProfile profile; ``` 房间模式，参看 [ByteRTCRoomProfile](#ByteRTCRoomProfile)，默认为普通音视频通话模式，进房后不可更改。 ### isAutoPublish ```objectivec @property(assign, nonatomic) BOOL isAutoPublish; ``` 是否自动发布音视频流，默认为自动发布。创建和加入多房间时，只能将其中一个房间设置为自动发布。若每个房间均不做设置，则默认在第一个加入的房间内自动发布流。若调用 [setUserVisibility:](70092#ByteRTCRoom-setuservisibility) 将自身可见性设为 false，无论是默认的自动发布流还是手动设置的自动发布流都不会进行发布，你需要将自身可见性设为 true 后方可发布。 ### isAutoSubscribeAudio ```objectivec @property(assign, nonatomic) BOOL isAutoSubscribeAudio; ``` 是否自动订阅音频流，默认为自动订阅。包含主流和屏幕流。 ### isAutoSubscribeVideo ```objectivec @property(assign, nonatomic) BOOL isAutoSubscribeVideo; ``` 是否自动订阅主视频流，默认为自动订阅。包含主流和屏幕流。 ### remoteVideoConfig ```objectivec @property(nonatomic, strong) ByteRTCRemoteVideoConfig * _Nonnull remoteVideoConfig; ``` 远端视频流参数，参看 [ByteRTCRemoteVideoConfig](#ByteRTCRemoteVideoConfig) # ByteRTCScreenCaptureSourceInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCScreenCaptureSourceInfo : NSObject ``` 屏幕采集对象的具体信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCScreenCaptureSourceType | [sourceType](#ByteRTCScreenCaptureSourceInfo-sourcetype) | | intptr_t | [sourceId](#ByteRTCScreenCaptureSourceInfo-sourceid) | | NSString*_Nullable | [sourceName](#ByteRTCScreenCaptureSourceInfo-sourcename) | | NSString*_Nullable | [application](#ByteRTCScreenCaptureSourceInfo-application) | | int | [pid](#ByteRTCScreenCaptureSourceInfo-pid) | | BOOL | [primaryMonitor](#ByteRTCScreenCaptureSourceInfo-primarymonitor) | | CGRect | [regionRect](#ByteRTCScreenCaptureSourceInfo-regionrect) | ## 变量说明 ### sourceType ```objectivec @property (assign, nonatomic) ByteRTCScreenCaptureSourceType sourceType; ``` 屏幕分享时，共享对象的类型，参看 [ByteRTCScreenCaptureSourceType](#ByteRTCScreenCaptureSourceType) ### sourceId ```objectivec @property (assign, nonatomic) intptr_t sourceId; ``` 屏幕分享时，共享对象的 ID。 ### sourceName ```objectivec @property (copy, nonatomic) NSString * _Nullable sourceName; ``` 屏幕分享时共享对象的名称。 ### application ```objectivec @property (copy, nonatomic) NSString * _Nullable application; ``` 共享的应用窗体所属应用的名称当共享对象为应用窗体时有效 ### pid ```objectivec @property (assign, nonatomic) int pid; ``` 共享的应用窗体所属应用进程的 pid 当共享对象为应用窗体时有效 ### primaryMonitor ```objectivec @property (assign, nonatomic) BOOL primaryMonitor; ``` 共享的屏幕是否为主屏。当共享对象为屏幕时有效 ### regionRect ```objectivec @property (assign, nonatomic) CGRect regionRect; ``` 屏幕共享对象的坐标。多显示器的场景下，屏幕坐标系统以主屏左上角为原点 (0, 0)，向右向下扩展。 # ByteRTCVideoCompositingLayout ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoCompositingLayout : NSObject ``` > Deprecated since 3.52, use [ByteRTCMixedStreamLayoutConfig](#ByteRTCMixedStreamLayoutConfig) instead. 视频流合流整体布局信息。开启转推直播功能后，你可以设置参与合流的每路视频流的预设布局信息和合流背景信息等。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [backgroundColor](#ByteRTCVideoCompositingLayout-backgroundcolor) | | NSArray* | [regions](#ByteRTCVideoCompositingLayout-regions) | | NSString* | [appData](#ByteRTCVideoCompositingLayout-appdata) | ## 变量说明 ### backgroundColor ```objectivec @property(copy, nonatomic) NSString *_Nonnull backgroundColor; ``` 合流背景颜色，用十六进制颜色码（HEX）表示。例如，#FFFFFF 表示纯白，#000000 表示纯黑。默认值为 #000000。值不合法或未设置时，自动使用默认值。 ### regions ```objectivec @property(copy, nonatomic) NSArray * _Nonnull regions; ``` 用户布局信息列表。每条流的具体布局参看 [ByteRTCVideoCompositingRegion](#ByteRTCVideoCompositingRegion)。值不合法或未设置时，自动使用默认值。 ### appData ```objectivec @property(copy, nonatomic) NSString *_Nonnull appData; ``` 透传的 App 数据，长度不超过 4KB。 # ByteRTCBandFrequency ```objectivec typedef NS_ENUM( NSInteger, ByteRTCBandFrequency ) ``` 音频均衡效果。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCBandFrequency31 | 0 | 中心频率为 31Hz 的频带。 | | ByteRTCBandFrequency62 | 1 | 中心频率为 62Hz 的频带。 | | ByteRTCBandFrequency125 | 2 | 中心频率为 125Hz 的频带。 | | ByteRTCBandFrequency250 | 3 | 中心频率为 250Hz 的频带。 | | ByteRTCBandFrequency500 | 4 | 中心频率为 500Hz 的频带。 | | ByteRTCBandFrequency1k | 5 | 中心频率为 1kHz 的频带。 | | ByteRTCBandFrequency2k | 6 | 中心频率为 2kHz 的频带。 | | ByteRTCBandFrequency4k | 7 | 中心频率为 4kHz 的频带。 | | ByteRTCBandFrequency8k | 8 | 中心频率为 8kHz 的频带。 | | ByteRTCBandFrequency16k | 9 | 中心频率为 16kHz 的频带。 | # ByteRTCAudioDumpStatus ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioDumpStatus ) ``` 音频 dump 状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioDumpStartFailure | 0 | 音频 dump 启动失败 | | ByteRTCAudioDumpStartSuccess | 1 | 音频 dump 启动成功 | | ByteRTCAudioDumpStopFailure | 2 | 音频 dump 停止失败 | | ByteRTCAudioDumpStopSuccess | 3 | 音频 dump 停止成功 | | ByteRTCAudioDumpRunningFailure | 4 | 音频 dump 运行失败 | | ByteRTCAudioDumpRunningSuccess | 5 | 音频 dump 运行成功 | # ByteRTCAudioProfileType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioProfileType ) ``` 音质档位 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioProfileDefault | 0 | 默认音质
服务器下发或客户端已设置的 [ByteRTCRoomProfile](#ByteRTCRoomProfile) 的音质配置 | | ByteRTCAudioProfileFluent | 1 | 流畅
单声道，采样率为 16 kHz，编码码率为 32 Kbps。
流畅优先、低功耗、低流量消耗，适用于大部分游戏场景，如小队语音、组队语音、国战语音等。 | | ByteRTCAudioProfileStandard | 2 | 单声道标准音质。
采样率为 24 kHz，编码码率为 48 Kbps。
适用于对音质有一定要求的场景，同时延时、功耗和流量消耗相对适中，适合教育场景和狼人杀等游戏。 | | ByteRTCAudioProfileHD | 3 | 双声道音乐音质
采样率为 48 kHz，编码码率为 128 kbps。
超高音质，同时延时、功耗和流量消耗相对较大，适用于连麦 PK 等音乐场景。
游戏场景不建议使用。 | | ByteRTCAudioProfileStandardStereo | 4 | 双声道标准音质。采样率为 48 KHz，编码码率最大值为 80 Kbps | | ByteRTCAudioProfileHDMono | 5 | 单声道音乐音质。采样率为 48 kHz，编码码率最大值为 64 Kbps | # ByteRTCAggregationOption ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAggregationOption ) ``` > Available since 3.56 流聚合策略 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAggregationOptionMin | 0 | 流聚合向下取值（默认策略） | | ByteRTCAggregationOptionMax | 1 | 流聚合向上取值 | | ByteRTCAggregationOptionMajority | 2 | 流聚合按比例取值，比例相同时，向下取值 | # ByteRTCMediaStreamType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMediaStreamType ) ``` 媒体流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMediaStreamTypeAudio | 1 << 0 | 只控制音频 | | ByteRTCMediaStreamTypeVideo | 1 << 1 | 只控制视频 | | ByteRTCMediaStreamTypeBoth | ByteRTCMediaStreamTypeAudio \| ByteRTCMediaStreamTypeVideo | 同时控制音频和视频 | # ByteRTCEchoTestResult ```objectivec typedef NS_ENUM( NSInteger, ByteRTCEchoTestResult ) ``` 音视频回路测试结果 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCEchoTestResultSuccess | 0 | 接收到采集的音视频的回放，通话回路检测成功 | | ByteRTCEchoTestResultTimeout | 1 | 测试超过 60s 仍未完成，已自动停止 | | ByteRTCEchoTestResultIntervalShort | 2 | 上一次测试结束和下一次测试开始之间的时间间隔少于 5s | | ByteRTCEchoTestResultAudioDeviceError | 3 | 音频采集异常 | | ByteRTCEchoTestResultVideoDeviceError | 4 | 视频采集异常 | | ByteRTCEchoTestResultAudioReceiveError | 5 | 音频接收异常 | | ByteRTCEchoTestResultVideoReceiveError | 6 | 视频接收异常 | | ByteRTCEchoTestResultInternalError | 7 | 内部错误，不可恢复 | # ByteRTCRoomProfile ```objectivec typedef NS_ENUM( NSInteger, ByteRTCRoomProfile ) ``` 房间模式根据所需场景，选择合适的房间模式，应用不同的音视频算法、视频参数和网络配置调用 `setAudioProfile` 改变音频参数配置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRoomProfileCommunication | 0 | 默认场景，通用模式
与 `ByteRTCRoomProfileMeeting = 16` 配置相同。
你可以联系技术支持更换默认配置参数。 | | ByteRTCRoomProfileGame | 2 | 游戏语音模式，低功耗、低流量消耗。
低端机在此模式下运行时，进行了额外的性能优化：

部分低端机型配置编码帧长 40/60

部分低端机型关闭软件 3A 音频处理增强对 iOS 其他屏幕录制进行的兼容性，避免音频录制被 RTC 打断。

| | ByteRTCRoomProfileCloudGame | 3 | 云游戏模式。
如果你的游戏场景需要低延迟的配置，使用此设置。
此设置下，弱网抗性较差。 | | ByteRTCRoomProfileLowLatency | 4 | 云渲染模式。超低延时配置。
如果你的应用并非游戏但又对延时要求较高时，选用此模式
该模式下，音视频通话延时会明显降低，但同时弱网抗性、通话音质等均会受到一定影响。 | | ByteRTCRoomProfileChat | 5 | 适用于 1 vs 1 音视频通话 | | ByteRTCRoomProfileChatRoom | 6 | 适用于 3 人及以上纯语音通话。
通话中，闭麦时为是媒体模式，上麦后切换为通话模式。 | | ByteRTCRoomProfileLwTogether | 7 | 实现多端同步播放音视频，适用于 “一起看” 或 “一起听” 场景。
该场景中，使用 RTC 信令同步播放进度，共享的音频内容不通过 RTC 进行传输。 | | ByteRTCRoomProfileGameHD | 8 | 适用于对音质要求较高的游戏场景，优化音频 3A 策略，只通过媒体模式播放音频 | | ByteRTCRoomProfileCoHost | 9 | 适用于直播中主播之间连麦的业务场景。
该场景中，直播时通过 CDN，发起连麦 PK 时使用 RTC。 | | ByteRTCRoomProfileInteractivePodcast | 10 | 适用于单主播和观众进行音视频互动的直播。通话模式，上下麦不会有模式切换，避免音量突变现象 | | ByteRTCRoomProfileKTV | 11 | 线上 KTV 场景，音乐音质，低延迟
使用 RTC 传输伴奏音乐，混音后的歌声，适合独唱或单通合唱 | | ByteRTCRoomProfileChorus | 12 | 适合在线实时合唱场景，高音质，超低延迟。使用本配置前请联系技术支持进行协助完成其他配置。 | | ByteRTCRoomProfileVRChat | 13 | 适用于 VR 场景。支持最高 192 KHz 音频采样率，可开启球形立体声。345 之后支持 | | ByteRTCRoomProfileGameStreaming | 14 | 适用于 1 vs 1 游戏串流，支持公网或局域网。 | | ByteRTCRoomProfileLanLiveStreaming | 15 | 适用于局域网的 1 对多视频直播，最高支持 8K， 60 帧/秒， 100 Mbps 码率
需要在局域网配置私有化部署媒体服务器。 | | ByteRTCRoomProfileMeeting | 16 | 适用于云端会议中的个人设备 | | ByteRTCRoomProfileMeetingRoom | 17 | 适用于云端会议中的会议室终端设备，例如 Rooms，投屏盒子等。 | | ByteRTCRoomProfileClassroom | 18 | 适用于课堂互动，房间内所有成员都可以进行音视频互动
当你的场景中需要同时互动的成员超过 10 人时使用此模式 | | [deprecated] ByteRTCRoomProfileLiveBroadcasting | 1 | `Deprecated since 3.42 and will be deleted in 3.51, use ByteRTCRoomProfileInteractivePodcast instead.`
直播模式。
当你对音视频通话的音质和画质要求较高时，应使用此设置。
此设置下，当用户使用蓝牙耳机收听时，蓝牙耳机使用媒体模式。 | # ByteRTCPositionInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCPositionInfo : NSObject ``` 用户在空间音频坐标系里的位置信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCPosition* | [position](#ByteRTCPositionInfo-position) | | ByteRTCHumanOrientation* | [orientation](#ByteRTCPositionInfo-orientation) | ## 变量说明 ### position ```objectivec @property(strong, nonatomic) ByteRTCPosition *_Nonnull position; ``` 用户在空间音频坐标系里的位置，需自行建立空间直角坐标系。参看 [ByteRTCPosition](#ByteRTCPosition)。 ### orientation ```objectivec @property(strong, nonatomic) ByteRTCHumanOrientation *_Nonnull orientation; ``` 用户在空间音频坐标系里的三维朝向信息。三个向量需要两两垂直。参看 [ByteRTCHumanOrientation](#ByteRTCHumanOrientation)。 # ByteRTCScreenParam ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCScreenParam : NSObject ``` 屏幕采集设置参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [frameRate](#ByteRTCScreenParam-framerate) | | NSInteger | [bitrate](#ByteRTCScreenParam-bitrate) | ## 变量说明 ### frameRate ```objectivec @property(nonatomic, assign) NSInteger frameRate; ``` 编码帧率,单位为 fps ### bitrate ```objectivec @property(nonatomic, assign) NSInteger bitrate; ``` 编码码率，小于 0 时 SDK 会根据高宽自适应码率, 单位 kbps # ByteRTCScreenCaptureSourceType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCScreenCaptureSourceType ) ``` 屏幕采集对象的类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCScreenCaptureSourceTypeUnknown | 0 | 类型未知 | | ByteRTCScreenCaptureSourceTypeWindow | 1 | 应用程序的窗口 | | ByteRTCScreenCaptureSourceTypeScreen | 2 | 桌面 | # ByteRTCTranscoderContentControlType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCTranscoderContentControlType ) ``` > Deprecated since 3.52, use [ByteRTCMixedStreamMediaType](#ByteRTCMixedStreamMediaType) instead. 合流输出内容类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCTranscoderContentControlTypeHasAudioAndVideo | 0 | 输出的混流包含音频和视频 | | ByteRTCTranscoderContentControlTypeHasAudioOnly | 1 | 输出的混流只包含音频 | | ByteRTCTranscoderContentControlTypeHasVideoOnly | 2 | 输出的混流只包含视频 | # ByteRTCClientMixVideoFormat ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCClientMixVideoFormat ) ``` > Deprecated since 3.52, use [ByteRTCMixedStreamClientMixVideoFormat](#ByteRTCMixedStreamClientMixVideoFormat) instead. 客户端合流回调视频格式。设置为系统不支持的格式时，自动回调系统默认格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCClientMixVideoFormatI420 | 0 | YUV I420。Android、Windows 默认回调格式。支持系统：Android、Windows。 | | ByteRTCClientMixVideoFormatTexture2D | 1 | OpenGL GL_TEXTURE_2D 格式纹理。支持系统：安卓。 | | ByteRTCClientMixVideoFormatCVPixelBufferBGRA | 2 | CVPixelBuffer BGRA。iOS 默认回调格式。支持系统: iOS。 | | ByteRTCClientMixVideoFormatNV12 | 3 | YUV NV12。macOS 默认回调格式。支持系统: macOS。 | # ByteRTCForwardStreamState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCForwardStreamState ) ``` 媒体流跨房间转发状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCForwardStreamStateIdle | 0 | 空闲状态

成功调用 `stopForwardStreamToRooms` 后，所有目标房间为空闲状态。

成功调用 `updateForwardStreamToRooms` 减少目标房间后，本次减少的目标房间为空闲状态。

| | ByteRTCForwardStreamStateSuccess | 1 | 开始转发

调用 `startForwardStreamToRooms` 成功向所有房间开始转发媒体流后，返回此状态。

调用 `updateForwardStreamToRooms` 后，成功向新增目标房间开始转发媒体流后，返回此状态。

| | ByteRTCForwardStreamStateFailure | 2 | 转发失败，失败详情参考 [ByteRTCForwardStreamError](#ByteRTCForwardStreamError)
调用 `startForwardStreamToRooms` 或 `updateForwardStreamToRooms` 后，如遇转发失败，返回此状态。 | # ByteRTCMediaPlayerCustomSourceSeekWhence ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMediaPlayerCustomSourceSeekWhence ) ``` 音频数据的起始读取位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMediaPlayerCustomSourceSeekWhenceSet | 0 | 从音频数据的头开始读取，读取后的位置为参数 offset 的值。 | | ByteRTCMediaPlayerCustomSourceSeekWhenceCur | 1 | 从音频数据的某一位置开始读取，读取后的位置为音频数据当前的读取位置加上参数 offset 的值。 | | ByteRTCMediaPlayerCustomSourceSeekWhenceEnd | 2 | 从音频数据的尾开始读取，读取后的位置为用户传入的音频数据大小加上参数 offset 的值。 | | ByteRTCMediaPlayerCustomSourceSeekWhenceSize | 3 | 返回音频数据的大小。 | # ByteRTCAudioMixingDualMonoMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioMixingDualMonoMode ) ``` 混音播放声道类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioMixingDualMonoModeAuto | 0 | 和音频文件一致 | | ByteRTCAudioMixingDualMonoModeL | 1 | 只能听到音频文件中左声道的音频 | | ByteRTCAudioMixingDualMonoModeR | 2 | 只能听到音频文件中右声道的音频 | | ByteRTCAudioMixingDualMonoModeMix | 3 | 能同时听到音频文件中左右声道的音频 | # ByteRTCRecordingType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCRecordingType ) ``` 本地录制的媒体类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRecordingTypeAudioOnly | 0 | 只录制音频 | | ByteRTCRecordingTypeVideoOnly | 1 | 只录制视频 | | ByteRTCRecordingTypeVideoAndAudio | 2 | 同时录制音频和视频 | # ByteRTCZoomDirectionType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCZoomDirectionType ) ``` 数字变焦操作类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCZoomDirectionTypeMoveLeft | 0 | 相机向左移动 | | ByteRTCZoomDirectionTypeMoveRight | 1 | 相机向右移动 | | ByteRTCZoomDirectionTypeMoveUp | 2 | 相机向上移动 | | ByteRTCZoomDirectionTypeMoveDown | 3 | 相机向下移动 | | ByteRTCZoomDirectionTypeZoomOut | 4 | 相机缩小焦距 | | ByteRTCZoomDirectionTypeZoomIn | 5 | 相机放大焦距 | | ByteRTCZoomDirectionTypeReset | 6 | 恢复到原始画面 | # ByteRTCNetworkDetectionStopReason ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCNetworkDetectionStopReason ) ``` 通话前探测的停止原因 `rtcEngine:onNetworkDetectionStopped:` 回调的参数类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCNetworkDetectionStopReasonUser | 0 | 用户主动停止。 | | ByteRTCNetworkDetectionStopReasonTimeout | 1 | 探测超过三分钟。 | | ByteRTCNetworkDetectionStopReasonConnectionLost | 2 | 探测网络连接断开。
当超过 12s 没有收到回复，SDK 将断开网络连接，并且不再尝试重连。 | | ByteRTCNetworkDetectionStopReasonStreaming | 3 | 本地开始推拉流，停止探测。 | | ByteRTCNetworkDetectionStopReasonInnerErr | 4 | 网络探测失败，内部异常 | # ByteRTCAudioQuality ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioQuality ) ``` 音频质量 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioQualityLow | 0 | 低音质 | | ByteRTCAudioQualityMedium | 1 | 中音质 | | ByteRTCAudioQualityHigh | 2 | 高音质 | | ByteRTCAudioQualityUltraHigh | 3 | 超高音质 | # ByteRTCMediaPlayerCustomSourceMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMediaPlayerCustomSourceMode ) ``` 自定义音频源模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMediaPlayerCustomSourceModePush | 0 | 当播放来自本地的 PCM 数据时，使用此选项。 | | ByteRTCMediaPlayerCustomSourceModePull | 1 | 当播放来自内存的音频数据时，使用此选项。 | # ByteRTCRenderMode ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCRenderMode ) ``` > Deprecated since 3.52, use [ByteRTCMixedStreamRenderMode](#ByteRTCMixedStreamRenderMode) instead. 图片或视频流的缩放模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRenderModeHidden | 1 | 视窗填满优先，默认值。
视频尺寸等比缩放，直至视窗被填满。当视频尺寸与显示窗口尺寸不一致时，多出的视频将被截掉。 | | ByteRTCRenderModeFit | 2 | 视频帧内容全部显示优先。
视频尺寸等比缩放，优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时，会把窗口未被填满的区域填充成背景颜色。 | | ByteRTCRenderModeFill | 3 | 视频帧自适应画布。
视频尺寸非等比例缩放，把窗口充满。在此过程中，视频帧的长宽比例可能会发生变化。 | # ByteRTCSEIStreamEventType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCSEIStreamEventType ) ``` 黑帧视频流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCSEIStreamEventTypeStreamAdd | 0 | 远端用户发布黑帧视频流。
纯语音通话场景下，远端用户调用 [sendSEIMessage:andMessage:andRepeatCount:andCountPerFrame:](70092#ByteRTCVideo-sendseimessage-andmessage-andrepeatcount-andcountperframe) 发送 SEI 数据时，SDK 会自动发布一路黑帧视频流，并触发该回调。 | | ByteRTCSEIStreamEventTypeStreamRemove | 1 | 远端黑帧视频流移除。该回调的触发时机包括：

远端用户开启摄像头采集，由语音通话切换至视频通话，黑帧视频流停止发布；

远端用户调用 [sendSEIMessage:andMessage:andRepeatCount:andCountPerFrame:](70092#ByteRTCVideo-sendseimessage-andmessage-andrepeatcount-andcountperframe) 后 1min 内未有 SEI 数据发送，黑帧视频流停止发布；

远端用户调用 [setVideoSourceType:WithStreamIndex:](70092#ByteRTCVideo-setvideosourcetype-withstreamindex) 切换至自定义视频采集时，黑帧视频流停止发布。

| # ByteRTCRecordingConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRecordingConfig : NSObject ``` 本地录制参数配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString*_Nullable | [dirPath](#ByteRTCRecordingConfig-dirpath) | | ByteRTCRecordingFileType | [recordingFileType](#ByteRTCRecordingConfig-recordingfiletype) | ## 变量说明 ### dirPath ```objectivec @property(strong, nonatomic) NSString* _Nullable dirPath; ``` 录制文件保存的绝对路径，需精确到文件夹，文件名由 RTC 自动生成。你需要确保对该路径具有读写权限。 ### recordingFileType ```objectivec @property(assign, nonatomic) ByteRTCRecordingFileType recordingFileType; ``` 录制存储文件格式，参看 [ByteRTCRecordingFileType](#ByteRTCRecordingFileType) # ByteRTCRemoteVideoSinkConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRemoteVideoSinkConfig : NSObject ``` 远端视频帧回调配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCRemoteVideoRenderPosition | [position](#ByteRTCRemoteVideoSinkConfig-position) | | ByteRTCVideoSinkPixelFormat | [requiredPixelFormat](#ByteRTCRemoteVideoSinkConfig-requiredpixelformat) | | ByteRTCVideoApplyRotation | [applyRotation](#ByteRTCRemoteVideoSinkConfig-applyrotation) | | ByteRTCVideoRenderMirrorType | [mirrorType](#ByteRTCRemoteVideoSinkConfig-mirrortype) | ## 变量说明 ### position ```objectivec @property(nonatomic, assign) ByteRTCRemoteVideoRenderPosition position; ``` 远端视频帧回调位置，参看 [ByteRTCLocalVideoRenderPosition](#ByteRTCLocalVideoRenderPosition)，默认回调后处理后的视频帧。 ### requiredPixelFormat ```objectivec @property(nonatomic, assign) ByteRTCVideoSinkPixelFormat requiredPixelFormat; ``` 远端视频帧回调格式，参看 [ByteRTCVideoSinkPixelFormat](#ByteRTCVideoSinkPixelFormat)，默认值为 0。 ### applyRotation ```objectivec @property(nonatomic, assign) ByteRTCVideoApplyRotation applyRotation; ``` 是否将视频帧自动转正，参看 [ByteRTCVideoApplyRotation](#ByteRTCVideoApplyRotation)，默认为不旋转。 ### mirrorType ```objectivec @property(nonatomic, assign) ByteRTCVideoRenderMirrorType mirrorType; ``` 是否将视频帧镜像。参看 [ByteRTCVideoRenderMirrorType](#ByteRTCVideoRenderMirrorType)，默认为不镜像。本设置与 [setRemoteVideoMirrorType:withMirrorType:](70092#ByteRTCVideo-setremotevideomirrortype-withmirrortype)（适用于内部渲染）相互独立。 # ByteRTCVideoOutputOrientationMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoOutputOrientationMode ) ``` 视频输出方向模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoOutputOrientationModeAdaptative | 0 | 自适应布局 | | ByteRTCVideoOutputOrientationModeFixedLandscape | 1 | 横屏布局 | | ByteRTCVideoOutputOrientationModeFixedPortrait | 2 | 竖屏布局 | # ByteRTCLocalVideoRenderPosition ```objectivec typedef NS_ENUM( NSInteger, ByteRTCLocalVideoRenderPosition ) ``` 本地视频帧回调位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLocalVideoRenderPositionAfterCapture | 0 | 采集后。 | | ByteRTCLocalVideoRenderPositionAfterPreprocess | 1 | （默认值）前处理后。 | # ByteRTCRemoteVideoStateChangeReason ```objectivec typedef NS_ENUM( NSInteger, ByteRTCRemoteVideoStateChangeReason ) ``` 远端视频流状态改变的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRemoteVideoStateChangeReasonInternal | 0 | 内部原因 | | ByteRTCRemoteVideoStateChangeReasonNetworkCongestion | 1 | 网络阻塞 | | ByteRTCRemoteVideoStateChangeReasonNetworkRecovery | 2 | 网络恢复正常 | | ByteRTCRemoteVideoStateChangeReasonLocalMuted | 3 | 本地用户停止接收远端视频流或本地用户禁用视频模块 | | ByteRTCRemoteVideoStateChangeReasonLocalUnmuted | 4 | 本地用户恢复接收远端视频流或本地用户启用视频模块 | | ByteRTCRemoteVideoStateChangeReasonRemoteMuted | 5 | 远端用户停止发送视频流或远端用户禁用视频模块 | | ByteRTCRemoteVideoStateChangeReasonRemoteUnmuted | 6 | 远端用户恢复发送视频流或远端用户启用视频模块 | | ByteRTCRemoteVideoStateChangeReasonRemoteOffline | 7 | 远端用户离开房间 | # ByteRTCVideoStreamType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoStreamType ) ``` 视频流类型目前 C++ SDK 只支持 ByteRTCVideoStreamTypeHigh 类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoStreamTypeHigh | 0 | 高分辨率视频流 | | ByteRTCVideoStreamTypeLow | 1 | 低分辨率视频 | # ByteRTCMixedStreamVideoCodecType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMixedStreamVideoCodecType ) ``` 视频编码格式。(新) ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamVideoCodecTypeH264 | 0 | H.264 格式，默认值。 | | ByteRTCMixedStreamVideoCodecTypeByteVC1 | 1 | ByteVC1 格式。 | # ByteRTCFirstFramePlayState ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCFirstFramePlayState ) ``` 首帧播放状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCFirstFramePlayStatePlaying | 0 | 播放中 | | ByteRTCFirstFramePlayStatePlay | 1 | 播放成功 | | ByteRTCFirstFramePlayStateEnd | 2 | 播放失败 | # ByteRTCAVSyncState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAVSyncState ) ``` 音视频同步状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAVSyncStateAVStreamSyncBegin | 0 | 音视频开始同步 | | ByteRTCAVSyncStateAudioStreamRemove | 1 | 音视频同步过程中音频移除，但不影响当前的同步关系 | | ByteRTCAVSyncStateVideoStreamRemove | 2 | 音视频同步过程中视频移除，但不影响当前的同步关系 | # ByteRTCPauseResumControlMediaType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCPauseResumControlMediaType ) ``` 暂停/恢复接收远端的媒体流类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCControlMediaTypeAudio | 0 | 只控制音频，不影响视频 | | ByteRtcControlMediaTypeVideo | 1 | 只控制视频，不影响音频 | | ByteRtcControlMediaTypeAudioAndVideo | 2 | 同时控制音频和视频 | # ByteRTCVideoCaptureConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoCaptureConfig: NSObject ``` 视频采集参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCVideoCapturePreference | [preference](#ByteRTCVideoCaptureConfig-preference) | | CGSize | [videoSize](#ByteRTCVideoCaptureConfig-videosize) | | NSInteger | [frameRate](#ByteRTCVideoCaptureConfig-framerate) | ## 变量说明 ### preference ```objectivec @property(nonatomic, assign) ByteRTCVideoCapturePreference preference; ``` 视频采集模式，参看 [ByteRTCVideoCapturePreference](#ByteRTCVideoCapturePreference) ### videoSize ```objectivec @property(nonatomic, assign) CGSize videoSize; ``` 视频采集分辨率 ### frameRate ```objectivec @property(nonatomic, assign) NSInteger frameRate; ``` 视频采集帧率，单位：fps。 # ByteRTCUser ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCUser : NSObject ``` 用户信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [userId](#ByteRTCUser-userid) | | NSString* | [metaData](#ByteRTCUser-metadata) | ## 变量说明 ### userId ```objectivec @property(nonatomic, copy, nullable) NSString *userId; ``` 用户 ID ### metaData ```objectivec @property(nonatomic, copy, nullable) NSString *metaData; ``` 元信息 # ByteRTCPerformanceAlarmMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCPerformanceAlarmMode ) ``` 性能回退的模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCPerformanceAlarmModeNormal | 0 | 未开启发布性能回退 | | ByteRTCPerformanceAlarmModeSimulcast | 1 | 已开启发布性能回退 | # ByteRTCRemoteStreamSwitchEvent ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRemoteStreamSwitchEvent : NSObject ``` 流切换信息。本地用户订阅的远端流触发回退策略时的流切换信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [uid](#ByteRTCRemoteStreamSwitchEvent-uid) | | BOOL | [isScreen](#ByteRTCRemoteStreamSwitchEvent-isscreen) | | NSInteger | [beforeVideoIndex](#ByteRTCRemoteStreamSwitchEvent-beforevideoindex) | | NSInteger | [afterVideoIndex](#ByteRTCRemoteStreamSwitchEvent-aftervideoindex) | | BOOL | [beforeVideoEnabled](#ByteRTCRemoteStreamSwitchEvent-beforevideoenabled) | | BOOL | [afterVideoEnabled](#ByteRTCRemoteStreamSwitchEvent-aftervideoenabled) | | ByteRTCFallbackOrRecoverReason | [reason](#ByteRTCRemoteStreamSwitchEvent-reason) | ## 变量说明 ### uid ```objectivec @property(nonatomic, copy) NSString * _Nonnull uid; ``` 订阅的音视频流的发布者的用户 ID。 ### isScreen ```objectivec @property(nonatomic, assign) BOOL isScreen; ``` 流是否是屏幕流 ### beforeVideoIndex ```objectivec @property(nonatomic, assign) NSInteger beforeVideoIndex; ``` 流切换前订阅视频流的分辨率对应的索引 ### afterVideoIndex ```objectivec @property(nonatomic, assign) NSInteger afterVideoIndex; ``` 流切换后订阅视频流的分辨率对应的索引 ### beforeVideoEnabled ```objectivec @property(nonatomic, assign) BOOL beforeVideoEnabled; ``` 流切换前是否有视频流 ### afterVideoEnabled ```objectivec @property(nonatomic, assign) BOOL afterVideoEnabled; ``` 流切换后是否有视频流 ### reason ```objectivec @property(nonatomic, assign) ByteRTCFallbackOrRecoverReason reason; ``` 流切换原因，详见 [ByteRTCFallbackOrRecoverReason](#ByteRTCFallbackOrRecoverReason)。 # ByteRTCLocalAudioStats ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCLocalAudioStats : NSObject ``` 本地音频流统计信息，统计周期为 2s 。本地用户发布音频流成功后，SDK 会周期性地通过 `onLocalStreamStats` 通知本地用户发布的音频流在此次统计周期内的发送状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [audioLossRate](#ByteRTCLocalAudioStats-audiolossrate) | | float | [sentKBitrate](#ByteRTCLocalAudioStats-sentkbitrate) | | NSInteger | [recordSampleRate](#ByteRTCLocalAudioStats-recordsamplerate) | | NSInteger | [statsInterval](#ByteRTCLocalAudioStats-statsinterval) | | NSInteger | [rtt](#ByteRTCLocalAudioStats-rtt) | | NSInteger | [numChannels](#ByteRTCLocalAudioStats-numchannels) | | NSInteger | [sentSampleRate](#ByteRTCLocalAudioStats-sentsamplerate) | | NSInteger | [jitter](#ByteRTCLocalAudioStats-jitter) | ## 变量说明 ### audioLossRate ```objectivec @property(assign, nonatomic) float audioLossRate; ``` 音频丢包率。此次统计周期内的音频上行丢包率，取值范围为 [0, 1] 。 ### sentKBitrate ```objectivec @property(assign, nonatomic) float sentKBitrate; ``` 发送的码率。此次统计周期内的音频发送码率，单位为 kbps 。 ### recordSampleRate ```objectivec @property(assign, nonatomic) NSInteger recordSampleRate; ``` 采集采样率。此次统计周期内的音频采集采样率信息，单位为 Hz 。 ### statsInterval ```objectivec @property(assign, nonatomic) NSInteger statsInterval; ``` 统计间隔。此次统计周期的间隔，单位为 ms 。此字段用于设置回调的统计周期，默认设置为 2s 。 ### rtt ```objectivec @property(assign, nonatomic) NSInteger rtt; ``` 往返时延。单位为 ms 。 ### numChannels ```objectivec @property(assign, nonatomic) NSInteger numChannels; ``` 音频声道数。 ### sentSampleRate ```objectivec @property(assign, nonatomic) NSInteger sentSampleRate; ``` 音频发送采样率。此次统计周期内的音频发送采样率信息，单位为 Hz 。 ### jitter ```objectivec @property(assign, nonatomic) NSInteger jitter; ``` 音频上行网络抖动，单位为 ms。 # ByteRTCAudioAlignmentMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioAlignmentMode ) ``` 远端音频流精准对齐模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioAlignmentModeOff | 0 | 不对齐 | | ByteRTCAudioAlignmentModeAudioMixing | 1 | 远端音频流都对齐伴奏进度同步播放 | # ByteRTCReceiveRange ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCReceiveRange : NSObject ``` 本地用户能收听到、且具有衰减效果的音频接收范围 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [min](#ByteRTCReceiveRange-min) | | int | [max](#ByteRTCReceiveRange-max) | ## 变量说明 ### min ```objectivec @property(nonatomic, assign) int min; ``` 能够接收语音、并且具有衰减效果的最小距离值，该值须 ≥ 0，但 ≤ max。小于该值的范围内没有范围语音效果，即收听到的音频音量相同。 ### max ```objectivec @property(nonatomic, assign) int max; ``` 能够收听语音的最大距离值，该值须 \> 0 且 ≥ min。当收听者和声源距离处于 [min, max) 之间时，收听到的音量根据距离呈衰减效果。超出该值范围的音频将无法收听到。 # ByteRTCRecordingState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCRecordingState ) ``` 本地录制的状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRecordingStateError | 0 | 录制异常 | | ByteRTCRecordingStateProcessing | 1 | 录制进行中 | | ByteRTCRecordingStateSuccess | 2 | 录制文件保存成功，调用 `stopFileRecording:` 结束录制之后才会收到该状态码。 | # ByteRTCFaceDetectionResult ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCFaceDetectionResult : NSObject ``` 人脸检测结果 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [detectResult](#ByteRTCFaceDetectionResult-detectresult) | | int | [imageWidth](#ByteRTCFaceDetectionResult-imagewidth) | | int | [imageHeight](#ByteRTCFaceDetectionResult-imageheight) | | NSArray*_Nullable | [faces](#ByteRTCFaceDetectionResult-faces) | | CMTime | [frameTimestamp](#ByteRTCFaceDetectionResult-frametimestamp) | ## 变量说明 ### detectResult ```objectivec @property(assign, nonatomic) int detectResult; ``` 人脸检测结果 - 0：检测成功 - !0：检测失败。详见[错误码](https://www.volcengine.com/docs/6705/102042)。 ### imageWidth ```objectivec @property(assign, nonatomic) int imageWidth; ``` 原始图片宽度(px) ### imageHeight ```objectivec @property(assign, nonatomic) int imageHeight; ``` 原始图片高度(px) ### faces ```objectivec @property(nonatomic, copy) NSArray * _Nullable faces; ``` 识别到人脸的矩形框。数组的长度和检测到的人脸数量一致。参看 [ByteRTCRectangle](#ByteRTCRectangle)。 ### frameTimestamp ```objectivec @property(assign, nonatomic) CMTime frameTimestamp; ``` 进行人脸识别的视频帧的时间戳。 # ByteRTCVideoByteWatermark ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoByteWatermark: NSObject ``` 水印图片相对视频流的位置和大小。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [x](#ByteRTCVideoByteWatermark-x) | | float | [y](#ByteRTCVideoByteWatermark-y) | | float | [width](#ByteRTCVideoByteWatermark-width) | | float | [height](#ByteRTCVideoByteWatermark-height) | ## 变量说明 ### x ```objectivec @property(assign, nonatomic) float x; ``` 水印图片相对视频流左上角的横向偏移与视频流宽度的比值，取值范围为 [0,1)。 ### y ```objectivec @property(assign, nonatomic) float y; ``` 水印图片相对视频流左上角的纵向偏移与视频流高度的比值，取值范围为 [0,1)。 ### width ```objectivec @property(assign, nonatomic) float width; ``` 水印图片宽度与视频流宽度的比值，取值范围 [0,1)。 ### height ```objectivec @property(assign, nonatomic) float height; ``` 水印图片高度与视频流高度的比值，取值范围为 [0,1)。 # ByteRTCStreamSycnInfoConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCStreamSycnInfoConfig : NSObject ``` 媒体流信息同步的相关配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCStreamIndex | [streamIndex](#ByteRTCStreamSycnInfoConfig-streamindex) | | int | [repeatCount](#ByteRTCStreamSycnInfoConfig-repeatcount) | | ByteRTCSyncInfoStreamType | [streamType](#ByteRTCStreamSycnInfoConfig-streamtype) | ## 变量说明 ### streamIndex ```objectivec @property(assign, nonatomic) ByteRTCStreamIndex streamIndex; ``` 流属性，主流或屏幕流。见 [ByteRTCStreamIndex](#ByteRTCStreamIndex)。 ### repeatCount ```objectivec @property(assign, nonatomic) int repeatCount; ``` 消息发送的重复次数，取值范围是 [0,25]，建议设置为 [3,5]。 ### streamType ```objectivec @property(assign, nonatomic) ByteRTCSyncInfoStreamType streamType; ``` 媒体流信息同步的流类型，见 [ByteRTCSyncInfoStreamType](#ByteRTCSyncInfoStreamType)。 # ByteRTCEchoTestConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCEchoTestConfig : NSObject ``` 音视频回路测试参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCView*_Nullable | [view](#ByteRTCEchoTestConfig-view) | | NSString* | [roomId](#ByteRTCEchoTestConfig-roomid) | | NSString* | [userId](#ByteRTCEchoTestConfig-userid) | | NSString* | [token](#ByteRTCEchoTestConfig-token) | | BOOL | [enableAudio](#ByteRTCEchoTestConfig-enableaudio) | | BOOL | [enableVideo](#ByteRTCEchoTestConfig-enablevideo) | | NSInteger | [audioReportInterval](#ByteRTCEchoTestConfig-audioreportinterval) | ## 变量说明 ### view ```objectivec @property(strong, nonatomic) ByteRTCView* _Nullable view; ``` 用于渲染接收到的视频的视图 ### roomId ```objectivec @property(copy, nonatomic) NSString *_Nonnull roomId; ``` 测试用户加入的房间 ID。 ### userId ```objectivec @property(copy, nonatomic) NSString *_Nonnull userId; ``` 进行音视频通话回路测试的用户 ID ### token ```objectivec @property(copy, nonatomic) NSString *_Nonnull token; ``` 对用户进房时进行鉴权验证的动态密钥，用于保证音视频通话回路测试的安全性。 ### enableAudio ```objectivec @property(assign, nonatomic) BOOL enableAudio; ``` 是否检测音频。检测设备为系统默认音频设备。 - true：是 - 若使用 SDK 内部采集，此时设备麦克风会自动开启，并在 audioReportInterval 值大于 0 时触发 `onLocalAudioPropertiesReport` 回调，你可以根据该回调判断麦克风的工作状态 - 若使用自定义采集，此时你需调用 [pushExternalAudioFrame:](70092#ByteRTCVideo-pushexternalaudioframe) 将采集到的音频推送给 SDK - false：否 ### enableVideo ```objectivec @property(assign, nonatomic) BOOL enableVideo; ``` 是否检测视频。PC 端默认检测列表中第一个视频设备。 - true：是 - 若使用 SDK 内部采集，此时设备摄像头会自动开启 - 若使用自定义采集，此时你需调用 [pushExternalVideoFrame:](70092#ByteRTCVideo-pushexternalvideoframe) 将采集到的视频推送给 SDK - false：否视频的发布参数固定为：分辨率 640px × 360px，帧率 15fps。 ### audioReportInterval ```objectivec @property(assign, nonatomic) NSInteger audioReportInterval; ``` 音量信息提示间隔，单位：ms，默认为 100ms - `<= 0`: 关闭信息提示 - `(0,100]`: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms - `> 100`: 开启信息提示，并将信息提示间隔设置为此值 # ByteRTCFrameRateRatio ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCFrameRateRatio ) ``` 占发布端原始帧率的比例 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCFrameRateRatioOrigin | 0 | 100% | | ByteRTCFrameRateRatioHalf | 1 | 50% | | ByteRTCFrameRateRatioQuater | 2 | 25% | # ByteRTCMixedStreamRenderMode ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMixedStreamRenderMode ) ``` 图片或视频流的缩放模式。(新) ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamRenderModeHidden | 1 | 视窗填满优先，默认值。
视频尺寸等比缩放，直至视窗被填满。当视频尺寸与显示窗口尺寸不一致时，多出的视频将被截掉。 | | ByteRTCMixedStreamRenderModeFit | 2 | 视频帧内容全部显示优先。
视频尺寸等比缩放，优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时，会把窗口未被填满的区域填充成背景颜色。 | | ByteRTCMixedStreamRenderModeAdaptive | 3 | 视频帧自适应画布。
视频尺寸非等比例缩放，把窗口充满。在此过程中，视频帧的长宽比例可能会发生变化。 | # ByteRTCMirrorType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMirrorType ) ``` 镜像类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMirrorTypeNone | 0 | 本地预览和编码传输时均无镜像效果 | | ByteRTCMirrorTypeRender | 1 | 本地预览时有镜像效果，编码传输时无镜像效果 | | ByteRTCMirrorTypeRenderAndEncoder | 3 | 本地预览和编码传输时均有镜像效果 | # ByteRTCForwardStreamError ```objectivec typedef NS_ENUM( NSInteger, ByteRTCForwardStreamError ) ``` 媒体流跨房间转发过程中抛出的错误码 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCForwardStreamErrorOK | 0 | 正常 | | ByteRTCForwardStreamErrorInvalidArgument | 1201 | 参数异常 | | ByteRTCForwardStreamErrorInvalidToken | 1202 | Token 错误 | | ByteRTCForwardStreamErrorResponse | 1203 | 服务端异常 | | ByteRTCForwardStreamErrorRemoteKicked | 1204 | 目标房间有相同 user id 的用户加入，转发中断 | | ByteRTCForwardStreamErrorNotSupport | 1205 | 服务端不支持转发功能 | # ByteRTCReturnStatus ```objectivec typedef NS_ENUM( NSInteger, ByteRTCReturnStatus ) ``` 方法调用结果。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCReturnStatusSuccess | 0 | 成功。 | | ByteRTCReturnStatusFailure | -1 | 失败。 | | ByteRTCReturnStatusParameterErr | -2 | 参数错误。确认传入的参数类型，数值不超过边界等。 | | ByteRTCReturnStatusWrongState | -3 | 接口状态错误。确认当前的调用时机符合接口要求等。 | | ByteRTCReturnStatusHasInRoom | -4 | 失败，用户已在房间内。 | | ByteRTCReturnStatusHasInLogin | -5 | 失败，用户已登录。 | | ByteRTCReturnStatusHasInEchoTest | -6 | 失败，用户已经在进行通话回路测试中。 | | ByteRTCReturnStatusNeitherVideoNorAudio | -7 | 失败，音视频均未采集。 | | ByteRTCReturnStatusRoomIdInUse | -8 | 失败，该 roomId 已被使用。 | | ByteRTCReturnStatusScreenNotSupport | -9 | 失败，屏幕流不支持。 | | ByteRTCReturnStatusNotSupport | -10 | 失败，不支持该操作。 | | ByteRTCReturnStatusResourceOverflow | -11 | 失败，资源已占用。 | | ByteRTCReturnStatusAudioNoFrame | -101 | 失败，没有音频帧。 | | ByteRTCReturnStatusAudioNotImplemented | -102 | 失败，未实现。 | | ByteRTCReturnStatusAudioNoPermission | -103 | 失败，采集设备无麦克风权限，尝试初始化设备失败。 | | ByteRTCReturnStatusAudioDeviceNotExists | -104 | 失败，设备不存在。当前没有设备或设备被移除时返回该值。 | | ByteRTCReturnStatusAudioDeviceFormatNotSupport | -105 | 失败，设备音频格式不支持。 | | ByteRTCReturnStatusAudioDeviceNoDevice | -106 | 失败，系统无可用设备。 | | ByteRTCReturnStatusAudioDeviceCannotUse | -107 | 失败，当前设备不可用，需更换设备。 | | ByteRTCReturnStatusAudioDeviceInitFailed | -108 | 系统错误，设备初始化失败。 | | ByteRTCReturnStatusAudioDeviceStartFailed | -109 | 系统错误，设备开启失败。 | | ByteRTCReturnStatusNativeInValid | -201 | 失败。底层未初始化，engine 无效。 | # ByteRTCAudioMixingType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioMixingType ) ``` 混音播放类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioMixingTypePlayout | 0 | 仅本地播放 | | ByteRTCAudioMixingTypePublish | 1 | 仅远端播放 | | ByteRTCAudioMixingTypePlayoutAndPublish | 2 | 本地和远端同时播放 | # ByteRTCVideoEnhancementMode ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCVideoEnhancementMode ) ``` 弱光适应类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoEnhancementModeDisabled | 0 | 关闭弱光适应 | | ByteRTCVideoEnhancementModeAuto | 1 | 开启弱光适应 | # ByteRTCSubscribeMediaType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCSubscribeMediaType ) ``` 订阅媒体的类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCSubscribeMediaTypeNone | 0 | 既不订阅音频，也不订阅视频 | | ByteRTCSubscribeMediaTypeAudioOnly | 1 | 只订阅音频，不订阅视频 | | ByteRTCSubscribeMediaTypeVideoOnly | 2 | 只订阅视频，不订阅音频 | | ByteRTCSubscribeMediaTypeAudioAndVideo | 3 | 同时订阅音频和视频 | # ByteRTCPushSingleStreamParam ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCPushSingleStreamParam : NSObject ``` 单流转推直播配置参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString*_Nullable | [url](#ByteRTCPushSingleStreamParam-url) | | NSString* | [roomId](#ByteRTCPushSingleStreamParam-roomid) | | NSString*_Nullable | [userId](#ByteRTCPushSingleStreamParam-userid) | | BOOL | [isScreen](#ByteRTCPushSingleStreamParam-isscreen) | ## 变量说明 ### url ```objectivec @property(copy, nonatomic) NSString * _Nullable url; ``` 推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 `/^rtmps?:\/\//`。本参数不支持过程中更新。 ### roomId ```objectivec @property(copy, nonatomic) NSString * _Nonnull roomId; ``` 媒体流所在的房间 ID ### userId ```objectivec @property(copy, nonatomic) NSString * _Nullable userId; ``` 媒体流所属的用户 ID ### isScreen ```objectivec @property(nonatomic, assign) BOOL isScreen; ``` 媒体流是否为屏幕流。 # ByteRTCMediaDeviceWarning ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMediaDeviceWarning ) ``` 媒体设备警告 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMediaDeviceWarningOK | 0 | 无警告 | | ByteRTCMediaDeviceWarningOperationDenied | 1 | 非法设备操作。在使用外部设备时，调用了 SDK 内部设备 API。 | | ByteRTCMediaDeviceWarningCaptureSilence | 2 | 采集到的数据为静音帧。 | | ByteRTCMediaDeviceWarningDetectLeakEcho | 11 | 通话中出现回声现象。
当 [ByteRTCRoomProfile](#ByteRTCRoomProfile) 为 `ByteRTCRoomProfileMeeting` 和 `ByteRTCRoomProfileMeetingRoom` ，且 AEC 关闭时，SDK 自动启动回声检测，如果检测到回声问题，将通过 `rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning:` 返回本枚举值。 | | ByteRTCMediaDeviceWarningCaptureDetectHowling | 16 | 啸叫。触发该回调的情况如下：1）不支持啸叫抑制的房间模式下，检测到啸叫；2）支持啸叫抑制的房间模式下，检测到未被抑制的啸叫。
仅 ByteRTCRoomProfileCommunication、ByteRTCRoomProfileMeeting、ByteRTCRoomProfileMeetingRoom 三种房间模式支持啸叫抑制。
建议提醒用户检查客户端的距离或将麦克风和扬声器调至静音。 | # ByteRTCExpressionDetectConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCExpressionDetectConfig : NSObject ``` 人像属性检测参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [enableAgeDetect](#ByteRTCExpressionDetectConfig-enableagedetect) | | BOOL | [enableGenderDetect](#ByteRTCExpressionDetectConfig-enablegenderdetect) | | BOOL | [enableEmotionDetect](#ByteRTCExpressionDetectConfig-enableemotiondetect) | | BOOL | [enableAttractivenessDetect](#ByteRTCExpressionDetectConfig-enableattractivenessdetect) | | BOOL | [enableHappinessDetect](#ByteRTCExpressionDetectConfig-enablehappinessdetect) | ## 变量说明 ### enableAgeDetect ```objectivec @property (assign, nonatomic) BOOL enableAgeDetect; ``` 是否开启年龄检测。 ### enableGenderDetect ```objectivec @property (assign, nonatomic) BOOL enableGenderDetect; ``` 是否开启性别检测。 ### enableEmotionDetect ```objectivec @property (assign, nonatomic) BOOL enableEmotionDetect; ``` 是否开启表情检测。 ### enableAttractivenessDetect ```objectivec @property (assign, nonatomic) BOOL enableAttractivenessDetect; ``` 是否开启吸引力检测。 ### enableHappinessDetect ```objectivec @property (assign, nonatomic) BOOL enableHappinessDetect; ``` 是否开启开心程度检测。 # ByteRTCAudioReportMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioReportMode ) ``` 音量回调模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioReportModeNormal | 0 | 默认始终开启音量回调。 | | ByteRTCAudioReportModeDisconnect | 1 | 可见用户进房并停止推流后，关闭音量回调。 | | ByteRTCAudioReportModeReset | 2 | 可见用户进房并停止推流后，开启音量回调，回调值重置为 0。 | # ByteRTCTranscodingClientMixParam ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCTranscodingClientMixParam : NSObject ``` > Deprecated since 3.52, use [ByteRTCMixedStreamClientMixConfig](#ByteRTCMixedStreamClientMixConfig) instead. 客户端合流参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [clientMixUseOriginalFrame](#ByteRTCTranscodingClientMixParam-clientmixuseoriginalframe) | | BOOL | [clientMixUseAudioMixer](#ByteRTCTranscodingClientMixParam-clientmixuseaudiomixer) | | ByteRTCClientMixVideoFormat | [clientMixVideoFormat](#ByteRTCTranscodingClientMixParam-clientmixvideoformat) | ## 变量说明 ### clientMixUseOriginalFrame ```objectivec @property(assign, nonatomic) BOOL clientMixUseOriginalFrame; ``` 是否使用原始视频帧。默认为 False。 ### clientMixUseAudioMixer ```objectivec @property(assign, nonatomic) BOOL clientMixUseAudioMixer; ``` 客户端合流是否使用音频混音，默认为 true。 ### clientMixVideoFormat ```objectivec @property(assign, nonatomic) ByteRTCClientMixVideoFormat clientMixVideoFormat; ``` 客户端合流回调视频格式，参看 [ByteRTCClientMixVideoFormat](#ByteRTCClientMixVideoFormat)。 # ByteRTCSourceWantedData ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCSourceWantedData : NSObject ``` 性能回退相关数据 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [width](#ByteRTCSourceWantedData-width) | | NSInteger | [height](#ByteRTCSourceWantedData-height) | | NSInteger | [frameRate](#ByteRTCSourceWantedData-framerate) | ## 变量说明 ### width ```objectivec @property(nonatomic, assign) NSInteger width; ``` 推荐视频输入宽 ### height ```objectivec @property(nonatomic, assign) NSInteger height; ``` 推荐视频输入高 ### frameRate ```objectivec @property(nonatomic, assign) NSInteger frameRate; ``` 推荐视频输入帧率 # ByteRTCLogConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCLogConfig : NSObject ``` SDK 日志配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [logPath](#ByteRTCLogConfig-logpath) | | ByteRTCLocalLogLevel | [logLevel](#ByteRTCLogConfig-loglevel) | | int | [logFileSize](#ByteRTCLogConfig-logfilesize) | | NSString* | [logFilenamePrefix](#ByteRTCLogConfig-logfilenameprefix) | ## 变量说明 ### logPath ```objectivec @property(copy, nonatomic) NSString *_Nonnull logPath; ``` 日志存储路径，必填。 ### logLevel ```objectivec @property(assign, nonatomic) ByteRTCLocalLogLevel logLevel; ``` 日志输出等级，参看 [ByteRTCLocalLogLevel](#ByteRTCLocalLogLevel)，必填，默认为警告级别。 ### logFileSize ```objectivec @property(assign, nonatomic) int logFileSize; ``` 设置日志文件总大小上限（即所有日志文件大小之和），单位为 MB，必填，取值范围为 1～100 MB。系统处理机制如下： - 超出取值范围：若 `logFileSize` < 1，则按 1 MB 处理；若 `logFileSize` \> 100，则按 100 MB 处理。 - 其中，单个日志文件最大为 2 MB： - 若 1 ≤ `logFileSize` ≤ 2，则会生成一个日志文件。 - 若 `logFileSize` \> 2，系统会将日志分割成多个文件，每个文件最大 2 MB。当所有日志文件的总大小达到 `logFileSize` 设置的上限时，系统会自动删除最旧的日志文件。例如，`logFileSize` 设置为 10 MB，系统最多会保留 5 个 2 MB 大小的日志文件。当需要写入新日志且总大小即将超过 10 MB 时，最旧的那个文件会被删除，以此类推。 ### logFilenamePrefix ```objectivec @property(copy, nonatomic) NSString *_Nonnull logFilenamePrefix; ``` 日志文件名前缀，必填。该字符串必须符合正则表达式：[a-zA-Z0-9_@-.]{1,128}。最终的日志文件名为`前缀 + "_" + 文件创建时间 + "_rtclog".log`，如 `logPrefix_2023-05-25_172324_rtclog.log`。 # ByteRTCPublicStreamRegion ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCPublicStreamRegion : NSObject ``` 合成公共流的每条流的布局信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [userId](#ByteRTCPublicStreamRegion-userid) | | NSString* | [roomId](#ByteRTCPublicStreamRegion-roomid) | | NSString* | [alternateImage](#ByteRTCPublicStreamRegion-alternateimage) | | CGFloat | [x](#ByteRTCPublicStreamRegion-x) | | CGFloat | [y](#ByteRTCPublicStreamRegion-y) | | CGFloat | [width](#ByteRTCPublicStreamRegion-width) | | CGFloat | [height](#ByteRTCPublicStreamRegion-height) | | NSInteger | [zOrder](#ByteRTCPublicStreamRegion-zorder) | | CGFloat | [alpha](#ByteRTCPublicStreamRegion-alpha) | | NSInteger | [mediaType](#ByteRTCPublicStreamRegion-mediatype) | | NSInteger | [streamType](#ByteRTCPublicStreamRegion-streamtype) | | ByteRTCRenderMode | [renderMode](#ByteRTCPublicStreamRegion-rendermode) | | ByteRTCSourceCropInfo* | [sourceCrop](#ByteRTCPublicStreamRegion-sourcecrop) | ## 变量说明 ### userId ```objectivec @property(copy, nonatomic) NSString * _Nonnull userId; ``` 用户 ID。必填。服务端将通过用户 ID 和房间 ID，找到需要合成到公共流中的媒体流。 ### roomId ```objectivec @property(copy, nonatomic) NSString * _Nonnull roomId; ``` 房间 ID。必填。服务端将通过用户 ID 和房间 ID，找到需要合成到公共流中的媒体流。 ### alternateImage ```objectivec @property(copy, nonatomic) NSString * _Nonnull alternateImage; ``` 背景图片地址 ### x ```objectivec @property(assign, nonatomic) CGFloat x; ``` 用户视频布局相对画布左侧的偏移量，相对值。范围[0.0 - 1.0] ### y ```objectivec @property(assign, nonatomic) CGFloat y; ``` 用户视频布局相对画布顶端的偏移量，相对值。范围[0.0 - 1.0] ### width ```objectivec @property(assign, nonatomic) CGFloat width; ``` 用户视频宽度相对用户原始视频宽度的比例，相对值。范围[0.0 - 1.0] ### height ```objectivec @property(assign, nonatomic) CGFloat height; ``` 用户视频高度相对用户原始视频高度的比例，相对值。范围[0.0 - 1.0] ### zOrder ```objectivec @property(assign, nonatomic) NSInteger zOrder; ``` 用户视频布局在画布中的层级，0 为底层，值越大越上层。范围[0 - 100] ### alpha ```objectivec @property(assign, nonatomic) CGFloat alpha; ``` 透明度，必填。可选范围为 [0.0, 1.0]。 ### mediaType ```objectivec @property(assign, nonatomic) NSInteger mediaType; ``` 推流内容控制。默认为 0。 0: 输出的混流包含音视频 1: 只包含音频 2: 表示只包含视频 ### streamType ```objectivec @property(assign, nonatomic) NSInteger streamType; ``` 推流媒体类型 0：普通音视频流 1: 屏幕流 ### renderMode ```objectivec @property(assign, nonatomic) ByteRTCRenderMode renderMode; ``` 视频显示模式。详见 [ByteRTCRenderMode](#ByteRTCRenderMode) 数据类型。 ### sourceCrop ```objectivec @property(strong, nonatomic) ByteRTCSourceCropInfo * _Nonnull sourceCrop; ``` 视频裁剪信息。详见 [ByteRTCSourceCropInfo](#ByteRTCSourceCropInfo)。 # ByteRTCSubscribeVideoConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCSubscribeVideoConfig : NSObject ``` 视频订阅配置信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [videoIndex](#ByteRTCSubscribeVideoConfig-videoindex) | | NSInteger | [priority](#ByteRTCSubscribeVideoConfig-priority) | ## 变量说明 ### videoIndex ```objectivec @property(assign, nonatomic) NSInteger videoIndex; ``` 订阅的视频流分辨率下标。当远端用户通过调用 [enableSimulcastMode:](70092#ByteRTCVideo-enablesimulcastmode) 方法启动发布多路不同分辨率的视频流时，本地用户需通过此参数指定希望订阅的流。默认值为 0，即订阅第一路流。如果不想更改之前的设置，可以输入 -1。 ### priority ```objectivec @property(assign, nonatomic) NSInteger priority; ``` 远端用户优先级，参看 [ByteRTCRemoteUserPriority](#ByteRTCRemoteUserPriority)，默认值为 0。 # ByteRTCNetworkTimeInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCNetworkTimeInfo: NSObject ``` 网络时间信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int64_t | [timestamp](#ByteRTCNetworkTimeInfo-timestamp) | ## 变量说明 ### timestamp ```objectivec @property(assign, nonatomic) int64_t timestamp; ``` 网络时间，单位：ms # ByteRTCRemoteAudioPropertiesInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRemoteAudioPropertiesInfo : NSObject ``` 远端音频属性信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCRemoteStreamKey* | [streamKey](#ByteRTCRemoteAudioPropertiesInfo-streamkey) | | ByteRTCAudioPropertiesInfo* | [audioPropertiesInfo](#ByteRTCRemoteAudioPropertiesInfo-audiopropertiesinfo) | ## 变量说明 ### streamKey ```objectivec @property(strong, nonatomic) ByteRTCRemoteStreamKey *_Nonnull streamKey; ``` 远端流信息，详见 [ByteRTCRemoteStreamKey](#ByteRTCRemoteStreamKey) ### audioPropertiesInfo ```objectivec @property(strong, nonatomic) ByteRTCAudioPropertiesInfo *_Nonnull audioPropertiesInfo; ``` 音频属性信息，详见 [ByteRTCAudioPropertiesInfo](#ByteRTCAudioPropertiesInfo) # ByteRTCTranscodingAudioCodec ```objectivec typedef NS_ENUM( NSInteger, ByteRTCTranscodingAudioCodec ) ``` > Deprecated since 3.52, use [ByteRTCMixedStreamAudioCodecType](#ByteRTCMixedStreamAudioCodecType) instead. 音频编码类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCTranscodingAudioCodecAAC | 0 | AAC 格式。 | # ByteRTCSubtitleMessage ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCSubtitleMessage : NSObject ``` 字幕具体内容。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [userId](#ByteRTCSubtitleMessage-userid) | | NSString* | [text](#ByteRTCSubtitleMessage-text) | | NSString* | [language](#ByteRTCSubtitleMessage-language) | | NSInteger | [mode](#ByteRTCSubtitleMessage-mode) | | NSInteger | [sequence](#ByteRTCSubtitleMessage-sequence) | | BOOL | [definite](#ByteRTCSubtitleMessage-definite) | ## 变量说明 ### userId ```objectivec @property(copy, nonatomic) NSString *_Nonnull userId; ``` 说话者的用户 ID。 ### text ```objectivec @property(copy, nonatomic) NSString *_Nonnull text; ``` 语音识别或翻译后的文本, 采用 UTF-8 编码。 ### language ```objectivec @property(copy, nonatomic) NSString *_Nonnull language; ``` 字幕语种，根据字幕模式为原文或译文对应的语种。 ### mode ```objectivec @property(assign, nonatomic) NSInteger mode; ``` 字幕模式，参看 [ByteRTCSubtitleMode](#ByteRTCSubtitleMode)。 ### sequence ```objectivec @property(assign, nonatomic) NSInteger sequence; ``` 语音识别或翻译后形成的文本的序列号，同一发言人的完整发言和不完整发言会按递增顺序单独分别编号。 ### definite ```objectivec @property(assign, nonatomic) BOOL definite; ``` 语音识别出的文本是否为一段完整的一句话。 True 代表是, False 代表不是。 # ByteRTCVirtualBackgroundSourceType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVirtualBackgroundSourceType ) ``` 虚拟背景类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVirtualBackgroundSourceTypeColor | 0 | 使用纯色背景替换视频原有背景。 | | ByteRTCVirtualBackgroundSourceTypeImage | 1 | 使用自定义图片替换视频原有背景。 | # ByteRTCAudioPropertiesInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCAudioPropertiesInfo : NSObject ``` 音频属性信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [linearVolume](#ByteRTCAudioPropertiesInfo-linearvolume) | | NSInteger | [nonlinearVolume](#ByteRTCAudioPropertiesInfo-nonlinearvolume) | | NSInteger | [vad](#ByteRTCAudioPropertiesInfo-vad) | | NSArray* | [spectrum](#ByteRTCAudioPropertiesInfo-spectrum) | | NSInteger | [voicePitch](#ByteRTCAudioPropertiesInfo-voicepitch) | ## 变量说明 ### linearVolume ```objectivec @property(assign, nonatomic) NSInteger linearVolume; ``` 线性音量，与原始音量呈线性关系，数值越大，音量越大。取值范围是：[0,255]。 - \[0, 25]: 近似无声 - \[26, 75]: 低音量 - \[76, 204]: 中音量 - \[205, 255]: 高音量 ### nonlinearVolume ```objectivec @property(assign, nonatomic) NSInteger nonlinearVolume; ``` 非线性音量。由原始音量的对数值转化而来，因此在中低音量时更灵敏，可以用作 Active Speaker（房间内最活跃用户）的识别。取值范围是：[-127，0]，单位 dB。 - \[-127, -60]: 近似无声 - \[-59, -40]: 低音量 - \[-39, -20]: 中音量 - \[-19, 0]: 高音量 ### vad ```objectivec @property(assign, nonatomic) NSInteger vad; ``` 人声检测（VAD）结果 - 1: 检测到人声。 - 0: 未检测到人声。 - -1: 未开启 VAD。 ### spectrum ```objectivec @property(copy, nonatomic) NSArray * _Nonnull spectrum; ``` 频谱数组。默认长度为 257。 ### voicePitch ```objectivec @property(assign, nonatomic) NSInteger voicePitch; ``` 本地用户的人声基频，单位为赫兹。同时满足以下两个条件时，返回的值为本地用户的人声基频： - 调用 [enableAudioPropertiesReport:](70092#ByteRTCVideo-enableaudiopropertiesreport)，并设置参数 enableVoicePitch 的值为 `true`。 - 本地采集的音频中包含本地用户的人声。其他情况下返回 `0`。 # ByteRTCLogoutReason ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCLogoutReason ) ``` 用户登出的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLogoutReasonLogout | 0 | 用户主动退出
用户调用 `logout` 接口登出，或者销毁引擎登出。 | | ByteRTCLogoutReasonDuplicateLogin | 1 | 用户被动退出
另一个用户以相同 UserId 进行了 `login`，导致本端用户被踢出。 | # ByteRTCMixedStreamLayoutConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMixedStreamLayoutConfig : NSObject ``` 视频流合流整体布局信息。(新) ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [backgroundColor](#ByteRTCMixedStreamLayoutConfig-backgroundcolor) | | NSArray* | [regions](#ByteRTCMixedStreamLayoutConfig-regions) | | NSString* | [userConfigExtraInfo](#ByteRTCMixedStreamLayoutConfig-userconfigextrainfo) | | NSString* | [backgroundImageUrl](#ByteRTCMixedStreamLayoutConfig-backgroundimageurl) | ## 变量说明 ### backgroundColor ```objectivec @property(copy, nonatomic) NSString *_Nonnull backgroundColor; ``` 合流背景颜色，用十六进制颜色码（HEX）表示。例如，#FFFFFF 表示纯白，#000000 表示纯黑。默认值为 #000000。建议设置。值不合法或未设置时，自动使用默认值。 ### regions ```objectivec @property(copy, nonatomic) NSArray * _Nonnull regions; ``` 用户布局信息列表。每条流的具体布局参看 [ByteRTCMixedStreamLayoutRegionConfig](#ByteRTCMixedStreamLayoutRegionConfig)。建议设置。值不合法或未设置时，自动使用默认值。 ### userConfigExtraInfo ```objectivec @property(copy, nonatomic) NSString *_Nonnull userConfigExtraInfo; ``` 用户透传的额外数据。 ### backgroundImageUrl ```objectivec @property(copy, nonatomic) NSString *_Nonnull backgroundImageUrl; ``` > Available since 3.57 设置合流后整体画布的背景图片 URL，长度最大为 1024 bytes。支持的图片格式包括：JPG, JPEG, PNG。如果背景图片的宽高和整体屏幕的宽高不一致，背景图片会缩放到铺满屏幕。 # ByteRTCVideoWatermarkConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoWatermarkConfig: NSObject ``` 水印参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [visibleInPreview](#ByteRTCVideoWatermarkConfig-visibleinpreview) | | ByteRTCVideoByteWatermark* | [positionInLandscapeMode](#ByteRTCVideoWatermarkConfig-positioninlandscapemode) | | ByteRTCVideoByteWatermark* | [positionInPortraitMode](#ByteRTCVideoWatermarkConfig-positioninportraitmode) | ## 变量说明 ### visibleInPreview ```objectivec @property(nonatomic, assign) BOOL visibleInPreview; ``` 水印是否在视频预览中可见，默认可见。 ### positionInLandscapeMode ```objectivec @property(strong, nonatomic) ByteRTCVideoByteWatermark * _Nonnull positionInLandscapeMode; ``` 横屏时的水印位置和大小，参看 [ByteRTCVideoByteWatermark](#ByteRTCVideoByteWatermark)。 ### positionInPortraitMode ```objectivec @property(strong, nonatomic) ByteRTCVideoByteWatermark * _Nonnull positionInPortraitMode; ``` 竖屏时的水印位置和大小，参看 [ByteRTCVideoByteWatermark](#ByteRTCVideoByteWatermark)。 # ByteRTCMixedStreamPushMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMixedStreamPushMode ) ``` 服务端合流转推发起模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamPushModeOnStream | 0 | 无用户发布媒体流时，发起合流任务无效。默认设置。
当有用户发布媒体流时，才能发起合流任务。 | | ByteRTCMixedStreamPushModeOnStartRequest | 1 | 无用户发布媒体流时，可以使用占位图发起合流任务。
占位图设置参看 [alternateImageUrl](#ByteRTCMixedStreamLayoutRegionConfig-alternateimageurl) 和 [alternateImageFillMode](#ByteRTCMixedStreamLayoutRegionConfig-alternateimagefillmode) | # ByteRTCLocalVideoStats ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCLocalVideoStats : NSObject ``` 本地视频流统计信息，统计周期为 2s 。本地用户发布视频流成功后，SDK 会周期性地通过 `onLocalStreamStats` 通知本地用户发布的视频流在此次统计周期内的发送状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [sentKBitrate](#ByteRTCLocalVideoStats-sentkbitrate) | | NSInteger | [inputFrameRate](#ByteRTCLocalVideoStats-inputframerate) | | NSInteger | [sentFrameRate](#ByteRTCLocalVideoStats-sentframerate) | | NSInteger | [encoderOutputFrameRate](#ByteRTCLocalVideoStats-encoderoutputframerate) | | NSInteger | [rendererOutputFrameRate](#ByteRTCLocalVideoStats-rendereroutputframerate) | | NSInteger | [statsInterval](#ByteRTCLocalVideoStats-statsinterval) | | float | [videoLossRate](#ByteRTCLocalVideoStats-videolossrate) | | NSInteger | [rtt](#ByteRTCLocalVideoStats-rtt) | | NSInteger | [encodedBitrate](#ByteRTCLocalVideoStats-encodedbitrate) | | NSInteger | [encodedFrameWidth](#ByteRTCLocalVideoStats-encodedframewidth) | | NSInteger | [encodedFrameHeight](#ByteRTCLocalVideoStats-encodedframeheight) | | NSInteger | [encodedFrameCount](#ByteRTCLocalVideoStats-encodedframecount) | | ByteRTCVideoCodecType | [codecType](#ByteRTCLocalVideoStats-codectype) | | BOOL | [isScreen](#ByteRTCLocalVideoStats-isscreen) | | NSInteger | [jitter](#ByteRTCLocalVideoStats-jitter) | ## 变量说明 ### sentKBitrate ```objectivec @property(assign, nonatomic) float sentKBitrate; ``` 发送码率。此次统计周期内实际发送的分辨率最大的视频流的发送码率，单位为 Kbps ### inputFrameRate ```objectivec @property(assign, nonatomic) NSInteger inputFrameRate; ``` 采集帧率。此次统计周期内的视频采集帧率，单位为 fps 。 ### sentFrameRate ```objectivec @property(assign, nonatomic) NSInteger sentFrameRate; ``` 发送帧率。此次统计周期内实际发送的分辨率最大的视频流的视频发送帧率，单位为 fps 。 ### encoderOutputFrameRate ```objectivec @property(assign, nonatomic) NSInteger encoderOutputFrameRate; ``` 编码器输出帧率。当前编码器在此次统计周期内实际发送的分辨率最大的视频流的输出帧率，单位为 fps 。 ### rendererOutputFrameRate ```objectivec @property(assign, nonatomic) NSInteger rendererOutputFrameRate; ``` 本地渲染帧率。此次统计周期内的本地视频渲染帧率，单位为 fps 。 ### statsInterval ```objectivec @property(assign, nonatomic) NSInteger statsInterval; ``` 统计间隔，单位为 ms 。此字段用于设置回调的统计周期，默认设置为 2s 。 ### videoLossRate ```objectivec @property(assign, nonatomic) float videoLossRate; ``` 视频丢包率。统计周期内的视频上行丢包率，取值范围为 [0, 1] 。 ### rtt ```objectivec @property(assign, nonatomic) NSInteger rtt; ``` 往返时延。单位为 ms 。 ### encodedBitrate ```objectivec @property(assign, nonatomic) NSInteger encodedBitrate; ``` 视频编码码率。此次统计周期内的实际发送的分辨率最大的视频流视频编码码率，单位为 Kbps 。 ### encodedFrameWidth ```objectivec @property(assign, nonatomic) NSInteger encodedFrameWidth; ``` 实际发送的分辨率最大的视频流的视频编码宽度，单位为 px 。 ### encodedFrameHeight ```objectivec @property(assign, nonatomic) NSInteger encodedFrameHeight; ``` 实际发送的分辨率最大的视频流的视频编码高度，单位为 px 。 ### encodedFrameCount ```objectivec @property(assign, nonatomic) NSInteger encodedFrameCount; ``` 此次统计周期内实际发送的分辨率最大的视频流的发送的视频帧总数。 ### codecType ```objectivec @property(nonatomic) ByteRTCVideoCodecType codecType; ``` 编码类型。参看 [ByteRTCVideoCodecType](#ByteRTCVideoCodecType) 类型。 ### isScreen ```objectivec @property(assign, nonatomic) BOOL isScreen; ``` 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 ### jitter ```objectivec @property(assign, nonatomic) NSInteger jitter; ``` 视频上行网络抖动，单位为 ms。 # ByteRTCStream ```objectivec BYTERTC_APPLE_EXPORT @protocol ByteRTCStream ``` 流属性。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [userId](#ByteRTCStream-userid) | | BOOL | [isScreen](#ByteRTCStream-isscreen) | | BOOL | [hasVideo](#ByteRTCStream-hasvideo) | | BOOL | [hasAudio](#ByteRTCStream-hasaudio) | | NSArray* | [videoStreamDescriptions](#ByteRTCStream-videostreamdescriptions) | | ByteRTCVideoSolution* | [maxVideoStreamDescription](#ByteRTCStream-maxvideostreamdescription) | | ByteRTCStreamIndex | [index](#ByteRTCStream-index) | ## 变量说明 ### userId ```objectivec @property(nonatomic, copy, readonly) NSString * userId; ``` 发布此流的用户 ID 。 ### isScreen ```objectivec @property(nonatomic, assign, readonly) BOOL isScreen; ``` 此流是否为共享屏幕流。 ### hasVideo ```objectivec @property(nonatomic, assign, readonly) BOOL hasVideo; ``` 此流是否包括视频流。 ### hasAudio ```objectivec @property(nonatomic, assign, readonly) BOOL hasAudio; ``` 流是否包括音频流。 ### videoStreamDescriptions ```objectivec @property(nonatomic, copy, readonly) NSArray * videoStreamDescriptions; ``` 视频流的分辨率信息。当远端用户调用 [setVideoEncoderConfig:](70092#ByteRTCVideo-setvideoencoderconfig) 方法发布多个配置的视频流时，此处会包含该用户发布的所有视频流的属性信息。参看 [ByteRTCVideoSolution](#ByteRTCVideoSolution)。 ### maxVideoStreamDescription ```objectivec @property(nonatomic, retain, readonly) ByteRTCVideoSolution *maxVideoStreamDescription; ``` 视频流最大分辨率，在开启多分辨率发布订阅时，回调发布端能支持的最大发布分辨率。 ### index ```objectivec @property(nonatomic, assign) ByteRTCStreamIndex index; ``` # ByteRTCPublicStreaming ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCPublicStreaming : NSObject ``` 公共流参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCPublicStreamLayout* | [layout](#ByteRTCPublicStreaming-layout) | | ByteRTCPublicStreamVideoConfig* | [video](#ByteRTCPublicStreaming-video) | ## 静态函数 | 返回 | 名称 | | --- | --- | | instancetype | [defaultPublicStreaming](#ByteRTCPublicStreaming-defaultpublicstreaming) | ## 变量说明 ### layout ```objectivec @property(strong, nonatomic) ByteRTCPublicStreamLayout * _Nonnull layout; ``` 视频流公共流整体布局参数，必填。详见 [ByteRTCPublicStreamLayout](#ByteRTCPublicStreamLayout) ### video ```objectivec @property(strong, nonatomic) ByteRTCPublicStreamVideoConfig * _Nonnull video; ``` 公共流视频编码参数。详见 [ByteRTCPublicStreamVideoConfig](#ByteRTCPublicStreamVideoConfig)。 ## 函数说明 ### defaultPublicStreaming ```objectivec + (instancetype _Nonnull)defaultPublicStreaming; ``` 获取默认的公共流转码配置属性。 **返回值** 包含默认配置的 [ByteRTCPublicStreaming](#ByteRTCPublicStreaming) 结构体 # ByteRTCScreenMediaType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCScreenMediaType ) ``` 屏幕采集媒体类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCScreenMediaTypeVideoOnly | 0 | 只采集视频数据 | | ByteRTCScreenMediaTypeAudioOnly | 1 | 只采集音频数据 | | ByteRTCScreenMediaTypeVideoAndAudio | 2 | 音视频数据都采集 | # ByteRTCAudioRecordingConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCAudioRecordingConfig : NSObject ``` 音频录制配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [absoluteFileName](#ByteRTCAudioRecordingConfig-absolutefilename) | | ByteRTCAudioFrameSource | [frameSource](#ByteRTCAudioRecordingConfig-framesource) | | ByteRTCAudioSampleRate | [sampleRate](#ByteRTCAudioRecordingConfig-samplerate) | | ByteRTCAudioChannel | [channel](#ByteRTCAudioRecordingConfig-channel) | | ByteRTCAudioQuality | [quality](#ByteRTCAudioRecordingConfig-quality) | ## 变量说明 ### absoluteFileName ```objectivec @property(nonatomic, copy) NSString* _Nonnull absoluteFileName; ``` 录制文件路径。一个有读写权限的绝对路径，包含文件名和文件后缀。 **注意** 录制文件的格式仅支持 .aac 和 .wav。 ### frameSource ```objectivec @property(nonatomic, assign) ByteRTCAudioFrameSource frameSource; ``` 录音内容来源，参看 [ByteRTCAudioFrameSource](#ByteRTCAudioFrameSource)。默认为 ByteRTCAudioFrameSourceTypeMixed = 2。 ### sampleRate ```objectivec @property(nonatomic, assign) ByteRTCAudioSampleRate sampleRate; ``` 录音采样率。参看 [ByteRTCAudioSampleRate](#ByteRTCAudioSampleRate)。 ### channel ```objectivec @property(nonatomic, assign) ByteRTCAudioChannel channel; ``` 录音音频声道。参看 [ByteRTCAudioChannel](#ByteRTCAudioChannel)。如果录制时设置的的音频声道数与采集时的音频声道数不同： - 如果采集的声道数为 1，录制的声道数为 2，那么，录制的音频为经过单声道数据拷贝后的双声道数据，而不是立体声。 - 如果采集的声道数为 2，录制的声道数为 1，那么，录制的音频为经过双声道数据混合后的单声道数据。 ### quality ```objectivec @property(nonatomic, assign) ByteRTCAudioQuality quality; ``` 录音音质。仅在录制文件格式为 .aac 时可以设置。参看 [ByteRTCAudioQuality](#ByteRTCAudioQuality)。采样率为 32kHz 时，不同音质录制文件（时长为 10min）的大小分别是： - 低音质：1.2MB； - 【默认】中音质：2MB； - 高音质：3.75MB； - 超高音质：7.5MB。 # ByteRTCAudioFrameCallbackMethod ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioFrameCallbackMethod ) ``` 音频回调方法 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioFrameCallbackRecord | 0 | 本地麦克风录制的音频数据回调 | | ByteRTCAudioFrameCallbackPlayback | 1 | 订阅的远端所有用户混音后的音频数据回调 | | ByteRTCAudioFrameCallbackMixed | 2 | 本地麦克风录制和订阅的远端所有用户混音后的音频数据回调 | | ByteRTCAudioFrameCallbackRemoteUser | 3 | 订阅的远端每个用户混音前的音频数据回调 | # ByteRTCMixedStreamAlternateImageFillMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMixedStreamAlternateImageFillMode ) ``` 服务端合流占位图填充模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamAlternateImageFillModeFit | 0 | 占位图跟随用户原始视频帧相同的比例缩放。默认设置。 | | ByteRTCMixedStreamAlternateImageFillModeFill | 1 | 占位图不跟随用户原始视频帧相同的比例缩放，保持图片原有比例。 | # ByteRTCTranscoderLayoutRegionType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCTranscoderLayoutRegionType ) ``` > Deprecated since 3.52, use [ByteRTCMixedStreamLayoutRegionType](#ByteRTCMixedStreamLayoutRegionType) instead. 合流布局区域类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCTranscoderLayoutRegionTypeVideoStream | 0 | 合流布局区域类型为视频。 | | ByteRTCTranscoderLayoutRegionTypeImage | 1 | 合流布局区域类型为图片。 | # ByteRTCNetworkQuality ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCNetworkQuality ) ``` 媒体流网络质量。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCNetworkQualityUnknown | 0 | 网络质量未知。 | | ByteRTCNetworkQualityExcellent | 1 | 网络质量极好。 | | ByteRTCNetworkQualityGood | 2 | 主观感觉和 kNetworkQualityExcellent 差不多，但码率可能略低。 | | ByteRTCNetworkQualityPoor | 3 | 主观感受有瑕疵但不影响沟通。 | | ByteRTCNetworkQualityBad | 4 | 勉强能沟通但不顺畅。 | | ByteRTCNetworkQualityVeryBad | 5 | 网络质量非常差，基本不能沟通。 | | ByteRTCNetworkQualityDown | 6 | 网络连接断开，无法通话。网络可能由于 12s 内无应答、开启飞行模式、拔掉网线等原因断开。
更多网络状态信息参见 [连接状态提示](https://www.volcengine.com/docs/6348/95376)。 | # ByteRTCStreamRemoveReason ```objectivec typedef NS_ENUM( NSInteger, ByteRTCStreamRemoveReason ) ``` 房间内远端流移除原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCStreamRemoveReasonUnpublish | 0 | 远端用户停止发布流。 | | ByteRTCStreamRemoveReasonPublishFailed | 1 | 远端用户发布流失败。 | | ByteRTCStreamRemoveReasonKeepLiveFailed | 2 | 媒体服务器 10s 没收到客户端的媒体数据。 | | ByteRTCStreamRemoveReasonClientDisconnected | 3 | 远端用户断网。 | | ByteRTCStreamRemoveReasonRepublish | 4 | 远端用户重新发布流。 | | ByteRTCStreamRemoveReasonOther | 5 | 其他原因。 | | ByteRTCStreamRemoveReasonPublishPrivilegeExpired | 6 | 远端用户 Token 发布权限过期。 | # ByteRTCForwardStreamStateInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCForwardStreamStateInfo: NSObject ``` 跨房间转发媒体流过程中的不同目标房间的状态和错误信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString*_Nullable | [roomId](#ByteRTCForwardStreamStateInfo-roomid) | | ByteRTCForwardStreamState | [state](#ByteRTCForwardStreamStateInfo-state) | | ByteRTCForwardStreamError | [error](#ByteRTCForwardStreamStateInfo-error) | ## 变量说明 ### roomId ```objectivec @property(strong, nonatomic) NSString* _Nullable roomId; ``` 跨房间转发媒体流过程中目标房间 ID 空字符串代表所有目标房间 ### state ```objectivec @property(assign, nonatomic) ByteRTCForwardStreamState state; ``` 跨房间转发媒体流过程中该目标房间的状态，参看 [ByteRTCForwardStreamState](#ByteRTCForwardStreamState) ### error ```objectivec @property(assign, nonatomic) ByteRTCForwardStreamError error; ``` 跨房间转发媒体流过程中该目标房间抛出的错误码，参看 [ByteRTCForwardStreamError](#ByteRTCForwardStreamError) # ByteRTCSourceCropInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCSourceCropInfo : NSObject ``` 公共流裁剪信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | CGFloat | [locationX](#ByteRTCSourceCropInfo-locationx) | | CGFloat | [locationY](#ByteRTCSourceCropInfo-locationy) | | CGFloat | [widthProportion](#ByteRTCSourceCropInfo-widthproportion) | | CGFloat | [heightProportion](#ByteRTCSourceCropInfo-heightproportion) | ## 变量说明 ### locationX ```objectivec @property(assign, nonatomic) CGFloat locationX; ``` 裁剪后得到的视频帧左上角横坐标相对于裁剪前整体画面的比例，取值范围[0.0, 1.0) ### locationY ```objectivec @property(assign, nonatomic) CGFloat locationY; ``` 裁剪后得到的视频帧左上角纵坐标相对于裁剪前整体画面的比例，取值范围[0.0, 1.0) ### widthProportion ```objectivec @property(assign, nonatomic) CGFloat widthProportion; ``` 裁剪后得到的视频帧宽度相对于裁剪前整体画面的比例，取值范围(0.0, 1.0] ### heightProportion ```objectivec @property(assign, nonatomic) CGFloat heightProportion; ``` 裁剪后得到的视频帧高度相对于裁剪前整体画面的比例，取值范围(0.0, 1.0] # ByteRTCMulDimSingScoringMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMulDimSingScoringMode ) ``` K 歌打分维度。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMulDimSingScoringModeNote | 0 | 按照音高进行评分。 | # ByteRTCAttenuationType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAttenuationType ) ``` 空间音频音量随距离衰减模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAttenuationTypeNone | 0 | 不随距离衰减 | | ByteRTCAttenuationTypeLinear | 1 | 线性衰减，音量随距离增大而线性减小 | | ByteRTCAttenuationTypeExponential | 2 | 指数型衰减，音量随距离增大进行指数衰减 | # ByteRTCASRErrorCode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCASRErrorCode ) ``` 语音识别服务错误码。除网络原因导致的错误，语音识别服务内部会自行重试之外，其他错误都会停止服务，此时建议再次调用 `startASR:handler:` 重启语音识别功能。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCASRErrorNetworkInterrupted | -1 | 网络连接中断，服务不可用，内部会进行重连 | | ByteRTCASRErrorAlreadyStarted | -2 | 用户已经调用过 `startASR:handler:`。
开启语音识别服务后，你需要先调用 `stopASR` 停止语音识别服务，才能二次调用 `startASR:handler:` 再次开启服务。 | | ByteRTCASRErrorTokenEmpty | -3 | 语音识别服务所需 token 为空 | | ByteRTCErrorSignatureKeyEmpty | -4 | Signature 鉴权模式下 secretKey 为空 | | ByteRTCASRErrorUserIdNull | -5 | 用户 ID 为空 | | ByteRTCASRErrorAPPIDNull | -6 | 应用 ID 为空 | | ByteRTCASRErrorClusterNull | -7 | 语音识别服务 cluster 为空 | | ByteRTCASRErrorOperationDenied | -8 | 语音识别服务连接失败，该版本没有语音识别功能，请联系 RTC 技术支持。 | # ByteRTCLogLevel ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCLogLevel ) ``` 日志输出等级。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLogLevelTrace | 0 | 打印 trace 级别及以上级别信息。 | | ByteRTCLogLevelDebug | 1 | 打印 debug 级别及以上级别信息。 | | ByteRTCLogLevelInfo | 2 | 打印 info 级别及以上级别信息。 | | ByteRTCLogLevelWarning | 3 | 打印 warning 级别及以上级别信息。 | | ByteRTCLogLevelError | 4 | 打印 error 级别信息。 | # ByteRTCRemoteVideoRenderConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRemoteVideoRenderConfig : NSObject ``` 远端视频帧渲染设置 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCRenderMode | [renderMode](#ByteRTCRemoteVideoRenderConfig-rendermode) | | NSInteger | [backgroundColor](#ByteRTCRemoteVideoRenderConfig-backgroundcolor) | | ByteRTCVideoRotation | [renderRotation](#ByteRTCRemoteVideoRenderConfig-renderrotation) | ## 变量说明 ### renderMode ```objectivec @property(assign, nonatomic) ByteRTCRenderMode renderMode; ``` 渲染模式，参看 [ByteRTCRenderMode](#ByteRTCRenderMode) ### backgroundColor ```objectivec @property(assign, nonatomic) NSInteger backgroundColor; ``` 用于填充画布空白部分的背景颜色。取值范围是 `[0x00000000, 0xFFFFFFFF]`,格式为 BGR。默认值是 `0x00000000`。其中，透明度设置无效。 ### renderRotation ```objectivec @property(assign, nonatomic) ByteRTCVideoRotation renderRotation; ``` 视频帧旋转角度。参看 [ByteRTCVideoRotation](#ByteRTCVideoRotation)。默认为 0 度，即不做旋转处理。 # ByteRTCAudioRenderType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioRenderType ) ``` 音频输出源类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioRenderTypeExternal | 0 | 自定义渲染音频 | | ByteRTCAudioRenderTypeInternal | 1 | RTC SDK 内部渲染音频 | # ByteRTCVideoDeviceType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoDeviceType ) ``` 当前视频设备类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoDeviceTypeUnknown | -1 | 未知视频设备 | | ByteRTCVideoDeviceTypeRenderDevice | 0 | 视频渲染设备类型 | | ByteRTCVideoDeviceTypeCaptureDevice | 1 | 视频采集设备类型 | | ByteRTCVideoDeviceTypeScreenCaptureDevice | 2 | 屏幕流视频设备 | # ByteRTCVideoOrientation ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCVideoOrientation ) ``` 视频帧朝向 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoOrientationAdaptive | 0 | （默认）使用相机输出的原始视频帧的角度，不对视频帧进行额外旋转。 | | ByteRTCVideoOrientationPortrait | 1 | 固定为竖屏，将相机采集到的视频帧转换为竖屏，在整个 RTC 链路中传递竖屏帧。 | | ByteRTCVideoOrientationLandscape | 2 | 固定为横屏，将相机采集到的视频帧转换为横屏，在整个 RTC 链路中传递横屏帧。 | # ByteRTCSingScoringRealtimeInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCSingScoringRealtimeInfo : NSObject ``` 实时评分信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [currentPosition](#ByteRTCSingScoringRealtimeInfo-currentposition) | | int | [userPitch](#ByteRTCSingScoringRealtimeInfo-userpitch) | | int | [standardPitch](#ByteRTCSingScoringRealtimeInfo-standardpitch) | | int | [sentenceIndex](#ByteRTCSingScoringRealtimeInfo-sentenceindex) | | int | [sentenceScore](#ByteRTCSingScoringRealtimeInfo-sentencescore) | | int | [totalScore](#ByteRTCSingScoringRealtimeInfo-totalscore) | | int | [averageScore](#ByteRTCSingScoringRealtimeInfo-averagescore) | ## 变量说明 ### currentPosition ```objectivec @property(nonatomic, assign) int currentPosition; ``` 当前的播放进度。 ### userPitch ```objectivec @property(nonatomic, assign) int userPitch; ``` 演唱者的音高。 ### standardPitch ```objectivec @property(nonatomic, assign) int standardPitch; ``` 标准音高。 ### sentenceIndex ```objectivec @property(nonatomic, assign) int sentenceIndex; ``` 歌词分句索引。 ### sentenceScore ```objectivec @property(nonatomic, assign) int sentenceScore; ``` 上一句歌词的评分。 ### totalScore ```objectivec @property(nonatomic, assign) int totalScore; ``` 当前演唱的累计分数。 ### averageScore ```objectivec @property(nonatomic, assign) int averageScore; ``` 当前演唱的平均分数。 # ByteRTCAlphaLayout ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAlphaLayout ) ``` Alpha 通道相对于 RGB 通道数据的排列位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAlphaLayoutTop | 0 | Alpha 数据置于 RGB 数据上方。 | # ByteRTCVideoFrameInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoFrameInfo : NSObject ``` 视频帧基础信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [width](#ByteRTCVideoFrameInfo-width) | | NSInteger | [height](#ByteRTCVideoFrameInfo-height) | | ByteRTCVideoRotation | [rotation](#ByteRTCVideoFrameInfo-rotation) | ## 变量说明 ### width ```objectivec @property(nonatomic, assign) NSInteger width; ``` 视频帧的宽度（像素） ### height ```objectivec @property(nonatomic, assign) NSInteger height; ``` 视频帧的高度（像素） ### rotation ```objectivec @property(nonatomic, assign) ByteRTCVideoRotation rotation; ``` 视频帧顺时针旋转角度。参看 [ByteRTCVideoRotation](#ByteRTCVideoRotation)。 # ByteRTCScreenCaptureParam ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCScreenCaptureParam : NSObject ``` 屏幕采集设置参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [width](#ByteRTCScreenCaptureParam-width) | | NSInteger | [height](#ByteRTCScreenCaptureParam-height) | | NSInteger | [frameRate](#ByteRTCScreenCaptureParam-framerate) | | NSInteger | [bitrate](#ByteRTCScreenCaptureParam-bitrate) | | NSInteger | [minBitrate](#ByteRTCScreenCaptureParam-minbitrate) | | CGRect | [regionRect](#ByteRTCScreenCaptureParam-regionrect) | | ByteRTCMouseCursorCaptureState | [mouseCursorCaptureState](#ByteRTCScreenCaptureParam-mousecursorcapturestate) | | NSArray*_Nullable | [excludedWindowList](#ByteRTCScreenCaptureParam-excludedwindowlist) | | ByteRTCHighlightConfig* | [highlightConfig](#ByteRTCScreenCaptureParam-highlightconfig) | ## 变量说明 ### width ```objectivec @property(nonatomic, assign) NSInteger width; ``` 屏幕采集宽度 ### height ```objectivec @property(nonatomic, assign) NSInteger height; ``` 屏幕采集高度 ### frameRate ```objectivec @property(nonatomic, assign) NSInteger frameRate; ``` 屏幕采集帧率，单位 fps ### bitrate ```objectivec @property(nonatomic, assign) NSInteger bitrate; ``` 发送屏幕采集码率，单位 kbps ### minBitrate ```objectivec @property(nonatomic, assign) NSInteger minBitrate; ``` 视频最小编码码率, 单位 kbps。编码码率不会低于 `minBitrate`。默认值为 `0`。范围：[0, bitrate)，当 `bitrate` < `minBitrate` 时，为适配码率模式。以下情况，设置本参数无效： - 当 `bitrate` 为 `0` 时，不对视频流进行编码发送。 - 当 `bitrate` < `0` 时，适配码率模式。 ### regionRect ```objectivec @property(nonatomic, assign) CGRect regionRect; ``` 采集区域 ### mouseCursorCaptureState ```objectivec @property(nonatomic, assign) ByteRTCMouseCursorCaptureState mouseCursorCaptureState; ``` 是否采集鼠标 ### excludedWindowList ```objectivec @property (strong, nonatomic) NSArray * _Nullable excludedWindowList; ``` 屏幕过滤设置 ### highlightConfig ```objectivec @property (strong, nonatomic) ByteRTCHighlightConfig * _Nonnull highlightConfig; ``` 采集区域的边框高亮设置，参看 [ByteRTCHighlightConfig](#ByteRTCHighlightConfig)。 # ByteRTCProblemFeedbackRoomInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCProblemFeedbackRoomInfo: NSObject ``` 通话质量反馈房间信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [roomId](#ByteRTCProblemFeedbackRoomInfo-roomid) | | NSString* | [userId](#ByteRTCProblemFeedbackRoomInfo-userid) | ## 变量说明 ### roomId ```objectivec @property(nonatomic, copy) NSString * _Nonnull roomId; ``` 通话质量反馈的房间 ID ### userId ```objectivec @property(nonatomic, copy) NSString * _Nonnull userId; ``` 通话质量反馈的用户 ID # ByteRTCSetRoomExtraInfoResult ```objectivec typedef NS_ENUM( NSInteger, ByteRTCSetRoomExtraInfoResult ) ``` 设置房间附加消息结果。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCSetRoomExtraInfoResultSuccess | 0 | 设置房间附加信息成功 | | ByteRTCSetRoomExtraInfoResultNotJoinRoom | -1 | 设置失败，尚未加入房间 | | ByteRTCSetRoomExtraInfoResultKeyIsNull | -2 | 设置失败，key 指针为空 | | ByteRTCSetRoomExtraInfoResultValueIsNull | -3 | 设置失败，value 指针为空 | | ByteRTCSetRoomExtraInfoResultUnknow | -99 | 设置失败，未知错误 | | ByteRTCSetRoomExtraInfoResultKeyIsEmpty | -400 | 设置失败，key 长度为 0 | | ByteRTCSetRoomExtraInfoResultTooOften | -406 | 调用 `setRoomExtraInfo` 过于频繁，建议不超过 10 次/秒。 | | ByteRTCSetRoomExtraInfoResultSilentUser | -412 | 设置失败，用户已调用 `setUserVisibility` 将自身设为隐身状态。 | | ByteRTCSetRoomExtraInfoResultKeyTooLong | -413 | 设置失败，Key 长度超过 10 字节 | | ByteRTCSetRoomExtraInfoResultValueTooLong | -414 | 设置失败，value 长度超过 128 字节 | | ByteRTCSetRoomExtraInfoResultServerError | -500 | 设置失败，服务器错误 | # ByteRTCAudioVolumeInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCAudioVolumeInfo : NSObject ``` 音频流来源的用户 ID, 及对应的音量。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [uid](#ByteRTCAudioVolumeInfo-uid) | | NSUInteger | [linearVolume](#ByteRTCAudioVolumeInfo-linearvolume) | | NSUInteger | [nonlinearVolume](#ByteRTCAudioVolumeInfo-nonlinearvolume) | ## 变量说明 ### uid ```objectivec @property(copy, nonatomic) NSString * _Nonnull uid; ``` 音频流来源的用户 ID ### linearVolume ```objectivec @property(assign, nonatomic) NSUInteger linearVolume; ``` 线性音量，取值范围为：[0,255] ### nonlinearVolume ```objectivec @property(assign, nonatomic) NSUInteger nonlinearVolume; ``` 非线性音量，取值范围为：[-127,0] # ByteRTCLocalProxyInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCLocalProxyInfo : NSObject ``` 本地代理配置详细信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCLocalProxyType | [localProxyType](#ByteRTCLocalProxyInfo-localproxytype) | | NSString*_Nullable | [localProxyIp](#ByteRTCLocalProxyInfo-localproxyip) | | int | [localProxyPort](#ByteRTCLocalProxyInfo-localproxyport) | | NSString*_Nullable | [localProxyUsername](#ByteRTCLocalProxyInfo-localproxyusername) | | NSString*_Nullable | [localProxyPassword](#ByteRTCLocalProxyInfo-localproxypassword) | ## 变量说明 ### localProxyType ```objectivec @property(assign, nonatomic) ByteRTCLocalProxyType localProxyType; ``` 本地代理的类型，参看 [ByteRTCLocalProxyType](#ByteRTCLocalProxyType)。 ### localProxyIp ```objectivec @property(copy, nonatomic) NSString * _Nullable localProxyIp; ``` 本地代理服务器 IP。 ### localProxyPort ```objectivec @property(assign, nonatomic) int localProxyPort; ``` 本地代理服务器端口。 ### localProxyUsername ```objectivec @property(copy, nonatomic) NSString * _Nullable localProxyUsername; ``` 本地代理用户名。 ### localProxyPassword ```objectivec @property(copy, nonatomic) NSString * _Nullable localProxyPassword; ``` 本地代理密码。 # ByteRTCASRConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCASRConfig : NSObject ``` 使用自动语音识别服务所需校验信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [appId](#ByteRTCASRConfig-appid) | | NSString* | [userId](#ByteRTCASRConfig-userid) | | NSString* | [accessToken](#ByteRTCASRConfig-accesstoken) | | NSString* | [secretKey](#ByteRTCASRConfig-secretkey) | | NSString* | [cluster](#ByteRTCASRConfig-cluster) | | ByteRTCASRAuthorizationType | [authorizationType](#ByteRTCASRConfig-authorizationtype) | ## 变量说明 ### appId ```objectivec @property(copy, nonatomic) NSString *_Nonnull appId; ``` 应用 ID ### userId ```objectivec @property(copy, nonatomic) NSString *_Nonnull userId; ``` 用户 ID ### accessToken ```objectivec @property(copy, nonatomic) NSString *_Nonnull accessToken; ``` 访问令牌 ### secretKey ```objectivec @property(copy, nonatomic) NSString *_Nonnull secretKey; ``` 私钥。Signature 鉴权模式下不能为空，token 鉴权模式下为空。参看[关于鉴权](https://www.volcengine.com/docs/6561/107789) ### cluster ```objectivec @property(copy, nonatomic) NSString *_Nonnull cluster; ``` 场景信息，参看[业务集群](https://www.volcengine.com/docs/6561/80818#_3-2-2-%E5%8F%91%E9%80%81-full-client-request) ### authorizationType ```objectivec @property(assign, nonatomic) ByteRTCASRAuthorizationType authorizationType; ``` 鉴权模式，参看 [ByteRTCASRAuthorizationType](#ByteRTCASRAuthorizationType) # ByteRTCMixedStreamMediaType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMixedStreamMediaType ) ``` 合流输出内容类型。(新) ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamMediaTypeAudioAndVideo | 0 | 输出的混流包含音频和视频 | | ByteRTCMixedStreamMediaTypeAudioOnly | 1 | 输出的混流只包含音频 | | ByteRTCMixedStreamMediaTypeVideoOnly | 2 | 输出的混流只包含视频 | # ByteRTCTranscodingAudioConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCTranscodingAudioConfig : NSObject ``` > Deprecated since 3.52, use [ByteRTCMixedStreamAudioConfig](#ByteRTCMixedStreamAudioConfig) instead. 音频转码配置参数。值不合法或未设置时，自动使用默认值。本参数不支持过程中更新。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCTranscodingAudioCodec | [codec](#ByteRTCTranscodingAudioConfig-codec) | | NSInteger | [sampleRate](#ByteRTCTranscodingAudioConfig-samplerate) | | NSInteger | [channels](#ByteRTCTranscodingAudioConfig-channels) | | NSInteger | [kBitRate](#ByteRTCTranscodingAudioConfig-kbitrate) | | ByteRTCAACProfile | [profile](#ByteRTCTranscodingAudioConfig-profile) | ## 变量说明 ### codec ```objectivec @property(assign, nonatomic) ByteRTCTranscodingAudioCodec codec; ``` 音频编码格式。 ### sampleRate ```objectivec @property(assign, nonatomic) NSInteger sampleRate; ``` 音频采样率，单位 Hz。可取 32000 Hz、44100 Hz、48000 Hz，默认值为 48000 Hz。 ### channels ```objectivec @property(assign, nonatomic) NSInteger channels; ``` 音频声道数。可取 1（单声道）、2（双声道），默认值为 2。 ### kBitRate ```objectivec @property(assign, nonatomic) NSInteger kBitRate; ``` 音频码率，单位 Kbps。可取范围 [32, 192]，默认值为 64 Kbps。 ### profile ```objectivec @property(assign, nonatomic) ByteRTCAACProfile profile; ``` AAC 编码规格，参看 [ByteRTCAACProfile](#ByteRTCAACProfile)。默认值为 `0`。 # ByteRTCRecordingProgress ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRecordingProgress : NSObject ``` 本地录制进度 ## 成员变量 | 类型 | 名称 | | --- | --- | | unsignedlonglong | [duration](#ByteRTCRecordingProgress-duration) | | unsignedlonglong | [fileSize](#ByteRTCRecordingProgress-filesize) | ## 变量说明 ### duration ```objectivec @property(assign, nonatomic) unsigned long long duration; ``` 当前文件的累计录制时长，单位：毫秒 ### fileSize ```objectivec @property(assign, nonatomic) unsigned long long fileSize; ``` 当前录制文件的大小，单位：byte # ByteRTCAudioSelectionPriority ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCAudioSelectionPriority ) ``` 音频选路优先级设置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioSelectionPriorityNormal | 0 | 正常，参加音频选路 | | ByteRTCAudioSelectionPriorityHigh | 1 | 高优先级，跳过音频选路 | # ByteRTCStreamMixingEvent ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCStreamMixingEvent ) ``` 转推直播事件 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCStreamMixingEventStart | 1 | 请求发起转推直播任务 | | ByteRTCStreamMixingEventStartSuccess | 2 | 发起转推直播任务成功 | | ByteRTCStreamMixingEventStartFailed | 3 | 发起转推直播任务失败 | | ByteRTCStreamMixingEventUpdate | 4 | 请求更新转推直播任务配置 | | ByteRTCStreamMixingEventUpdateSuccess | 5 | 成功更新转推直播任务配置 | | ByteRTCStreamMixingEventUpdateFailed | 6 | 更新转推直播任务配置失败 | | ByteRTCStreamMixingEventStop | 7 | 请求结束转推直播任务 | | ByteRTCStreamMixingEventStopSuccess | 8 | 结束转推直播任务成功 | | ByteRTCStreamMixingEventStopFailed | 9 | 结束转推直播任务失败 | | ByteRTCStreamMixingEventChangeMixType | 10 | 更新转推直播任务配置的请求超时 | | ByteRTCStreamMixingEventFirstAudioFrameByClientMixer | 11 | 得到客户端合流音频首帧 | | ByteRTCStreamMixingEventFirstVideoFrameByClientMixer | 12 | 收到客户端合流视频首帧 | | ByteRTCStreamMixingEventUpdateTimeout | 13 | 更新转推直播任务配置超时 | | ByteRTCStreamMixingEventStartTimeout | 14 | 发起转推直播任务配置超时 | | ByteRTCStreamMixingEventRequestParamError | 15 | 合流布局参数错误 | | ByteRTCStreamMixingEventMixImage | 16 | 合流加图片 | # ByteRTCAudioSampleRate ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioSampleRate ) ``` 音频采样率，单位为 Hz。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioSampleRateAuto | -1 | 默认设置。48000Hz。 | | ByteRTCAudioSampleRate8000 | 8000 | 8000Hz | | ByteRTCAudioSampleRate16000 | 16000 | 16000Hz | | ByteRTCAudioSampleRate32000 | 32000 | 32000Hz | | ByteRTCAudioSampleRate44100 | 44100 | 44100Hz | | ByteRTCAudioSampleRate48000 | 48000 | 48000Hz | # ByteRTCAudioChannel ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioChannel ) ``` 音频声道。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioChannelAuto | -1 | 默认设置。默认值为 `2`。 | | ByteRTCAudioChannelMono | 1 | 单声道 | | ByteRTCAudioChannelStereo | 2 | 双声道 | # ByteRTCHardwareEchoDetectionResult ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCHardwareEchoDetectionResult ) ``` 通话前回声检测结果 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCHardwareEchoDetectionCanceled | 0 | 主动调用 `stopHardwareEchoDetection` 结束流程时，未有回声检测结果。 | | ByteRTCHardwareEchoDetectionUnknown | 1 | 未检测出结果。建议重试，如果仍然失败请联系技术支持协助排查。 | | ByteRTCHardwareEchoDetectionNormal | 2 | 无回声 | | ByteRTCHardwareEchoDetectionPoor | 3 | 有回声。可通过 UI 建议用户使用耳机设备入会。 | # ByteRTCEffectBeautyMode ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCEffectBeautyMode ) ``` 基础美颜模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCEffectBeautyModeWhite | 0 | 美白。 | | ByteRTCEffectBeautyModeSmooth | 1 | 磨皮。 | | ByteRTCEffectBeautyModeSharpen | 2 | 锐化。 | | ByteRTCEffectBeautyModeClear | 3 | 清晰，需集成 v4.4.2+ 版本的特效 SDK。 | # ByteRTCVideoCanvas ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoCanvas : NSObject ``` 视频帧渲染设置 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCView*_Nullable | [view](#ByteRTCVideoCanvas-view) | | ByteRTCRenderMode | [renderMode](#ByteRTCVideoCanvas-rendermode) | | NSInteger | [backgroundColor](#ByteRTCVideoCanvas-backgroundcolor) | | ByteRTCVideoRotation | [renderRotation](#ByteRTCVideoCanvas-renderrotation) | ## 变量说明 ### view ```objectivec @property(strong, nonatomic) ByteRTCView* _Nullable view; ``` 本地视图句柄 ### renderMode ```objectivec @property(assign, nonatomic) ByteRTCRenderMode renderMode; ``` 渲染模式，参看 [ByteRTCRenderMode](#ByteRTCRenderMode) ### backgroundColor ```objectivec @property(assign, nonatomic) NSInteger backgroundColor; ``` 用于填充画布空白部分的背景颜色。取值范围是 `[0x00000000, 0xFFFFFFFF]`,格式为 BGR。默认值是 `0x00000000`。其中，透明度设置无效。 ### renderRotation ```objectivec @property(assign, nonatomic) ByteRTCVideoRotation renderRotation; ``` 设置接收到的远端视频帧在本端渲染时的旋转角度。参看 [ByteRTCVideoRotation](#ByteRTCVideoRotation)。默认为 0 度，即不做旋转处理。该设置仅对远端视频有效，对本地视频设置不生效。 # ByteRTCRemoteAudioState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCRemoteAudioState ) ``` 用户订阅的远端音频流状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRemoteAudioStateStopped | 0 | 远端音频流默认初始状态，在以下时机回调该状态：

本地用户停止接收远端音频流，对应原因是 [ByteRTCRemoteAudioStateChangeReason](#ByteRTCRemoteAudioStateChangeReason) 中的 `ByteRTCRemoteAudioStateChangeReasonLocalMuted`

远端用户停止发送音频流，对应原因是 [ByteRTCRemoteAudioStateChangeReason](#ByteRTCRemoteAudioStateChangeReason) 中的 `ByteRTCRemoteAudioStateChangeReasonRemoteMuted`

远端用户离开房间，对应原因是 [ByteRTCRemoteAudioStateChangeReason](#ByteRTCRemoteAudioStateChangeReason) 中的 `ByteRTCRemoteAudioStateChangeReasonRemoteOffline`

成功解码远端音频首帧，对应原因是 [ByteRTCRemoteAudioStateChangeReason](#ByteRTCRemoteAudioStateChangeReason) 中的 `ByteRTCRemoteAudioStateChangeReasonLocalUnmuted`

网络由阻塞恢复正常，对应原因是 [ByteRTCRemoteAudioStateChangeReason](#ByteRTCRemoteAudioStateChangeReason) 中的 `ByteRTCRemoteAudioStateChangeReasonNetworkRecovery`

本地用户恢复接收远端音频流，对应原因是 [ByteRTCRemoteAudioStateChangeReason](#ByteRTCRemoteAudioStateChangeReason) 中的 `ByteRTCRemoteAudioStateChangeReasonLocalUnmuted`

远端用户恢复发送音频流，对应原因是 [ByteRTCRemoteAudioStateChangeReason](#ByteRTCRemoteAudioStateChangeReason) 中的 `ByteRTCRemoteAudioStateChangeReasonRemoteUnmuted`

| | ByteRTCRemoteAudioStateFrozen | 3 | 远端音频流卡顿。 | # ByteRTCMuteState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMuteState ) ``` 音视频流的发送/播放状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMuteStateOff | 0 | 发送 | | ByteRTCMuteStateOn | 1 | 停止发送 | # ByteRTCTranscodingVideoConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCTranscodingVideoConfig : NSObject ``` > Deprecated since 3.52, use [ByteRTCMixedStreamVideoConfig](#ByteRTCMixedStreamVideoConfig) instead. 视频转码配置参数。值不合法或未设置时，自动使用默认值。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCTranscodingVideoCodec | [codec](#ByteRTCTranscodingVideoConfig-codec) | | NSInteger | [width](#ByteRTCTranscodingVideoConfig-width) | | NSInteger | [height](#ByteRTCTranscodingVideoConfig-height) | | NSInteger | [fps](#ByteRTCTranscodingVideoConfig-fps) | | NSInteger | [gop](#ByteRTCTranscodingVideoConfig-gop) | | NSInteger | [kBitRate](#ByteRTCTranscodingVideoConfig-kbitrate) | | BOOL | [bFrame](#ByteRTCTranscodingVideoConfig-bframe) | | BOOL | [deprecated] [lowLatency](#ByteRTCTranscodingVideoConfig-lowlatency) | ## 变量说明 ### codec ```objectivec @property(assign, nonatomic) ByteRTCTranscodingVideoCodec codec; ``` 视频编码格式，参看 [ByteRTCTranscodingVideoCodec](#ByteRTCTranscodingVideoCodec)。默认值为 `0`。本参数不支持过程中更新。 ### width ```objectivec @property(assign, nonatomic) NSInteger width; ``` 合流视频宽度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 640 px。设置值为非偶数时，自动向上取偶数。 ### height ```objectivec @property(assign, nonatomic) NSInteger height; ``` 合流视频高度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 360 px。设置值为非偶数时，自动向上取偶数。 ### fps ```objectivec @property(assign, nonatomic) NSInteger fps; ``` 合流视频帧率。单位为 FPS，取值范围为 [1,60]，默认值为 15 FPS。 ### gop ```objectivec @property(assign, nonatomic) NSInteger gop; ``` 视频 I 帧时间间隔。单位为秒，取值范围为 [1, 5]，默认值为 2 秒。本参数不支持过程中更新。 ### kBitRate ```objectivec @property(assign, nonatomic) NSInteger kBitRate; ``` 合流视频码率。单位为 Kbps，取值范围为 [1,10000]，默认值为自适应模式。 ### bFrame ```objectivec @property(assign, nonatomic) BOOL bFrame; ``` 是否在合流中开启 B 帧，仅服务端合流支持. ### lowLatency ```objectivec @property(assign, nonatomic) BOOL lowLatency; ``` > Deprecated since 3.45 and will be deleted in 3.51. 是否使用低延时特性。 # ByteRTCVideoPreprocessorConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoPreprocessorConfig : NSObject ``` 视频处理配置参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCVideoPixelFormat | [requiredPixelFormat](#ByteRTCVideoPreprocessorConfig-requiredpixelformat) | ## 变量说明 ### requiredPixelFormat ```objectivec @property(nonatomic, assign) ByteRTCVideoPixelFormat requiredPixelFormat; ``` 视频帧的像素格式，参看 [ByteRTCVideoPixelFormat](#ByteRTCVideoPixelFormat)。当前仅支持 `ByteRTCVideoPixelFormatI420` 和 `ByteRTCVideoPixelFormatUnknown` 格式。 # ByteRTCRemoteAudioStateChangeReason ```objectivec typedef NS_ENUM( NSInteger, ByteRTCRemoteAudioStateChangeReason ) ``` 接收远端音频流状态改变的原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRemoteAudioStateChangeReasonInternal | 0 | 内部原因 | | ByteRTCRemoteAudioStateChangeReasonNetworkCongestion | 1 | 网络阻塞 | | ByteRTCRemoteAudioStateChangeReasonNetworkRecovery | 2 | 网络恢复正常 | | ByteRTCRemoteAudioStateChangeReasonLocalMuted | 3 | 本地用户停止接收远端音频流 | | ByteRTCRemoteAudioStateChangeReasonLocalUnmuted | 4 | 本地用户恢复接收远端音频流 | | ByteRTCRemoteAudioStateChangeReasonRemoteMuted | 5 | 远端用户停止发送音频流 | | ByteRTCRemoteAudioStateChangeReasonRemoteUnmuted | 6 | 远端用户恢复发送音频流 | | ByteRTCRemoteAudioStateChangeReasonRemoteOffline | 7 | 远端用户离开房间 | # ByteRTCPublicStreamLayout ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCPublicStreamLayout : NSObject ``` 公共流的合流布局。必填 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [layoutMode](#ByteRTCPublicStreamLayout-layoutmode) | | NSInteger | [interpolationMode](#ByteRTCPublicStreamLayout-interpolationmode) | | NSString* | [backgroundColor](#ByteRTCPublicStreamLayout-backgroundcolor) | | NSString* | [backgroundImage](#ByteRTCPublicStreamLayout-backgroundimage) | | NSArray* | [regions](#ByteRTCPublicStreamLayout-regions) | ## 变量说明 ### layoutMode ```objectivec @property(assign, nonatomic) NSInteger layoutMode; ``` 布局模式。可选： - `0`: 自动布局。默认值 - `2`: 自定义布局。 ### interpolationMode ```objectivec @property(assign, nonatomic) NSInteger interpolationMode; ``` 插帧模式。 - `0`: 补最后一帧 - `1`: 补背景图片，如果没有设置背景图片则补黑帧 ### backgroundColor ```objectivec @property(copy, nonatomic) NSString *_Nonnull backgroundColor; ``` 画布的背景颜色。格式为 RGB 定义下的 Hex 值，如 #FFB6C1 表示浅粉色。默认值 #000000，表示为黑色 ### backgroundImage ```objectivec @property(copy, nonatomic) NSString *_Nonnull backgroundImage; ``` 背景图片地址 ### regions ```objectivec @property(copy, nonatomic) NSArray * _Nonnull regions; ``` 用户布局信息列表。每一个该类型对象为一路单独的视频流的布局信息。 # ByteRTCLocalVideoStreamState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCLocalVideoStreamState ) ``` 本地视频流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLocalVideoStreamStateStopped | 0 | 本地视频默认初始状态
摄像头停止工作时回调该状态，对应错误码 [ByteRTCLocalVideoStreamError](#ByteRTCLocalVideoStreamError) 中的 ByteRTCLocalVideoStreamErrorOk | | ByteRTCLocalVideoStreamStateRecording | 1 | 本地视频录制设备启动成功
采集到视频首帧时回调该状态，对应错误码 [ByteRTCLocalVideoStreamError](#ByteRTCLocalVideoStreamError) 中的 ByteRTCLocalVideoStreamErrorOk | | ByteRTCLocalVideoStreamStateEncoding | 2 | 本地视频首帧编码成功
本地视频首帧编码成功时回调该状态，对应错误码 [ByteRTCLocalVideoStreamError](#ByteRTCLocalVideoStreamError) 中的 ByteRTCLocalVideoStreamErrorOk | | ByteRTCLocalVideoStreamStateFailed | 3 | 本地视频启动失败, 在以下时机回调该状态：

本地采集设备启动失败，对应错误码 [ByteRTCLocalVideoStreamError](#ByteRTCLocalVideoStreamError) 中的 ByteRTCLocalVideoStreamErrorCaptureFailure

检测到没有摄像头权限，对应错误码 [ByteRTCLocalVideoStreamError](#ByteRTCLocalVideoStreamError) 中的 ByteRTCLocalVideoStreamErrorDeviceNoPermission

视频编码失败，对应错误码 [ByteRTCLocalVideoStreamError](#ByteRTCLocalVideoStreamError) 中的 ByteRTCLocalVideoStreamErrorEncodeFailure

| # ByteRTCSingScoringConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCSingScoringConfig : NSObject ``` K 歌评分配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCMulDimSingScoringMode | [mode](#ByteRTCSingScoringConfig-mode) | | ByteRTCAudioSampleRate | [sampleRate](#ByteRTCSingScoringConfig-samplerate) | | NSString* | [lyricsFilepath](#ByteRTCSingScoringConfig-lyricsfilepath) | | NSString* | [midiFilepath](#ByteRTCSingScoringConfig-midifilepath) | ## 变量说明 ### mode ```objectivec @property(nonatomic, assign) ByteRTCMulDimSingScoringMode mode; ``` 打分维度，详见 [ByteRTCMulDimSingScoringMode](#ByteRTCMulDimSingScoringMode)。 ### sampleRate ```objectivec @property(nonatomic, assign) ByteRTCAudioSampleRate sampleRate; ``` 音频采样率。仅支持 44100 Hz、48000 Hz。 ### lyricsFilepath ```objectivec @property(nonatomic, copy) NSString *_Nonnull lyricsFilepath; ``` 歌词文件路径。打分功能仅支持 KRC 歌词文件。 ### midiFilepath ```objectivec @property(nonatomic, copy) NSString *_Nonnull midiFilepath; ``` 歌曲 midi 文件路径。 # ByteRTCFirstFrameSendState ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCFirstFrameSendState ) ``` 首帧发送状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCFirstFrameSendStateSending | 0 | 发送中 | | ByteRTCFirstFrameSendStateSent | 1 | 发送成功 | | ByteRTCFirstFrameSendStateEnd | 2 | 发送失败 | # ByteRTCRemoteMirrorType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCRemoteMirrorType ) ``` 远端流的镜像类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRemoteMirrorTypeNone | 0 | （默认值）远端视频渲染无镜像效果。 | | ByteRTCRemoteMirrorTypeRender | 1 | 远端视频渲染有镜像效果。 | # ByteRTCVoiceEqualizationConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVoiceEqualizationConfig : NSObject ``` 语音均衡效果。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCBandFrequency | [frequency](#ByteRTCVoiceEqualizationConfig-frequency) | | int | [gain](#ByteRTCVoiceEqualizationConfig-gain) | ## 变量说明 ### frequency ```objectivec @property(assign, nonatomic) ByteRTCBandFrequency frequency; ``` 频带。参看 [ByteRTCBandFrequency](#ByteRTCBandFrequency)。 ### gain ```objectivec @property(assign, nonatomic) int gain; ``` 频带增益（dB）。取值范围是 `[-15, 15]`。 # ByteRTCConnectionState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCConnectionState ) ``` SDK 与信令服务器连接状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCConnectionStateDisconnected | 1 | 连接断开超过 12s，此时 SDK 会尝试自动重连。 | | ByteRTCConnectionStateConnecting | 2 | 首次请求建立连接，正在连接中。 | | ByteRTCConnectionStateConnected | 3 | 首次连接成功。 | | ByteRTCConnectionStateReconnecting | 4 | 涵盖了以下情况：

首次连接时，10 秒连接不成功;

连接成功后，断连 10 秒。自动重连中。

| | ByteRTCConnectionStateReconnected | 5 | 连接断开后，重连成功。 | | ByteRTCConnectionStateLost | 6 | 处于 `ByteRTCConnectionStateDisconnected` 状态超过 10 秒，且期间重连未成功。SDK 仍将继续尝试重连。 | | ByteRTCConnectionStateFailed | 7 | 连接失败，服务端状态异常。SDK 不会自动重连，请重新进房，或联系技术支持。 | # ByteRTCFallbackOrRecoverReason ```objectivec typedef NS_ENUM( NSInteger, ByteRTCFallbackOrRecoverReason ) ``` 本地用户订阅的远端流触发回退策略的原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCFallbackOrRecoverReasonUnknown | -1 | 其他原因，非带宽和性能原因引起的回退或恢复。默认值 | | ByteRTCFallbackOrRecoverReasonSubscribeFallbackByBandwidth | 0 | 由带宽不足导致的订阅端音视频流回退。 | | ByteRTCFallbackOrRecoverReasonSubscribeFallbackByPerformance | 1 | 由性能不足导致的订阅端音视频流回退。 | | ByteRTCFallbackOrRecoverReasonSubscribeRecoverByBandwidth | 2 | 由带宽恢复导致的订阅端音视频流恢复。 | | ByteRTCFallbackOrRecoverReasonSubscribeRecoverByPerformance | 3 | 由性能恢复导致的订阅端音视频流恢复。 | | ByteRTCFallbackOrRecoverReasonPublishFallbackByBandwidth | 4 | 由带宽不足导致的发布端音视频流回退。 | | ByteRTCFallbackOrRecoverReasonPublishFallbackByPerformance | 5 | 由性能不足导致的发布端音视频流回退。 | | ByteRTCFallbackOrRecoverReasonPublishRecoverByBandwidth | 6 | 由带宽恢复导致的发布端音视频流恢复。 | | ByteRTCFallbackOrRecoverReasonPublishRecoverByPerformance | 7 | 由性能恢复导致的发布端音视频流恢复。 | # ByteRTCRecordingFileType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCRecordingFileType ) ``` 本地录制文件的存储格式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRecordingFileTypeAAC | 0 | aac 格式文件 | | ByteRTCRecordingFileTypeMP4 | 1 | mp4 格式文件 | # ByteRTCVideoPictureType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoPictureType ) ``` 编码帧类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoPictureTypeUnknown | 0 | 未知类型 | | ByteRTCVideoPictureTypeI | 1 | I 帧，关键帧，编解码不需要参考其他视频帧 | | ByteRTCVideoPictureTypeP | 2 | P 帧，向前参考帧，编解码需要参考前一帧视频帧 | | ByteRTCVideoPictureTypeB | 3 | B 帧，前后参考帧，编解码需要参考前后两帧视频帧 | # ByteRTCVideoStreamScaleMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoStreamScaleMode ) ``` 视频帧缩放模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoStreamScaleModeAuto | 0 | 自动缩放模式，默认设置为 ByteRTCVideoStreamScaleModeFitWithCropping。 | | ByteRTCVideoStreamScaleModeStretch | 1 | 对视频帧进行缩放，直至充满和视窗分辨率一致为止。这一过程不保证等比缩放。 | | ByteRTCVideoStreamScaleModeFitWithCropping | 2 | 视窗填满优先。
视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。
缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长。 | | ByteRTCVideoStreamScaleModeFitWithFilling | 3 | 视频帧内容全部显示优先。
视频帧等比缩放，直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同，视窗上未被视频帧填满区域将被涂黑。
缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长。保持纵横比来缩放图像，填充短边 | # ByteRTCSubtitleConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCSubtitleConfig : NSObject ``` 字幕配置信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCSubtitleMode | [mode](#ByteRTCSubtitleConfig-mode) | | NSString* | [targetLanguage](#ByteRTCSubtitleConfig-targetlanguage) | ## 变量说明 ### mode ```objectivec @property(assign, nonatomic) ByteRTCSubtitleMode mode; ``` 字幕模式。可以根据需要选择识别和翻译两种模式。开启识别模式，会将识别后的用户语音转化成文字；开启翻译模式，会在语音识别后进行翻译。参看 [ByteRTCSubtitleMode](#ByteRTCSubtitleMode)。 ### targetLanguage ```objectivec @property(copy, nonatomic) NSString *_Nonnull targetLanguage; ``` 目标翻译语言。可点击 [语言支持](https://www.volcengine.com/docs/4640/35107) 查看翻译服务最新支持的语种信息。 # ByteRTCAudioMixingConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCAudioMixingConfig : NSObject ``` 混音配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCAudioMixingType | [type](#ByteRTCAudioMixingConfig-type) | | NSInteger | [playCount](#ByteRTCAudioMixingConfig-playcount) | | NSInteger | [position](#ByteRTCAudioMixingConfig-position) | | NSInteger | [callbackOnProgressInterval](#ByteRTCAudioMixingConfig-callbackonprogressinterval) | | BOOL | [syncProgressToRecordFrame](#ByteRTCAudioMixingConfig-syncprogresstorecordframe) | ## 变量说明 ### type ```objectivec @property(assign, nonatomic) ByteRTCAudioMixingType type; ``` 混音播放类型，详见 [ByteRTCAudioMixingType](#ByteRTCAudioMixingType) ### playCount ```objectivec @property(assign, nonatomic) NSInteger playCount; ``` 混音播放次数 - play_count <= 0: 无限循环 - play_count == 1: 播放一次（默认） - play_count \> 1: 播放 play_count 次 ### position ```objectivec @property(assign, nonatomic) NSInteger position; ``` 混音时音频文件播放进度条位置，参数为整数，单位为毫秒 ### callbackOnProgressInterval ```objectivec @property(assign, nonatomic) NSInteger callbackOnProgressInterval; ``` 设置音频文件播放进度回调的时间间隔，参数为为大于 0 的 10 的倍数，单位为毫秒，设置后 SDK 将按照设置的值触发 `rtcEngine:onAudioMixingPlayingProgress:progress:` 回调，默认不回调。 - 当传入的值不能被 10 整除时，则默认向上取整 10，如设为 52ms 时会默认调整为 60ms。 - 当传入的值小于等于 0 时，不会触发进度回调。 ### syncProgressToRecordFrame ```objectivec @property(assign, nonatomic) BOOL syncProgressToRecordFrame; ``` 在采集音频数据时，附带本地混音文件播放进度的时间戳。启用此功能会提升远端人声和音频文件混音播放时的同步效果。 - 仅在单个音频文件混音时使用有效。 - `true` 时开启此功能，`false` 时关闭此功能，默认为关闭。 # ByteRTCVideoSinkPixelFormat ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoSinkPixelFormat ) ``` 视频帧编码格式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoSinkPixelFormatOriginal | 0 | 原始视频帧格式 | | ByteRTCVideoSinkPixelFormatI420 | 1 | YUV I420 格式 | | ByteRTCVideoSinkPixelFormatBGRA | 2 | BGRA 格式 | | ByteRTCVideoSinkPixelFormatRGBA | 5 | RGBA 格式, 字节序为 R8 G8 B8 A8 | | ByteRTCVideoSinkPixelFormatNV12 | 8 | YUV NV21 格式 | # ByteRTCAudioMixingError ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioMixingError ) ``` 混音错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioMixingErrorOk | 0 | 正常 | | ByteRTCAudioMixingErrorPreloadFailed | 1 | 预加载失败，找不到混音文件或者文件长度超出 20s | | ByteRTCAudioMixingErrorStartFailed | 2 | 混音开启失败，找不到混音文件或者混音文件打开失败 | | ByteRTCAudioMixingErrorIdNotFound | 3 | 混音 ID 异常 | | ByteRTCAudioMixingErrorSetPositionFailed | 4 | 设置混音文件的播放位置出错 | | ByteRTCAudioMixingErrorInValidVolume | 5 | 音量参数不合法，仅支持设置的音量值为[0, 400] | | ByteRTCAudioMixingErrorLoadConflict | 6 | 播放的文件与预加载的文件不一致。请先使用 [unloadAudioMixing:](70092#ByteRTCAudioMixingManager-unloadaudiomixing) 卸载此前的文件。 | | ByteRTCAudioMixingErrorIdTypeNotMatch | 7 | 不支持此混音类型。 | | ByteRTCAudioMixingErrorInValidPitch | 8 | 设置混音文件的音调不合法 | | ByteRTCAudioMixingErrorInValidAudioTrack | 9 | 设置混音文件的音轨不合法 | | ByteRTCAudioMixingErrorIsStarting | 10 | 混音文件正在启动中 | | ByteRTCAudioMixingErrorInValidPlaybackSpeed | 11 | 设置混音文件的播放速度不合法 | # ByteRTCMixedStreamSpatialAudioConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMixedStreamSpatialAudioConfig : NSObject ``` 推流 CDN 的空间音频参数。(新) ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [enableSpatialRender](#ByteRTCMixedStreamSpatialAudioConfig-enablespatialrender) | | ByteRTCPosition*_Nullable | [audienceSpatialPosition](#ByteRTCMixedStreamSpatialAudioConfig-audiencespatialposition) | | ByteRTCHumanOrientation*_Nullable | [audienceSpatialOrientation](#ByteRTCMixedStreamSpatialAudioConfig-audiencespatialorientation) | ## 变量说明 ### enableSpatialRender ```objectivec @property(assign, nonatomic) BOOL enableSpatialRender; ``` 是否开启推流 CDN 时的空间音频效果。当你启用此效果时，你需要设定推流中各个 [ByteRTCMixedStreamLayoutRegionConfig](#ByteRTCMixedStreamLayoutRegionConfig) 的 `spatialPosition` 值，实现空间音频效果。 ### audienceSpatialPosition ```objectivec @property (strong, nonatomic) ByteRTCPosition * _Nullable audienceSpatialPosition; ``` 听众的空间位置。参看 [ByteRTCPosition](#ByteRTCPosition)。听众指收听来自 CDN 的音频流的用户。 ### audienceSpatialOrientation ```objectivec @property(strong, nonatomic) ByteRTCHumanOrientation * _Nullable audienceSpatialOrientation; ``` 听众的空间朝向。参看 [ByteRTCHumanOrientation](#ByteRTCHumanOrientation)。听众指收听来自 CDN 的音频流的用户。 # ByteRTCTranscodingSpatialConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCTranscodingSpatialConfig : NSObject ``` > Deprecated since 3.52, use [ByteRTCMixedStreamSpatialAudioConfig](#ByteRTCMixedStreamSpatialAudioConfig) instead. 推流 CDN 的空间音频参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [enableSpatialRender](#ByteRTCTranscodingSpatialConfig-enablespatialrender) | | ByteRTCPosition*_Nullable | [audienceSpatialPosition](#ByteRTCTranscodingSpatialConfig-audiencespatialposition) | | ByteRTCHumanOrientation*_Nullable | [audienceSpatialOrientation](#ByteRTCTranscodingSpatialConfig-audiencespatialorientation) | ## 变量说明 ### enableSpatialRender ```objectivec @property(assign, nonatomic) BOOL enableSpatialRender; ``` 是否开启推流 CDN 时的空间音频效果。当你启用此效果时，你需要设定推流中各个 [ByteRTCTranscodingSpatialConfig](#ByteRTCTranscodingSpatialConfig) 的 `spatialPosition` 值，实现空间音频效果。 ### audienceSpatialPosition ```objectivec @property (strong, nonatomic) ByteRTCPosition * _Nullable audienceSpatialPosition; ``` 听众的空间位置。参看 [ByteRTCPosition](#ByteRTCPosition)。听众指收听来自 CDN 的音频流的用户。 ### audienceSpatialOrientation ```objectivec @property(strong, nonatomic) ByteRTCHumanOrientation * _Nullable audienceSpatialOrientation; ``` 听众的空间朝向。参看 [ByteRTCHumanOrientation](#ByteRTCHumanOrientation)。听众指收听来自 CDN 的音频流的用户。 # ByteRTCProblemFeedbackInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCProblemFeedbackInfo: NSObject ``` 通话质量反馈信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [problemDesc](#ByteRTCProblemFeedbackInfo-problemdesc) | | NSArray*_Nullable | [roomInfo](#ByteRTCProblemFeedbackInfo-roominfo) | ## 变量说明 ### problemDesc ```objectivec @property(nonatomic, copy) NSString * _Nonnull problemDesc; ``` 通话质量反馈的文字描述 ### roomInfo ```objectivec @property(nonatomic, strong) NSArray * _Nullable roomInfo; ``` 通话质量反馈的房间信息。参看 [ByteRTCProblemFeedbackRoomInfo](#ByteRTCProblemFeedbackRoomInfo)。 # ByteRTCRectangle ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRectangle : NSObject ``` 矩形区域，用于指定屏幕区域。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [x](#ByteRTCRectangle-x) | | int | [y](#ByteRTCRectangle-y) | | int | [width](#ByteRTCRectangle-width) | | int | [height](#ByteRTCRectangle-height) | ## 变量说明 ### x ```objectivec @property(assign, nonatomic) int x; ``` 矩形区域左上角的 x 坐标。 ### y ```objectivec @property(assign, nonatomic) int y; ``` 矩形区域左上角的 y 坐标。 ### width ```objectivec @property(assign, nonatomic) int width; ``` 矩形宽度，单位：px。 ### height ```objectivec @property(assign, nonatomic) int height; ``` 矩形高度，单位：px。 # ByteRTCColorSpace ```objectivec typedef NS_ENUM( NSInteger, ByteRTCColorSpace ) ``` 颜色空间 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCColorSpaceUnknown | 0 | - | | ByteRTCColorSpaceYCbCrBT601LimitedRange | 1 | BT.601 数字编码标准，颜色空间[16-235] | | ByteRTCColorSpaceYCbCrBT601FullRange | 2 | BT.601 数字编码标准，颜色空间[0-255] | | ByteRTCColorSpaceYCbCrBT709LimitedRange | 3 | BT.7091 数字编码标准，颜色空间[16-235] | | ByteRTCColorSpaceYCbCrBT709FullRange | 4 | BT.7091 数字编码标准，颜色空间[0-255] | # ByteRTCExpressionDetectResult ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCExpressionDetectResult : NSObject ``` 人像属性检测结果 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [detectResult](#ByteRTCExpressionDetectResult-detectresult) | | int | [faceCount](#ByteRTCExpressionDetectResult-facecount) | | NSArray* | [detectInfo](#ByteRTCExpressionDetectResult-detectinfo) | ## 变量说明 ### detectResult ```objectivec @property (assign, nonatomic) int detectResult; ``` 特征识别结果 - 0：识别成功 - !0：识别失败 ### faceCount ```objectivec @property (assign, nonatomic) int faceCount; ``` 识别到的人脸数量。 ### detectInfo ```objectivec @property (nonatomic, copy) NSArray * _Nonnull detectInfo; ``` 特征识别信息。数组的长度和检测到的人脸数量一致。参看 [ByteRTCExpressionDetectInfo](#ByteRTCExpressionDetectInfo)。 # ByteRTCEncodedVideoFrame ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCEncodedVideoFrame : NSObject ``` 视频帧信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCVideoCodecType | [codecType](#ByteRTCEncodedVideoFrame-codectype) | | ByteRTCVideoPictureType | [pictureType](#ByteRTCEncodedVideoFrame-picturetype) | | SInt64 | [timestampUs](#ByteRTCEncodedVideoFrame-timestampus) | | SInt64 | [timestampDtsUs](#ByteRTCEncodedVideoFrame-timestampdtsus) | | int | [width](#ByteRTCEncodedVideoFrame-width) | | int | [height](#ByteRTCEncodedVideoFrame-height) | | ByteRTCVideoRotation | [rotation](#ByteRTCEncodedVideoFrame-rotation) | | NSData* | [data](#ByteRTCEncodedVideoFrame-data) | ## 变量说明 ### codecType ```objectivec @property(assign, nonatomic) ByteRTCVideoCodecType codecType; ``` 视频编码类型。参看 [ByteRTCVideoCodecType](#ByteRTCVideoCodecType) ### pictureType ```objectivec @property(assign, nonatomic) ByteRTCVideoPictureType pictureType; ``` 视频帧类型。参看 [ByteRTCVideoPictureType](#ByteRTCVideoPictureType) ### timestampUs ```objectivec @property(assign, nonatomic) SInt64 timestampUs; ``` 视频采集时间戳，单位：微秒 ### timestampDtsUs ```objectivec @property(assign, nonatomic) SInt64 timestampDtsUs; ``` 视频编码时间戳，单位：微秒 ### width ```objectivec @property(assign, nonatomic) int width; ``` 视频帧宽，单位：px ### height ```objectivec @property(assign, nonatomic) int height; ``` 视频帧高，单位：px ### rotation ```objectivec @property(nonatomic, assign) ByteRTCVideoRotation rotation; ``` 视频帧旋转角度。参看 [ByteRTCVideoRotation](#ByteRTCVideoRotation) ### data ```objectivec @property(strong, nonatomic) NSData * _Nonnull data; ``` 视频帧数据指针地址 # ByteRTCMediaDeviceType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMediaDeviceType ) ``` 当前媒体设备类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMediaDeviceTypeAudioUnknown | -1 | 未知音频设备 | | ByteRTCMediaDeviceTypeAudioRenderDevice | 0 | 音频渲染设备类型 | | ByteRTCMediaDeviceTypeAudioCaptureDevice | 1 | 音频采集设备类型 | | ByteRTCMediaDeviceTypeVideoCaptureDevice | 3 | 视频采集设备类型 | | ByteRTCMediaDeviceTypeScreenVideoCaptureDevice | 4 | 屏幕流视频设备 | | ByteRTCMediaDeviceTypeScreenAudioCaptureDevice | 5 | 屏幕流音频设备 | # ByteRTCFrameUpdateInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCFrameUpdateInfo : NSObject ``` RTC 智能决策后得到的帧率和分辨率积（宽*高）。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [pixel](#ByteRTCFrameUpdateInfo-pixel) | | int | [framerate](#ByteRTCFrameUpdateInfo-framerate) | ## 变量说明 ### pixel ```objectivec @property(assign, nonatomic) int pixel; ``` 分辨率积（宽*高）。 ### framerate ```objectivec @property(assign, nonatomic) int framerate; ``` 帧率。 # ByteRTCAnsMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAnsMode ) ``` 降噪模式。降噪算法受调用 [joinRoom:userInfo:roomConfig:](70092#ByteRTCRoom-joinroom-userinfo-roomconfig) 时设置的房间模式影响。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAnsModeDisable | 0 | 关闭所有音频降噪能力。 | | ByteRTCAnsModeLow | 1 | 适用于微弱降噪。 | | ByteRTCAnsModeMedium | 2 | 适用于抑制中度平稳噪声，如空调声和风扇声。 | | ByteRTCAnsModeHigh | 3 | 适用于抑制嘈杂非平稳噪声，如键盘声、敲击声、碰撞声、动物叫声。 | | ByteRTCAnsModeAutomatic | 4 | 启用音频降噪能力。具体的降噪算法由 RTC 智能决策。 | # ByteRTCMixedStreamClientMixConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMixedStreamClientMixConfig : NSObject ``` 客户端合流参数。(新) ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [useAudioMixer](#ByteRTCMixedStreamClientMixConfig-useaudiomixer) | | ByteRTCMixedStreamClientMixVideoFormat | [videoFormat](#ByteRTCMixedStreamClientMixConfig-videoformat) | ## 变量说明 ### useAudioMixer ```objectivec @property(assign, nonatomic) BOOL useAudioMixer; ``` 客户端合流是否使用混音，默认为 true。 ### videoFormat ```objectivec @property(assign, nonatomic) ByteRTCMixedStreamClientMixVideoFormat videoFormat; ``` 客户端合流回调视频格式，参看 [ByteRTCMixedStreamClientMixVideoFormat](#ByteRTCMixedStreamClientMixVideoFormat)。 # ByteRTCRemoteUserPriority ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCRemoteUserPriority ) ``` 远端用户优先级。在性能不足需要回退时，会先回退优先级低的用户的音视频流 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRemoteUserPriorityLow | 0 | 用户优先级为低，默认值 | | ByteRTCRemoteUserPriorityMedium | 100 | 用户优先级为正常 | | ByteRTCRemoteUserPriorityHigh | 200 | 用户优先级为高 | # ByteRTCHumanOrientation ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCHumanOrientation : NSObject ``` 三维朝向信息，三个向量需要两两垂直。参看 [ByteRTCOrientation](#ByteRTCOrientation)。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCOrientation* | [forward](#ByteRTCHumanOrientation-forward) | | ByteRTCOrientation* | [right](#ByteRTCHumanOrientation-right) | | ByteRTCOrientation* | [up](#ByteRTCHumanOrientation-up) | ## 变量说明 ### forward ```objectivec @property(nonatomic, strong) ByteRTCOrientation* _Nonnull forward; ``` 正前方朝向，默认值为 {1,0,0}，即正前方朝向 x 轴正方向 ### right ```objectivec @property(nonatomic, strong) ByteRTCOrientation* _Nonnull right; ``` 正右方朝向，默认值为 {0,1,0}，即右手朝向 y 轴正方向 ### up ```objectivec @property(nonatomic, strong) ByteRTCOrientation* _Nonnull up; ``` 正上方朝向，默认值为 {0,0,1}，即头顶朝向 z 轴正方向 # ByteRTCRecordingErrorCode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCRecordingErrorCode ) ``` 本地录制错误码 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRecordingErrorCodeOk | 0 | 录制正常。 | | ByteRTCRecordingErrorCodeNoPermission | -1 | 没有存储路径写权限。确认 App 可以对保存录制文件的文件夹进行读写访问。确认当前用户已经发布媒体流。 | | ByteRTCRecordingErrorCodeNotSupport | -2 | 当前版本 SDK 不支持本地录制功能。建议下载最新版本的 SDK。 | | ByteRTCRecordingErrorCodeOther | -3 | 其他异常。 | # ByteRTCTorchState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCTorchState ) ``` 相机补光灯状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCTorchStateOff | 0 | 相机补光灯关闭 | | ByteRTCTorchStateOn | 1 | 相机补光灯打开 | # ByteRTCAudioFrame ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCAudioFrame : NSObject ``` PCM 音频帧 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSData* | [buffer](#ByteRTCAudioFrame-buffer) | | int | [samples](#ByteRTCAudioFrame-samples) | | ByteRTCAudioChannel | [channel](#ByteRTCAudioFrame-channel) | | ByteRTCAudioSampleRate | [sampleRate](#ByteRTCAudioFrame-samplerate) | ## 变量说明 ### buffer ```objectivec @property(strong, nonatomic) NSData * _Nonnull buffer; ``` PCM 数据 ### samples ```objectivec @property(assign, nonatomic) int samples; ``` 采样点个数 ### channel ```objectivec @property(assign, nonatomic) ByteRTCAudioChannel channel; ``` 音频声道，参看 [ByteRTCAudioChannel](#ByteRTCAudioChannel)。双声道的情况下，左右声道的音频帧数据以 LRLRLR 形式排布。 ### sampleRate ```objectivec @property(assign, nonatomic) ByteRTCAudioSampleRate sampleRate; ``` 采样率，参看 [ByteRTCAudioSampleRate](#ByteRTCAudioSampleRate)。 # ByteRTCRemoteAudioStats ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRemoteAudioStats : NSObject ``` 远端音频流统计信息，统计周期为 2s 。本地用户订阅远端音频流成功后，SDK 会周期性地通过 `onRemoteStreamStats` 通知本地用户订阅的音频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [audioLossRate](#ByteRTCRemoteAudioStats-audiolossrate) | | float | [receivedKBitrate](#ByteRTCRemoteAudioStats-receivedkbitrate) | | NSInteger | [stallCount](#ByteRTCRemoteAudioStats-stallcount) | | NSInteger | [stallDuration](#ByteRTCRemoteAudioStats-stallduration) | | NSInteger | [playoutSampleRate](#ByteRTCRemoteAudioStats-playoutsamplerate) | | NSInteger | [e2eDelay](#ByteRTCRemoteAudioStats-e2edelay) | | NSInteger | [statsInterval](#ByteRTCRemoteAudioStats-statsinterval) | | NSInteger | [rtt](#ByteRTCRemoteAudioStats-rtt) | | NSInteger | [totalRtt](#ByteRTCRemoteAudioStats-totalrtt) | | NSInteger | [quality](#ByteRTCRemoteAudioStats-quality) | | NSInteger | [jitterBufferDelay](#ByteRTCRemoteAudioStats-jitterbufferdelay) | | NSInteger | [numChannels](#ByteRTCRemoteAudioStats-numchannels) | | NSInteger | [receivedSampleRate](#ByteRTCRemoteAudioStats-receivedsamplerate) | | NSInteger | [frozenRate](#ByteRTCRemoteAudioStats-frozenrate) | | NSInteger | [concealedSamples](#ByteRTCRemoteAudioStats-concealedsamples) | | NSInteger | [concealmentEvent](#ByteRTCRemoteAudioStats-concealmentevent) | | NSInteger | [decSampleRate](#ByteRTCRemoteAudioStats-decsamplerate) | | NSInteger | [decDuration](#ByteRTCRemoteAudioStats-decduration) | | NSInteger | [jitter](#ByteRTCRemoteAudioStats-jitter) | ## 变量说明 ### audioLossRate ```objectivec @property(assign, nonatomic) float audioLossRate; ``` 音频丢包率。统计周期内的音频下行丢包率，取值范围为 [0, 1] 。 ### receivedKBitrate ```objectivec @property(assign, nonatomic) float receivedKBitrate; ``` 接收码率。统计周期内的音频接收码率，单位为 kbps 。 ### stallCount ```objectivec @property(assign, nonatomic) NSInteger stallCount; ``` 音频卡顿次数。统计周期内的卡顿次数。 ### stallDuration ```objectivec @property(assign, nonatomic) NSInteger stallDuration; ``` 音频卡顿时长。统计周期内的卡顿时长，单位为 ms 。 ### playoutSampleRate ```objectivec @property(assign, nonatomic) NSInteger playoutSampleRate; ``` 播放采样率。统计周期内的音频播放采样率信息，单位为 Hz 。 ### e2eDelay ```objectivec @property(assign, nonatomic) NSInteger e2eDelay; ``` 用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为 ms 。 ### statsInterval ```objectivec @property(assign, nonatomic) NSInteger statsInterval; ``` 统计间隔。此次统计周期的间隔，单位为 ms 。 ### rtt ```objectivec @property(assign, nonatomic) NSInteger rtt; ``` 客户端到服务端数据传输的往返时延，单位为 ms。 ### totalRtt ```objectivec @property(assign, nonatomic) NSInteger totalRtt; ``` 发送端——服务端——接收端全链路数据传输往返时延。单位为 ms 。 ### quality ```objectivec @property(assign, nonatomic) NSInteger quality; ``` 远端用户发送的音频流质量。值含义参考 [ByteRTCNetworkQuality](#ByteRTCNetworkQuality)。 ### jitterBufferDelay ```objectivec @property(assign, nonatomic) NSInteger jitterBufferDelay; ``` 因引入 jitter buffer 机制导致的延时。单位为 ms 。 ### numChannels ```objectivec @property(assign, nonatomic) NSInteger numChannels; ``` 音频声道数。 ### receivedSampleRate ```objectivec @property(assign, nonatomic) NSInteger receivedSampleRate; ``` 音频接收采样率。统计周期内接收到的远端音频采样率信息，单位为 Hz 。 ### frozenRate ```objectivec @property(assign, nonatomic) NSInteger frozenRate; ``` 远端用户在加入房间后发生音频卡顿的累计时长占音频总有效时长的百分比。音频有效时长是指远端用户进房发布音频流后，除停止发送音频流和禁用音频模块之外的音频时长。 ### concealedSamples ```objectivec @property(assign, nonatomic) NSInteger concealedSamples; ``` 音频 PLC 样点总个数。 ### concealmentEvent ```objectivec @property(assign, nonatomic) NSInteger concealmentEvent; ``` 音频丢包补偿(PLC) 累计次数。 ### decSampleRate ```objectivec @property(assign, nonatomic) NSInteger decSampleRate; ``` 音频解码采样率。统计周期内的音频解码采样率信息，单位为 Hz 。 ### decDuration ```objectivec @property(assign, nonatomic) NSInteger decDuration; ``` 此次订阅中，对远端音频流进行解码的累计耗时。单位为 s。 ### jitter ```objectivec @property(assign, nonatomic) NSInteger jitter; ``` 视频下行网络抖动，单位为 ms。 # ByteRTCOrientation ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCOrientation : NSObject ``` 方向朝向信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [x](#ByteRTCOrientation-x) | | float | [y](#ByteRTCOrientation-y) | | float | [z](#ByteRTCOrientation-z) | ## 变量说明 ### x ```objectivec @property(nonatomic, assign) float x; ``` x 坐标 ### y ```objectivec @property(nonatomic, assign) float y; ``` y 坐标 ### z ```objectivec @property(nonatomic, assign) float z; ``` z 坐标 # ByteRTCPerformanceAlarmReason ```objectivec typedef NS_ENUM( NSInteger, ByteRTCPerformanceAlarmReason ) ``` 性能相关告警的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCPerformanceAlarmReasonBandwidthFallback | 0 | 网络原因差，造成了发送性能回退。仅在开启发送性能回退时，会收到此原因。 | | ByteRTCPerformanceAlarmReasonBandwidthResumed | 1 | 网络性能恢复，发送性能回退恢复。仅在开启发送性能回退时，会收到此原因。 | | ByteRTCPerformanceAlarmReasonFallback | 2 | 如果未开启发送性能回退，收到此告警时，意味着性能不足；
如果开启了发送性能回退，收到此告警时，意味着性能不足，且已发生发送性能回退。 | | ByteRTCPerformanceAlarmReasonResumed | 3 | 如果未开启发送性能回退，收到此告警时，意味着性能不足已恢复；
如果开启了发送性能回退，收到此告警时，意味着性能不足已恢复，且已发生发送性能回退恢复。 | # ByteRTCVideoApplyRotation ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoApplyRotation ) ``` 是否将视频帧自动转正。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoApplyRotationDefault | -1 | （默认值）不旋转。 | | ByteRTCVideoApplyRotation0 | 0 | 自动转正视频，即根据视频帧的旋转角信息将视频帧旋转到 0 度。 | # ByteRTCAACProfile ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAACProfile ) ``` > Deprecated since 3.52, use [ByteRTCMixedStreamAudioProfile](#ByteRTCMixedStreamAudioProfile) instead. AAC 编码规格。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAACProfileLC | 0 | AAC-LC 规格，默认值。 | | ByteRTCAACProfileHEv1 | 1 | HE-AAC v1 规格。 | | ByteRTCAACProfileHEv2 | 2 | HE-AAC v2 规格。 | # ByteRTCStreamEx ```objectivec @interface ByteRTCStreamEx : NSObject ``` 流信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [userId](#ByteRTCStreamEx-userid) | | BOOL | [isScreen](#ByteRTCStreamEx-isscreen) | | BOOL | [hasVideo](#ByteRTCStreamEx-hasvideo) | | BOOL | [hasAudio](#ByteRTCStreamEx-hasaudio) | | NSArray* | [videoStreamDescriptions](#ByteRTCStreamEx-videostreamdescriptions) | | ByteRTCVideoSolution* | [maxVideoStreamDescription](#ByteRTCStreamEx-maxvideostreamdescription) | | ByteRTCStreamIndex | [index](#ByteRTCStreamEx-index) | ## 变量说明 ### userId ```objectivec @property(nonatomic, copy, nullable) NSString *userId; ``` 用户 ID ### isScreen ```objectivec @property(nonatomic, assign) BOOL isScreen; ``` 流是否为共享屏幕流。 ### hasVideo ```objectivec @property(nonatomic, assign) BOOL hasVideo; ``` 该路流中是否包含视频 ### hasAudio ```objectivec @property(nonatomic, assign) BOOL hasAudio; ``` 该路流中是否包含音频 ### videoStreamDescriptions ```objectivec @property(nonatomic, copy, nullable) NSArray *videoStreamDescriptions; ``` 视频流的分辨率信息，详见 [ByteRTCVideoSolution](#ByteRTCVideoSolution) 类。用户可以通过调用 [setVideoEncoderConfig:](70092#ByteRTCVideo-setvideoencoderconfig) 方法在一路流中发布多个不同的视频分辨率。此参数即为流中所有分辨率的相关信息。 ### maxVideoStreamDescription ```objectivec @property(nonatomic, retain, nullable) ByteRTCVideoSolution *maxVideoStreamDescription; ``` 视频流最大分辨率，在开启多分辨率发布订阅时，回调发布端能支持的最大发布分辨率。 ### index ```objectivec @property(nonatomic, assign) ByteRTCStreamIndex index; ``` # ByteRTCSyncInfoStreamType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCSyncInfoStreamType ) ``` 媒体流信息同步的流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCSyncInfoStreamTypeAudio | 0 | 音频流 | # ByteRTCMixedStreamType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMixedStreamType ) ``` 合流方式。(新) ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamByServer | 0 | 通过服务端合流 | | ByteRTCMixedStreamByClient | 1 | 保留字段，无意义 | # ByteRTCPublicStreamVideoConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCPublicStreamVideoConfig : NSObject ``` 公共流的视频编码参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [width](#ByteRTCPublicStreamVideoConfig-width) | | NSInteger | [height](#ByteRTCPublicStreamVideoConfig-height) | | NSInteger | [fps](#ByteRTCPublicStreamVideoConfig-fps) | | NSInteger | [bitrate](#ByteRTCPublicStreamVideoConfig-bitrate) | ## 变量说明 ### width ```objectivec @property(assign, nonatomic) NSInteger width; ``` 公共流视频宽度，必填。单位为 px，范围为 [2, 1920]，必须是偶数。 ### height ```objectivec @property(assign, nonatomic) NSInteger height; ``` 公共流视频高度，必填。单位为 px，范围为 [16, 1280]，必须是偶数。 ### fps ```objectivec @property(assign, nonatomic) NSInteger fps; ``` 公共流视频帧率。必填范围：[1, 60] ### bitrate ```objectivec @property(assign, nonatomic) NSInteger bitrate; ``` 视频码率，必填范围：[1,10000000] 单位为 bps # ByteRTCVoiceChangerType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVoiceChangerType ) ``` 变声特效类型。如需更多类型，联系技术支持。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVoiceChangerOriginal | 0 | 原声，不含特效 | | ByteRTCVoiceChangerGiant | 1 | 巨人 | | ByteRTCVoiceChangerChipmunk | 2 | 花栗鼠 | | ByteRTCVoiceChangerMinionst | 3 | 小黄人 | | ByteRTCVoiceChangerVibrato | 4 | 颤音 | | ByteRTCVoiceChangerRobot | 5 | 机器人 | # ByteRTCStandardPitchInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCStandardPitchInfo : NSObject ``` 标准音高数据组。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [startTime](#ByteRTCStandardPitchInfo-starttime) | | int | [duration](#ByteRTCStandardPitchInfo-duration) | | int | [pitch](#ByteRTCStandardPitchInfo-pitch) | ## 变量说明 ### startTime ```objectivec @property(nonatomic, assign) int startTime; ``` 开始时间，单位 ms。 ### duration ```objectivec @property(nonatomic, assign) int duration; ``` 持续时间，单位 ms。 ### pitch ```objectivec @property(nonatomic, assign) int pitch; ``` 音高。 # ByteRTCMixedStreamAudioProfile ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMixedStreamAudioProfile ) ``` AAC 编码规格。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamAudioProfileLC | 0 | AAC-LC 规格，默认值。 | | ByteRTCMixedStreamAudioProfileHEv1 | 1 | HE-AAC v1 规格。 | | ByteRTCMixedStreamAudioProfileHEv2 | 2 | HE-AAC v2 规格。 | # ByteRTCVoiceReverbConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVoiceReverbConfig : NSObject ``` 音频混响效果。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [roomSize](#ByteRTCVoiceReverbConfig-roomsize) | | float | [decayTime](#ByteRTCVoiceReverbConfig-decaytime) | | float | [damping](#ByteRTCVoiceReverbConfig-damping) | | float | [wetGain](#ByteRTCVoiceReverbConfig-wetgain) | | float | [dryGain](#ByteRTCVoiceReverbConfig-drygain) | | float | [preDelay](#ByteRTCVoiceReverbConfig-predelay) | ## 变量说明 ### roomSize ```objectivec @property(assign, nonatomic) float roomSize; ``` 混响模拟的房间大小，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。房间越大，混响越强。 ### decayTime ```objectivec @property(assign, nonatomic) float decayTime; ``` 混响的拖尾长度，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。 ### damping ```objectivec @property(assign, nonatomic) float damping; ``` 混响的衰减阻尼大小，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。 ### wetGain ```objectivec @property(assign, nonatomic) float wetGain; ``` 早期反射信号强度。取值范围 `[-20.0, 10.0]`，单位为 dB。默认值为 `0.0f`。 ### dryGain ```objectivec @property(assign, nonatomic) float dryGain; ``` 原始信号强度。取值范围 `[-20.0, 10.0]`，单位为 dB。默认值为 `0.0f`。 ### preDelay ```objectivec @property(assign, nonatomic) float preDelay; ``` 早期反射信号的延迟。取值范围 `[0.0, 200.0]`，单位为 ms。默认值为 `0.0f`。 # ByteRTCSEICountPerFrame ```objectivec typedef NS_ENUM( NSInteger, ByteRTCSEICountPerFrame ) ``` SEI 发送模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCSEICountPerFrameSingle | 0 | 单发模式。即在 1 帧间隔内多次发送 SEI 数据时，多个 SEI 按队列逐帧发送。 | | ByteRTCSEICountPerFrameMulti | 1 | 多发模式。即在 1 帧间隔内多次发送 SEI 数据时，多个 SEI 随下个视频帧同时发送。 | # ByteRTCSubtitleMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCSubtitleMode ) ``` 字幕模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCSubtitleModeRecognition | 0 | 识别模式。在此模式下，房间内用户语音会被转为文字。 | | ByteRTCSubtitleModeTranslation | 1 | 翻译模式。在此模式下，房间内用户语音会先被转为文字，再被翻译为目标语言。 | # ByteRTCPublishFallbackOption ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCPublishFallbackOption ) ``` 发布端音视频流回退选项 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCPublishFallbackOptionDisabled | 0 | 上行网络不佳或设备性能不足时，不对音视频流作回退处理。默认设置。 | | ByteRTCPublishFallbackOptionSimulcast | 1 | 上行网络不佳或设备性能不足时，发布的视频流会从大流到小流依次降级，直到与当前网络性能匹配，具体降级规则参看[性能回退](https://www.volcengine.com/docs/6348/70137)文档。 | # ByteRTCPosition ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCPosition : NSObject ``` 本地用户在房间内的位置坐标，需自行建立空间直角坐标系 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [x](#ByteRTCPosition-x) | | float | [y](#ByteRTCPosition-y) | | float | [z](#ByteRTCPosition-z) | ## 变量说明 ### x ```objectivec @property(nonatomic, assign) float x; ``` x 坐标 ### y ```objectivec @property(nonatomic, assign) float y; ``` y 坐标 ### z ```objectivec @property(nonatomic, assign) float z; ``` z 坐标 # ByteRTCVideoSolution ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCVideoSolution: NSObject ``` 视频流参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | CGSize | [videoSize](#ByteRTCVideoSolution-videosize) | | NSInteger | [frameRate](#ByteRTCVideoSolution-framerate) | | NSInteger | [maxKbps](#ByteRTCVideoSolution-maxkbps) | | NSInteger | [minKbps](#ByteRTCVideoSolution-minkbps) | | ByteRTCVideoEncoderPreference | [encoderPreference](#ByteRTCVideoSolution-encoderpreference) | ## 变量说明 ### videoSize ```objectivec @property(nonatomic, assign) CGSize videoSize; ``` 视频分辨率 ### frameRate ```objectivec @property(nonatomic, assign) NSInteger frameRate; ``` 视频预设帧率 ### maxKbps ```objectivec @property(nonatomic, assign) NSInteger maxKbps; ``` 最高编码码率（千比特每秒）。建议使用 `-1`，SDK 会自动根据分辨率和帧率适配合适的码率。 ### minKbps ```objectivec @property(nonatomic, assign) NSInteger minKbps; ``` 最低编码码率（千比特每秒） ### encoderPreference ```objectivec @property(nonatomic, assign) ByteRTCVideoEncoderPreference encoderPreference; ``` 视频编码质量策略，参见 [ByteRTCVideoEncoderPreference](#ByteRTCVideoEncoderPreference) # ByteRTCRemoteVideoConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRemoteVideoConfig : NSObject ``` 远端视频帧信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [framerate](#ByteRTCRemoteVideoConfig-framerate) | | int | [width](#ByteRTCRemoteVideoConfig-width) | | int | [height](#ByteRTCRemoteVideoConfig-height) | ## 变量说明 ### framerate ```objectivec @property (nonatomic, assign) int framerate; ``` 期望订阅的最高帧率，单位：fps，默认值为 0 即满帧订阅，设为大于 0 的值时开始生效。如果发布端发布帧率 > 订阅端订阅的帧率，下行媒体服务器 SVC 丢帧，订阅端收到通过此接口设置的帧率；如果发布端发布帧率 < 订阅端订阅的帧率，则订阅端只能收到发布的帧率仅码流支持 SVC 分级编码特性时方可生效。 ### width ```objectivec @property(nonatomic, assign) int width; ``` 视频宽度，单位：px ### height ```objectivec @property(nonatomic, assign) int height; ``` 视频高度，单位：px # ByteRTCLocalVideoStreamError ```objectivec typedef NS_ENUM( NSInteger, ByteRTCLocalVideoStreamError ) ``` 本地视频状态改变时的错误码 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCLocalVideoStreamErrorOk | 0 | 本地视频状态正常（本地视频状态改变正常时默认返回值） | | ByteRTCLocalVideoStreamErrorFailure | 1 | 本地视频流发布失败 | | ByteRTCLocalVideoStreamErrorDeviceNoPermission | 2 | 没有权限启动本地视频采集设备 | | ByteRTCLocalVideoStreamErrorDeviceBusy | 3 | 本地视频采集设备已被占用 | | ByteRTCLocalVideoStreamErrorDeviceNotFound | 4 | 本地视频采集设备不存在或已移除 | | ByteRTCLocalVideoStreamErrorCaptureFailure | 5 | 本地视频采集失败，建议检查采集设备是否正常工作 | | ByteRTCLocalVideoStreamErrorEncodeFailure | 6 | 本地视频编码失败 | | ByteRTCLocalVideoStreamErrorDeviceDisconnected | 7 | 通话过程中本地视频采集设备被其他程序抢占，导致设备连接中断 | # ByteRTCRemoteVideoRenderPosition ```objectivec typedef NS_ENUM( NSInteger, ByteRTCRemoteVideoRenderPosition ) ``` 远端视频帧回调位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRemoteVideoRenderPositionAfterPostprocess | 1 | （默认值）后处理后。 | # ByteRTCZoomConfigType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCZoomConfigType ) ``` 数码变焦参数类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCZoomConfigTypeFocusOffset | 0 | 设置缩放系数 | | ByteRTCZoomConfigTypeMoveOffset | 1 | 设置移动步长 | # ByteRTCMediaPlayerCustomSource ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMediaPlayerCustomSource : NSObject ``` 音频源 ## 成员变量 | 类型 | 名称 | | --- | --- | | id_Nullable | [provider](#ByteRTCMediaPlayerCustomSource-provider) | | ByteRTCMediaPlayerCustomSourceMode | [mode](#ByteRTCMediaPlayerCustomSource-mode) | | ByteRTCMediaPlayerCustomSourceStreamType | [type](#ByteRTCMediaPlayerCustomSource-type) | ## 变量说明 ### provider ```objectivec @property(weak, nonatomic) id _Nullable provider; ``` 仅使用内存播放时，传入对应的 [ByteRTCMediaPlayerCustomSourceProvider](70093#ByteRTCMediaPlayerCustomSourceProvider) 实例。 ### mode ```objectivec @property(assign, nonatomic) ByteRTCMediaPlayerCustomSourceMode mode; ``` 数据源模式，详见 [ByteRTCMediaPlayerCustomSourceMode](#ByteRTCMediaPlayerCustomSourceMode)。默认为 `push`。 ### type ```objectivec @property(assign, nonatomic) ByteRTCMediaPlayerCustomSourceStreamType type; ``` 数据源类型，详见 [ByteRTCMediaPlayerCustomSourceStreamType](#ByteRTCMediaPlayerCustomSourceStreamType)。默认为 `raw`。 # ByteRTCNetworkQualityStats ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCNetworkQualityStats: NSObject ``` 上行/下行网络质量 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [uid](#ByteRTCNetworkQualityStats-uid) | | double | [lossRatio](#ByteRTCNetworkQualityStats-lossratio) | | int | [rtt](#ByteRTCNetworkQualityStats-rtt) | | int | [totalBandwidth](#ByteRTCNetworkQualityStats-totalbandwidth) | | ByteRTCNetworkQuality | [txQuality](#ByteRTCNetworkQualityStats-txquality) | | ByteRTCNetworkQuality | [rxQuality](#ByteRTCNetworkQualityStats-rxquality) | ## 变量说明 ### uid ```objectivec @property(strong, nonatomic) NSString* _Nonnull uid; ``` 用户 ID ### lossRatio ```objectivec @property(assign, nonatomic) double lossRatio; ``` 本端的上行/下行的丢包率，范围 [0.0,1.0] 当 `uid` 为本地用户时，代表发布流的上行丢包率。当 `uid` 为远端用户时，代表接收所有订阅流的下行丢包率。 ### rtt ```objectivec @property(assign, nonatomic) int rtt; ``` 当 `uid` 为本地用户时有效，客户端到服务端的往返延时（RTT），单位：ms ### totalBandwidth ```objectivec @property(assign, nonatomic) int totalBandwidth; ``` 本端的音视频 RTP 包 2 秒内的平均传输速率，单位：bps 当 `uid` 为本地用户时，代表发送速率。当 `uid` 为远端用户时，代表所有订阅流的接收速率。 ### txQuality ```objectivec @property(assign, nonatomic) ByteRTCNetworkQuality txQuality; ``` 上行网络质量评分，详见 [ByteRTCNetworkQuality](#ByteRTCNetworkQuality)。 ### rxQuality ```objectivec @property(assign, nonatomic) ByteRTCNetworkQuality rxQuality; ``` 下行网络质量评分，详见 [ByteRTCNetworkQuality](#ByteRTCNetworkQuality)。 # ByteRTCStreamMixingType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCStreamMixingType ) ``` > Deprecated since 3.52, use ByteRTCMixedStreamType instead. 合流方式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCStreamMixingTypeByServer | 0 | 服务端合流 | | ByteRTCStreamMixingTypeByClient | 1 | 保留字段，无意义 | # ByteRTCMixedStreamLayoutRegionType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMixedStreamLayoutRegionType ) ``` 合流布局区域类型。(新) ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamLayoutRegionTypeVideoStream | 0 | 合流布局区域类型为视频。 | | ByteRTCMixedStreamLayoutRegionTypeImage | 1 | 合流布局区域类型为图片。 | # ByteRTCAudioFrameMethod ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioFrameMethod ) ``` 返回给音频处理器的音频类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioFrameProcessorRecord | 0 | 本地采集的音频。 | | ByteRTCAudioFrameProcessorPlayback | 1 | 远端音频流的混音音频。 | | ByteRTCAudioFrameProcessorRemoteUser | 2 | 各个远端音频流。 | | ByteRTCAudioFrameProcessorScreen | 4 | 屏幕共享音频。 | # ByteRTCEarMonitorMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCEarMonitorMode ) ``` 开启/关闭耳返功能。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCEarMonitorModeOff | 0 | 关闭耳返功能。 | | ByteRTCEarMonitorModeOn | 1 | 开启耳返功能。 | # ByteRTCVideoCodecType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoCodecType ) ``` 视频编码类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoCodecTypeUnknown | 0 | 未知类型 | | ByteRTCVideoCodecTypeH264 | 1 | 标准 H264 编码格式 | | ByteRTCVideoCodecTypeByteVC1 | 2 | ByteVC1 编码器 | # ByteRTCLocalStreamStats ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCLocalStreamStats : NSObject ``` 本地音/视频流统计信息以及网络状况，统计周期为 2s 。本地用户发布音/视频流成功后，SDK 会周期性地通过 `onLocalStreamStats` 通知本地用户发布的音/视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCLocalAudioStats* | [audioStats](#ByteRTCLocalStreamStats-audiostats) | | ByteRTCLocalVideoStats* | [videoStats](#ByteRTCLocalStreamStats-videostats) | | BOOL | [isScreen](#ByteRTCLocalStreamStats-isscreen) | | ByteRTCNetworkQuality | [deprecated] [txQuality](#ByteRTCLocalStreamStats-txquality) | | ByteRTCNetworkQuality | [deprecated] [rxQuality](#ByteRTCLocalStreamStats-rxquality) | ## 变量说明 ### audioStats ```objectivec @property(strong, nonatomic) ByteRTCLocalAudioStats *_Nonnull audioStats; ``` 本地设备发送音频流的统计信息，详见 [ByteRTCLocalAudioStats](#ByteRTCLocalAudioStats) ### videoStats ```objectivec @property(strong, nonatomic) ByteRTCLocalVideoStats *_Nonnull videoStats; ``` 本地设备发送视频流的统计信息，详见 [ByteRTCLocalVideoStats](#ByteRTCLocalVideoStats) ### isScreen ```objectivec @property(nonatomic, assign) BOOL isScreen; ``` 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 ### txQuality ```objectivec @property(assign, nonatomic) ByteRTCNetworkQuality txQuality; ``` > Deprecated since 3.36 and will be deleted in 3.51, use [rtcRoom:onNetworkQuality:remoteQualities:](70093#ByteRTCRoomDelegate-rtcroom-onnetworkquality-remotequalities) instead 所属用户的媒体流上行网络质量，详见 [ByteRTCNetworkQuality](#ByteRTCNetworkQuality) ### rxQuality ```objectivec @property(assign, nonatomic) ByteRTCNetworkQuality rxQuality; ``` > Deprecated since 3.36 and will be deleted in 3.51, use [rtcRoom:onNetworkQuality:remoteQualities:](70093#ByteRTCRoomDelegate-rtcroom-onnetworkquality-remotequalities) instead 所属用户的媒体流下行网络质量，详见 [ByteRTCNetworkQuality](#ByteRTCNetworkQuality) # ByteRTCVideoRotation ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoRotation ) ``` 视频帧旋转信息 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoRotation0 | 0 | 不旋转 | | ByteRTCVideoRotation90 | 90 | 顺时针旋转 90 度 | | ByteRTCVideoRotation180 | 180 | 顺时针旋转 180 度 | | ByteRTCVideoRotation270 | 270 | 顺时针旋转 270 度 | # ByteRTCDataFrameType ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCDataFrameType ) ``` 数据类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCDataFrameTypeSei | 0 | SEI 数据 | | ByteRTCDataFrameTypeRoi | 1 | 人脸识别数据 | | ByteRTCDataFrameTypeOther | 2 | 其他数据帧类型 | # ByteRTCTranscodingVideoCodec ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCTranscodingVideoCodec ) ``` > Deprecated since 3.52, use [ByteRTCMixedStreamVideoCodecType](#ByteRTCMixedStreamVideoCodecType) instead. 视频编码格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCTranscodingVideoCodecH264 | 0 | H.264 格式，默认值。 | | ByteRTCTranscodingVideoCodecH265 | 1 | ByteVC1 格式。 | # ByteRTCMouseCursorCaptureState ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCMouseCursorCaptureState ) ``` 内部采集屏幕视频流时，是否采集鼠标信息。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMouseCursorCaptureStateOn | 0 | 采集鼠标信息。 | | ByteRTCMouseCursorCaptureStateOff | 1 | 不采集鼠标信息。 | # ByteRTCSubscribeFallbackOption ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCSubscribeFallbackOption ) ``` 订阅端音视频流回退选项。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCSubscribeFallbackOptionDisabled | 0 | 下行网络不佳或设备性能不足时，不对音视频流作回退处理。默认设置。 | | ByteRTCSubscribeFallbackOptionVideoStreamLow | 1 | 下行网络不佳或设备性能不足时，对视频流做降级处理，具体降级规则参看[音视频流回退](70137)。
该设置仅对发布端调用 `enableSimulcastMode:` 开启发送多路流功能的情况生效。 | | ByteRTCSubscribeFallbackOptionAudioOnly | 2 | 下行网络不佳或设备性能不足时，先对视频流做回退处理。当网络状况不满足接收弱流时，则自动取消接收视频，仅接收音频。
该设置仅对发布端调用 `enableSimulcastMode:` 开启发送多路流功能的情况生效。 | # ByteRTCAudioSourceType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioSourceType ) ``` 音频输入源类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioSourceTypeExternal | 0 | 自定义采集音频源 | | ByteRTCAudioSourceTypeInternal | 1 | RTC SDK 内部采集音频源 | # ByteRTCRemoteStreamKey ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRemoteStreamKey : NSObject ``` 用户信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [userId](#ByteRTCRemoteStreamKey-userid) | | NSString* | [roomId](#ByteRTCRemoteStreamKey-roomid) | | ByteRTCStreamIndex | [streamIndex](#ByteRTCRemoteStreamKey-streamindex) | ## 变量说明 ### userId ```objectivec @property(nonatomic, copy, nullable) NSString *userId; ``` 用户 ID ### roomId ```objectivec @property(nonatomic, copy, nullable) NSString *roomId; ``` 房间 ID ### streamIndex ```objectivec @property(nonatomic, assign) ByteRTCStreamIndex streamIndex; ``` 流属性，包括主流、屏幕流。参看 [ByteRTCStreamIndex](#ByteRTCStreamIndex) # ByteRTCPlayerState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCPlayerState ) ``` 播放状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCPlayerStateIdle | 0 | 播放未启动 | | ByteRTCPlayerStatePreloaded | 1 | 已加载 | | ByteRTCPlayerStateOpened | 2 | 已打开 | | ByteRTCPlayerStatePlaying | 3 | 正在播放 | | ByteRTCPlayerStatePaused | 4 | 播放已暂停 | | ByteRTCPlayerStateStopped | 5 | 播放已停止 | | ByteRTCPlayerStateFailed | 6 | 播放失败 | | ByteRTCPlayerStateFinished | 7 | 播放已结束 | # ByteRTCMediaPlayerConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMediaPlayerConfig : NSObject ``` 混音配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCAudioMixingType | [type](#ByteRTCMediaPlayerConfig-type) | | NSInteger | [playCount](#ByteRTCMediaPlayerConfig-playcount) | | NSInteger | [startPos](#ByteRTCMediaPlayerConfig-startpos) | | NSInteger | [callbackOnProgressInterval](#ByteRTCMediaPlayerConfig-callbackonprogressinterval) | | BOOL | [syncProgressToRecordFrame](#ByteRTCMediaPlayerConfig-syncprogresstorecordframe) | | BOOL | [autoPlay](#ByteRTCMediaPlayerConfig-autoplay) | ## 变量说明 ### type ```objectivec @property(assign, nonatomic) ByteRTCAudioMixingType type; ``` 混音播放类型，详见 [ByteRTCAudioMixingType](#ByteRTCAudioMixingType) ### playCount ```objectivec @property(assign, nonatomic) NSInteger playCount; ``` 混音播放次数 - play_count <= 0: 无限循环 - play_count == 1: 播放一次（默认） - play_count \> 1: 播放 play_count 次 ### startPos ```objectivec @property(assign, nonatomic) NSInteger startPos; ``` 混音起始位置。默认值为 0，单位为毫秒。 ### callbackOnProgressInterval ```objectivec @property(assign, nonatomic) NSInteger callbackOnProgressInterval; ``` 设置音频文件混音时，收到 [onMediaPlayerPlayingProgress:progress:](70093#ByteRTCMediaPlayerEventHandler-onmediaplayerplayingprogress-progress) 的间隔。单位毫秒。 - interval \> 0 时，触发回调。实际间隔为 10 的倍数。如果输入数值不能被 10 整除，将自动向上取整。例如传入 `52`，实际间隔为 60 ms。 - interval <= 0 时，不会触发回调。 ### syncProgressToRecordFrame ```objectivec @property(assign, nonatomic) BOOL syncProgressToRecordFrame; ``` 在采集音频数据时，附带本地混音文件播放进度的时间戳。启用此功能会提升远端人声和音频文件混音播放时的同步效果。 - 仅在单个音频文件混音时使用有效。 - `true` 时开启此功能，`false` 时关闭此功能，默认为关闭。 ### autoPlay ```objectivec @property(assign, nonatomic) BOOL autoPlay; ``` 是否自动播放。如果不自动播放，调用 [start](70092#ByteRTCMediaPlayer-start) 播放音乐文件。默认为 True。 # ByteRTCVideoRotationMode ```objectivec typedef NS_ENUM( NSUInteger, ByteRTCVideoRotationMode ) ``` 视频旋转模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoRotationModeFollowApp | 0 | App 方向 | | ByteRTCVideoRotationModeFollowGSensor | 1 | 重力方向 | # ByteRTCForwardStreamEvent ```objectivec typedef NS_ENUM( NSInteger, ByteRTCForwardStreamEvent ) ``` 媒体流跨房间转发事件 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCForwardStreamEventDisconnected | 0 | 本端与服务器网络连接断开，暂停转发。 | | ByteRTCForwardStreamEventConnected | 1 | 本端与服务器网络连接恢复，转发服务连接成功。 | | ByteRTCForwardStreamEventInterrupt | 2 | 转发中断。转发过程中，如果相同 user_id 的用户进入目标房间，转发中断。 | | ByteRTCForwardStreamEventDstRoomUpdated | 3 | 目标房间已更新，由 `updateForwardStreamToRooms` 触发。 | | ByteRTCForwardStreamEventUnExpectAPICall | 4 | API 调用时序错误。例如，在调用 `startForwardStreamToRooms` 之前调用 `updateForwardStreamToRooms` 。 | # ByteRTCVideoFrameType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoFrameType ) ``` 视频帧类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoFrameTypeRawMemory | 0 | 视频帧类型：内存数据 | | ByteRTCVideoFrameTypePixelBuffer | 1 | 视频帧类型：CVPixelBuffer | # ByteRTCLocalAudioPropertiesInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCLocalAudioPropertiesInfo : NSObject ``` 本地音频属性信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCStreamIndex | [streamIndex](#ByteRTCLocalAudioPropertiesInfo-streamindex) | | ByteRTCAudioPropertiesInfo* | [audioPropertiesInfo](#ByteRTCLocalAudioPropertiesInfo-audiopropertiesinfo) | ## 变量说明 ### streamIndex ```objectivec @property(assign, nonatomic) ByteRTCStreamIndex streamIndex; ``` 流属性，包括主流、屏幕流。参看 [ByteRTCStreamIndex](#ByteRTCStreamIndex) ### audioPropertiesInfo ```objectivec @property(strong, nonatomic) ByteRTCAudioPropertiesInfo *_Nonnull audioPropertiesInfo; ``` 音频属性信息，详见 [ByteRTCAudioPropertiesInfo](#ByteRTCAudioPropertiesInfo) # ByteRTCCameraID ```objectivec typedef NS_ENUM( NSInteger, ByteRTCCameraID ) ``` 摄像头类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCCameraIDFront | 0 | 前置摄像头 | | ByteRTCCameraIDBack | 1 | 后置摄像头 | | ByteRTCCameraIDInvalid | 3 | 无效值 | # ByteRTCCloudProxyInfo ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCCloudProxyInfo: NSObject ``` 云代理信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [cloudProxyIp](#ByteRTCCloudProxyInfo-cloudproxyip) | | int | [cloudProxyPort](#ByteRTCCloudProxyInfo-cloudproxyport) | ## 变量说明 ### cloudProxyIp ```objectivec @property(strong, nonatomic) NSString* _Nonnull cloudProxyIp; ``` 云代理服务器 IP ### cloudProxyPort ```objectivec @property(assign, nonatomic) int cloudProxyPort; ``` 云代理服务器端口 # ByteRTCMixedStreamAudioConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMixedStreamAudioConfig : NSObject ``` 音频转码配置参数。(新) 值不合法或未设置时，自动使用默认值。本参数不支持过程中更新。 ## 成员变量 | 类型 | 名称 | | --- | --- | | ByteRTCMixedStreamAudioCodecType | [audioCodec](#ByteRTCMixedStreamAudioConfig-audiocodec) | | NSInteger | [sampleRate](#ByteRTCMixedStreamAudioConfig-samplerate) | | NSInteger | [channels](#ByteRTCMixedStreamAudioConfig-channels) | | NSInteger | [bitrate](#ByteRTCMixedStreamAudioConfig-bitrate) | | ByteRTCMixedStreamAudioProfile | [audioProfile](#ByteRTCMixedStreamAudioConfig-audioprofile) | ## 变量说明 ### audioCodec ```objectivec @property(assign, nonatomic) ByteRTCMixedStreamAudioCodecType audioCodec; ``` 音频编码格式。建议设置。 ### sampleRate ```objectivec @property(assign, nonatomic) NSInteger sampleRate; ``` 音频采样率，单位 Hz。可取 32000 Hz、44100 Hz、48000 Hz，默认值为 48000 Hz。建议设置。 ### channels ```objectivec @property(assign, nonatomic) NSInteger channels; ``` 音频声道数。可取 1（单声道）、2（双声道），默认值为 2。建议设置。 ### bitrate ```objectivec @property(assign, nonatomic) NSInteger bitrate; ``` 音频码率，单位 Kbps。可取范围 [32, 192]，默认值为 64 Kbps。建议设置。 ### audioProfile ```objectivec @property(assign, nonatomic) ByteRTCMixedStreamAudioProfile audioProfile; ``` AAC 编码规格，参看 [ByteRTCMixedStreamAudioProfile](#ByteRTCMixedStreamAudioProfile)。默认值为 `0`。建议设置。 # ByteRTCSubscribeState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCSubscribeState ) ``` 订阅媒体流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCSubscribeStateSuccess | 0 | 订阅/取消订阅流成功 | | ByteRTCSubscribeStateFailedNotInRoom | 1 | 订阅/取消订阅流失败，本地用户未在房间中 | | ByteRTCSubscribeStateFailedStreamNotFound | 2 | 订阅/取消订阅流失败，房间内未找到指定的音视频流 | | ByteRTCSubscribeStateFailedOverLimit | 3 | 超过订阅流数上限 | # ByteRTCVideoEncoderPreference ```objectivec typedef NS_ENUM( NSInteger, ByteRTCVideoEncoderPreference ) ``` 编码策略偏好。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCVideoEncoderPreferenceDisabled | 0 | 无偏好。不降低帧率和分辨率。 | | ByteRTCVideoEncoderPreferenceMaintainFramerate | 1 | （默认值）帧率优先。分辨率不变。 | | ByteRTCVideoEncoderPreferenceMaintainQuality | 2 | 分辨率优先。 | | ByteRTCVideoEncoderPreferenceBalance | 3 | 平衡帧率与分辨率。 | # ByteRTCAudioMixingState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioMixingState ) ``` 音频混音文件播放状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioMixingStatePreloaded | 0 | 混音已加载 | | ByteRTCAudioMixingStatePlaying | 1 | 混音正在播放 | | ByteRTCAudioMixingStatePaused | 2 | 混音暂停 | | ByteRTCAudioMixingStateStopped | 3 | 混音停止 | | ByteRTCAudioMixingStateFailed | 4 | 混音播放失败 | | ByteRTCAudioMixingStateFinished | 5 | 混音播放结束 | | ByteRTCAudioMixingStatePCMEnabled | 6 | 准备 PCM 混音 | | ByteRTCAudioMixingStatePCMDisabled | 7 | PCM 混音播放结束 | # ByteRTCMixedStreamAudioCodecType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMixedStreamAudioCodecType ) ``` 音频编码类型。(新) ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamAudioCodecTypeAAC | 0 | AAC 格式。 | # ByteRTCSubtitleState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCSubtitleState ) ``` 字幕任务状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCSubtitleStateStarted | 0 | 开启字幕。 | | ByteRTCSubtitleStateStoped | 1 | 关闭字幕。 | | ByteRTCSubtitleStateError | 2 | 字幕任务出现错误。 | # ByteRTCMixedStreamServerControlConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCMixedStreamServerControlConfig : NSObject ``` 服务端合流控制参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [enableVolumeIndication](#ByteRTCMixedStreamServerControlConfig-enablevolumeindication) | | CGFloat | [volumeIndicationInterval](#ByteRTCMixedStreamServerControlConfig-volumeindicationinterval) | | NSInteger | [talkVolume](#ByteRTCMixedStreamServerControlConfig-talkvolume) | | BOOL | [isAddVolumeValue](#ByteRTCMixedStreamServerControlConfig-isaddvolumevalue) | | ByteRTCMixedStreamSEIContentMode | [seiContentMode](#ByteRTCMixedStreamServerControlConfig-seicontentmode) | | NSInteger | [seiPayloadType](#ByteRTCMixedStreamServerControlConfig-seipayloadtype) | | NSString* | [seiPayloadUUID](#ByteRTCMixedStreamServerControlConfig-seipayloaduuid) | | ByteRTCMixedStreamMediaType | [mediaType](#ByteRTCMixedStreamServerControlConfig-mediatype) | | ByteRTCMixedStreamPushMode | [pushStreamMode](#ByteRTCMixedStreamServerControlConfig-pushstreammode) | ## 变量说明 ### enableVolumeIndication ```objectivec @property(assign, nonatomic) BOOL enableVolumeIndication; ``` > Available since 3.56 是否开启单独发送声音提示 SEI 的功能： - True：开启； - False：关闭。（默认值）开启后，你可以通过 `ByteRTCMixedStreamServerControlConfig.seiContentMode` 控制 SEI 的内容是否只携带声音信息。 ### volumeIndicationInterval ```objectivec @property(assign, nonatomic) CGFloat volumeIndicationInterval; ``` > Available since 3.56 声音提示间隔，单位为秒，取值范围为 [0.3,+∞)，默认值为 2。此值仅取整百毫秒。若传入两位及以上小数，则四舍五入取第一位小数的值。例如，若传入 0.36，则取 0.4。 ### talkVolume ```objectivec @property(assign, nonatomic) NSInteger talkVolume; ``` > Available since 3.56 有效音量大小，取值范围为 [0, 255]，默认值为 0。超出取值范围则自动调整为默认值，即 0。 ### isAddVolumeValue ```objectivec @property(assign, nonatomic) BOOL isAddVolumeValue; ``` > Available since 3.56 声音信息 SEI 是否包含音量值： - True：是； - False：否，默认值。 ### seiContentMode ```objectivec @property(assign, nonatomic) ByteRTCMixedStreamSEIContentMode seiContentMode; ``` > Available since 3.56 设置 SEI 内容。参看 [ByteRTCMixedStreamSEIContentMode](#ByteRTCMixedStreamSEIContentMode)。 ### seiPayloadType ```objectivec @property(assign, nonatomic) NSInteger seiPayloadType; ``` > Available since 3.56 SEI 信息的 payload type。默认值为 `100`，只支持设置 `5` 和 `100`。在转推直播的过程中，该参数不支持变更。 ### seiPayloadUUID ```objectivec @property(copy, nonatomic) NSString *seiPayloadUUID; ``` > Available since 3.56 SEI 信息的 payload UUID。 **注意** PayloadType 为 `5` 时，必须填写 PayloadUUID，否则会收到错误回调，错误码为 1091。 PayloadType 不是 `5` 时，不需要填写 PayloadUUID，如果填写会被后端忽略。该参数长度需为 32 位，否则会收到错误码为 1091 的回调。该参数每个字符的范围需为 [0, 9] [a, f] [A, F] 该参数不应带有`-`字符，如系统自动生成的 UUID 中带有`-`，则应删去。在转推直播的过程中，该参数不支持变更。 ### mediaType ```objectivec @property(assign, nonatomic) ByteRTCMixedStreamMediaType mediaType; ``` > Available since 3.57 设置合流推到 CDN 时输出的媒体流类型。参看 [ByteRTCMixedStreamMediaType](#ByteRTCMixedStreamMediaType)。默认输出音视频流。支持输出纯音频流，但暂不支持输出纯视频流。 ### pushStreamMode ```objectivec @property(assign, nonatomic) ByteRTCMixedStreamPushMode pushStreamMode; ``` > Available since 3.57 设置是否在没有用户发布流的情况下发起转推直播。具体参看 [ByteRTCMixedStreamPushMode](#ByteRTCMixedStreamPushMode)。该参数在发起合流任务后的转推直播过程中不支持动态变更。 # ByteRTCScreenVideoEncoderPreference ```objectivec typedef NS_ENUM( NSInteger, ByteRTCScreenVideoEncoderPreference ) ``` 屏幕流编码模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCScreenVideoEncodePreferenceAuto | 0 | 智能模式。根据屏幕内容智能决策选择流畅模式或清晰模式。 | | ByteRTCScreenVideoEncodePreferenceFramerate | 1 | 流畅模式，优先保障帧率。适用于共享游戏、视频等动态画面。 | | ByteRTCScreenVideoEncodePreferenceQuality | 2 | 清晰模式，优先保障分辨率。适用于共享 PPT、文档、图片等静态画面。 | # ByteRTCRemoteStreamStats ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCRemoteStreamStats : NSObject ``` 用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s 。订阅远端用户发布音/视频流成功后，SDK 会周期性地通过 `onRemoteStreamStats` 通知本地用户订阅的远端音/视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [uid](#ByteRTCRemoteStreamStats-uid) | | ByteRTCRemoteAudioStats* | [audioStats](#ByteRTCRemoteStreamStats-audiostats) | | ByteRTCRemoteVideoStats* | [videoStats](#ByteRTCRemoteStreamStats-videostats) | | BOOL | [isScreen](#ByteRTCRemoteStreamStats-isscreen) | | ByteRTCNetworkQuality | [deprecated] [txQuality](#ByteRTCRemoteStreamStats-txquality) | | ByteRTCNetworkQuality | [deprecated] [rxQuality](#ByteRTCRemoteStreamStats-rxquality) | ## 变量说明 ### uid ```objectivec @property(copy, nonatomic) NSString *_Nonnull uid; ``` 用户 ID 。音频来源的用户 ID 。 ### audioStats ```objectivec @property(strong, nonatomic) ByteRTCRemoteAudioStats *_Nonnull audioStats; ``` 远端音频流的统计信息，详见 [ByteRTCRemoteAudioStats](#ByteRTCRemoteAudioStats) ### videoStats ```objectivec @property(strong, nonatomic) ByteRTCRemoteVideoStats *_Nonnull videoStats; ``` 远端视频流的统计信息，详见 [ByteRTCRemoteVideoStats](#ByteRTCRemoteVideoStats) ### isScreen ```objectivec @property(nonatomic, assign) BOOL isScreen; ``` 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 ### txQuality ```objectivec @property(assign, nonatomic) ByteRTCNetworkQuality txQuality; ``` > Deprecated since 3.36 and will be deleted in 3.51, use [rtcRoom:onNetworkQuality:remoteQualities:](70093#ByteRTCRoomDelegate-rtcroom-onnetworkquality-remotequalities) instead 所属用户的媒体流上行网络质量，详见 [ByteRTCNetworkQuality](#ByteRTCNetworkQuality) ### rxQuality ```objectivec @property(assign, nonatomic) ByteRTCNetworkQuality rxQuality; ``` > Deprecated since 3.36 and will be deleted in 3.51, use [rtcRoom:onNetworkQuality:remoteQualities:](70093#ByteRTCRoomDelegate-rtcroom-onnetworkquality-remotequalities) instead 所属用户的媒体流下行网络质量，详见 [ByteRTCNetworkQuality](#ByteRTCNetworkQuality) # ByteRTCHighlightConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCHighlightConfig: NSObject ``` 屏幕共享时的边框高亮设置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [enableHighlight](#ByteRTCHighlightConfig-enablehighlight) | | uint32_t | [borderColor](#ByteRTCHighlightConfig-bordercolor) | | int | [borderWidth](#ByteRTCHighlightConfig-borderwidth) | ## 变量说明 ### enableHighlight ```objectivec @property (assign, nonatomic) BOOL enableHighlight; ``` 是否显示高亮边框，默认显示。 ### borderColor ```objectivec @property (assign, nonatomic) uint32_t borderColor; ``` 边框的颜色, 颜色格式为十六进制 ARGB: 0xAARRGGB。 ### borderWidth ```objectivec @property (assign, nonatomic) int borderWidth; ``` 边框的宽度，单位：像素。 # ByteRTCRemoteVideoState ```objectivec typedef NS_ENUM( NSInteger, ByteRTCRemoteVideoState ) ``` 远端视频流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCRemoteVideoStateStopped | 0 | 远端视频流默认初始状态, 在以下时机回调该状态：

本地用户停止接收远端视频流，对应错误码 [ByteRTCRemoteVideoStateChangeReason](#ByteRTCRemoteVideoStateChangeReason) 中的 ByteRTCRemoteVideoStateChangeReasonLocalMuted

远端用户停止发送视频流，对应错误码 [ByteRTCRemoteVideoStateChangeReason](#ByteRTCRemoteVideoStateChangeReason) 中的 ByteRTCRemoteVideoStateChangeReasonRemoteMuted

远端用户离开房间，对应错误码 [ByteRTCRemoteVideoStateChangeReason](#ByteRTCRemoteVideoStateChangeReason) 中的 ByteRTCRemoteVideoStateChangeReasonRemoteOffline

| | ByteRTCRemoteVideoStateStarting | 1 | 本地用户已接收远端视频首包
收到远端视频首包时回调该状态，对应错误码 [ByteRTCRemoteVideoStateChangeReason](#ByteRTCRemoteVideoStateChangeReason) 中的 ByteRTCRemoteVideoStateChangeReasonLocalUnmuted | | ByteRTCRemoteVideoStateDecoding | 2 | 远端视频流正在解码，正常播放, 在以下时机回调该状态：

成功解码远端视频首帧，对应错误码 [ByteRTCRemoteVideoStateChangeReason](#ByteRTCRemoteVideoStateChangeReason) 中的 ByteRTCRemoteVideoStateChangeReasonLocalUnmuted

网络由阻塞恢复正常，对应错误码 [ByteRTCRemoteVideoStateChangeReason](#ByteRTCRemoteVideoStateChangeReason) 中的 ByteRTCRemoteVideoStateChangeReasonNetworkRecovery

本地用户恢复接收远端视频流，对应错误码 [ByteRTCRemoteVideoStateChangeReason](#ByteRTCRemoteVideoStateChangeReason) 中的 ByteRTCRemoteVideoStateChangeReasonLocalUnmuted

远端用户恢复发送视频流，对应错误码 [ByteRTCRemoteVideoStateChangeReason](#ByteRTCRemoteVideoStateChangeReason) 中的 ByteRTCRemoteVideoStateChangeReasonRemoteUnmuted

| | ByteRTCRemoteVideoStateFrozen | 3 | 远端视频流卡顿
网络阻塞、丢包率等原因造成视频卡顿流时会回报该状态，对应错误码 [ByteRTCRemoteVideoStateChangeReason](#ByteRTCRemoteVideoStateChangeReason) 中的 ByteRTCRemoteVideoStateChangeReasonNetworkCongestion | | ByteRTCRemoteVideoStateFailed | 4 | 远端视频流播放失败
如果内部处理远端视频流失败，则会回调该方法，对应错误码 [ByteRTCRemoteVideoStateChangeReason](#ByteRTCRemoteVideoStateChangeReason) 中的 ByteRTCRemoteVideoStateChangeReasonInternal | # ByteRTCMediaDeviceError ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMediaDeviceError ) ``` 媒体设备错误类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMediaDeviceErrorOK | 0 | 媒体设备正常 | | ByteRTCMediaDeviceErrorDeviceNoPermission | 1 | 没有权限启动媒体设备 | | ByteRTCMediaDeviceErrorDeviceBusy | 2 | 媒体设备已经在使用中 | | ByteRTCMediaDeviceErrorDeviceFailure | 3 | 媒体设备错误 | | ByteRTCMediaDeviceErrorDeviceNotFound | 4 | 未找到指定的媒体设备 | | ByteRTCMediaDeviceErrorDeviceDisconnected | 5 | 媒体设备被移除 | | ByteRTCMediaDeviceErrorDeviceNoCallback | 6 | 无采集数据。当媒体设备的预期行为是正常采集，但没有收到采集数据时，将收到该错误。 | | ByteRTCMediaDeviceErrorUNSupportFormat | 7 | 设备采样率不支持 | # ByteRTCMixedStreamSEIContentMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMixedStreamSEIContentMode ) ``` 服务端合流转推 SEI 内容。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMixedStreamSEIContentModeDefault | 0 | 视频流中包含全部的 SEI 信息。默认设置。 | | ByteRTCMixedStreamSEIContentModeEnableVolumeIndication | 1 | 随非关键帧传输的 SEI 数据中仅包含音量信息。
当设置 `ByteRTCMixedStreamServerControlConfig.enableVolumeIndication` 为 True 时，此参数设置生效。 | # ByteRTCAudioPropertiesMode ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioPropertiesMode ) ``` [rtcEngine:onLocalAudioPropertiesReport:](70093#ByteRTCVideoDelegate-rtcengine-onlocalaudiopropertiesreport) 中包含的音频信息的范围。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioPropertiesModeMicrohone | 0 | 仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据。 | | ByteRTCAudioPropertiesModeAudioMixing | 1 | 包含以下信息：

本地麦克风采集的音频数据和本地屏幕音频采集数据；

本地混音的音频数据。

| # ByteRTCTranscoderLayoutRegionDataParam ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCTranscoderLayoutRegionDataParam : NSObject ``` > Deprecated since 3.52, use [ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig](#ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig) instead. 图片合流相关参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [imageWidth](#ByteRTCTranscoderLayoutRegionDataParam-imagewidth) | | NSInteger | [imageHeight](#ByteRTCTranscoderLayoutRegionDataParam-imageheight) | ## 变量说明 ### imageWidth ```objectivec @property (assign, nonatomic) NSInteger imageWidth; ``` 原始图片的宽度，单位为 px。 ### imageHeight ```objectivec @property (assign, nonatomic) NSInteger imageHeight; ``` 原始图片的高度，单位为 px。 # ByteRTCAudioDeviceType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCAudioDeviceType ) ``` 当前音频设备类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCAudioDeviceTypeUnknown | -1 | 未知音频设备 | | ByteRTCAudioDeviceTypeRenderDevice | 0 | 音频渲染设备 | | ByteRTCAudioDeviceTypeCaptureDevice | 1 | 音频采集设备 | | ByteRTCAudioDeviceTypeScreenCaptureDevice | 2 | 屏幕流音频设备 | # ByteRTCMediaPlayerCustomSourceStreamType ```objectivec typedef NS_ENUM( NSInteger, ByteRTCMediaPlayerCustomSourceStreamType ) ``` 自定义音频流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ByteRTCMediaPlayerCustomSourceStreamTypeRaw | 0 | 当播放来自本地的 PCM 数据时，使用此选项。 | | ByteRTCMediaPlayerCustomSourceStreamTypeEncoded | 1 | 当播放来自内存的音频数据时，使用此选项。 | # ByteRTCAudioPropertiesConfig ```objectivec BYTERTC_APPLE_EXPORT @interface ByteRTCAudioPropertiesConfig : NSObject ``` 音频属性信息提示的相关配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [interval](#ByteRTCAudioPropertiesConfig-interval) | | BOOL | [enableSpectrum](#ByteRTCAudioPropertiesConfig-enablespectrum) | | BOOL | [enableVad](#ByteRTCAudioPropertiesConfig-enablevad) | | ByteRTCAudioReportMode | [localMainReportMode](#ByteRTCAudioPropertiesConfig-localmainreportmode) | | float | [smooth](#ByteRTCAudioPropertiesConfig-smooth) | | ByteRTCAudioPropertiesMode | [audioReportMode](#ByteRTCAudioPropertiesConfig-audioreportmode) | | BOOL | [enableVoicePitch](#ByteRTCAudioPropertiesConfig-enablevoicepitch) | ## 变量说明 ### interval ```objectivec @property(assign, nonatomic) NSInteger interval; ``` 信息提示间隔，单位：ms - `<= 0`: 关闭信息提示 - `(0,100]`: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms - `> 100`: 开启信息提示，并将信息提示间隔设置为此值 ### enableSpectrum ```objectivec @property(assign, nonatomic) BOOL enableSpectrum; ``` 是否开启音频频谱检测。 ### enableVad ```objectivec @property(assign, nonatomic) BOOL enableVad; ``` 是否开启人声检测 (VAD)。 ### localMainReportMode ```objectivec @property(assign, nonatomic) ByteRTCAudioReportMode localMainReportMode; ``` 音量回调模式。详见 [ByteRTCAudioReportMode](#ByteRTCAudioReportMode)。 ### smooth ```objectivec @property(nonatomic, assign) float smooth; ``` 适用于音频属性信息提示的平滑系数。取值范围是 `(0.0, 1.0]`。默认值为 `1.0`，不开启平滑效果；值越小，提示音量平滑效果越明显。如果要开启平滑效果，可以设置为 `0.3`。 ### audioReportMode ```objectivec @property(assign, nonatomic) ByteRTCAudioPropertiesMode audioReportMode; ``` [rtcEngine:onLocalAudioPropertiesReport:](70093#ByteRTCVideoDelegate-rtcengine-onlocalaudiopropertiesreport) 中包含音频数据的范围。参看 [ByteRTCAudioPropertiesMode](#ByteRTCAudioPropertiesMode)。默认仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据。 ### enableVoicePitch ```objectivec @property(assign, nonatomic) BOOL enableVoicePitch; ``` 是否回调本地用户的人声基频。