JS SDK
  • 帮助与文档 点播 播放SDK JS SDK

    概述

    应用场景支持:PC(web浏览器),移动(H5)场景播放
    使用说明

    PPCloud客户 Customer:在PPCloud上注册的客户,并借助PPCloud平台,分销自己的视频产品

    PPCloud用户 Client:观看或者消费PPCloud的视频产品的用户

    PPCPlayer是自适应的多终端播放器

    PPCloud HTML5播放器 H5Player:适应移动设备的播放器

    PPCloud PC播放器 PCPlayer:适用于支持Adobe Flash Plyer的终端设备,不适用在Android平台

    注:上述名词定义仅仅是用于区分JSSDK接口和相关的事件

    适用Demo地址:http://v-pptvyun.suning.com/jssdk/v5

    player.min.js 下载地址: http://static9.suning.com/cloud_platform/ppKit/release/js/player/v6/v_20181226160602/player.min.js

    使用例子:

    
    var ppcplayer = new PPCLoudplayer({
        id: 'bgvid',//播放器容器ID
        playCode:'0a2dnq-Xo6icmq6L4K2koqvho6CdnKaeoQ',
        //playSrc:"http://m4.suning.com/*.mp4",
        poster:"http://***/*.jpg",
        autoplay: 1,
        rotate:0,	
        events: {
            afterPlayerShow: function() {},			
            onPlay: function() {},
            onPause: function() {},
            onEnd:function(obj){
                console.log('播放结束事件');
            }
        },
        //video原生事件回调
        origEvents: { 
            onPlay: function(obj) {},
            onPause: function(obj) {},
            onLoadedmetadata: function(obj) {}
        }
    });
                        

    JSSDK方法需要在播放器初始化完成后调用,调用方法如下:

    
    ppcplayer.play();ppcplayer.pause();ppcplayer.getDuration();
                        

    浏览器支持

    PC端
    IE7+, Firefox 4+, Chrome, Safari 4+, and Opera 11+
    (建议使用火狐,chrome,和 IE9 以上的浏览器)
    移动端
    直播、点播播放器经验证支持的iPhone机型有:6plus、6s、6、5s、5、5c、SE,系统环境:9.3.2直播、点播播放器经验证支持的安卓机型
    有:小米2S、小米4、华为P6、魅族MX4,浏览器:自带浏览器、QQ浏览器
    (其中小米2S,用自带浏览器打开点播、直播,在全屏状态下,不能点击“pause”方法)
    注:其它未经测试验证的机型及浏览器,在实际使用时可能会存在兼容性问题。

    API描述

    重要属性
    属性名
    值的类型
    描述
    id String 播放器父节点的id
    playCode String 视频的播放串
    autoplay int 1自动播放,0否
    isMute Boolean 播放器初始化时是否静音,
    true:静音 false:不静音
    isEffect(pc) Boolean 是否开启控制菜单自己隐藏
    playSrc String 指定白名单mp4播放
    (使用此参数播放pc优化使用H5播放)
    audio 0/1 值为1时可使用playSrc播放声音文件
    poster String 播放器封面
    isDebug Boolean 是否为开发模式,
    true, 开发模式
    false,发布模式,为默认值
    Webconfig {
    buskin:'*.swf',
    showShare:"",
    watermark:{
    //lefttop*righttop*leftbottom*rightbottom
    diaphaneity:1,
    align:"rightbottom"
    },
    logo:{
    //0左1右;diaphaneity透明度0-1
    pos:0,
    diaphaneity:0.9,
    }
    }
    Pc播放器样式修改
    extraTip {
    //是否显示
    show:false,
    //提示内容
    extraTipContent:'提示内容',
    //提示ICON
    extraTipIcon:'../icon.png',
    //提示的显示时长
    extraTipDuration:5000
    }
    提示层相关的配置
    subTitles Array 
    参数描述:
    [{
    src: 'lines/AliceGoffman_ch.vtt',
    lang: 'ch',
    label: 'Chinese',
    isDefault: true
    },
    {
    src: 'lines/AliceGoffman_en.vtt',
    lang: 'en',
    label: 'English'
    }]
    src: 字幕地址
    lang: 字幕语言简称(en,ch)
    label:字幕语言全称
    isDefault: 一定要写,作为默认语言(true/false)
    需要配置所有需要支持的字幕
    callLineBack Function 参数说明:
    1. currentTime,当前时间 
    2. content, 当前时间显示的字幕内容
    字幕回调函数
    reportVideoEvent Function
    参数描述:
    0 = HAVE_NOTHING -没有关于播放器是否就绪的信息
    1 = HAVE_METADATA - 关于播放器就绪的元数据
    2 = HAVE_CURRENT_DATA -关于当前播放位置的数据是可用的,但没有足够的数据来播放下一帧/毫秒
    3 = HAVE_FUTURE_DATA -当前及至少下一帧的数据是可用的
    4 = HAVE_ENOUGH_DATA - 可用数据足以开始播放
    当isDebug设置为true,
    reportVideoEvent用来调试。
    函数的参数:
    Event:Event,
    obj = {
    type:事件名称,
    msg:提示信息,
    readyState:属性返回播放器的当前就绪状态
    }
    errorCall Function
    参数描述:
    1 = MEDIA_ERR_ABORTED - 取回过程被用户中止
    2 = MEDIA_ERR_NETWORK - 当下载时发生错误
    3 = MEDIA_ERR_DECODE - 当解码时发生错误
    4 = MEDIA_ERR_SRC_NOT_SUPPORTED - 不支持音频/视频
    播放器出错的时候,执行此函数。
    函数的参数:obj = {
    type:事件名称,
    msg: 提示信息,
    readyState:属性返回播放器的当前就绪状态
    }
    origEvents Object Video原生的事件监听
    events Object 事件回调函数 
    数据结构: 
    {
    onPlay: function(){},
    onPause: function(){},
    onStop: function(){},
    onFullScreen:function(){},
    afterPlayerShow:function(){},
    onQuitFullScreen:function(){}
    };
    注:H5Player,暂不支持onQuitFullScreen事件

    方法
    方法名
    值的类型
    描述
    play Object { playStr:***, mp4:*** } 播放视频
    {playStr:播放串}切换当前播放视频
    {mp4:视频地址}直播播放视频地址
    pause 无 暂停视频
    seekPlay number Posi播放位置,秒
    getCurrentTime 无 返回当前播放位置、秒
    getDuration 无 返回视频时长、秒
    swicthPlay {playStr:"播放串"} 播放串
    setPlayBackRate 设置播放速度 
    参数说明:
    1. playBackRate, 取值范围在[0.5, 2]
    设置播放速度
    changeSubtitle 切换字幕 
    参数说明:
    1. lang,和属性subTitles中的lang保持一致
    切换字幕
    fullScreen 无 视频最大化 
    注:PCPlayer暂不支持
    getStatus 无 获取播放器当前状态 
    注:H5Player暂不支持
    getVolume 无 获取播放器音量 
    注:H5Player暂不支持
    setMute Boolean 设置是否静音, 
    注:H5Player暂不支持 
    如果设置true就是静音,如果设置false就是打开音量

    常见问题

    chrome不能自动播放视频的问题,目前我们的解决方案:
    建议播放器是16:9的比例,例如播放器的长800px,宽450px,虽然chrome没有明确给出相关说明,但是如果播放器的长度大于600px,播放器的宽度根据16:9的比例去计算,chrome是不会阻止播放器进行播放的。
    目前PC Chrome63 版本已上H5不能自动播放问题解决方案初始化的时候设置视频为静音播放进,可自动播放
    • 文本导读:
    • 浏览器支持
    • API描述
    • 常见问题
苏宁视频云服务