Test-zj999 NPM

H5-API

import { JRTCClient } from 'test-zj999'

1.JRTCClient

init(JRTCInitParams)

const JWebrtc = JRTCClient.init(JRTCInitParams:{ appId: string }) 参数：initParam 返回: JRTCClient实例 JRTCInitParams:

参数	类型	说明
appId	string	appId

getPeerId()

JWebrtc.getPeerId(userInfo: UserInfo) 参数： UserInfo 说明：获取peerId，返回用户 {peerId} 注：后期废弃

参数	说明	是否必填
userId	userId	Y
userName	userName	N
temporary	是否是临时用户	Y

setVideoEncodingParam()

JWebrtc.setVideoEncodingParam(resolution: string) 设置分辨率参数： resolution

参数	说明	是否必填
resolution	resolution nhd(640360)、hd(1280720)、fhd(1920*1080)	Y

setAudioCodecOptions()

JWebrtc.setSudioCodecOptions(isStereo: Boolean) 参数： isStereo 是否开启立体声：true开启，false关闭返回：无

getVideoTrack()

JWebrtc.getVideoTrack() 参数：无说明：获取视频track 返回：videoTrack

getAudioTrack()

JWebrtc.getAudioTrack() 参数：无说明：获取音频track 返回：audioTrack

getScreenTrack()

JWebrtc.getScreenTrack() 说明：获取屏幕共享track 参数：无返回：screenTrack

createRoom()

JWebrtc.createRoom(roomInfo: RoomInfo) 说明：创建房间返回：roomId

参数	类型	是否必填
roomName	string	N
peerId	string	Y
templateId	number	Y
limitPeople	int	Y
expireModeId	int	Y
expireTime	date: 过期类型为: 设定某个时间过期, expireTime必填	Y

enterRoom()

JWebrtc.enterRoom(enterRoomInfo) 说明：进入房间成功, 会返回一个ROOM对象: JRTCRoom, 参数：enterRoomInfo Object如下

参数	类型	是否必填	说明
appId	string	Y	应用ID，控制台获取
token	string	Y	用户生成token，生成方式参见XXXX取
userId	string or number	Y	用户Id
nonce	string	Y	令牌随机码，用户生成
timeStamp	string	Y	令牌过期时间，用户生成
roomId	number	Y	roomId
peerId	string	Y	peerId
nickname	string	N	nickname
subscribeType	string	N	大房间模式下，音频订阅模式： 1 固定订阅 2 普通订阅。默认为 1

exitRoom()

JWebrtc.exitRoom(roomId: string, peerId: string) 说明：退出房间参数： roomId、peerId 返回：无

initBroadcast()

JWebrtc.initBroadcast(initBroadcastParams:{ appId: string, token: string, peerId: string | number, userName: string}) 说明：消息大厅初始化，初始化成功后, 会返回一个Msg对象: JRTCMsg, initBroadcastParams:

参数	类型	是否必填	说明
appId	string	Y	应用ID，控制台获取
token	string	Y	用户生成token，生成方式参见XXXX取
peerId	string	Y	peerId
userName	string	Y	用户昵称

错误监听

JWebrtc.on('onError', (err) => {}) 说明：错误事件，返回 { errorCode: XXX, message: XXXX} 错误信息参考：

类型	errorCode	message	说明
鉴权错误	12000	'Authentication failure.'	鉴权错误
网络错误	11000	network_error	网络已断开
音频错误	10001	audio device not found	未找到音频设备
	10003	audio device not allowed	浏览器禁用音频设备
	10005	audio device not readable	系统禁用音频设备
视频错误	10002	video device not found	未找到视频设备
	10004	video device not allowed	浏览器禁用视频设备
	10006	video device not readable	系统禁用视频设备
屏幕共享	10010	"unknown screenshare error"	屏幕共享未知错误
	10011		screenshare not allowed	屏幕共享被禁用
	10012	screenshare ended	屏幕共享已取消
其它错误	10007	"constraints " + e.constraint + " error" OverConstrainedError	无法满足要求错误
	1e4	e.message : "device unknown error"	未知错误

2.JRTCRoom

initBroadcast 调用JWebrtc.enterRoom 进入房间成功, 会返回一个ROOM对象: JRTCRoom, 1. 可通过JRTCRoom来进行房间内操作 2. 可直接通过调用JRTCRoom = await 也可在加入房间成功后，调用JRTCRoom = JWebrtc.JWebrtc.getRoomObj() 来获取enterRoom(XXXX)加入房间成功后的返回值来获取

publishVideoStream()

const { track, streamId } = await JRTCRoom.publishVideoStream(videoTrack) 说明：发布视频流参数： videoTrack 返回：track及streamId

publishAudioStream()

const { track, streamId } = await JRTCRoom.publishAudioStream(audioTrack) 说明：发布音频参数： audioTrack 返回：track及streamId

unPublishStream()

JRTCRoom.unPublishStream(streamId) 说明：取消发布参数： streamId 返回：无

subscribeStreams()

