SewisePlayer使用手册.docx

42Sewise播放器V1.0使用说明书 Sewise播放器V1.0 使用手册目录1产品简介21.1产品说明21.2产品功能32参数与接口说明52.1播放器运行原理52.2页面播放器嵌入方式52.3 参数说明62.3.1参数说明62.3.2参数优先级142.3.3参数例子142.4 接口说明152.4.1点、直播通用接口方法152.4.2点、直播专用接口方法182.4.3播放器回调的函数203使用说明与示例233.1 SewisePlayer文件介绍233.2 使用示例243.2.1关于SewisePlayer的安装243.2.2 SewisePlayer的使用示例244搭配sewise的流媒体服务器401产品简介1.1 产品说明Sewise播放器（名为SewisePlayer）是一款专业的免费网页视频流播放器，它功能强大，体积小，跨平台，使用方便简洁、随心所欲。播放器是主要以HTML5技术为平台开发，同时兼容flash技术，实现了跨平台各浏览器 兼容的视频播放。使用Sewise Player您可以在Windows, MacOS, Linux，Windows Phone, Android, IOS等任意平台上，通过对应的浏览器播放视频。SewisePlayer 使用非常简单，只要在页面对应的DIV内嵌入一个JS文件即可，播放器将通过自动识别浏览器的功能来启用HTML5或flash模式播放视频。你不需要掌 握任何专业的JavaScript或ActionScript技术就可以制作出专业的网页视频播放器。SewisePlayer即可以做为 单一的前台播放器来在页面上播放视频，也可以结sewise Server后台技术实现专业的可交互的点播、直播视频播放。1.2产品功能 支持跨终端播放，不仅适用PC端，也适配移动终端ipad/iphone/android手机/平板电脑等 支持HTML5, Flash视频播放技术。 支持多平台，PC包括Windows, MacOS, Linux等。Mobile包括Android, IOS, Windows Phone等。 支持多浏览器兼容，IE6/7/8/9/10、Google Chrome、Firefox、safari、Opera等。 支持多种视频格式，mp4、m3u8、oga、webm、theora、flv、f4v等。 支持多种协议直播流，rtmp、udp、http ts、rtsp的直播和回放。 支持Flash播放m3u8文件，以及AES-128解码播放。 支持PC与Mobile平台播放器自动识别功能，PC终端启动flash播放器，移动终端时启动html播放器。 支持浏览器HTML5与Flash特性检测。 支持播放地址AMF, AJAX, JOSNP类型请求。 支持自定义HTML5与Flash皮肤，无需了解程序，即可自己制作出超烗风格皮肤。 支持前置广告（swf, 图片, 视频）。 支持字幕。 支持多种播放参数设定。 支持丰富的api接口，快速打造功能强大的插件。 支持自定义Logo、播放器的宽度与高度，视频可以自适应窗口大小。 支持画质（标清、高清、超清）的自由切换，移动端自适应切换。支持点击播放和自动播放。2 参数与接口说明这一章介绍一下SewisePlayer的运行原理，参数说明、接口说明及其页面嵌入的使用。2.1播放器运行原理第一步：页面加载sewise.player.min.js文件后，该脚本会将相应的参数解析出来，并检查出当前的设备平台、浏览器特性，同时还会根据JS文件的路径取出host地址，用于播放地址请求。第二步：通过分析出来的vod与type参数与及浏览器特性，来确定播放器是启用HTML5还是Flash模块。对于不同平台和浏览器同时支持的视频格式或流协议，将优先启用HTML5播放模块。第三步：加载对应的皮肤文件与库文件。第四步：在皮肤加载完成后将根据给定的参数来初始化播放器。播放器初始化完成后，会在当前页面中回调playerReady()方法（HTML5或Flash播放器都会回调该方法），表示播放器API接口已可用。2.2页面播放器嵌入方式点播地址sourceid请求播放点播地址videourl直接播放直播地址pid请求播放直播地址streamurl直接播放2.3 参数说明2.3.1参数说明1、点、直播通用参数-autoStart说明：可选加载视频地址等信息后是否自动开始播放类型：字符串取值：true、false，为空表示：true对应：通用-serverPath说明：服务器给Flash提供数据请求服务的地址类型：字符串取值：19/flashservice/gateway.php对应：通用-serverApi说明：服务器给播放器提供的数据请求接口方法类型：字符串取值：ServerApi.execute对应：通用-skin说明：可选播放器皮肤的相对路径类型：字符串取值：如，vodOrange.swf对应：通用-buffer说明：可选播放器开始播放前所需下载的缓冲数据时长，单位：秒类型：浮点数取值：如，5对应：通用-programId说明：可选被播放节目的id类型：字符串取值：sewise直播或点播服务中节目的id，如：5v6s3gkk，为空表示：需要从JS调用相关方法进行视频播放对应：通用-title说明：可选所播放节目的标题类型：字符串取值：如，深圳卫视对应：通用-type说明：可选播放视频类型类型：字符串取值：rtmp、http、flv、mp4、m3u8 为空表示：默认的flv播放模式，其中rtmp、http为直播的播放模式；flv、mp4、m3u8为点播的播放模式对应：通用-draggable说明：可选进度条是否可以拖动类型：字符串取值：true、false，缺省默认值为：true对应：通用-published说明：可选是否去检查节目发布状态的开关参数类型：数值取值：0或1,0表示：不需要检查节目是否发布，即无论节目是否发布都尝试去播放节目的源；1表示：需要检查节目的发布状态，未发布则不请求节目源地址对应：通用-lang说明：可选播放器显示语言类型：字符串取值：en_US或zh_CN对应：通用-logo说明：可选播放器角落logo类型：字符串取值：如，/logo.png对应：通用-playerName说明：可选播放器右键菜单选项中播放器名称显示内容类型：字符串取值：如，Sewise Player对应：通用-copyright说明：可选播放器右键菜单选项中播放器版权显示内容类型：字符串取值：如，(C) All right reserved the SEWISE inc 2011-2013对应：通用-clarityButton说明：可选是否开启“清晰度”设置按钮类型：字符串取值：enable或disable, 缺省默认值为：enable对应：通用-timeDisplay说明：可选是否显示播放时间类型：字符串取值：enable或disable, 缺省默认值为：enable对应：通用-controlBarDisplay说明：可选是否显示播放控制栏类型：字符串取值：enable或disable, 缺省默认值为：enable对应：通用-topBarDisplay说明：可选是否显示顶部标题栏类型：字符串取值：enable或disable, 缺省默认值为：enable对应：通用-2、非通用参数点播专用参数-videoUrl说明：点播视频时的播放地址类型：字符串取值：如，19:5080/flvseek/data/201310/25102442M.flv对应：flv、mp4-startTime说明：可选视频播放的开始时间类型：数值取值：开始播放的时间，如：234.341，缺省默认值为：从头开始对应：flv、mp4、m3u8-直播专用参数-streamUrl说明：http-flv模式直播流的播放地址，rtmp模式直播服务器应用连接地址 + 流名称。另，通过“_”字符在流地址后添加14位的开始时间和结束时间(如：rtmp:/19/livestream/qq3tvegb_20130812094010_20130812094210),可以实现流从开始时间播放到结束时间后停止流播放。类型：字符串取值：如19:5080/livestream/v2qrgj3a.flv或：rtmp:/19:1935/livestream/v2qrgj3a对应：http、rtmp-duration说明：可选直播时播放器的进度条代表的时间跨度类型：数字取值：时间称数，如：3600对应：http、rtmp-shiftTime说明：可选直播启动播放时的开始播放时间类型：字符串取值：14位绝对时间字符串，如，20130413102312对应：http、rtmp-2.3.2参数优先级programId与直接播放的视频源地址（videoUrl/httpUrl/rtmpUrl+streamName）之间选择播放源，programId优先。2.3.3参数例子var flashvars = /点、直播通用参数autoStart : true,serverPath : 19/flashservice/gateway.php,serverApi : ServerApi.execute,skin : vodOrange.swf,buffer : 5,programId : 5v6s3gkk,title : 深圳卫视,type : flv,draggable : true,published : 1,lang : zh_CN,logo : 19/logo.png,playerName : Sewiseplayer,copyright : (C) All right reserved the SEWISE inc 2011-2013,clarityButton : enable,timeDisplay : enable,controlBarDisplay : enable,topBarDisplay : enable,/点播专用参数videoUrl : 19:5080/flvseek/data/201310/25102442M.flv,startTime : 232.324/直播专用参数streamUrl : rtmp:/19:1935/livestream/v2qrgj3a,duration : 3600,shiftTime : 20130413102312;2.4 接口说明2.4.1点、直播通用接口方法-doPlay()说明：启动、恢复播放参数：无返回：无示例：player.doPlay();-doPause()说明：暂停播放参数：无返回：无示例：player.doPause();-doStop()说明：停止播放参数：无返回：无示例：player.doStop();-doSeek(time)说明：跳转播放参数：time类型点播时为数值表示要跳转到的位置（秒），直播时为字符串表示要跳转到的日期（如：20130503123456）返回：无示例：点播 player.doSeek(20);直播 player.doSeek(20130503123055);-toPlay(url, title, startTime, autoPlay)说明：根据视频地址播放视频参数：url类型为字符串表示要播放的视频地址， title类型为字符串表示视频标题， startTime类型点播时为数值表示开始播放的位置（秒）。 直播时为字符串表示开始播放位置的日期（如：20130503123456），autoPlay类型为布尔值表示是否自动开始播放。 另，直播时当流地址后添加了14位的开始时间和结束时间后(如：rtmp:/19/livestream/qq3tvegb_20130812094010_20130812094210)，流将从开始时间点播放到结束时间点后停止流播放。返回：无示例：点播 player.toPlay(19:5080/flvseek/data/26144610yg.flv,深圳卫视, 20, true);直播 player.toPlay(rtmp:/19/livestream/6jzcdjgi, 深圳卫视, 20130927150000, true);-setVolume(volue)说明：设置音量参数：volue类型为数值（0 - 1）,表示要设置的音量值返回：无示例：player.setVolume(0.5);-playTime()说明：获取当前播放时间位置、日期参数：无返回：点播返回当前视频播放到的位置（秒）。直播返回当前视频播放到的时间点（日期）示例：player.playTime();-2.4.2点、直播专用接口方法1、点播专用方法-playProgram(pid, startTime, autoPlay)说明：通过节目ID来播放视频参数：无返回：pid类型为字符串表示节目ID，startTime类型为数值表示视频开始播放的位置（秒），autoPlay类型为布尔值表示是否自动开始播放示例：player.playProgram(jCAH3SAY, 20, true);-duration()说明：获取视频的总时长参数：无返回：返回当前播放视频的总时长示例：player.duration();-2、直播专用方法-doLive()说明：回到直播参数：无返回：无示例：player.doLive();-playChannel(cid, startTime, autoPlay)说明：通过频道ID来播放视频参数：cid类型为字符串表示节目ID，startTime类型为字符串表示开始播放的时间点（日期）（如：20130503123456），autoPlay类型为布尔值表示是否自动开始播放返回：无示例：player.playChannel(y894tgf3, 20130503123456, true);-liveTime()说明：获取最新直播时间参数：无返回：当前视频最新的直播时间日期示例：player.liveTime();-2.4.3播放器回调的函数1、点、直播通用回调函数-playerReady(id)说明：播放器准备好后回调的函数参数：id类型为字符串，表示页面中嵌入播放器的id或name值返回：无示例：var player;function playerReady(id) player = document.getElementById(sewise_x_player);player.doSeek(10);-onMetadata(meta)说明：播放器获取到播放视频metadata信息后回调的函数参数：meta类型为JSON对象，表示metadata信息数据对象返回：无示例：function onMetadata(meta)alert(meta);-onStart()说明：视频开始播放后回调的函数参数：无返回：无示例：function onStart()alert(play start)-onStop()说明：视频停止播放后回调的函数参数：无返回：无示例：function onStop()alert(play stopped)-onClarity(clarity)说明：切换清晰度后回调的函数参数：clarity类型为Object对象，表示清晰度信息数据对象返回：无示例：function onClarity(clarity)alert(clarity.id + n + + n + clarity.videoUrl);-3 使用说明与示例对SewisePlayer的接口与参数有了一定了解或，下面介绍一下如何使用sewise播放器，首先会介绍一下SewisePlayer的文件构成，再给出一些实例来说明如何调用Sewise播放器。3.1 SewisePlayer文件介绍首先您可以通过首页下载SewisePlayer，里面包含播放器以及皮肤；使用之前请先了解一下里面的文件结构，以便您更好的玩转SewisePlayer：图3-1现在您已对SewisePlayer的文件结构有了一定的了解，接下来我们来看看怎么使用它，来定制您的专属播放器吧。3.2 使用示例SewisePlayer上手使用其实很简单，在不涉及到插件的制作或复杂的js交互使用的情况下，你无需撑握任何编程语言。一：如果您从没做过网站，想使用SewisePlayer播放视频建议您先了解下网站架构的基本原理和html（超文本标记语言,不是编程语言）的基本知识，至少，你需要了解怎么在网页中调用flash(文件后缀为.swf)的方法。二：如果您对html有些了解，知道怎么在网页中插入flash播放器，看过javascript，但并不了解。您可以使用SewisePlayer完整的功能。三：如果您对js熟悉，会使用您可以使用SewisePlayer完整的功能并且可以用js自由的和播放器进行交互，把SewisePlayer玩弄于股掌中。四：如果您熟悉as3语言您可以制作出强大的跟播放器交互的功能插件3.2.1关于SewisePlayer的安装安装很简单，只要你有网站的空间或服务器，直接把SewisePlayer文件夹（包括sewise.player.min.js）放在你网站根目录下，请注意，跟你网站使用的什么环境和程序语言没有任何关系，就相当于一个js文件一样使用即可。3.2.2 SewisePlayer的使用示例以下给出几种播放器的使用示例。点播MP4视频播放 Sewise Player点播FLV视频播放Sewise Player点播节目ID视频播放Sewise Player直播放节目ID播放Sewise Playerlive_streamurl_rtmp.html 直播RTMP流播放Se