SewisePlayer使用手册.docx

SewisePlayer使用手册.docx

《SewisePlayer使用手册.docx》由会员分享，可在线阅读，更多相关《SewisePlayer使用手册.docx（46页珍藏版）》请在冰豆网上搜索。

SewisePlayer使用手册

Sewise播放器V1.0

使用手册

1产品简介

1.1产品说明

Sewise播放器（名为SewisePlayer）是一款专业的免费网页视频流播放器，它功能强大，体积小，跨平台，使用方便简洁、随心所欲。

播放器是主要以HTML5技术为平台开发，同时兼容flash技术，实现了跨平台各浏览器兼容的视频播放。

使用SewisePlayer您可以在Windows,MacOS,Linux，WindowsPhone,Android,IOS等任意平台上，通过对应的浏览器播放视频。

SewisePlayer使用非常简单，只要在页面对应的DIV内嵌入一个JS文件即可，播放器将通过自动识别浏览器的功能来启用HTML5或flash模式播放视频。

你不需要掌握任何专业的JavaScript或ActionScript技术就可以制作出专业的网页视频播放器。

SewisePlayer即可以做为单一的前台播放器来在页面上播放视频，也可以结sewiseServer后台技术实现专业的可交互的点播、直播视频播放。

1.2产品功能

Ø支持跨终端播放，不仅适用PC端，也适配移动终端ipad/iphone/android手机/平板电脑等

Ø支持HTML5,Flash视频播放技术。

Ø支持多平台，PC包括Windows,MacOS,Linux等。

Mobile包括Android,IOS,WindowsPhone等。

Ø支持多浏览器兼容，IE6/7/8/9/10、GoogleChrome、Firefox、safari、Opera等。

Ø支持多种视频格式，mp4、m3u8、oga、webm、theora、flv、f4v等。

Ø支持多种协议直播流，rtmp、udp、httpts、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请求播放

640px;height:

360px;">

640px;height:

360px;">

640px;height:

360px;">

640px;height:

360px;">

"true"

对应：

通用

---------------------------------------------------------------

serverPath

说明：

服务器给Flash提供数据请求服务的地址

类型：

字符串

取值：

'http:

//192.168.1.219/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

类型：

字符串

取值：

如，

对应：

通用

---------------------------------------------------------------

playerName

说明：

[可选]播放器右键菜单选项中播放器名称显示内容

类型：

字符串

取值：

如，"SewisePlayer"

对应：

通用

---------------------------------------------------------------

copyright

说明：

[可选]播放器右键菜单选项中播放器版权显示内容

类型：

字符串

取值：

如，"（C）AllrightreservedtheSEWISEinc2011-2013"

对应：

通用

---------------------------------------------------------------

clarityButton

说明：

[可选]是否开启“清晰度”设置按钮

类型：

字符串

取值：

"enable"或"disable",缺省默认值为：

"enable"

对应：

通用

---------------------------------------------------------------

timeDisplay

说明：

[可选]是否显示播放时间

类型：

字符串

取值：

"enable"或"disable",缺省默认值为：

"enable"

对应：

通用

---------------------------------------------------------------

controlBarDisplay

说明：

[可选]是否显示播放控制栏

类型：

字符串

取值：

"enable"或"disable",缺省默认值为：

"enable"

对应：

通用

---------------------------------------------------------------

topBarDisplay

说明：

[可选]是否显示顶部标题栏

类型：

字符串

取值：

"enable"或"disable",缺省默认值为：

"enable"

对应：

通用

---------------------------------------------------------------

2、非通用参数

点播专用参数

---------------------------------------------------------------

videoUrl

说明：

点播视频时的播放地址

类型：

字符串

取值：

如，'http:

//192.168.1.219:

5080/flvseek/data/201310/25102442M.flv'

对应：

flv、mp4

---------------------------------------------------------------

startTime

说明：

[可选]视频播放的开始时间

类型：

数值

取值：

开始播放的时间，如：

234.341，缺省默认值为：

从头开始

对应：

flv、mp4、m3u8

---------------------------------------------------------------

直播专用参数

---------------------------------------------------------------

streamUrl

说明：

http-flv模式直播流的播放地址，rtmp模式直播服务器应用连接地址+流名称。

另，通过“_”字符在流地址后添加14位的开始时间和结束时间（如：

"rtmp:

//192.168.1.219/livestream/qq3tvegb_20130812094010_20130812094210"）,可以实现流从开始时间播放到结束时间后停止流播放。

类型：

字符串

取值：

如'http:

//192.168.1.219:

5080/livestream/v2qrgj3a.flv'

或：

'rtmp:

//192.168.1.219:

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参数例子

varflashvars={

//点、直播通用参数

autoStart  :

'true',

serverPath :

'http:

//192.168.1.219/flashservice/gateway.php',

serverApi  :

'ServerApi.execute',

skin      :

'vodOrange.swf',

buffer      :

5,

programId  :

'5v6s3gkk',

title       :

'深圳卫视',

type       :

'flv',

draggable :

'true',

published  :

1,

lang       :

'zh_CN',

logo       :

'http:

//192.168.1.219/logo.png',

playerName       :

'Sewiseplayer',

copyright         :

'（C）AllrightreservedtheSEWISEinc2011-2013',

clarityButton      :

'enable',

timeDisplay      :

'enable',

controlBarDisplay :

'enable',

topBarDisplay    :

'enable',

//点播专用参数

videoUrl  :

'http:

//192.168.1.219:

5080/flvseek/data/201310/25102442M.flv',

startTime :

232.324

//直播专用参数

streamUrl  :

'rtmp:

//192.168.1.219:

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:

//192.168.1.219/livestream/qq3tvegb_20130812094010_20130812094210"），流将从开始时间点播放到结束时间点后停止流播放。

返回：

无

示例：

点播player.toPlay（"http:

//192.168.1.219:

5080/flvseek/data/26144610yg.flv","深圳卫视",20,true）; 

直播player.toPlay（"rtmp:

//192.168.1.219/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（）;

---