Web接口列表

本文介绍Web端SDK提供的类和方法。

重点接口类简介

  • RoomEngine:Room的全局管理类单例,需要全局初始化一次,负责鉴权、登入、登出等。

  • RoomChannel:提供互动直播PaaS关于直播间以及插件能力调用。

方法列表

RoomEngine方法

方法

参数

描述

getInstance

创建RoomEngine实例

init

config

初始化config数据

auth

userId

鉴权登录

logout

登出

getRoomChannel

roomId

获取RoomChannel实例

getDeviceId

获取deviceId(当前会话下的设备ID)

getRoomList

pageIndex、pageSize

获取直播间列表

pageIndex从1开始,其他接口相同

RoomChannel方法

方法

参数

描述

getPluginService

pluginId

获取各个插件实例

pluginId:'live','chat','rtc'

enterRoom

nick

进入直播间并获取直播间信息,返回值为roomDetail

getRoomDetailAsync

异步获取直播间信息

getRoomDetail

获取保存的直播间信息,进入直播间后可用

leaveRoom

roomId

离开直播间

updateNotice

notice

更新直播间公告

updateTitle

title

更新直播间标题

listUser

pageIndex、pageSize

分页获取直播间用户在线列表

kickUser

userId

踢出直播间用户

getDockey

获取白板Dockey,如果没有就创建一个

ChatService方法

方法

参数

描述

getChatDetail

获取互动详情

sendComment

comment

发送弹幕

sendLike

点赞

内置合流操作,两秒执行一次发送点赞,集合所有期间的点赞数。

listComment

sortType、pageIndex、pageSize

分页拉取弹幕

sortType:排序方式。

  • 0:时间递增顺序。

  • 1:时间递减顺序。

muteAllUser

全体弹幕禁言

cancelMuteAllUser

取消全体弹幕禁言

muteUser

userId、muteSeconds

禁言某个用户

cancelMuteUser

userId、muteSeconds

取消某个用户的禁言

LiveService方法

方法

参数

描述

getLiveDetail

获取直播详情

setPlayerConfig

config、extPlayerOptions

设置播放器创建参数

具体设置参数请参见播放器参数

tryPlayLive

开始尝试拉流播放

switchPlaySource

url

切换直播源

startPlay

播放器开始播放

pausePlay

播放器暂停播放

播放器参数

// config 基础参数
interface IPlayerBaseParms {
  container: string; // dom容器的id
  playUrl: string; // 播放地址
  isLive?: boolean; // 是否直播
}
// extPlayerOptions 额外参数
interface IExtPlayerOptions {
  id: string;
  source: string;
  useH5Prism: boolean;
  autoplay: boolean;
  preload: boolean;
  isLive: boolean;
  width: string;
  height: string;
  waitingTimeout?: number;
  playsinline?: boolean;
  skinLayout?: any;
  rePlay?: boolean;
  controlBarVisibility?: string;
  playerShortCuts?: boolean;
  aliplayerSdkVer?: string;
}

RtcService方法

方法

参数

描述

getDeviceInfo

获取设备信息

startRtcPreview

video

开始摄像头预览

video: HTML video Dom实例

startPublish

开始RTC推流

startPublishScreen

发布屏幕流

stopPublishScreen

结束发布屏幕流

stopPublish

url

结束RTC推流

subscribe

userId

订阅流

subscribeScreen

userId

订阅屏幕流

unSubscribe

userId

取消手动订阅

setAutoSubscribe

isAutoSubscribe

设置自动订阅

只能在未进入频道时设置。

listConfUser

pageIndex、pageSize

获取会议成员列表

listApplyLinkMicUser

pageIndex、pageSize

获取申请连麦成员列表

getChannelDetail

获取RTC会议详情

joinChannel

nick

RTC进入频道

startRoadPublish

开始旁路推流

stopRoadPublish

结束旁路推流

setLayout

userIds、model

设置旁路推流的layout

model取值:

  • 1:一宫格。

  • 2:一大四小。

  • 3:九宫格。

leaveSeat

断开连麦

applyJoinChannel

apply

申请连麦

handleApplyJoinChannel

userId,approve

处理连麦申请

approve之后被申请方需要主动invite。

inviteJoinChannel

userModels

邀请连麦

kickUserFromChannel

kickedUserList

踢出指定用户

switchCamera

deviceId

切换摄像头

setMutePush

mute

设置静音推流

返回值为true代表设置成功。

setMuteCamera

mute

设置是否关闭摄像头推流

返回值为true代表设置成功。

leaveRtc

needDestroy

离开RTC频道

事件列表

RoomChannel事件

事件名称

描述

'room.service.enterRoom'

app层调用进入直播间

'room.service.leaveRoom'

app层调用离开直播间

'paas.room.enter'

服务端进入直播间

paas.room.changeTitle'

修改直播间标题

'paas.room.changeNotice'

修改直播间公告

'paas.room.kickUser'

踢出用户

ChatService事件

事件名称

描述

'paas.chat.reciveComment'

服务端收到弹幕

'paas.chat.reciveLike'

服务端收到点赞

'paas.chat.muteUser'

服务端禁言用户

LiveService事件

事件名称

描述

'paas.live.publish'

直播开始

'paas.live.stop'

直播结束

'service.live.playerEvent'

播放器事件

播放器事件列表
const H5_PLAYER_EVENTS = {
    VIDEO_ABORT: 'video:abort',
    VIDEO_ENDED: 'video:ended',
    VIDEO_ERROR: 'video:error',
    VIDEO_PLAY: 'video:play',
    VIDEO_PLAYING: 'video:playing',
    VIDEO_PROGRESS: 'video:progress',
    VIDEO_LOADSTART: 'video:loadstart',
    VIDEO_LOADEDMETADATA: 'video:loadedmetadata',
    VIDEO_SUSPEND: 'video:suspend',
    VIDEO_STALLED: 'video:stalled',
    VIDEO_WAITING: 'video:waiting',
    VIDEO_CANPLAY: 'video:canplay',
    VIDEO_CANPLAYTHROUGH: 'video:canplaythrough',
    VIDEO_TIMEUPDATE: 'video:timeupdate',
    VIDEO_VOLUMECHANGE: 'video:volumechange',
    VIDEO_SEEKING: 'video:seeking',
    VIDEO_SEEKED: 'video:seeked',
    VIDEO_PAUSE: 'video:pause',
    VIDEO_RATECHANGE: 'video:ratechange',
    VIDEO_REALPLAY: 'video:realPlay',
    VIDEO_EXITFULLSCREEN: 'video:exitFullscreen',
    VIDEO_ENTERFULLSCREEN: 'video:enterFullscreen',
};

RtcService事件

事件名称

描述

'paas.rtc.joinSuccess'

进入频道成功

'paas.rtc.joinFailed'

进入频道失败

'paas.rtc.leaveChannel'

离开频道

'paas.rtc.kickUser'

踢出用户

'paas.rtc.confStart'

开始会议

'paas.rtc.confStop'

结束会议

'paas.rtc.invite'

用户被邀请

'paas.rtc.refuse'

用户被拒绝

'paas.rtc.apply'

有用户申请

'onSubscribeResult'

RTC订阅用户结果消息

其他RTC事件请参见回调及监听