Player API 开发指南版本: 1.0.6
⽇日期: 2017-6-30
创盛视联数码科技(北北京)有限公司(CC视频)
⽬目录
...................................................................................................................................
1. 概述1
............................................................................................................................
2. 接⼝口说明1
............................................................................................................................
3. 配置说明2
............................................................................................................................
4. 插件介绍5
......................................................................................................................................................
4.1 字幕插件5 4.2 弹幕插件6
......................................................................................................................................................
...................................................................................................................................................
4.3 跑⻢马灯插件7
.............................................................................................................................................. 4.4问答功能插件10附录 1. Flash和Javascript交互11
............................................................................................
..........................................................................................................附录 2. 播放器器错误码13
1. 概述
利利⽤用 Player API 与 CC视频播放器器进⾏行行交互,可以改变播放器器界⾯面、实现⼀一些增值功能。
⽬目前仅限于Flash播放器器,FlashPlayer插件版本要求为10.1及以上,播放器器⻚页⾯面代码中必须允许播放器器与⻚页⾯面脚本通信。
2. 接⼝口说明
接⼝口分为两种类型:⽅方法、回调;
⽅方法:播放器器开放的JavaScript函数,播放器器的句句柄需要⽤用Object标签的id属性或embed的name属性来获取;回调:播放器器运⾏行行过程中尝试调⽤用⻚页⾯面JS函数,可理理解为事件。
使⽤用⽅方法可参考附录1. Flash与JavaScript交互;
接⼝口类型说明
start()⽅方法开始播放
pause()⽅方法暂停播放
resume()⽅方法恢复播放
seek(time)⽅方法定位⾄至指定时间
参数 time 单位秒
getDuration()⽅方法获取视频⽚片⻓长,返回值单位秒
getPosition()⽅方法获取当前播放时间,返回值单位秒
getQualities()⽅方法获取当前视频可⽤用清晰度列列表,返回类型 Array,
格式如下:
[ { value:"0" , label:"普通" } , { value:"1" , label:"清晰" } ] setQuality(quality)⽅方法设置清晰度
参数 quality 为 getQualities⽅方法获取的value值
setVolume(volume)⽅方法设置⾳音量量
参数 volume 取值范围0-1
normalScreen()⽅方法退出全屏
setConfig(config)⽅方法配置播放器器
参数 config 为配置对象,详⻅见3. 配置说明
on_cc_player_init(vid,swfID)回调播放器器界⾯面元素初始化时
vid : 视频唯⼀一标识
swfID : ⻚页⾯面中播放器器的id
3. 配置说明
播放器器配置可以改变播放器器的界⾯面,开启更更多的回调接⼝口,还可以使⽤用⼀一些特殊的功能,如⾃自定义全屏、字幕功能。
配置的⽅方法是在回调接⼝口 on_cc_player_init 触发时,调⽤用 setConfig ⽅方法传递⼀一个 Object 对象,此对象每个 key 都是⼀一个配置项,对应的 value 就是所配置的值。
播放器器所⽀支持的配置项如下:on_cc_player_pluginready(name)回调插件准备就绪,意味着该插件相关接⼝口可⽤用
name : 插件名称
fast_forward_time(time)⽅方法设置快进快退速率。参数:time>1则以time 值为准,
0<time<1则以总时⻓长的百分⽐比为准;
getTitle()⽅方法
获取标题。返回类型:字符串串。getValidQuality()⽅方法获取当前播放视频的清晰度列列表。返回值:Array();getZScale()⽅方法获取当前视频窗⼝口的缩放值。返回值:Number ;setZScale(value)⽅方法设置当前视频窗⼝口的缩放。
参数:value:Number;最⼤大值时1,最⼩小值是0;
setScale(value)⽅方法设置当前视频画⾯面的⽐比例例。
参数:value:String ‘full’=全屏 ‘scale43’=画⾯面4⽐比3
‘scale169’=画⾯面16⽐比9 ‘original’=原始⽐比例例
getScale()⽅方法获取当前视频画⾯面的⽐比例例。
返回值 类型:String;
clipVideoImage()⽅方法
给视频截图并且保存到本地。接⼝口
类型说明配置项
说明control_enable 是否显示控制条
默认1,设置为0则不不显示控制条
配置项说明
progressbar_enable是否可操作进度条
默认1,设置为0则进度条不不可操作
loadingpic_enable是否启⽤用缓冲⽚片头
默认1,设置为0则不不会出现缓冲⽚片头
loading_enable是否显示loading图标
默认1,设置为0则不不显示loading图标
bigbutton_enable是否显示⾮非⾃自动播放时出现的开始按钮和暂停时的⼤大播放按钮
默认1,设置为0则不不显示
如需要单独控制请使⽤用 startbutton_enable,resumebutton_enable startbutton_enable是否显示⾮非⾃自动播放时出现的开始按钮
默认1,设置为0则不不显示
resumebutton_enable是否显示暂停时的⼤大播放按钮
默认1,设置为0则不不显示
tip_enable是否可显示播放器器顶部的提示条
默认1,设置为0则不不再出现提示条
alert_enable是否可显示播放器器中间的提示⾯面板
默认1,设置为0则不不再出现提示⾯面板
recommend_enable是否启⽤用播放结束后的推荐界⾯面
默认1,设置为0则播放结束后不不显示推荐界⾯面
keyboard_enable是否启⽤用按键操作
默认1,设置为0则按键操作不不可⽤用
rightmenu_enable是否启⽤用右侧菜单
默认1,设置为0则不不显示右侧菜单
fullscreen_enable 是否使⽤用⾃自定义全屏操作
默认0,设置为1可以替代Flash全屏
play_start_time设置开播的时间点,单位秒,如果超出视频时⻓长会按0处理理,
flash swf播放器此配置项能够使接着上次观看功能失效
fullscreen_function替代Flash全屏的JS函数的名称,需 fullscreen_enable 设置为1,
这个函数需要返回⼀一个值以确定当前状态(0:正常,1:全屏) video_marks配置视频打点数据,此配置项的值是⼀一个数组,格式如下:
[ { time : time , desc : desc } ]
time 为视频时间,单位秒;desc 为对应时间的打点说明
video_marks_json_url配置视频打点数据接⼝口地址,优先级⾼高于 video_marks,
接⼝口必须返回JSON数据,格式如下:
{ value : [ { time : time , desc : desc } ] }
player_plugins配置播放器器插件,详⻅见4. 插件介绍
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论