JRTCRoom.subscribeStreams(streamIds: string[]) 说明：订阅流，订阅成功如果产生新的消费者需手动监听streamSubscribed 参数： streamIds: string[] 返回：无监听：streamSubscribed，返回peerInfo, peerInfo信息如下 JRTCRoom.on('StreamSubscribed', ({ streamInfo}) => { console.log(stream}) Info)

参数	说明
peerId	用户Id
nickName	昵称
audioTrack	audioTrack
videoTrack	videoTrack

unSubscribeStreams()

JRTCRoom.unSubscribeStreams(streamIds: string[]) 说明：取消订阅参数： streamIds: string[] 返回：无

pausePublish()

JRTCRoom.pausePublish(streamId) 说明：暂停发布参数： streamId 返回：无

resumePublish()

JRTCRoom.resumePublish(streamId) 说明：恢复发布参数： streamId 返回：无

pauseSubscribe()

JRTCRoom.pauseSubscribe(streamId) 说明：暂停订阅参数： streamId 返回：无

resumeSubscribe()

JRTCRoom.resumeSubscribe(streamId) 说明：恢复订阅参数： streamId 返回：无

sendMessage()

JRTCRoom.sendMessaage({msg: string, peerId?: string}) 说明：发送消息，可发送给指定人，可发送消息到房间参数：msg: 消息体， peerId: 指定peerId 返回：无

changeNickName()

JRTCRoom.changeNickName(nickName: string) 说明：修改昵称参数： nickName 返回：无监听：NickNameUpdate, 返回 {roomId: string, peerId: string, nickName: string}

enableStreamStat()

JRTCRoom.enableStreamStat(isStat, intervalSec) 说明：监控接口参数：

参数	说明	类型
isStat	是否开启监控	boolean
interValSec	几秒获取一次监控信息	number

返回：{ JRTCNetStats, JRTCLocalStreamStats, JRTCRemoteStreamStats }

参数	说明	类型
JRTCNetStats	基本信息	`{localIp：XX，serverIp： XX}`
JRTCLocalStreamStats	本地流信息	`{peerId: XX,streamId: XX,kind: XX,rtt: XX,netLoss: XX,frameWidth: XX,frameHeight: XX,fps: XX}`
JRTCRemoteStreamStats	远端流信息	`{ peerId: XX,streamId: XX,kind: XX,jitterBufferDelay: XX,netLoss: XX,jitterBufferDelay: XX,netLoss: XX,frameWidth: XX,frameHeight: XX,fps: XX}`

getFixedAudioConsumers()

JRTCRoom.getFixedAudioConsumers() 说明：如果房间为大房间，可获取大房间固定音频，可自行订阅参数：无返回：fixedAudioConsumerList fixedAudioConsumerList：

参数	说明
streamId	流ID
kind	媒体类型
track	音频track

会控相关接口

removePeer

JRTCRoom.removePeer(targetPeerId, appData) 说明：移除指定用户参数说明：

参数	类型	是否必须	说明
targetPeerId	string	Y	移除目标用户ID
appData	Object	N, 默认为 {}	自定义参数

muteAudio

JRTCRoom.muteAudio({targetPeerId, appData}) 说明：广播房间内全局静音/指定用户静音参数说明：

参数	类型	是否必须	说明
targetPeerId	string	N	目标用户ID，如果传入targetPeerId则为指定用户操作，不传则是对房间全局操作
appData	Object	N ,默认为 {}	自定义参数

closeVideo

JRTCRoom.closeVideo()

说明：广播房间内全局关闭视频/关闭指定用户视频

参数说明：同muteAudio

forbidChat

JRTCRoom.forbidChat(appData) 说明：广播房间禁言参数说明：

参数	类型	是否必须	说明
appData	Object	N ,默认为 {}	自定义参数

unForbidChat

JRTCRoom.unForbidChat() 说明：广播房间解除禁言参数：同forbidChat

customSignal

JRTCRoom.customSignal() 说明：广播用户自定义信令参数说明：

参数	类型	是否必须	说明
eventName	string	Y	自定义信令名称
targetPeerId	string	N	目标用户ID
appData	Object	N ,默认为 {}	自定义参数

JRTCRoom房间内消息监听

UserJoinedRoom

JRTCRoom.on('UserJoinRoom', (data: {peerId:  string, nickName: string}) => {})

说明：加入房间

UserLeavedRoom

JRTCRoom.on('UserLeaveRoom', (data: {peerId:  string, nickName: string}) => {})

说明：离开房间

NickNameUpdated

JRTCRoom.on('NickNameUpdate', (data: {roomId: string, peerId:  string, nickName: string}) => {})

说明：用户修改昵称

MessageRecived

JRTCRoom.on('MessageRecived', (data: {peerId: string, nickName: string, msg: string}) => {})

说明：有成员发送消息时

参数	说明
peerId	发送者id
nickName	发送者昵称
msg	消息体

StreamPublished

JRTCRoom.on('StreamPublished', (streamsInfo: streamInfo[]) => {
let streamIds = streamInfos.map(streamInfo => streamInfo.streamId);
      console.log('StreamPublished', streamIds)
      JRTCRoom.subscribeStreams(streamIds) // 可选择订阅
    })

