• 实时音视频
    • 实时音视频>客户端 API>iOS

    iOS

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

    枚举

    视频相关枚举值定义  
    BRTCVideoResolution 视频分辨率
    BRTCVideoResolutionMode 视频宽高比模式
    BRTCVideoStreamType 视频流类型
    BRTCVideoFillMode 视频画面填充模式
    BRTCVideoRotation 视频画面旋转方向
    BRTCVideoMirrorType 本地视频预览镜像类型
    BRTCSnapshotSourceType 视频截图来源
    BRTCGSensorMode 重力感应开关
    网络相关枚举值定义  
    BRTCQosControlMode 流控模式
    BRTCVideoQosPreference 画质偏好
    BRTCRoleType 角色
    BRTCNetworkQualityLevel 推拉流质量级别
    BRTCCollectionQuality 推拉流质量评价详情
    声音相关枚举值定义  
    BRTCAudioQuality 声音音质
    BRTCAudioRoute 音频路由，即声音由哪里输出
    BRTCSystemVolumeType 系统音量类型，即声音由用哪种音量输出
    BRTCAudioSampleRate 音频采样率
    Log 相关枚举值定义  
    BRTCLogLevel Log 级别

    关键类型定义

    对象 说明
    BRTCParams 进入房间参数
    BRTCUser BRTCUser
    BRTCRenderParams 画面显示参数
    BRTCVideoEncParam 视频配置参数
    BRTCNetworkQosParam 网络流控相关参数
    BRTCVolumeInfo 音量大小
    BRTCCustomAudioFrame 自定义音频帧参数
    BRTCCustomAudioDelegateFormat 自定义音频帧回调格式
    BRTCStatistics 统计数据
    BRTCRemoteStatistics 远端成员的音视频统计信息
    BRTCLocalStatistics 本地的音视频统计信息

    BRTCVideoResolution

    视频分辨率

    变量名 值 描述
    BRTCVideoResolution_120_120 1 建议码率 VideoCall:80kbps LIVE:120kbps
    BRTCVideoResolution_160_160 3 建议码率 VideoCall:100kbps LIVE:150kbps
    BRTCVideoResolution_270_270 5 建议码率 VideoCall:200kbps LIVE:120kbps
    BRTCVideoResolution_480_480 7 建议码率 VideoCall:350kbps LIVE:120kbps
    BRTCVideoResolution_160_120 50 建议码率 VideoCall:100kbps LIVE:150kbps
    BRTCVideoResolution_240_180 52 建议码率 VideoCall:150kbps LIVE:225kbps
    BRTCVideoResolution_280_210 54 建议码率 VideoCall:200kbps LIVE:300kbps
    BRTCVideoResolution_320_240 56 建议码率 VideoCall:250kbps LIVE:375kbps
    BRTCVideoResolution_400_300 58 建议码率 VideoCall:300kbps LIVE:450kbps
    BRTCVideoResolution_480_360 60 建议码率 VideoCall:400kbps LIVE:600kbps
    BRTCVideoResolution_640_480 62 建议码率 VideoCall:600kbps LIVE:900kbps
    BRTCVideoResolution_960_720 64 建议码率 VideoCall:1000kbps LIVE:1500kbps
    BRTCVideoResolution_160_90 100 建议码率 VideoCall:150kbps LIVE:250kbps
    BRTCVideoResolution_256_144 102 建议码率 VideoCall:200kbps LIVE:300kbps
    BRTCVideoResolution_320_180 104 建议码率 VideoCall:250kbps LIVE:400kbps
    BRTCVideoResolution_480_270 106 建议码率 VideoCall:350kbps LIVE:550kbps
    BRTCVideoResolution_640_360 108 建议码率 VideoCall:550kbps LIVE:900kbps
    BRTCVideoResolution_960_540 110 建议码率 VideoCall:850kbps LIVE:1300kbps
    BRTCVideoResolution_1280_720 112 建议码率 VideoCall:1200kbps LIVE:1800kbps
    BRTCVideoResolution_1920_1080 114 建议码率 VideoCall:2000kbps LIVE:3000kbps

    详情

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

    BRTCVideoResolutionMode

    视频宽高比模式

    变量名 值 描述
    BRTCVideoResolutionModeLandscape 0 横屏分辨率
    BRTCVideoResolutionModePortrait 1 竖屏分辨率

    详情

    • 横屏分辨率：BRTCVideoResolution_640_360 + BRTCVideoResolutionModeLandscape | 640 × 360
    • 竖屏分辨率：BRTCVideoResolution_640_360 + BRTCVideoResolutionModePortrait | 360 × 640

    BRTCVideoStreamType

    视频流类型

    变量名 值 描述
    BRTCVideoStreamTypeBig 0 主画面视频流
    BRTCVideoStreamTypeSmall 1 小画面视频流
    BRTCVideoStreamTypeSub 2 辅流（屏幕分享）

    详情

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

    BRTCVideoFillMode

    视频画面填充模式

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

    详情

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

    BRTCVideoRotation

    视频画面旋转方向

    变量名 值 描述
    BRTCVideoRotation_0 0 不旋转
    BRTCVideoRotation_90 1 顺时针旋转90度
    BRTCVideoRotation_180 2 顺时针旋转180度
    BRTCVideoRotation_270 3 顺时针旋转270度

    详情

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

    BRTCVideoMirrorType

    本地视频预览镜像类型

    变量名 值 描述
    BRTCVideoMirrorTypeAuto 0 前置摄像头镜像，后置摄像头不镜像
    BRTCVideoMirrorTypeEnable 1 前后置摄像头画面均镜像
    BRTCVideoMirrorTypeDisable 2 前后置摄像头画面均不镜像

    BRTCSnapshotSourceType

    视频截图来源

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

    BRTCGSensorMode

    重力感应开关

    变量名 值 描述
    BRTCGSensorMode_Disable 0 该模式是桌面平台上的默认值，该模式下，当前用户发布出去的视频画面不受重力感应方向变化的影响
    BRTCGSensorMode_UIAutoLayout 1 该模式是移动平台上的默认值，该模式下，当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整，同时本地预览画面保持方向不变。
    SDK 目前支持的一种适配模式是：当手机或 Pad 上下颠倒时，为了保证远端用户看到的画面方向正常，SDK 会自动将发布出去的画面上下旋转180度。
    如果您的 APP 的界面层开启了重力感应自适应，推荐使用 UIFixLayout 模式
    BRTCGSensorMode_UIFixLayout 2 该模式下，当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整，同时本地预览画面也会进行相应的旋转适配。
    目前支持的一种特性是：当手机或 Pad 上下颠倒时，为了保证远端用户看到的画面方向正常，SDK 会自动将发布出去的画面上下旋转180度。
    如果您的 APP 的界面层不支持重力感应自适应，并且希望 SDK 的视频画面能够适配重力感应方向，推荐使用 UIFixLayout 模式

    BRTCQosControlMode

    流控模式

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

    详情

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

    BRTCVideoQosPreference

    画质偏好

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

    详情

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

    BRTCRoleType

    角色

    变量名 值 描述
    BRTCRoleAnchor 20 主播：可以随时发布自己的音视频流，但人数有限制，同一个房间中最多只允许 50 个主播同时发布自己的音视频流
    BRTCRoleAudience 21 观众：只能观看其他用户的音视频流，要发布音视频流，需要先通过switchRole 切换成主播，同一个房间中最多能容纳10万观众

    BRTCNetworkQualityLevel

    推、拉流质量评价级别

    变量名 值 描述
    UNKNOWN 0 未知，通常是不存在推流或拉流的情形
    EXCELLENT 1 极好
    GOOD 2 良好
    POOR 3 一般
    BAD 4 差
    VBAD 5 极差
    DOWN 6 不可用

    BRTCCollectionQuality

    推、拉流质量评价详情

    变量名 类型 描述
    qualityLevel BRTCNetworkQualityLevel 推、拉流质量评价级别，参考 BRTCNetworkQualityLevel
    userId NSString 用户ID，本地或远端用户。本地用户ID始终为0。

    BRTCAudioQuality

    声音音质

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

    详情

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

    BRTCAudioRoute

    音频路由，即声音由哪里输出

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

    BRTCSystemVolumeType

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

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

    BRTCAudioSampleRate

    音频采样率

    变量名 值 描述
    BRTCAudioSampleRate16000 16000 16k采样率
    BRTCAudioSampleRate32000 32000 32k采样率
    BRTCAudioSampleRate44100 44100 44.1k采样率
    BRTCAudioSampleRate48000 48000 48k采样率

    BRTCLogLevel

    Log 级别

    变量名 值 描述
    BRTCLogLevelVerbose 0 输出所有级别的 Log
    BRTCLogLevelDebug 1 输出 DEBUG，INFO，WARNING，ERROR 级别的 Log
    BRTCLogLevelInfo 2 输出 INFO，WARNING，ERROR 级别的 Log
    BRTCLogLevelWarn 3 只输出WARNING，ERROR 级别的 Log
    BRTCLogLevelError 4 只输出ERROR 级别的 Log

    详情

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

    BRTCParams

    进入房间参数

    变量名 类型 是否必填 描述
    appID NSString 是 appID
    sign NSString 是 用户签名 参考SDK 动态授权
    roomID NSString 是 房间号
    userID NSString 是 用户标识
    user（废弃） BRTCUser 否 用户数据

    BRTCUser

    用户信息(废弃)

    变量名 类型 是否必填 描述
    uid int32 否 用户数据

    BRTCRenderParams

    渲染参数

    变量名 类型 是否必填 描述
    rotation BRTCVideoRotation 否 画面朝向
    fillMode BRTCVideoFillMode 否 画面填充模式
    mirrorType BRTCVideoMirrorType 否 画面朝向

    BRTCVideoEncParam

    视频配置参数

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

    BRTCNetworkQosParam

    网络流控相关参数

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

    详情

    • BRTCVideoQosPreference 弱网下是“保清晰”或“保流畅”

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

    • BRTCQosControlMode 视频分辨率（云端控制 - 客户端控制），推荐取值：云端控制

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

    BRTCVolumeInfo

    音量大小

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

    详情

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

    BRTCCustomAudioFrame

    自定义音频帧参数

    变量名 类型 是否必填 描述
    data NSData 是 音频数据
    sampleRate BRTCAudioSampleRate 是 采样率
    channel int 是 声道数
    timestamp uint64_t 是 时间戳，单位ms

    详情

    • 音频帧数据

    BRTCCustomAudioDelegateFormat

    自定义音频帧参数

    变量名 类型 是否必填 描述
    sampleRate BRTCAudioSampleRate 是 采样率
    channel int 是 声道数
    samplesPerCall int 是 采样点数

    BRTCStatistics

    统计数据

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

    BRTCLocalStatistics

    本地的音视频统计信息

    类型 变量名 说明
    width uint32_t 视频宽度
    height uint32_t 视频高度
    frameRate uint32_t 帧率（fps）
    videoBitrate uint32_t 视频发送码率（Kbps）
    audioSampleRate uint32_t 音频采样率（Hz）
    audioBitrate uint32_t 音频发送码率（Kbps）
    streamType BRTCVideoStreamType 流类型（大画面 / 小画面 / 辅路画面）

    BRTCRemoteStatistics

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

    变量名 类型 说明
    uid NSUInteger 用户 ID，指定是哪个用户的视频流
    finalLoss uint32_t 该线路的总丢包率（％），该值越小越好，例如，丢包率为0表示网络很好， 丢包率是该线路的 userId 从上行到服务器再到下行的总丢包率。 如果 downLoss 为0， 但是 finalLoss 不为0，说明该 userId 在上行就出现了无法恢复的丢包
    width uint32_t 视频宽度
    height uint32_t 视频高度
    frameRate uint32_t 接收帧率（fps）
    videoBitrate uint32_t 视频码率（Kbps）
    audioSampleRate uint32_t 音频采样率（Hz）
    audioBitrate uint32_t 音频码率（Kbps）
    jitterBufferDelay uint32_t 播放时延（ms）
    streamType BRTCVideoStreamType 流类型（大画面 / 小画面 / 辅路画面）
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论