acc5GSJC

来自于:开发者立即使用

概述

acc5GSJC模块封装了展视互动平台的直播和点播SDK,使用此模块可实现在线课堂的直播和点播功能。

使用展视互动基本流程说明: 1.在展视互动网站( http://www.gensee.com/ )申请账号试用。

playGS

打开一个直播或点播

playGS({params},function(ret,err))

params

uid

  • 类型:数值型(0-100000000000)
  • 描述:自定义的uid。

domain

  • 类型:字符串
  • 描述:从展视互动申请到的域名。

account

  • 类型:字符串
  • 描述:从展视互动申请到的账号。

accountPwd

  • 类型:字符串
  • 描述:从展视互动申请到的账号密码。

room

  • 类型:数值型
  • 描述:直播或者点播的房间号。

joinPwd

  • 类型:字符串
  • 描述:用户加入房间需要的密码。
          drect: {x:0,y:0,w:300,h:200},//文档的大小位置
          vrect: {x:0,y:200,w:100,h:100},//摄像头的大小位置
    

nickName

  • 类型:字符串
  • 描述:昵称。

fixedOn

  • 类型:字符串类型
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认:模块依附于当前 window

switchFlag

  • 类型:布尔型
  • 描述:是否可以切换摄像头和文档的显示位置,true可以切换,false不可以。
  • 默认:false。

isVod

  • 类型:布尔值
  • 描述:设置当前打开的是直播还是点播,true为点播,false为直播。
  • 默认值:false。

vrect

  • 类型:JSON 对象
  • 描述:(可选项)摄像头区域的位置及尺寸
  • 内部字段:
  • {
    • x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
    • y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
    • w: 320, //(可选项)数字类型;模块的宽度;默认:所属的 Window 或 Frame 的宽度
    • h: 300 //(可选项)数字类型;模块的高度;默认:w的3/4 }

drect

  • 类型:JSON 对象
  • 描述:(可选项)文档区域的位置及尺寸
  • 内部字段:
  • {
    • x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
    • y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
    • w: 320, //(可选项)数字类型;模块的宽度;默认:所属的 Window 或 Frame 的宽度
    • h: 300 //(可选项)数字类型;模块的高度;默认:w的3/4 }

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:


    {    
        cmd:"",//onJoin加入成功;onRosterTotal返回观看人数;didUserJoin用户加入;didUserLeave用户离开;screenStatus老师屏幕分享和摄像头切换时会调用
        sendMsgStatus:1,//1 信息发送成功;0 信息发送失败
        type:'public',//仅当type==1&&sendMsgStatus==1有聊天信息回调
        nickName:'',//仅当type==1&&sendMsgStatus==1有值,发言者的昵称
        chatId,'',//仅当type==1&&sendMsgStatus==1有值,发言id
        senderId,//仅当type==1&&sendMsgStatus==1有值,发言者id
        role,//仅当type==1&&sendMsgStatus==1有值,发言者角色
        msg,//仅当cmd=onRosterTotal有值,为观看人数
    }

示例代码


    var acc5GSJC=api.require('acc5GSJC');
    acc5GSJC.playGS({
            uid: 0, //用户自定义的id,可根据自家数据库用户的id给定此值
            domain: "xx.gensee.com",//从展视互动申请到的域名
            account: "xx@xx.com",//从展视互动申请到的账号
            accountPwd: "pwd123456",//账号密码
            room: "90000000",//房间号
            joinPwd: "123456",//房间密码
            nickName: '',昵称//
            fixedOn: api.frameName,//当前frame的名字
            switchFlag:true,//文档和摄像头互换,true为可以,false 为不可以
            isVod:true,//true当前是点播;false当前是直播;
            drect: {x:0,y:0,w:300,h:200},//文档的大小位置
            vrect: {x:0,y:200,w:100,h:100},//摄像头的大小位置
    },function(ret,err){
        alert(JSON.stringify(ret));
    })

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

close

关闭直播或者点播

close()

示例代码


    var acc5GSJC=api.require('acc5GSJC');
    acc5GSJC.close()

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

changeVisible

设置视频区域和文档区域的显示与隐藏

params

type

  • 类型:字符串
  • 描述:要隐藏的区域,doc为文档区域,video为视频区域。

isShow

  • 类型:数值类型
  • 描述:显示或者隐藏,0为隐藏,1为显示。

changeVisible({params},function(ret,err))

示例代码


    var acc5GSJC=api.require('acc5GSJC');
    acc5GSJC.changeVisible({
        type: 'doc',
        isShow: 1
    })

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

sendMsg

发送聊天消息。

sendMsg({params},function(ret,err))

params

content

  • 类型:字符串
  • 描述:聊天消息纯文本。

richtext

  • 类型:数值类型
  • 描述:聊天消息富文本。

示例代码


    var acc5GSJC=api.require('acc5GSJC');
    acc5GSJC.sendMsg({
        content:'test',
        richtext:'<span style="color:red">test</span>'

    },function(ret,err){
        alert(JSON.stringify(ret));
    })

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

fullscreen

文档区域全屏显示

fullscreen()

示例代码


    var acc5GSJC=api.require('acc5GSJC');
    acc5GSJC.fullscreen()

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

cancelFullscreen

文档区域取消全屏

cancelFullscreen()

示例代码


    var acc5GSJC=api.require('acc5GSJC');
    acc5GSJC.cancelFullscreen()

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setRect

设置文档或者摄像头区域的位置及大小

setRect({params})

params

type

  • 类型:字符串
  • 描述:要设置的区域,video为摄像头区域,doc文档区域。

rect

  • 类型:JSON 对象
  • 描述:(可选项)文档或摄像头区域的位置及尺寸
  • 内部字段:
  • {
    • x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
    • y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
    • w: 320, //(可选项)数字类型;模块的宽度;默认:所属的 Window 或 Frame 的宽度
    • h: 300 //(可选项)数字类型;模块的高度;默认:w的3/4 }

示例代码


    var acc5GSJC=api.require('acc5GSJC');
    acc5GSJC.setRect({ 
        type: 'video',//video摄像头区域,doc文档区域
        rect: {x:0,y:0,w:300,h:200}
    });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

seek

点播播放的位置

seek({params})

params

pos

  • 类型:int
  • 描述:点播播放的位置,单位为毫秒。

示例代码


    var acc5GSJC=api.require('acc5GSJC');
    acc5GSJC.seek({
        pos:10*1000,//仅当playGS()时isVod==true才有效,因为只有是点播的时候才知道视频的时长,才能查找
    })

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

switchDV

文档和摄像头区域互换位置大小,仅当playGS()中switchFlag==true时有效

switchDV()

示例代码


    var acc5GSJC=api.require('acc5GSJC');
    acc5GSJC.switchDV()

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本