互动直播>客户端 API>iOS

iOS

编辑文档 更新于
概况BLiveBLiveDelegateBRTCDeviceManagerBLiveBeautyManager对象和枚举错误码

对象和枚举 定义了一些配置参数和文件夹包含 SDK 接口的入参及出参的类的定义。

详细信息

枚举

视频相关枚举值定义  
BLiveVideoResolution 视频分辨率
BLiveVideoResolutionMode 视频宽高比模式
BLiveVideoStreamType 视频流类型
BLiveVideoFillMode 视频画面填充模式
BLiveVideoRotation 视频画面旋转方向
BLiveVideoMirrorType 本地视频预览镜像类型
BLiveSnapshotSourceType 视频截图来源
网络相关枚举值定义  
BLiveQosControlMode 流控模式
BLiveVideoQosPreference 画质偏好
声音相关枚举值定义  
BLiveAudioQuality 声音音质
BLiveAudioRoute 音频路由,即声音由哪里输出
BLiveSystemVolumeType 系统音量类型,即声音由用哪种音量输出
Log 相关枚举值定义  
BLiveLogLevel Log 级别

关键类型定义

对象 说明
BLiveParams 进入房间参数
BLiveRoleType 用户角色
BLiveRenderParams 画面显示参数
BLiveVideoEncParam 视频配置参数
BLiveNetworkQosParam 网络流控相关参数
BLiveVolumeInfo 音量大小
BLiveStatistics 统计数据
BLiveRemoteStatistics 远端成员的音视频统计信息
BLiveLocalStatistics 本地的音视频统计信息

详细信息

BLiveVideoResolution
视频分辨率

变量名 值 描述
BLiveVideoResolution_120_120 1 建议码率 VideoCall:80kbps LIVE:120kbps
BLiveVideoResolution_160_160 3 建议码率 VideoCall:100kbps LIVE:150kbps
BLiveVideoResolution_270_270 5 建议码率 VideoCall:200kbps LIVE:120kbps
BLiveVideoResolution_480_480 7 建议码率 VideoCall:350kbps LIVE:120kbps
BLiveVideoResolution_160_120 50 建议码率 VideoCall:100kbps LIVE:150kbps
BLiveVideoResolution_240_180 52 建议码率 VideoCall:150kbps LIVE:225kbps
BLiveVideoResolution_280_210 54 建议码率 VideoCall:200kbps LIVE:300kbps
BLiveVideoResolution_320_240 56 建议码率 VideoCall:250kbps LIVE:375kbps
BLiveVideoResolution_400_300 58 建议码率 VideoCall:300kbps LIVE:450kbps
BLiveVideoResolution_480_360 60 建议码率 VideoCall:400kbps LIVE:600kbps
BLiveVideoResolution_640_480 62 建议码率 VideoCall:600kbps LIVE:900kbps
BLiveVideoResolution_960_720 64 建议码率 VideoCall:1000kbps LIVE:1500kbps
BLiveVideoResolution_160_90 100 建议码率 VideoCall:150kbps LIVE:250kbps
BLiveVideoResolution_256_144 102 建议码率 VideoCall:200kbps LIVE:300kbps
BLiveVideoResolution_320_180 104 建议码率 VideoCall:250kbps LIVE:400kbps
BLiveVideoResolution_480_270 106 建议码率 VideoCall:350kbps LIVE:550kbps
BLiveVideoResolution_640_360 108 建议码率 VideoCall:550kbps LIVE:900kbps
BLiveVideoResolution_960_540 110 建议码率 VideoCall:850kbps LIVE:1300kbps
BLiveVideoResolution_1280_720 112 建议码率 VideoCall:1200kbps LIVE:1800kbps
BLiveVideoResolution_1920_1080 114 建议码率 VideoCall:2000kbps LIVE:3000kbps

详情

  • 此处仅定义横屏分辨率，如需使用竖屏分辨率（例如360 × 640），需要同时指定 BLiveVideoResolutionMode 为 Portrait

