JRTCEngine类 参考

Public 成员函数
	joinChannel (channelId, uid, token, joinConfig)
	加入/创建频道
	leaveChannel ()
	离开频道
	on (eventName, handler, options)
	添加事件监听器
	off (eventName, handler)
	移除事件监听器，要提供与调用on时相同的参数
	updatePusherState (log)
	上报推流状态
	updatePusherNetState (log)
	上报推流网络状态
	updatePlayerState (log)
	上报拉流状态
	updatePlayerNetState (log)
	上报拉流网络状态
	destroy ()
	销毁JRTCEngine
	publish (video, audio)
	开始推流
	unpublish ()
	停止推流
	setLayout (mode, layoutConfig)
	设置合流布局
	sendMessage (message, uid)
	发送消息

成员函数说明

destroy()

JRTCEngine::destroy ( )

inline

销毁JRTCEngine

注解

调用该接口后会销毁所有监听事件，并退出频道

joinChannel()

JRTCEngine::joinChannel (   channelId,   uid,   token,   joinConfig  )

inline

加入/创建频道

参数

channelId	string类型，频道ID
uid	string类型，用户标识符，不能为空。同一频道下不能重复，同名加入的情况下，先加入频道的人会被迫退出频道，并收到selfLeft回调通知
token	string类型，长度不能超过 128 字符。免鉴权模式密码可以输入null 或 ""，Token鉴权模式密码需要输入外部生成的 Token

注解

uid 和 channelId的规则

• 最大不超过 64 字节，不可填 null。以下为支持的字符集范围（共 89 个字符）：
• 26 个小写英文字母 a-z
• 26 个大写英文字母 A-Z
• 10 个数字 0-9
• 空格(空格不能为第一或者最后一个字符)
• "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","

参数

channelConfig

频道配置参数，详细定义见 JRTCChannelConfig

注解

由selfJoined监听入会结果,并返回推拉流地址

leaveChannel()

JRTCEngine::leaveChannel ( )

inline

离开频道

前置条件

调用joinChannel加入成功后之后可执行

注解

调用后直接退出频道

off()

JRTCEngine::off (   eventName,   handler  )

inline

移除事件监听器，要提供与调用on时相同的参数

前置条件

需要先调用on监听器，才能移除。

参数

eventName	- 要移除的事件监听器类型
handler	- 要移除的事件监听回调

返回

返回值 返回true表示有该fun监听器并且移除成功

on()

JRTCEngine::on (   eventName,   handler,   options  )

inline

添加事件监听器

参数

eventName	- 要监听的事件类型ChannelEventType
handler	- 事件监听回调
options	- 监听参数 可选 once 监听到后自动移除当前事件监听

返回

若添加成功则返回一个函数，用于移除事件监听

注解

重复添加监听，回调依次生效，及时移除不需要的监听事件

publish()

JRTCEngine::publish (   video,   audio  )

inline

开始推流

注解

更改本端推流状态，修改后会更新其他端看到的本端音视频以及相应状态

前置条件

调用小程序live-pusher实例推流时调用该方法

参数

video	boolean类型，是否推送本端视频流，入会默认为true
audio	boolean类型，是否推送本端音频流，入会默认为true

注解

调用该接口后请及时调用live-pusher实例 开始推流

返回

void

sendMessage()

JRTCEngine::sendMessage (   message,   uid  )

inline

发送消息

参数

message	要发送的消息，String类型，最大长度1024字节
uid	为空时发送给频道内所有人，否则发送给指定uid的用户

注解

小程序使用messageReceived 监听频道内消息接收

setLayout()

JRTCEngine::setLayout (   mode,   layoutConfig  )

inline

设置合流布局

参数

mode	布局模式，必选，1-智能布局，2-自定义布局
layoutConfig	布局模式布局参数，详见 layoutConfig

unpublish()

JRTCEngine::unpublish ( )

inline

停止推流

前置条件

调用小程序live-pusher实例停止推流时调用该方法

注解

调用接口后请及时调用live-pusher实例停止推流

返回

void

updatePlayerNetState()

JRTCEngine::updatePlayerNetState (   log )

inline

上报拉流网络状态

参数

log	- Live-Player组件监听 bindnetstatus 返回的数据。详情见微信小程序Live-Player组件

警告

安全性提醒：请勿在此接口填写用户敏感信息

返回值

Void

updatePlayerState()

JRTCEngine::updatePlayerState (   log )

inline

上报拉流状态

参数

log	- Live-Player组件监听bindstatechange返回的数据。详情见微信小程序Live-Player组件

警告

安全性提醒：请勿在此接口填写用户敏感信息

返回值

Void

updatePusherNetState()

updatePusherNetState (   log )

inline

上报推流网络状态

参数

log	- Live-Pusher组件监听bindnetstatus返回的数据。详情见微信小程序Live-Pusher组件

警告

安全性提醒：请勿在此接口填写用户敏感信息

返回值

void

updatePusherState()

updatePusherState (   log )

inline

上报推流状态

参数

log	- Live-Pusher组件监听bindstatechange返回的数据。详情见微信小程序Live-Pusher组件

警告

安全性提醒：请勿在此接口填写用户敏感信息

返回值

void