概览JuphoonWeChatSdkClientSocketEventJRTCEventType错误码

Public 成员函数
	join (roomId, joinConfig)
	leave ()
	stop ()
	on (eventName, handler)
	off (eventName, handler)
	subscribe (uid)
	unsubscribe (uid)
	updatePusherState (log)
	updatePusherNetState (log)
	updatePlayerState (log)
	updatePlayerNetState (log)
	destroyClient ()
	startRecord (recordConfig)
	stopRecord ()
	startCdn (cdnConfig)
	stopCdn ()
	publish ()
	setLayout (mode, layoutConfig)

成员函数说明

◆ destroyClient()

Client::destroyClient ( )

inline

销毁Client，释放Client，调用此方法后，你将无法再使用 Client 的其它方法和回调，如需在销毁后再次初始化 Client 实例，需要等待 destroyClient 方法执行结束后再初始化实例。

前置条件

初始化实例成功JRTCEventType.CREATE之后，可执行该方法

◆ join()

Client::join (   roomId,   joinConfig  )

inline

加入/创建会议

参数

{string}	roomId 会议 ID
{Object}	joinConfig 加入参数配置，包含以下参数： displayName：字符串类型，表示显示的昵称。 roomPwd：字符串类型，表示会议密码。 enableRecordCdn：布尔类型，表示是否启用录制 CDN。 capacity：数字类型，表示会议人数上限。 autoSubscribe：布尔类型，表示是否自动订阅，默认自动订阅 videoWidth 会议分辨率宽度 创会人 携带生效 videoHeight 会议分辨率宽度 创会人 携带生效

返回

Promise {pullUrl,pushUrl} 异步返回推拉流地址

◆ leave()

Client::leave ( )

inline

离开会议 并自动销毁Client

前置条件

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

◆ off()

Client::off (   eventName,   handler  )

inline

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

前置条件

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

参数

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

返回

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

◆ on()

Client::on (   eventName,   handler  )

inline

添加事件监听器

参数

eventName	- 要监听的事件类型JRTCEventType
handler	- 事件监听回调

返回

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

注解

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

◆ publish()

Client::publish ( )

inline

开始推流

前置条件

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

注解

由ConferenceEventType.PUBLISH监听事件是否成功 调用后请及时调用live-pusher实例 开始推流

返回

void

◆ setLayout()

Client::setLayout (   mode,   layoutConfig  )

inline

设置合流布局

参数

mode

布局模式 必选 1-等分布局 2-大屏布局 3-自定义布局

layoutConfig

可选 布局模式 mergeFps 帧率 number类型 默认24 videoWidth number类型 布局宽度 videoHeight number类型 布局宽度 uid 大屏用户ID mode=2 模式下必填且生效 layout layoutItem[] mode=3模式下必填 生效 screenRatio 大屏屏幕大小 1-X2 2-X3 默认X2 mode=2 大屏布局模式下生效 interface layoutItem:{ uid:string, //用户名称 level:number, // 图像等级 可选 0, 256，512，768，1024 xPos:number, // x坐标 相对于画布左上角原点横向坐标 yPos:number, // y坐标 相对于画布左上角原点纵向坐标 width:number, // 渲染宽度 height:number // 渲染高度 }

◆ startCdn()

Client::startCdn (   cdnConfig )

inline

开始CDN推流

前置条件

调用joinClient.join enableRecordCdn参数需设置为true

参数

{Object}

cdnConfig 开始录制选项，包括以下属性： cdn：string CDN推流地址

返回

Promise

◆ startRecord()

Client::startRecord (   recordConfig )

inline

开始录制 调用joinClient.join enableRecordCdn参数需设置为true

参数

{Object}

recordConfig 录制配置选项，包括以下属性： recordType: string; 存储云类型 可用类型 阿里云-alioss 七牛云-qiniu AWS-S3 video: boolean; 是否为视频录制。 bucketName: string; 存储云中的 bucket 名称。 secretKey: string; 存储云的密钥，用于身份验证。 accessKey: string; 存储云的访问密钥，用于身份验证。 uploadEndPoint?: string; 上传文件的端点地址，可选。 fileName: string; 录制文件的名称。

返回

Boolean

◆ stop()

Client::stop ( )

inline

结束会议 并自动销毁Client

前置条件

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

◆ stopCdn()

Client::stopCdn ( )

inline

停止CDN推流

前置条件

调用 startCdnClient.startCdn 成功后之后可执行

返回

Promise<void>

◆ stopRecord()

Client::stopRecord ( )

inline

停止录制

返回

void

◆ subscribe()

Client::subscribe (   uid )

inline

订阅对端视频流

参数

{string}

uid 订阅用户的uid

注解

由ConferenceEventType.SUBSCRIBE监听事件是否成功

返回

void

◆ unsubscribe()

Client::unsubscribe (   uid )

inline

取消订阅对端视频流

参数

{string}

uid 取消订阅用户的uid

注解

由ConferenceEventType.UNSUBSCRIBE监听事件是否成功

返回

void

◆ updatePlayerNetState()

updatePlayerNetState (   log )

inline

上报拉流网络状态

参数

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

警告

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

返回值

Promise

◆ updatePlayerState()

updatePlayerState (   log )

inline

上报拉流状态

参数

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

警告

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

返回值

Promise

◆ updatePusherNetState()

updatePusherNetState (   log )

inline

上报推流网络状态

参数

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

警告

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

返回值

Promise

◆ updatePusherState()

updatePusherState (   log )

inline

上报推流状态

参数

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

警告

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

返回值

Promise

提交成功