BLiveVideoResolutionMode
视频宽高比模式

变量名 值 描述
BLiveVideoResolutionModeLandscape 0 横屏分辨率
BLiveVideoResolutionModePortrait 1 竖屏分辨率

详情

  • 横屏分辨率：BLiveVideoResolution_640_360 + BLiveVideoResolutionModeLandscape | 640 × 360
  • 竖屏分辨率：BLiveVideoResolution_640_360 + BLiveVideoResolutionModePortrait | 360 × 640

BLiveVideoStreamType
视频流类型

变量名 值 描述
BLiveVideoStreamTypeBig 0 主画面视频流
BLiveVideoStreamTypeSmall 1 小画面视频流
BLiveVideoStreamTypeSub 2 辅流（屏幕分享）

详情

  • BLive 内部有三种不同的音视频流，分别是：
    • 主画面：最常用的一条线路，一般用来传输摄像头的视频数据
    • 小画面：跟主画面的内容相同，但是分辨率和码率更低
    • 辅流画面：一般用于屏幕分享，以及远程播片（例如老师放一段视频给学生）
  • 如果主播的上行网络和性能比较好，则可以同时送出大小两路画面
  • SDK 不支持单独开启小画面，小画面必须依附于主画面而存在

BLiveVideoFillMode
视频画面填充模式

变量名 值 描述
BLiveVideoFillMode_Fill 0 图像铺满屏幕，超出显示视窗的视频部分将被裁剪
BLiveVideoFillMode_Fit 1 图像长边填满屏幕，短边区域会被填充黑色

详情

  • 如果画面的显示分辨率不等于画面的原始分辨率，就需要您设置画面的填充模式:
    • BLiveVideoFillMode_Fill，图像铺满屏幕，超出显示视窗的视频部分将被裁剪，画面显示可能不完整
    • BLiveVideoFillMode_Fit，图像长边填满屏幕，短边区域会被填充黑色，画面的内容完整

BLiveVideoRotation
视频画面旋转方向

变量名 值 描述
BLiveVideoRotation_0 0 不旋转
BLiveVideoRotation_90 1 顺时针旋转90度
BLiveVideoRotation_180 2 顺时针旋转180度
BLiveVideoRotation_270 3 顺时针旋转270度

详情

  • BLive SDK 提供了对本地和远程画面的旋转角度设置 API，下列的旋转角度都是指顺时针方向的

BLiveVideoMirrorType
本地视频预览镜像类型

变量名 值 描述
BLiveVideoMirrorTypeAuto 0 前置摄像头镜像，后置摄像头不镜像
BLiveVideoMirrorTypeEnable 1 前后置摄像头画面均镜像
BLiveVideoMirrorTypeDisable 2 前后置摄像头画面均不镜像

BLiveSnapshotSourceType
视频截图来源

变量名 值 描述
BLiveSnapshotSourceTypeStream 0 从视频流上截取视频画面
BLiveSnapshotSourceTypeView 1 从渲染 View 上截取视频画面

BLiveQosControlMode
流控模式

变量名 值 描述
BLiveQosControlModeClient 0 客户端控制（用于 SDK 开发内部调试，客户请勿使用）
BLiveQosControlModeServer 1 云端控制 （默认）

详情

  • SDK 内部需要时刻根据网络情况调整内部的编解码器和网络模块，以便能够对网络的变化做出反应
  • 为了支持快速算法升级，SDK 内部设置了两种不同的流控模式：
    • ModeServer：云端控制，默认模式，推荐选择
    • ModeClient：本地控制，用于 SDK 开发内部调试，客户请勿使用

BLiveVideoQosPreference
画质偏好

变量名 值 描述
BLiveVideoQosPreferenceSmooth 1 弱网下保流畅
BLiveVideoQosPreferenceClear 2 弱网下保清晰，默认值

