Web 播放器 SDK API 文档

如果你是第一次使用neplayer,请先阅读 Web 播放器 SDK 开发指南

1 HTML

<link href="//nos.netease.com/vod163/nep.min.css" rel="stylesheet">
<!-- 注意video元素不要使用display:none隐藏,这会flash模式下swf文件得不到加载,播放器一直处于初始化过程中 -->
<video id="my-video" class="video-js" x-webkit-airplay="allow" webkit-playsinline controls poster="poster.png" preload="auto" width="640" height="360" data-setup="{}">
    <source src="MY_VIDEO.mp4" type="video/mp4">
</video>
<script src="//nos.netease.com/vod163/nep.min.js"></script>
<script>
/*注意: 使用data-setup时,initOptions将无效,因为播放器已经自动加载过了*/
var myPlayer = neplayer("my-video", [initOptions], [ready]);
</script>

2 Constructor

neplayer( idString, [options], [ready]);

Parameters

name type required description
idString String yes video标签的id属性值
options Object no 初始化参数对象,详情见下
ready Function no 播放器初始化完成时的回调函数
@params options
{
    "controls": true//是否显示控制条
    "autoplay": true//是否自动播放(ios不支持自动播放)

    /*预加载选项*/
    "preload": "auto"/*
    'auto'预加载视频(需要浏览器允许);
    'metadata'仅预加载视频meta信息;
    'none'不预加载;
    */

    "poster": "myPoster.jpg"//视频播放前显示的图片
    "loop": true//是否循环播放
    "width": 640//设置播放器宽度
    "height": 480//设置播放器高度

    /*设置播放器控件*/
    controlBar: { 
        playToggle: false
    }
    /*
    //设置不显示大播放按钮
    bigPlayButton:false
     */
    /*默认播放器控件列表
    posterImage
    textTrackDisplay
    loadingSpinner
    bigPlayButton
    controlBar
        playToggle
        volumeMenuButton
        currentTimeDisplay
        timeDivider
        durationDisplay
        progressControl
            seekBar
                loadProgressBar
                mouseTimeDisplay
                playProgressBar
        liveDisplay
        remainingTimeDisplay
        customControlSpacer
        playbackRateMenuButton
        chaptersButton
        descriptionsButton
        subtitlesButton
        captionsButton
        audioTrackButton
        fullscreenToggle
    */
}

关于播放器控件的介绍以及如何自定义播放器样式和控件的说明,请参见 视频云web播放器样式和组件自定义

3 Methods

请在播放器初始化完成后再调用api接口,推荐使用播放器的初始化完成回调函数。

3.1 getCurrentPosition()

获取当前播放位置(单位毫秒)

var currentPos = myPlayer.getCurrentPosition();

3.2 getDuration()

获取视频总时长(单位毫秒)

var duration = myPlayer.getDuration();

3.3 getPlayableDuration()

获取当前已缓存位置的时间点(单位毫秒)

var buffered = myPlayer.getPlayableDuration();

3.4 getVersion()

获取sdk版本号

var version = myPlayer.getVersion();

3.5 getVideoHeight()

获取视频高度

var height = myPlayer.getVideoHeight();

3.6 getVideoWidth()

获取视频宽度

var width = myPlayer.getVideoWidth();

3.7 play()

开始播放

myPlayer.play();

3.8 pause()

暂停播放

myPlayer.pause();

3.9 reset()

重置播放器

myPlayer.reset();

3.10 release()

释放播放器所有资源

myPlayer.release();

3.11 seekTo(msec)

设置到指定时间点播放

Parameters

name type required description
msec Number yes 要跳转到的播放时间(单位毫秒)
myPlayer.seekTo(12345);

3.12 setDataSource(source)

设置数据源

Parameters

name type required description
source String ¦ Object ¦ Array yes 要设置的数据源

数据源支持三种格式: