帮助手册>ActionScript3.0-API>控制函数

控制函数列表

在查阅该文之前需要了解的内容如下:

actionscript3.0的控制函数主要是用来制作插件时使用。可以控制播放器里的事件。比如控制暂停,播放,退出全屏等动作。

以下是一个示例,作用是在播放到100秒的时候暂停播放视频。这个示例同时用到的监听函数,有关监听函数的使用方法和列表请查看:监听函数说明及使用方法监听函数列表

var ck: Object = null;
var myNmae:String="temp.swf";
var isNumber=true;//是否是第一次判断
function setAppObj(app: Object): void {
	ck = app;
	ck.addListener(myName, "time", timeHandler);
}
function timeHandler(time:Number):void{
	//time=当前播放时间
	if(time>=100 && isNumber){
	    isNumber=false;
	    ck.videoPause();
	}
}

将上面的代码保存成temp.swf,安装到播放器里,上面代码的意思是:

首先,定义一个(对象)变量:ck,当播放器加载插件temp.swf时,首先会调用该插件里的setAppObj()函数并同时把播放器本身传递给播放器。

接下来,ck=app,即ck被定义成播放器,控制ck就是控制播放器。同样,监听ck就是监听播放器的事件,ck.addListener(myName, "time", timeHandler);是监听当前播放时间的,监听并把当前时间发送给timeHandler()函数。在timeHandler()函数里进行了一个判断。如果当前播放时间大于等于100(秒)并且是第一次判断(isNumber==true),则暂停播放并同时设置不是第一次判断了。这样做的意义在于只进行一次(判断)暂停。

正文:

控制函数的格式如下:

播放器.事件()

下面列出ckplayer支持的控制函数:

getType

判断当前调用的是flashplayer还是HTML5的Video,支持HTML5

默认值:无

详细语法:getType()

详细说明:返回true=调用的HTML5-Video,false=调用的是flashplayer

videoPlay

播放视频,支持HTML5

默认值:无

详细语法:videoPlay()

详细说明:控制播放器进行播放

videoPause

暂停播放视频,支持HTML5

默认值:无

详细语法:videoPause()

详细说明:控制播放器视频暂停

playOrPause

在播放/暂停视频二个事件中进行切换,支持HTML5

默认值:无

详细语法:playOrPause()

详细说明:在播放/暂停视频二个事件中进行切换

fastNext

快进,支持HTML5

默认值:无

详细语法:fastNext()

详细说明:快进

fastBack

快退,支持HTML5

默认值:无

详细语法:fastBack()

详细说明:快退

videoSeek

跳转到指定秒数进行播放,支持HTML5

默认值:无

详细语法:videoSeek(Int)

详细说明:跳转到指定秒数进行播放

changeVolume

改变音量,支持HTML5

默认值:无

详细语法:changeVolume(Int)

详细说明:改变的音量范围为0-100的整数

newAddress

改变播放器参数并同时重新播放(新)视频,支持HTML5

默认值:无

详细语法:newAddress(String)

详细说明:向播放器传递新的初始化参数,并且重新播放,传递的参数应该是一个字符型数据,各个属性用{}包含,比如:newAddress('{f->http://movie.ks.js.cn/flv/2012/02/6-1.flv}{html5->http://movie.ks.js.cn/flv/other/2014/06/20-2.mp4->video/mp4}'),这里的代码兼容flashplayer和html5并会自动判断。如果当前是pc端的flashplayer,则会把f属性发给播放器,如果是使用html5,则会向html5播放器发送html5属性。播放器将替换掉原flashvars里的(html5部分的var video=[];)重新播放。这个事件跟changeFlashvars()函数是有区别的,需要注意

changeFlashvars

改变播放器参数

默认值:无

详细语法:changeFlashvars(String)

详细说明:向播放器传递新的初始化参数,这里的改变将在下一次调用生效,比如changeFlashvars('{d->1.jpg}'),暂停广告地址被换成新的。在下一次暂停时会显示这个广告。

changeStyle

改变配置属性

默认值:无

详细语法:changeStyle(String,String,[Int])

