# web.kit.flash 库模块帮助文档

## web.kit.flash 成员列表 <a id="web.kit.flash" href="#web.kit.flash">&#x23;</a>

用 web.kit.form 加载 Flash

### web.kit.flash.transparent() <a id="web.kit.flash.transparent" href="#web.kit.flash.transparent">&#x23;</a>
[返回对象:wkeFlashObject](#wkeFlashObject)

### web.kit.flash.transparent(winform,param) <a id="web.kit.flash.transparent" href="#web.kit.flash.transparent">&#x23;</a>
嵌入透明 FLASH 控件,  
参数@1为窗体或控件对象  
可选在参数@2中使用一个表对象设定Flash控件的属性值

## web.kit 成员列表 <a id="web.kit" href="#web.kit">&#x23;</a>

### web.kit.flash() <a id="web.kit.flash" href="#web.kit.flash">&#x23;</a>
[返回对象:wkeFlashObject](#wkeFlashObject)

### web.kit.flash(winform,param) <a id="web.kit.flash" href="#web.kit.flash">&#x23;</a>
嵌入 FLASH 控件,  
参数@1为窗体或控件对象  
可选在参数@2中使用一个表对象设定Flash控件的属性值

## wkeFlashObject 成员列表 <a id="wkeFlashObject" href="#wkeFlashObject">&#x23;</a>

### wkeFlashObject._form <a id="wkeFlashObject._form" href="#wkeFlashObject._form">&#x23;</a>
窗体对象  

[返回对象:winform](https://www.aardio.com/zh-cn/docs/library-reference/win/ui/_.html#winform)

### wkeFlashObject._host <a id="wkeFlashObject._host" href="#wkeFlashObject._host">&#x23;</a>
容器对象

### wkeFlashObject._host.adjust() <a id="wkeFlashObject._host.adjust" href="#wkeFlashObject._host.adjust">&#x23;</a>
调整控件窗口大小

### wkeFlashObject._object <a id="wkeFlashObject._object" href="#wkeFlashObject._object">&#x23;</a>
控件对象

### wkeFlashObject.allowFullScreen <a id="wkeFlashObject.allowFullScreen" href="#wkeFlashObject.allowFullScreen">&#x23;</a>
布尔值,是否允许全屏

### wkeFlashObject.allowNetworking <a id="wkeFlashObject.allowNetworking" href="#wkeFlashObject.allowNetworking">&#x23;</a>
是否允许网络交互,可选值:  
"all","internal","none"

### wkeFlashObject.allowScriptAccess <a id="wkeFlashObject.allowScriptAccess" href="#wkeFlashObject.allowScriptAccess">&#x23;</a>
是否允许调用外部脚本,可选值:  
"always","sameDomain","never"

### wkeFlashObject.back() <a id="wkeFlashObject.back" href="#wkeFlashObject.back">&#x23;</a>
影片后退一帧并停止播放

### wkeFlashObject.bgcolor <a id="wkeFlashObject.bgcolor" href="#wkeFlashObject.bgcolor">&#x23;</a>
背景色  
用"#RRGGBB"格式的文本表示

### wkeFlashObject.body <a id="wkeFlashObject.body" href="#wkeFlashObject.body">&#x23;</a>
网页 body 元素 HTML 代码节点,  
修改此元素属性后需要调用 render 函数才会生效  

[返回对象:eleObject](#eleObject)

### wkeFlashObject.currentFrame() <a id="wkeFlashObject.currentFrame" href="#wkeFlashObject.currentFrame">&#x23;</a>
当前帧索引,注意第一帧索引为0

### wkeFlashObject.disableLocalSecurity() <a id="wkeFlashObject.disableLocalSecurity" href="#wkeFlashObject.disableLocalSecurity">&#x23;</a>
禁用本地安全,  
请不要在播放动画以后调用此函数,  
播放的swf是程序自带的可信任文件时应当禁用本地安全  
当指定控件的external接口时也会自动调用此函数

### wkeFlashObject.embedMovie <a id="wkeFlashObject.embedMovie" href="#wkeFlashObject.embedMovie">&#x23;</a>
该值如果为true则允许在加载后删除swf文件

### wkeFlashObject.enforceLocalSecurity() <a id="wkeFlashObject.enforceLocalSecurity" href="#wkeFlashObject.enforceLocalSecurity">&#x23;</a>
启用本地安全,  
请不要在播放动画以后调用此函数,  
如果播放的swf是程序自带的可信任文件应当启用本地安全

### wkeFlashObject.external <a id="wkeFlashObject.external" href="#wkeFlashObject.external">&#x23;</a>

```aardio
wkeFlashObject.external = {
	函数名 = function(参数){
		/*在FLASH中可使用 ExternalInterface.call() 调用这里的函数*/
		return "返回值";
	} 
}
```

### wkeFlashObject.flashVars <a id="wkeFlashObject.flashVars" href="#wkeFlashObject.flashVars">&#x23;</a>
等价于parameters属性,参考该属性说明

### wkeFlashObject.forward() <a id="wkeFlashObject.forward" href="#wkeFlashObject.forward">&#x23;</a>
影片后退一帧并停止播放

### wkeFlashObject.getPersistStream() <a id="wkeFlashObject.getPersistStream" href="#wkeFlashObject.getPersistStream">&#x23;</a>
返回数据流对象  

[返回对象:IPersistStreamInitObject](#IPersistStreamInitObject)

### wkeFlashObject.getVariable("字符串参数") <a id="wkeFlashObject.getVariable" href="#wkeFlashObject.getVariable">&#x23;</a>
获取FLASH变量

### wkeFlashObject.gotoFrame(索引) <a id="wkeFlashObject.gotoFrame" href="#wkeFlashObject.gotoFrame">&#x23;</a>
将影片跳转到指定的帧并停止播放.  
必须首先调用percentLoaded()函数保证影片完全加载

### wkeFlashObject.hwndControl <a id="wkeFlashObject.hwndControl" href="#wkeFlashObject.hwndControl">&#x23;</a>
Flash控件窗口句柄

### wkeFlashObject.loadMovie(layer,url) <a id="wkeFlashObject.loadMovie" href="#wkeFlashObject.loadMovie">&#x23;</a>
将由url指定的影片载入到由layer指定的层上  
如果url指定了一个资源文件路径,使用临时文件加载,并设置embedMovie属性为 true

### wkeFlashObject.loop <a id="wkeFlashObject.loop" href="#wkeFlashObject.loop">&#x23;</a>
是否循环播放

### wkeFlashObject.menu <a id="wkeFlashObject.menu" href="#wkeFlashObject.menu">&#x23;</a>
右键是否显示Flash控制菜单

### wkeFlashObject.movie <a id="wkeFlashObject.movie" href="#wkeFlashObject.movie">&#x23;</a>
设置swf文件网址,  
参数必须是网址,  
本地文件建议使用 wsock.tcp.simpleHttpServer.startUrl 转换为网址

### wkeFlashObject.pan(x,y,mode) <a id="wkeFlashObject.pan" href="#wkeFlashObject.pan">&#x23;</a>
将一个放大过的影片平移由x和y指定的距离,x和y均为相对值,  
mode默认值为1,按百分比计算,如果设为0则以像素计算

### wkeFlashObject.parameters <a id="wkeFlashObject.parameters" href="#wkeFlashObject.parameters">&#x23;</a>
设置初始化参数,也就是AS里的loaderInfo.parameters,  
参数格式与URL参数相同,设置一个表参数可自动转换为字符串,  
读取属性时返回字符串

### wkeFlashObject.percentLoaded() <a id="wkeFlashObject.percentLoaded" href="#wkeFlashObject.percentLoaded">&#x23;</a>
返回影片加载的百分比

### wkeFlashObject.play() <a id="wkeFlashObject.play" href="#wkeFlashObject.play">&#x23;</a>
播放

### wkeFlashObject.playing <a id="wkeFlashObject.playing" href="#wkeFlashObject.playing">&#x23;</a>
影片是否正在播放

### wkeFlashObject.putMovie("/res/ui.swf") <a id="wkeFlashObject.putMovie" href="#wkeFlashObject.putMovie">&#x23;</a>
加载Flash文件,  
参数可以是网址,文件名,支持内嵌资源目录文件名  
参数也可以是Flash文件的内存数据  
加载内存或资源文件时,直接调用write函数写入内存

### wkeFlashObject.quality <a id="wkeFlashObject.quality" href="#wkeFlashObject.quality">&#x23;</a>
获取设置影片质量,可选使用以下字符串表示值:  
"Low":偏重于播放速度而不管显示效果.  
"High":偏重于画面而不管播放速度  
"AutoLow":先着重于播放速度,但只要有可能就改善显示效果.  
"AutoHigh":一开始是播放速度和显示效果并重,但如有必要就牺牲画质确保速度.

### wkeFlashObject.readyState <a id="wkeFlashObject.readyState" href="#wkeFlashObject.readyState">&#x23;</a>
返回影片的当前状态,readyState值有:  
0:正在载入  
1:未初始化  
2:已载入  
3:正在交互  
4:完成例子

### wkeFlashObject.render() <a id="wkeFlashObject.render" href="#wkeFlashObject.render">&#x23;</a>
更新属性并重新创建 Flash 控件,  
修改 Flash 控件属性后需要调用此函数才会生效,  
修改 movie 属性自动调用此函数

### wkeFlashObject.rewind() <a id="wkeFlashObject.rewind" href="#wkeFlashObject.rewind">&#x23;</a>
返回到影片的第一帧

### wkeFlashObject.sAlign <a id="wkeFlashObject.sAlign" href="#wkeFlashObject.sAlign">&#x23;</a>
使用字符串表示对齐:  
"L":即左对齐  
"T":即顶对齐  
"R":即右对齐  
"B":即底对齐  
上面的值可组合使用,但LTRB的先后顺序不能变,如:左和底的对齐必须写为"LB"

### wkeFlashObject.scale <a id="wkeFlashObject.scale" href="#wkeFlashObject.scale">&#x23;</a>
缩放模式:  
"NoScale":显示原始大小不缩放,  
"ShowAll":显示全部影片区域,保持影片长宽比例不变.  
"NoBorder":显示部分影片区域,保持影片长宽比例不变.  
"ExactFit":显示全部影片区域,强制将影片的长宽等于控件的长宽.

### wkeFlashObject.setVariable("变量名",值) <a id="wkeFlashObject.setVariable" href="#wkeFlashObject.setVariable">&#x23;</a>
设置FLASH变量

### wkeFlashObject.show() <a id="wkeFlashObject.show" href="#wkeFlashObject.show">&#x23;</a>
显示Flash所在窗口

### wkeFlashObject.stop() <a id="wkeFlashObject.stop" href="#wkeFlashObject.stop">&#x23;</a>
暂停

### wkeFlashObject.swfObject <a id="wkeFlashObject.swfObject" href="#wkeFlashObject.swfObject">&#x23;</a>
网页 Flash 控件 HTML 代码节点,  
修改此元素属性后需要调用 render 函数才会生效  

[返回对象:eleObject](#eleObject)

### wkeFlashObject.totalFrames <a id="wkeFlashObject.totalFrames" href="#wkeFlashObject.totalFrames">&#x23;</a>
返回影片总帧数

### wkeFlashObject.translateUrl <a id="wkeFlashObject.translateUrl" href="#wkeFlashObject.translateUrl">&#x23;</a>

```aardio
wkeFlashObject.translateUrl = function(url){
    /*可在此函数中转换 movie 属性传入的 URL 参数  
也可以直接使用 wsock.tcp.simpleHttpServer.startUrl 等函数*/
    return url;
}
```

### wkeFlashObject.transparent <a id="wkeFlashObject.transparent" href="#wkeFlashObject.transparent">&#x23;</a>
是否启用透明模式,只写属性,  
应当写在初始化参数中

### wkeFlashObject.version <a id="wkeFlashObject.version" href="#wkeFlashObject.version">&#x23;</a>
flash控件版本

### wkeFlashObject.wMode <a id="wkeFlashObject.wMode" href="#wkeFlashObject.wMode">&#x23;</a>
控件的窗口模式,可选值"Window","Opaque","Transparent"

### wkeFlashObject.wait() <a id="wkeFlashObject.wait" href="#wkeFlashObject.wait">&#x23;</a>
等待影片加载完成

### wkeFlashObject.wait(true) <a id="wkeFlashObject.wait" href="#wkeFlashObject.wait">&#x23;</a>
等待影片播放完成

### wkeFlashObject.wke <a id="wkeFlashObject.wke" href="#wkeFlashObject.wke">&#x23;</a>
浏览器对象  

[返回对象:webKitViewObject](#webKitViewObject)

### wkeFlashObject.write() <a id="wkeFlashObject.write" href="#wkeFlashObject.write">&#x23;</a>
直接通过写入内存数据重新加载swf文件

### wkeFlashObject.writeStream() <a id="wkeFlashObject.writeStream" href="#wkeFlashObject.writeStream">&#x23;</a>
写入数据流  
参数应是fsys.strem等兼容IStream接口的对象

### wkeFlashObject.xcall("FLASH函数名",其他参数) <a id="wkeFlashObject.xcall" href="#wkeFlashObject.xcall">&#x23;</a>
调用FLASH中使用ExternalInterface.addCallback()导出的函数
