控制接口
更新时间：2024-08-02
| 接口 | 参数列表 | 返回类型 | 接口功能 | 代码示例 |
|---|---|---|---|---|
| cyberplayer | String - 播放器DIV容器的id，用于盛放播放器 | Object | 在指定的DIV容器内创建一个播放器实例。 | var myPlayer =cyberplayer("playerContainer").setup({width:600,height:450,file:"http://ip:port/playlist.m3u8",image: "<Image_File>"}); |
| cyberplayer::setup | Object | 无 | 创建一个播放器。 | var myPlayer = cyberplayer("playerContainer").setup({flashplayer:"player/cyberplayer.flash.swf ", width:600,height:450,file:" http://ip:port/playlist.m3u8",image: "<Image_File> controlbar: {barLogo: false}});参数详解见下表 |
| cyberplayer::remove | 无 | 无 | 移除当前播放器。 | myPlayer.remove(); |
| cyberplayer::getPlaylist | 无 | Array | 获取当前的播放列表。 | var playlist = myPlayer. getPlaylist(); |
| cyberplayer::getPlaylistIndex | 无 | Number | 获取当前正在播放视频在播放列表中的位置，0代表第一个，依次类推。 | var playlistIndex = myPlayer. getPlaylistIndex(); |
| cyberplayer::getPlaylistItem | 无 | object | 获取当前正在播放的视频对象。 | var playlistItem = myPlayer. getPlaylistItem(); |
| cyberplayer::playlistItem | Number | object | 播放指定的播放条目，并返回该项对象，条目从0开始计数。 | var item = myPlayer.playlistItem(2); |
| cyberplayer::playlistNext | 无 | Object | 播放当前播放条目的后一项，并返回该项对象。 | var item = myPlayer.playlistNext(); |
| cyberplayer::playlistPrev | 无 | Object | 播放当前播放条目的前一项，并返回该项对象。 | var item = myPlayer.playlistPrev(); |
| cyberplayer::getBuffer | 无 | Object | 获取当前正在播放视频的缓冲时长，单位为秒。 | var buffer = myPlayer. getBuffer(); |
| cyberplayer::getState | 无 | String | 获取当前播放器状态。 | var state = myPlayer.getState();取值范围：{“playing”、“paused”、“idle”、“buffering”} |
| cyberplayer::play | 无 | 无 | 开始播放当前媒体内容。 | myPlayer.play(); |
| cyberplayer::pause | 无 | Number | 暂停播放当前媒体内容。 | myPlayer.pause(); |
| cyberplayer::stop | 无 | 无 | 停止播放当前媒体内容。 | myPlayer.stop(); |
| cyberplayer::getDuration | 无 | Number - 当前播放的媒体文件的总时长 | 获取当前播放的媒体文件的总时长。 | var duration = myPlayer.getDuration(); |
| cyberplayer::getPosition | 无 | Number | 获取当前播放的媒体文件的播放位置。 | var position = myPlayer.getPosition(); |
| cyberplayer::seek | Number - 目标播放时间 | 无 | 定位当前媒体内容开始播放的位置。 | myPlayer.seek(102); |
| cyberplayer::getMute | 无 | Boolean - true : 声音关闭； false : 声音打开 | 获取当前播放器声音是否打开。 | var mute = myPlayer.getMute(); |
| cyberplayer::getVolume | 无 | Number | 获取当前播放器的音量。 | var volume = myPlayer.getVolume(); |
| cyberplayer::setMute | Boolean - true : 关闭声音；false : 打开声音 | 无 | 设置当前播放器的声音开关。 | myPlayer.setMute(true); |
| cyberplayer::setVolume | Number - 音量大小（0-100） | 无 | 设置播放器音量。 | myPlayer.setVolume(90); |
| cyberplayer::getWidth | 无 | Number | 获取当前播放器窗口宽度。 | myPlayer.setVolume(90); |
| cyberplayer::getHeight | 无 | Number - 播放器高度 | 获取当前播放器显示窗口高度。 | var height = myPlayer.getHeight(); |
| cyberplayer::getFullscreen | 无 | Boolean - true : 全屏 ；false : 非全屏 | 获取当前播放器是否处于全屏状态。 | var fullscreen = myPlayer.getFullscreen(); |
| cyberplayer::resize | Number - 播放器宽, Number - 播放器高 | 无 | 调整播放器大小。 | myPlayer.resize(600, 400); |
| cyberplayer::setFullscreen | Boolean - true : 全屏；false : 非全屏 | 无 | 设置当前播放器是否全屏。 | myPlayer.setFullscreen(true); |
| cyberplayer::getQualityLevels | 无 | Array | 获取当前视频的所有码率。 | var qualityLevels = myPlayer.getQualityLevels(); |
| cyberplayer::getCurrentQuality | 无 | Number | 获取当前正在播放视频的码率索引，从0开始。 | var currentQuality = myPlayer.getCurrentQuality(); |
| cyberplayer::getControls | 无 | Boolean | 获得是否能展现播放器的controlbar。 | var controls = myPlayer.getControls(); |
| cyberplayer::getSafeRegion | 无 | Object | 获得播放器的位置对象。 | var region = myPlayer.getSafeRegion(); |
| cyberplayer::setControls | Boolean - true : 显示；false : 不显示 | Object | 设置播放器是否显示controlbar。 | myPlayer.setControls(); |
| cyberplayer::getMeta | 无 | Object - 元数据对象 | 获取当前播放的媒体文件的元数据对象。 | var meta = myPlayer.getMeta(); |
| cyberplayer::getRenderingMode | 无 | String - 渲染模式 | 获取当前播放器的渲染模式。 | var mode = myPlayer.getRenderingMode();取值范围：{“flash”、“html5”} |
| cyberplayer::getCaptionsList | 无 | Array | 获取当前视频的所有字符对象。 | var captionList = myPlayer.getCaptionList(); |
| cyberplayer::getCurrentCaptions | 无 | Number | 获取当前正在使用的字符文件索引，用0开始。 | var currentCaptions = myPlayer.getCurrentCaptions(); |
| cyberplayer::setCurrentCaptions | Number | Object | 设置使用某种特定字幕。 | myPlayer.setCurrentCaptions(1); |
| cyberplayer::setScreenshot | 无 | 无 | 播放器视频截图。 | myPlayer.setScreenshot(); |
| cyberplayer::setCaptureFrameStart | 无 | 无 | 播放器开启视频录制。 | myPlayer.setCaptureFrameStart(); |
| cyberplayer::setCaptureFrameEnd | 无 | 无 | 播放器结束视频录制。 | myPlayer.setCaptureFrameEnd(); |
| cyberplayer::sendDanmu | Object | 无 | 发送弹幕消息。 | myPlayer.sendDanmu({text:'欢迎使用cyberplayer',time:10}); |
| cyberplayer::getHlsCurrentLevel | Object | 无 | 获取当前播放hls分辨率。 | myPlayer.getHlsCurrentLevel(); |
| cyberplayer::setWatermark | Object | 无 | 设置水印样式 | myPlayer.setWatermark({type: 'text', speed: 0.5, content: "这里是水印", opacity: 1,fontSize: '12px',color: '#fff', left: '10px',rotate: '0deg'}); |
| cyberplayer::setLang | String or Object | 无 | 设置多语言 | myPlayer.setLang('en'); |
| cyberplayer::getMediaInfo | 无 | {video:{width:1920,height:1080,code:'avc1.64001f',frameRate:30,playStyle:'flv_live',demuxStyle:'flv',bitRate:500},audio:{bitRate:45,sampleRate:48000,code:''aac}} |
获取音视频分辨率、码流(单位：kbps)、帧率(单位：fps)、编码格式、封装格式 | myPlayer.setLang('en'); |
| cyberplayer::playNext | Object | 无 | 不重新创建播放器内核，设置播放下一个。url为播放链接，starttime设置下一个播放视频起播时间,默认为0 | myPlayer.playNext({url:'XXX.mp4',starttime:10}); |
| cyberplayer::VR | 无 | 无 | 获取VR播放API | 例如：设置移动到特定角度 myPlayer.VR().animateTo({ yaw: 30,pitch:20,fov:30,zoom:5 }, 1000)。其他更多API请参见开发指南实现VR播放章节 |
| cyberplayer::setCues | Array | 无 | 设置打点及缩略图， 更多使用说明请参见开发指南支持打点及缩略图章节 | player.setCues([{ begin: 50, text: '我的信息',img:'./assets/img.jpg',describe:'describe' }]) |
| cyberplayer::on | - | - | 播放器事件监听方法，当执行了某个动作后激活。 | myPlayer.on('play', function () {alert('视频已经播放了');});类似事件有 ready, setupError, playlist, playlistItem, playlistComplete, bufferChange, play, pause, buffer, idle, complete, error, seek, seeked, time, mute, volume, fullscreen, resize, levels, levelsChanged, captionsList, captionsChange, controls, displayClick, meta，performanceInfo, hls_level_updated,rtcEvent,sei_parsed 等。 |
cyberplayer::setup接口参数详解：setup只有一个Object类型的参数，该参数是一个参数集合，该参数集合所包含的参数元素及使用方法如下描述
| 参数名称 | 参数解释 | 备注 |
|---|---|---|
| width | 指定要创建的播放窗口的宽度。 | 必选 |
| height | 指定要创建的播放窗口的高度。 | 必选 |
| playlist | 请参见实现列表播放 | 可选 |
| imageAdvs | 在视频片头、片尾和播放暂停时显示图片广告，支持gif、png、jpeg格式图片。 start是片头广告参数，pause是暂停广告参数，end是片尾广告参数。Image参数表示显示图片地址，url表示链接地址，time表示片头广告显示时长，单位为秒。 暂停广告图片显示时会被缩放到400x300，推荐使用宽高比为4:3的图片作为暂停广告。 imageAdvs : { start : { image : "http://xxxx/abc.gif", url : "http://xxxx", time : 10 }, pause : { image : " http://xxxx/abc.gif ", url : " http://xxxx" }, end : { image : " http://xxxx/abc.gif ", url : " http://xxxx" } } |
可选 |
| autostart | 设置是否在播放器载入后自动播放：true : 自动播放；false : 不自动播放。 | 可选 |
| repeat | 设置视频的重复播放模式，重复模式分为： 1.false:无重复； 2.true:重复播放 |
可选 |
| file | 设置媒体流名称或文件名或M3U8播放列表地址 | 必选 |
| image | 设置媒体流的预览图 | 可选 |
| screenshot | 设置是否支持剪辑，布尔类型，默认false | 可选 |
| volume | 设置播放器音量大小，范围（0 - 100） | 可选 |
| controls | 设置播放器控制条的显示模式，显示模式分为： 1.none:不显示； 2.over:悬浮（鼠标无操作时自动隐藏） |
可选 |
| barLogo | 设置是否显示Logo，controls的子参数，可选值为true (显示)，false（不显示） |
可选 |
| skin | 设置播放器皮肤包 | 可选 |
| useSoftDecoding | 是否使用软解播放 | 可选 |
| liveInfoPanel | 是否显示面板信息，Object类型，参数包括showInfo，默认为false | 可选 |
| stretching | 设置播放器缩放方式，缩放方式分为： 1.none:不缩放； 2.uniform:添加黑边缩放； 3. exactfit:改变宽高比缩到最大； 4.fill:剪切并缩放到最大（默认方式为uniform） |
可选 |
| watermark | 设置水印样式， watermark:{ type:"text", speed:0.5, content:"这里是水印", opacity:1, fontSize:"12px", color:"#fff", left:"10px", bottom:"100px", rotate:"0deg" } |
可选 |
| pictinpict | 设置使用画中画功能，值可为：true or false，默认为false，不显示画中画切换按钮 | 可选 |
| maxBufferLength | 设置最大缓存长度，单位为秒，类型为Number | 可选 |
| playRate | 点播播放时是否展示倍速选择 ，默认为true，可设置为false，不展示倍速选择 | 可选 |
| playRateConfig | 点播播放时，可以配置倍速选择项 。例如：playRateConfig:[{"label":"×1"},{"label":"×2"},{"label":"×3"},{"label":"×4"}] | 可选 |
| RtcPlugin | rtc拉流播放配置项，详情请参见开发指南中WebRTC拉流播放章节 | 可选 |
| timeShift | 直播时移配置项，详情请参见开发指南中直播时移章节 | 可选 |
| header | 自定义headers配置项 | 可选 |
| lang | 默认选择的语言：值可以为:'zh'、'en' 。默认为'zh' | 可选 |
| showLang | 是否在控制栏显示多语言切换选项，默认为false | 可选 |
| languages | 配置的多语言项，详情请参见开发指南中多语言章节 | 可选 |
| isMemoryPlay | 记忆播放配置项 | 可选 |
| starttime | 从指定位置播放配置项，用来指定开始播放的时间 。单位：s | 可选 |
| isMirror | 视频镜像配置项 | 可选 |
| rotate | 视频旋转配置项 | 可选 |
| appid | 百度智能云控制台申请 License 后的licenseID | 必填 |
| licenseUrl | 百度智能云控制台申请后，将下载下来的.license文件存放到项目目录中，以静态资源方式传入 | 必填 |
| VRPlugin | VR播放配置参数。例如：VRPlugin:{initialYaw:0,initialPitch:90} 更多参数请参见开发指南实现VR播放章节 | 选填 |