详情

  • 指当 BLive SDK 在遇到弱网络环境时，您期望“保清晰”或“保流畅”，两种模式均会优先保障声音数据的传输
    • Smooth：弱网下优先流畅性，当用户网络较差的时候画面也会比较模糊
    • Clear：默认值，弱网下优先清晰度，当用户网络较差的时候会出现卡顿，但画面清晰度不会大幅缩水

BLiveAudioQuality
声音音质

变量名 值 描述
BLiveAudioQualitySpeech 1 流畅音质：采样率：16k；单声道；音频裸码率：16kbps；适合语音通话为主的场景，比如在线会议，语音通话
BLiveAudioQualityDefault 2 默认音质：采样率：48k；单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之
BLiveAudioQualityMusic 3 高音质：采样率：48k；双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，比如K歌、音乐直播等

详情

  • 音频音质用来衡量声音的保真程度，BLiveAudioQualitySpeech 适用于通话场景，BLiveAudioQualityMusic 适用于高音质音乐场景

BLiveAudioRoute
音频路由,即声音由哪里输出

音频输出路由 值 描述
BLiveAudioModeSpeakerphone 0 扬声器，位于手机底部，声音偏大，适合外放音乐
BLiveAudioModeEarpiece 1 听筒，位于手机顶部，声音偏小，适合通话

BLiveSystemVolumeType
系统音量类型,即声音由用哪种音量输出

系统音量输出 值 描述
BLiveSystemVolumeTypeAuto 0 麦上通话，麦下媒体”，即主播上麦时使用通话音量，观众不上麦则使用媒体音量
BLiveSystemVolumeTypeVOIP 1 通话全程使用媒体音量，不常用，适合个别有特殊需求（如主播外接声卡）的应用场景
BLiveSystemVolumeTypeMedia 2 全程使用通话音量，适合多人会议场景

BLiveLogLevel
Log 级别

变量名 值 描述
BLiveLogLevelVerbose 0 输出所有级别的 Log
BLiveLogLevelDebug 1 输出 DEBUG，INFO，WARNING，ERROR 级别的 Log
BLiveLogLevelInfo 2 输出 INFO，WARNING，ERROR 级别的 Log
BLiveLogLevelInfo 2 输出 INFO，WARNING，ERROR 级别的 Log
BLiveLogLevelWarn 3 只输出WARNING，ERROR 级别的 Log
BLiveLogLevelError 4 只输出ERROR 级别的 Log

详情

  • 不同的日志等级定义了不同的详实程度和日志数量，推荐一般情况下将日志等级设置为：BLiveLogLevelInfo

BLiveParams
进入房间参数

变量名 类型 是否必填 描述
appID NSString 是 appID
roomID NSString 是 房间号
sign NSString 是 用户签名 参考SDK 动态授权
userID NSString 是 用户 ID
role BLiveRoleType 是 用户角色

BLiveRoleType
用户角色

变量名 是否必填 描述
BLiveRoleType_Anchor 是 主播
BLiveRoleType_Audience 是 观众

BLiveRenderParams
BLiveRenderParams

变量名 类型 是否必填 描述
rotation BLiveVideoRotation 否 画面朝向
fillMode BLiveVideoFillMode 否 画面填充模式
mirrorType BLiveVideoMirrorType 否 画面朝向

BLiveVideoEncParam
视频配置参数

变量名 类型 是否必填 描述
bandWidth int 否 视频码率，单位为 Kb。不设置默认值为，不设置默认为400
width int 否 视频的宽。不设置默认值是640
height int 否 视频的高。不设置默认值是360
fps int 否 视频的帧率。不设置默认值是15
resolutionMode BLiveVideoResolutionMode 否 视频宽高比模式。不设置默认值是竖屏模式

BLiveNetworkQosParam
网络流控相关参数

变量名 类型 是否必填 描述
preference BLiveVideoQosPreference 否 弱网下是“保清晰”或“保流畅
controlMode BLiveQosControlMode 否 视频分辨率（云端控制 - 客户端控制）