详细说明:配置属性包括ckplayer.js中和ckstyle()或ckplayer.xml,以及language.xml和style.swf(修改成style.zip)里的style.xml,这里分为二种情况,一种是统一改变,比如:changeStyle('属性名称','属性值'),如果属性值是多个的,以","号隔开的,也可以单独修改某一个值,比如changeStyle('属性名称','要修改的属性值',该值在该属性里的编号(从0开始计算)),要注意的是,不是所有的属性改变后就能生效的。因为有些属性在加载时已经配置好。

changeStatus

控制全局监听的等级,支持HTML5

默认值:1

详细语法:changeStatus(Int)

详细说明:控制全局监听函数的监听等级,0=不使用监听,1=全部监听,2=全部监听并开启浏览器控制台监听,3=监听返回参数前添加播放器ID并同时开启浏览器控制台监听

getStatus

获取播放器相关属性,支持HTML5

默认值:无

详细语法:getStatus()

详细说明:获取播放器相关属性,返回一个对象,这个在HTML5环境中返回的属性较少,以下列出返回的属性:

属性类型说明
widthInt播放器宽
heightInt播放器高
vwidthInt视频展示的宽
vheightInt视频展示的高
awidthInt视频宽
aheightInt视频高
videoxInt视频在播放器中的x坐标
videoyInt视频在播放器中的y坐标
timeNumber当前播放时间
totalTimeNumber视频总时间
byteInt当前加载字节
totalBytesInt视频总字节
speedInt视频加载速度,默认是:字节/250毫秒
volumeInt当前音量
playBoolean是否播放
muteBoolean是否静音
bufferInt缓冲值
mouseArray鼠标位置
myflashvarsObjectflashvars值
myStyleObject配置参数的对象,包含风格等信息,语言包信息
myObjectObject自定义对象
controlBarShowBoolean控制栏是否显示状态

addListener

监听事件,支持HTML5

默认值:无

详细语法:javascript里监听示例:单独监听/删除监听的一个示例,actionscript3.0里的监听示例:控制函数的使用方法

详细说明:监听播放器事件

removeListener

删除监听事件,支持HTML5

默认值:无

详细语法:javascript里删除监听示例:单独监听/删除监听的一个示例,actionscript3.0里的删除监听示例:控制函数的使用方法

详细说明:删除监听播放器事件

frontAdPause

暂停前置广告

默认值:无

详细语法:frontAdPause()

详细说明:暂停前置广告

frontAdPause

是否暂停前置广告

默认值:true

详细语法:frontAdPause(Boolean)

详细说明:frontAdPause(true)=暂停前置广告,frontAdPause(false)=继续播放前置广告

frontAdUnload

跳过前置广告

默认值:无

详细语法:frontAdUnload()

详细说明:跳过前置广告

changeFace

是否隐藏控制栏

默认值:true

详细语法:changeFace(Boolean)

详细说明:changeFace(true)=隐藏控制栏,changeFace(false)=显示控制栏

plugin

控制插件

默认值:plugin('插件名称',true,,-1,-1,-1,-1,-1)

详细语法:plugin(String,[Boolean,Int,Int,Int,Int,Int])

详细说明:plugin('插件名称',是否显示,宽度,高度,相对于播放器左上角的X坐标,相对于播放器左上角的Y坐标,显示的深度(0=显示在最上层))

plugAttribute

获取插件的相关属性

默认值:无

详细语法:plugAttribute(String)

详细说明:plugAttribute('插件名称'),此时会返回一个对象:{exist:是否存在该插件,x:x坐标,y:y坐标,width:宽,height:高,show:是否显示}

videoClear

清除视频

默认值:无

详细语法:videoClear()

详细说明:视频清除后不能再使用newAddress来播放新的视频

promptUnload

清除提示点

默认值:无

详细语法:promptUnload()

详细说明:清除进度栏上的提示点

promptLoad

重新加载提示点

默认值:无

详细语法:promptLoad()

详细说明:重新加载提示点,该函数主要是动态改变提示点使用。需要注意的是在调用该函数前需要先使用:changeFlashvars()函数修改提示点时间和文字

marqueeLoad

显示滚动文字广告(改变滚动文字广告内容)

默认值:无

详细语法:marqueeLoad(true[,String])

详细说明:该函数传递二个属性,第一个属性固定为true,第二个参数可选,滚动文字广告内容

marqueeClose

关闭滚动文字广告

默认值:无

详细语法:marqueeClose()

详细说明:关闭滚动文字广告

videoBrightness

设置亮度值

默认值:无

详细语法:videoBrightness(Int)