说明：有新流发布 streamsInfo:,已发布流数组 streamInfo[]: streamInfo信息如下:

参数	说明
peerId	用户Id
streamId	流ID
kind	流类型
streamName	流名称

StreamUnpublished

JRTCRoom.on('StreamUnpublished', (streamInfo: StreamInfo) => {
      console.log('StreamUnpulished', streamInfo) // 返回取消发布的流信息
    })

说明：当有成员取消音频或视频发布时 StreamInfo:

参数	说明
peerId	用户Id
streamId	流ID
kind	流类型

StreamPaused

JRTCRoom.on('StreamPaused', (streamInfo: StreamInfo) => {
      console.log('StreamPaused', streamInfo) // // 返回目标消费信息
    })

说明：当有成员暂停音频或视频发布时，返回StreamInfo信息如下

参数	说明
roomId	房间ID
peerId	暂停流发布的用户Id
streamId	流ID
kind	流类型

StreamResumed

JRTCRoom.on('StreamResumed', (streamInfo: StreamInfo) => {
      console.log('StreamResumed', streamInfo) // 返回目标消费信息
    })

说明：当有成员恢复音频或视频发布时，返回StreamInfo信息如下

参数说明

参数	说明
roomId	房间ID
peerId	恢复流发布的用户Id
streamId	流ID
kind	流类型

会控相关监听

UserRemoved

JRTCRoom.on('UserRemoved', (data: {peerId:  string, nickName: string}) => {})

说明：某个用户被移出房间

AudioMuted

JRTCRoom.on('AudioMuted', (data: {peerId:  string, nickName: string}) => {})

说明：某个用户被静音

RoomAudioMuted

JRTCRoom.on('RoomAudioMuted', (data: {peerId:  string, nickName: string}) => {})

说明：房间被静音

VideoClosed

JRTCRoom.on('VideoClosed', (data: {peerId:  string, nickName: string}) => {})

说明：某个用户视频被关闭

RoomVideoClosed

JRTCRoom.on('RoomVideoClosed', (data: {peerId:  string, nickName: string}) => {})

说明：房间被关闭所有视频

RoomChatForbidden

JRTCRoom.on('RoomChatForbidden', (data: {peerId:  string, nickName: string}) => {})

说明：房间禁止所有文字聊天

RoomChatUnForbidden

JRTCRoom.on('RoomChatForbiddenlosed', (data: {peerId:  string, nickName: string}) => {})

说明：房间取消禁言

SignalCustom

JRTCRoom.on('RoomChatForbiddenlosed', (data: {peerId:  string, nickName: string, eventName}) => {})
说明：用户自定义信令

3. JRTCMsg

如若开启消息大厅模式：通过JRTCMsg对象来发送和监听大厅消息
消息大厅初始化成功后, 会返回一个Msg实例: 也可在initBroadcast成功后通过调用 JRTCMsg = JWebrtc.getMsgObj() 来获取JRTCMsg对象JRTCMsg

sendMessage()

JRTCMsg.sendMessage({msg: string, peerId?: string}) 说明：发送消息，可发送给指定人，可发送广播消息参数：msg: 消息内容， peerId: 指定peerId 返回：无

JRTCMsg消息大厅消息监听

BroadcastMessageRecived

JRTCMsg .on('BroadcastMessageRecived', (data) => {})

data: {requestId: XXXXX, peerId: string, data: string}

参数	说明
requestId	requestId
peerId	发送者ID
data	消息内容

说明：收到大厅消息，广播消息或单聊消息

js-md5 mediasoup-client socket.io-client

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

H5-API

1.JRTCClient

init(JRTCInitParams)

getPeerId()

setVideoEncodingParam()

setAudioCodecOptions()

getVideoTrack()

getAudioTrack()

getScreenTrack()

createRoom()

enterRoom()

exitRoom()

initBroadcast()

错误监听

2.JRTCRoom

publishVideoStream()

publishAudioStream()

unPublishStream()

subscribeStreams()

unSubscribeStreams()

pausePublish()

resumePublish()

pauseSubscribe()

resumeSubscribe()

sendMessage()

changeNickName()

enableStreamStat()

getFixedAudioConsumers()

会控相关接口

removePeer

muteAudio

closeVideo

说明：广播 房间内全局关闭视频/关闭指定用户视频

forbidChat

unForbidChat

customSignal

JRTCRoom房间内消息监听

UserJoinedRoom

UserLeavedRoom

NickNameUpdated

MessageRecived

StreamPublished

StreamUnpublished

StreamPaused

StreamResumed

参数 说明

会控相关监听

UserRemoved

AudioMuted

RoomAudioMuted

VideoClosed

RoomVideoClosed

RoomChatForbidden

RoomChatUnForbidden

SignalCustom

3. JRTCMsg

sendMessage()

JRTCMsg消息大厅消息监听

BroadcastMessageRecived

说明：广播房间内全局关闭视频/关闭指定用户视频

参数说明