详情

【BLiveVideoQosPreference】弱网下是“保清晰”或“保流畅”
【特别说明】

  • 弱网下保流畅：在遭遇弱网环境时，画面会变得模糊，且出现较多马赛克，但可以保持流畅不卡顿
  • 弱网下保清晰：在遭遇弱网环境时，画面会尽可能保持清晰，但可能会更容易出现卡顿

【BLiveQosControlMode】视频分辨率（云端控制 - 客户端控制）
【推荐取值】云端控制
【特别说明】

  • Server 模式（默认）：云端控制模式，若无特殊原因，请直接使用该模式
  • Client 模式：客户端控制模式，用于 SDK 开发内部调试，客户请勿使用

BLiveVolumeInfo
音量大小

变量名 类型 是否必填 描述
volume NSUInteger 否 说话者的音量, 取值范围0 - 100
userId NSString 否 说话者的 userId, nil 为自己

详情

  • 表示语音音量的评估大小，通过这个数值，您可以在 UI 界面上用图标表征 userId 是否有在说话

BLiveStatistics
统计数据

类型 变量名 说明
uint32_t cpu 当前 App 的 CPU 使用率（％）
uint32_t rtt 延迟（毫秒）, 指 SDK 到BLive服务器的一次网络往返时间,该值越小越好。 一般低于50ms的 rtt 相对理想,而高于100ms的 rtt 会引入较大的通话延时。 由于数据上下行共享一条网络连接,所以 local 和 remote 的 rtt 相同
uint32_t upLoss C -> S 上行丢包率（％）,该值越小越好,例如,丢包率为0表示网络很好, 丢包率为30%则意味着 SDK 向服务器发送的数据包中会有30%丢失在上行传输中
uint32_t downLoss S -> C 下行丢包率（％）,该值越小越好,例如,丢包率为0表示网络很好, 丢包率为30%则意味着 SDK 向服务器发送的数据包中会有30%丢失在下行传输中
uint64_t sendBytes 发送字节总数,注意是字节数（bytes）,不是比特数（bits)
uint64_t receiveBytes 接收字节总数,注意是字节数（bytes）,不是比特数（bits）
ArrayList< BLiveLocalStatistics > localArray 自己本地的音视频统计信息,可能有主画面、小画面以及辅路画面等多路的情况,因此是一个数组
ArrayList< BLiveRemoteStatistics > localArray 远端成员的音视频统计信息,可能有主画面、小画面以及辅路画面等多路的情况,因此是一个数组

BLiveRemoteStatistics 远端成员的音视频统计信息

类型 变量名 说明
NSUInteger userId 用户 ID,指定是哪个用户的视频流
uint32_t finalLoss 该线路的总丢包率（％）,该值越小越好,例如,丢包率为0表示网络很好, 丢包率是该线路的 userId 从上行到服务器再到下行的总丢包率。 如果 downLoss 为0, 但是 finalLoss 不为0,说明该 userId 在上行就出现了无法恢复的丢包
uint32_t width 视频宽度
uint32_t height 视频高度
uint32_t frameRate 接收帧率（fps）
uint32_t videoBitrate 视频码率（Kbps）
uint32_t audioSampleRate 音频采样率（Hz）
uint32_t audioBitrate 音频码率（Kbps）
uint32_t jitterBufferDelay 播放时延（ms）
BLiveVideoStreamType streamType 流类型（大画面 / 小画面 / 辅路画面）

BLiveLocalStatistics
本地的音视频统计信息

类型 变量名 说明
uint32_t width 视频宽度
uint32_t height 视频高度
uint32_t frameRate 帧率（fps）
uint32_t videoBitrate 视频发送码率（Kbps）
uint32_t audioSampleRate 音频采样率（Hz）
uint32_t audioBitrate 音频发送码率（Kbps）
BLiveVideoStreamType streamType 流类型（大画面 / 小画面 / 辅路画面）
{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论