音视频处理MCT

    控制接口

    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
        }
    });

    参数详解:setup只有一个Object类型的参数,该参数是一个参数集合,该参数集合所包含的参数元素及使用方法如下描述:

    参数名称参数解释备注
    flashplayer指定flash播放器swf文件的存放地址,可以是相对路径,也可以http协议开头的绝对路径。
    省略该参数则自动在js所在路径寻找cyberplayer.flash.swf文件。
    可选
    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设置媒体流的预览图可选
    volume设置播放器音量大小,范围(0 - 100)可选
    controls设置播放器控制条的显示模式,显示模式分为:
    1.none:不显示;
    2.over:悬浮(鼠标无操作时自动隐藏)
    可选
    barLogo设置是否显示Logo,`controls`的子参数,可选值为true (显示),false(不显示)可选
    skin设置播放器皮肤包可选
    stretching设置播放器缩放方式,缩放方式分为:
    1.none:不缩放;
    2.uniform:添加黑边缩放;
    3. exactfit:改变宽高比缩到最大;
    4.fill:剪切并缩放到最大(默认方式为uniform)
    可选
    参数名称 参数解释 备注
    flashplayer 指定flash播放器swf文件的存放地址,可以是相对路径,也可以http协议开头的绝对路径。
    省略该参数则自动在js所在路径寻找cyberplayer.flash.swf文件。
    可选
    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 设置媒体流的预览图 可选
    volume 设置播放器音量大小,范围(0 - 100) 可选
    controls 设置播放器控制条的显示模式,显示模式分为:
    1.none:不显示;
    2.over:悬浮(鼠标无操作时自动隐藏)
    可选
    barLogo 设置是否显示Logo,controls的子参数,可选值为true (显示),false(不显示) 可选
    skin 设置播放器皮肤包 可选
    stretching 设置播放器缩放方式,缩放方式分为:
    1.none:不缩放;
    2.uniform:添加黑边缩放;
    3. exactfit:改变宽高比缩到最大;
    4.fill:剪切并缩放到最大(默认方式为uniform)
    可选

    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

    接口功能:获取当前播放器窗口宽度。

    代码示例:

    var width = myPlayer.getWidth();

    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::setCurrentQuality

    参数列表:Number

    返回类型:Object

    接口功能:设置播放某种码率的视频。

    代码示例:

    myPlayer.setCurrentQuality(1);

    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::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 等。

    上一篇
    事件响应接口
    下一篇
    Android平台