文档

重要参数

更新时间:

本文介绍的是音视频引擎与会话接口的相关参数。

参数

说明

MRtcEngineInitParam

引擎初始化。

MRtcEncoderQosParams

音视频编码服务质量。

CreatRoomParam

创建一个房间。

JoinRoomParam

加入已有房间。

PublishParam

发布音视频流。

SubscribeParam

订阅音视频流。

MRtcEngineInitParam

引擎初始化。作为引擎初始化的参数,只有该参数填写正确,才能顺利创建会话。

参数

类型

说明

是否必填

roomUrl

String

房间服务器的接入地址。

logLevel

String

日志级别,none|error|warn|info|debug 中的某一个,none 表示不打印日志。

maxSessionNum

Int

运行并发的最大会话数量,大于 0 时配置生效。

enableRelay

Bool

如果服务器没有公网 IP,可以考虑打开该开关,走数据中转模式。

enableDataChannel

Bool

是否开启 DataChannel 功能。

MRtcEncoderQosParams

保证音视频服务提供的质量。实时调节编码器的输出帧率和码率。

参数

类型

说明

是否必填

target_kbps

Int

编码器的输出码率。

target_fps

Int

编码器的输出帧率。

CreatRoomParam

创建房间。作为创建房间的参数,只有该参数填写正确,才能顺利创建音视频房间。

参数

说明

uid

用户 ID,唯一标识房间里的某个用户。

sign

房间服务器需要验证该通话业务的合法性。

bizName

业务类型,比如 Bank(银行类业务)、Stock(证券类业务)。

subBiz

子业务类型,比如上海银行,平安证券等。

workspaceId

mPaaS 类业务需要填写,其他业务不需要该字段。

autoSubscribe

当房间里面有新人进入,发布了新的流,SDK 是否自动订阅。

ext

留作扩展,可用来配置录制相关的特性,参见 常见问题

JoinRoomParam

加入房间。作为进房参数,只有该参数填写正确,才能顺利进入 roomId 所指定的音视频房间。

参数

说明

roomId

创建的房间 ID,唯一标识。

uid

用户 ID,唯一标识房间里的某个用户。

sign

房间服务器需要验证该通话业务的合法性。

bizName

业务类型,比如 Bank(银行类业务)、Stock(证券类业务)。

subBiz

子业务类型,比如上海银行,平安证券等。

token

加入房间的凭证。

workspaceId

mPaaS 类业务需要填写,其他业务不需要该字段。

autoSubscribe

是否自动订阅房间里面发布者发布的音视频流。

ext

留作扩展,可用来配置录制相关的特性,参见 常见问题

PublishParam

发布音视频流。是否发布本地音视频到视频服务器。

参数

说明

enableVideo

是否发布本地视频到视频服务器。

enableAudio

是否发布本地音频到视频服务器。

SubscribeParam

订阅音视频流。手动订阅的场景下,是否订阅音视频。

参数

说明

enableVideo

手动订阅的场景下,是否订阅视频。

enableAudio

手动订阅的场景下,是否订阅音频。

streamId

房间里面的每个发布者都有唯一的一个流标识,这个标识指明去订阅哪个参与者的音视频流。

  • 本页导读 (0)
文档反馈