多平台统一管理软件接口,如何实现多平台统一管理软件接口
2252
2023-02-20
本文目录一览:
首要做的事情就是联系巅峰开放平台,申请相关的appid和appSecret。
然后保存到本地,在调用接口的时候使用,否则将无权限进行接口的调用。
1.接口调用原理
调用巅峰开放平台的API接口时,即是API调用端(即用户调用接口运行的程序)调用API服务器端的数据(即RC2P提供的服务器,可调用巅峰开放平台上的数据)时的交互流程。
2.申请调用接口使用权限
首先介绍概念:
appSecret:应用密钥,也是巅峰开放平台颁发给客户端应用的,不可对外公开,不需要在URL地址中进行传递,应用商家需注意保密,调用API的时候需要使用。
通过上面的介绍可知,如果要想调用巅峰开放平台的API接口服务,首要做的事情就是联系巅峰开放平台,申请相关的appid和appSecret,然后保存到本地,在调用接口的时候使用,否则将无权限进行接口的调用。
3.如何加密
针对每个API接口,都可能拼出不同的URL,针对该URL,需要调用巅峰开放平台提供的rc2p-utils.jar 实现加密,并将加密的值作为access_token参数的值。
CMP4的API接口简介
API就是应用程序接口音乐api接口文档,CMP4的API用来提供给插件或页面脚本进行调用音乐api接口文档,以达到对CMP4进行控制的目的
通过API,可以读取或设置CMP4的相关属性,可以调用部分方法,可以绑定一些事件进行侦听等等
CMP4支持API的地方:
(1),全局配置中插件plugins和背景backgrounds,自定义频谱mixer_src,还包括logo,video_image,lrc_image
(2),皮肤中的5个窗口背景src
(3),列表项的视频区背景bg_video和歌词区背景bg_lrc
(4),JavaScript页面脚本(部分支持),必须允许脚本通讯(allowScriptAccess=always)
其中Flash的脚本必须为ActionScript 3.0版本,所以API接口分以下两种情况进行讨论: 通过AS3的API接口通讯,我们可以在插件或皮肤中,直接获取CMP数据并进行控制,
下面是所以支持的属性,方法,事件
属性attributes:
cmp:Object;返回cmp对象
config:Object;取得cmp全局配置,包含所有可读写的全局配置,以及其音乐api接口文档他一些配置的只读属性,比如当前播放状态state,具体有哪些可用for in语句查询
item:Object;取得当前播放项,包含所有列表项属性,以及其他一些播放项的只读属性,具体有哪些可用for in语句查询
list_xml:XML;取得列表xml的引用
skin_xml:XMLList;取得当前皮肤配置的引用
tools:Object;返回cmp的工具箱,主要有:base64, effects, graphics, netclient, output, states, strings, types, zoom, zip
win_list:Object;
取得5个窗口的引用,有如下5个属性: option/list/media/console/lrc
当然还可以访问下一级对象,如要访问播放按钮bt_play则可:
var bt_play = api.win_list.console. bt_play;
结构和名称同皮肤包里面的skin.xml皮肤配置的结构和名称
方法methods:
addEventListener():void;
添加一个事件侦听器,如侦听皮肤加载完成事件:
api.addEventListener(api.key, 'skin_loaded', skinHandler);
特别不同,这里第一个参数需传入api.key,它是一个唯一key值,用于第三方flash移除时,销毁其key所在所有注册的事件
addProxy():void;
添加一个代理函数,用于src=proxy:函数名,函数参数这样的协议,如:
api.addProxy(youku, yk_callback);
这样就可以用自定义的yk_callback(函数参数)方法来解析协议:src=proxy:youku,函数参数
cookie():String读取(cookie(name))和写入(cookie(name, data))本地存储,类似于浏览器cookie,但无时间过期限制
removeEventListener():void;移除一个事件侦听器,如:api.removeEventListener('skin_loaded', skinHandler);
sendEvent():void;
发送一个事件,如:api.sendEvent(view_play);
如果有参数data要传递就是:api.sendEvent(view_play, data);
sendState():void;
发送一个新的播放状态,如将播放状态改为正连接:
api.sendState(connecting);
toString():String;打印api所有属性,方法,事件类型,方便查阅所有支持的api
事件类型events:按字母顺序
api发送api共享事件时调度
api_removeapi插件移除时调用
control_fullscreen全屏状态改变时调度
control_link打开链接页面时调度
control_load音乐开始加载时调度
control_max最大化改变时调度,事件的data将传递是lrc_max还是video_max
control_mute静音状态改变时调度
control_next播放下一个时调度
control_pause暂停时调度
control_play播放时调度
control_playmode播放模式改变时调度
control_prev播放上一个时调度
control_progress进度改变时调度
control_stop停止时调度
control_volume音量改变时调度
control_win窗口打开关闭时调度
control_winbt窗口对应按钮状态改变时调度
item_deleted
列表项删除时调度
事件的data将返回删除项对象
list_change列表已经改变时调度,表示新的列表已经刷新,可用于播放等操作
list_load
使列表开始加载时调度
事件的data可以传入新指定的配置lists进行加载
list_loaded
列表内容加载完时调度,多个列表会调度多个,每次会将加载的列表数据进行解析,然后附加到总列表,再刷新列表
事件的data可以传入新指定的xml列表内容字符进行解析,此功能便于外载调用,直接输入列表内容
lrc_complete
歌词成功加载完成时调度
事件data返回当前加载成功的歌词类型:lrc或kmc
lrc_error
歌词加载或解析错误时调度
事件data将返回错误信息
lrc_load
使当前音乐的歌词开始加载时调度
事件data可以传入指定当前音乐的歌词地址,支持lrc和kmc地址
lrc_loaded
歌词加载完成时调度
事件data可以传入指定的歌词内容,支持lrc和kmc格式内容
lrc_max对歌词最大化状态进行切换
lrc_resize歌词尺寸改变时调度,包括对歌词进行缩放调整
lrc_rowchange
当前歌词行内容改变时调度,仅支持lrc和kmc格式
事件data将传递返回当前行的歌词内容
有了这个事件可以很方便的调用js api在浏览器标题栏或状态栏打印当前位置的歌词
mixer_color
对混音器颜色进行变更时调度
事件data可以传入新的颜色值
mixer_displace
对混音器的置换效果状态进行切换时调度
事件data可传入true或false
mixer_filter
对混音器的滤镜效果状态进行切换时调度
事件data可传入true或false
mixer_next
使用下一个混音器效果时调度
事件data可以传入下一个频谱效果的id
mixer_prev
使用上一个混音器效果时调度
事件data可以传入下一个频谱效果的id
model_change
模块改变时调度
事件data可以传入要使用的新模块类型type
model_error
当前项发生错误时调度
事件data将返回错误信息
model_load
模块开始加载时调度
事件data可以传入即将要播放媒体url
model_loaded当前项下载完成时调度
model_loading当前项正在下载时调度
model_meta
当前项取得meta信息时调度
事件data将返回meta数据对象
model_start当前项第一次开始播放时调度,一般此时才开始加载歌词或开始显示频谱
model_state
当前项状态改变时调度
事件data将返回当前状态,所有支持状态码为:
undefined 未定义
connecting 连接中
buffering 缓冲
playing 正在播放
paused 已暂停
stopped 已停止
completed 播放完成
reconnecting 重试连接
状态改变时,将在皮肤的状态栏显示当前状态对应的说明,说明可以在皮肤配置的languages多语言里自定义
model_time当前项播放时间改变时调度
plugins_load
插件和背景开始加载时调度
事件data可传入新指定的配置plugins(不支持backgrounds)进行加载
plugins_loadedplugins参数指定的插件全部加载完成时调度(此时将第一次加载列表lists指定的文件)
plugins_remove插件和背景移除时调度
resize播放器舞台改变尺寸时调度
skin_change
针对皮肤id对皮肤进行改变时调度
事件data可以直接传入新的皮肤id
skin_complete皮肤显示完成时调度
skin_load
皮肤开始加载时调度
事件data可以传入新指定的配置skins参数进行加载
skin_loaded皮肤加载完成时调度
video_blackwhite
对视频是否启用黑白效果滤镜
事件data可传入true或false
video_effect
对视频进行颜色滤镜(ColorMatrixFilter)改变时调度
事件data可以传入一个英文逗号隔开的数组值,用来新建颜色矩阵滤镜ColorMatrixFilter
video_highlight
对视频是否启用高亮效果滤镜
事件data可传入true或false
video_max对视频最大化进行切换时调度
video_resize视频尺寸改变时调度
video_rotation
对视频进行旋转时调度
事件data可以传入旋转的角度值,如90
video_scalemode
对视频进行缩放模式改变时调度
事件data可以传入支持缩放模式的id,支持0,1,2,3
video_smoothing
对视频是否启用平滑效果时调度
事件data可以传入true或false
view_console对控制窗口状态进行改变时调度
view_forward点击快进按钮时调度
view_fullscreen对全屏状态进行改变时调度
view_item
对播放项进行改变时调度
view_link
点击链接按钮时调度
事件data可以传入新指定的链接进行打开
view_list对列表窗口进行改变时调度
view_lrc对歌词窗口进行改变时调度
view_mute点击静音按钮时调度
view_next点击下一个按钮时调度
view_option对设置窗口进行改变时调度
view_play
点击播放或暂停按钮时调度
事件的data可以传递列表id位置,表示播放第几个
view_prev点击上一个按钮时调度
view_progress
拖动播放进度条时调度
事件data可以传入指定的进度百分值
view_random点击随机播放模式按钮时调度
view_repeat点击重复播放模式按钮时调度
view_rewind点击快退按钮时调度
view_single点击单遍播放模式按钮时播放
view_stop点击停止按钮时调度
view_video对视频窗口状态进行改变时调度
view_volume
拖动音量条时调度
事件data可以传入指定的volume音量值和panning平移值,用英文逗号隔开,如:1,0
具体API接口应用的例子可以见安装包的示例:plugins/ApiExample .as 或者直接到官方插件库查看,
全部附源文件: 下列函数的调用,需要先获取CMP所在flash的对象,也就是例子中的cmpo,获取方法见使用范例
cmp_api();只读,返回CMP所有支持的API信息,包括CMP支持的所以APIvar str = cmpo.cmp_api();
config();1,读取CMP当前所有的全局配置,返回一个Object对象,包含所有可读写的全局配置属性设置,以及其他一些只读属性var config = cmpo.config();
2,读取配置的某个属性值,具体支持哪些属性,可用for in语句查询
var name = cmpo.config(name);
var name = cmpo.config().name;
3,修改某个属性的值,需传入属性名称和值
注意:修改属性仅是将值写入配置中,需要下次有相关的刷新(如发送事件)才应用新的值
cmpo.config(skin_id, 1);
item();1,返回当前播放项的一个Object对象,如果没有开始任何播放,将返回null,其包含当前项的所有属性var item = cmpo.item();
2,返回当前播放项的某个属性值,具体支持哪些属性,可用for in语句查询
var src = cmpo.item(src);
var src = cmpo.item().src;
3,修改某个属性的值(一般不用)cmpo.item(src, test .mp3);
list_xml();1,读取CMP当前列表内容,返回一个xml的字符串var xml = cmpo.list_xml();
2,修改列表内容,需传入一个xml列表格式的字符串
var xml = '<list<m label=test src=test .mp3 /</list';
cmpo.list_xml(xml);
如果需要覆盖原有的音乐可以设置第2个参数,表示是否附加到原有列表后面,默认为true表示附加,传入false表示不附加,将重建列表并写入新的列表内容cmpo.list_xml(xml, false);
list();
1,返回CMP列表数的所有信息,包括未打开的列表
将返回一个数组,数组每项都是一个音乐项对象,类型为Object
var arr = cmpo.list();
读取一级列表的个数var num = cmpo.list().length;
返回第二个项,数组是从0开始的,第二个项索引就是1var m2 = cmpo.list()[1];
如果这个音乐项是个目录,则会有children属性,表示它下面的子列表,也是一个数组
以此类推,这样我们可以逐个循环得到整个列表
当然音乐项也有parent属性,表示其父目录对象
var m2_arr = m2.children;
2,返回某个指定的项对象
参数可以是包含唯一key值Object型的项对象,也可以直接传入字符型key值
key值可以从上面1中的列表项对象中读取
var item = cmpo.list(m2);
var item = cmpo.list(ITEM_1);
3,读取项的某个属性var src = cmpo.list(ITEM_1, src);
如果传入的参数是项支持的一个方法名,则执行此项的某个方法
目前支持:play播放此项, open打开此目录, close关闭此目录, toggle开关切换, remove移除此项
cmpo.list(ITEM_1, play);
skin_xml();只读,返回当前皮肤配置文件内容的xml字符形式var xml = cmpo.skin_xml();
skin();1,读取皮肤元件的某个属性值,第1个参数表示皮肤元件位置,第2个是元件属性名
var width = cmpo.skin(console, width);
var xywh = cmpo.skin(console .bt_play, xywh);
2,修改元件的某个属性,如果修改成功将返回truecmpo.skin(console .bt_play, xywh, 0, 0, 100, 20);
sendEvent();
往CMP发送事件
第1个参数是事件类型,所有支持类型见AS3中的所有事件类型列表
第2个参数是需要传入的数据(可选)
cmpo.sendEvent(view_play);
cmpo.sendEvent(view_play, 2);
addEventListener();
添加一个js侦听方法
第1个参数是事件类型,同上
第2个参数是回调函数名,字符串格式
cmpo.addEventListener(item_deleted, del);
function del(data) { }
removeEventListener();移除一个已经注册的js侦听方法cmpo.removeEventListener(item_deleted, del);
cookie();CMP的通用存储接口,可以在本地电脑存储并读取已经存储的数据,flash需启用本地存储(默认是10K容量),这些数据是永久储存的,而且跨浏览器
cmpo.cookie(name, CMP4);
var name = cmpo.cookie(name);
版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。
发表评论
暂时没有评论,来抢沙发吧~