详细说明:设置亮度值,值的大小在-255和255之间,0为中间值,小于0则变暗,大于0则变亮

videoContrast

设置对比度值

默认值:无

详细语法:videoContrast(Number)

详细说明:设置对比度值,值的大小在-255和255之间,127.5为中间值,小于127.5则偏暗,大于127.5则对比鲜明

videoSaturation

设置饱和度值

默认值:无

详细语法:videoSaturation(Int)

详细说明:设置饱和度值,值的大小在-255和255之间,1为中间值,0则切换成黑白照片

videoSetHue

设置色相值

默认值:无

详细语法:videoSetHue(Int)

详细说明:设置色相值,值的大小在-255和255之间,0为中间值

videoWAndH

设置视频的宽高,按比例进行缩放

默认值:(100,100)

详细语法:videoWAndH(width:Int,height:Int)

详细说明:正常比例是:100:100,如设置成:videoWAndH(160,90),则宽变为原来的160%,高变为原来的90%

videoWHXY

设置视频的宽,高,x坐标,y坐标

默认值:无

详细语法:videoWAndH(width:Int,height:Int,x:Int(相对于播放器左上角的x坐标),y:Int(相对于播放器左上角的y坐标))

详细说明:如设置成:videoWAndH(1100,1200),则宽度变成1100px,高度变成的1200px,坐标变成0,0

fullScreen

全屏

默认值:无

详细语法:fullScreen()

详细说明:该函数只支持actionscript3.0的调用,并不支持js里调用

quitFullScreen

退出全屏

默认值:无

详细语法:quitFullScreen()

详细说明:退出全屏

sendJS

注册事件

默认值:无

详细语法:sendJS(String,*)

详细说明:向播放器发送一个事件,该事件会立刻发送给所有监听该事件的函数,sendJS("事件名称",事件值),事件值可以是:对象-Object,数组-Array,字符-String,数字-Int,数字-Number

formatUrl

替换字符

默认值:无

详细语法:formatUrl(String)

详细说明:字符里只要包含[$pat][$pat1]...的变量,会自动跟flashvars里的a值进行替换

allowFull

是否允许全屏

默认值:无

详细语法:allowFull(Boolean)

详细说明:true=允许进行(点击全屏按钮,双击播放器)全屏操作,false=不允许全屏

videoError

显示视频加载失败

默认值:无

详细语法:videoError(String)

详细说明:显示视频加载失败

errorTextShow

是否显示视频加载失败提示框

默认值:无

详细语法:errorTextShow(Boolean)

详细说明:是否显示视频加载失败提示框,true=显示,false=隐藏

openUrl

跳转网页地址

默认值:("#","_blank")

详细语法:openUrl(url:String,target:String)

详细说明:跳转网页地址,url=要打开的地址,target=窗口对象(_blank=新窗口,_top=当前窗口)

jsonParse

将字符串格式化成json对象

默认值:无

详细语法:jsonParse(String)

详细说明:将字符串格式化成json对象

promptShow

显示提示文字

默认值:无

详细语法:promptShow(title:String,x:Int,y:Int)

详细说明:显示提示文字,比如鼠标经过自定义插件对显示一个提示,("显示的文字",相对于播放器左上角的x坐标,相对于播放器左上角的y坐标)

screenShot

截屏函数,只支持as3

默认值:无

详细语法:screenShot(style:String,x1:Int,y1:Int,x2:Int,y2:Int):Object

详细说明:截图,style(字符类型:video=截取视频,all=截取播放器),x1,y1指左边和上方切掉的距离,x2,y2是右边和下方切掉的距离 例:screenShot("video",0,0,0,0)截取视频图片, 返回一个对象Object{BitmapData:位图,ByteArray:二进制} 下面演示了一个用JPGEncoder组件截图的简单示例关键代码:

var imgObj:Object=ck.screenShot("video",0,0,0,0); 
var encoderjpg:JPGEncoder = new JPGEncoder();
var bytes:ByteArray = encoderjpg.encode(imgObj.BitmapData);

该功能仅支持as3,不支持javascript

textBoxShow

在播放器中加载(显示)文本元件

默认值:无

详细语法:textBoxShow(Object):String

详细说明:发送一个对象,该对象定义了文本元件的内容及初始事件并返回该文本元件的名称,即name属性,对象的属性如下:

{
	name: 'textboxname', //该文本元件的名称,主要作用是关闭时需要用到
	coor: '0,2,-100,-100', //坐标
	text: '{a href="http://www.ckplayer.com" target="_blank"}{font color="#FFFFFF" size="12" face="Microsoft YaHei,微软雅黑"}这里是一个提示文字演示,6.8新增功能{/font}{/a}', //文字
	bgColor: '0x000000', //背景颜色
	borderColor: '0x000000', //边框颜色
	radius: 3, //圆角弧度
	alpha:0,//总体透明度
	bgAlpha: 50, //背景透明度
	xWidth: 20, //宽度修正
	xHeight: 5, //高度修正
	pic: ['temp/temp1.png','temp/temp2.png','temp/temp3.png'], //附加图片地址数组,可以增加多个图片
	pwh:[[30,30],[20,20],[100,100]],//图片缩放宽高,和上面图片一一对应
	pEvent:[['url','http://www.ckplayer.com'],['javascript','console.log'],['close','']],//图片事件数组
	pCoor: ['0,0,-22,-3','1,1,20,20','2,2,-30,-30'], //图片坐标数组
	pRadius: [30,0,0], //附加图片的弧度
	tween:[['x',1,50,0.3],['alpha',1,100,0.3]]//缓动效果
}

对象说明:

1、name=文本元件的名称,如果没有定义,系统会自动分配一个文件名称

2、coor=坐标,四个数字进行定义,可参考:界面元素的坐标控制

3、pic=要文本元件里同时添加图片,可以是多个

4、pwh=添加图片的宽高,进行等比缩放,和图片一一对应,如果是[0,0],则不进行缩放处理

5、pEvent=添加图片的点击事件,二维数组形式,[事件名称[,附加值]],事件名称分为三种:url=打开一个地址,javascript=调用一个js函数如:textbox(obj),同时传递一个对象,对象里包含该图片的基本数据,close=关闭该文本元件

6、pCoor=添加图片的坐标,二维数组形式,四个值控制坐标,这里的坐标是相对于文本内容的,坐标控制可参考:界面元素的坐标控制

7、pRadius=定义各图片的四个角弧度,如图片的宽高是:30,30,弧度也定义成30,则显示圆形。

8、tween=初始化缓动效果,即该文本元件加载后就进行缓动,二维数组形式,详细可参考下面的控制函数:textBoxTween()

textBoxClose

关闭文本

默认值:无

详细语法:textBoxClose(name:String)

详细说明:name=要关闭的文本元件名称,如果为空,则关闭所有

textBoxTween

文本元件进行缓动

默认值:无

详细语法:textBoxTween(name:String,tween:Array)

详细说明:name=要进行缓动的文本元件名称,tween=参与缓动的数组,这是一个二维数组,每组定义一个缓动方式:[['y',0,-30,0.3],['x',1,-30,0.3]],这个二维数组定义了该文本同时进行二个缓动,一处是y轴进行移动,一个是x轴进行移动,数组里有四个参数,意思分别是[缓动类型,相对/绝对,移动值,移动时间],缓动类型分为三种,分别是x,y,alpha,相对/绝对的区别是:0=相对,则先计算目前的属性值,然后缓动相对于目前的属性值,比如上面的['y',0,-30,0.3],是指在y轴上向上移动30个像素,1=绝对,如上面的['x',1,-30,0.3],是指在x轴上移动到x坐标为-30的位置,移动值是要移动的距离或透明度值,缓动时间:指完成该缓动经过的时间

getTextBox

获取文本元件的属性

默认值:无

详细语法:getTextBox(name:String)

详细说明:name=文本元件的名称,返回一个对象,包括如下信息:

{
    name: 该文本元件的名称,
    x: 该文本元件的x坐标,
    y: 该文本元件的y坐标,
    alpha: 该文本元件的透明度,范围0-100的整数,
    width: 该文本元件的宽度,
    height: 该文本元件的高度
}

changeMyObject

改变自定义对象(变量)的值

默认值:无

详细语法:changeMyObject(name:String,value:*)

详细说明:name=属性的名称,value=属性值,可以任意类型

getMyObject

获取自定义对象

默认值:无

详细语法:getMyObject()

详细说明:获取自定义对象。返回的是一个对象

Powered by ckplayer.com  
Copyright©ckplayer,2011-2016