Package | yy |
Interface | public interface IVideo extends flash.events.IEventDispatcher |
Method | Defined By | ||
---|---|---|---|
getCameraList():Object
获取当前计算机摄像头名称列表。
| IVideo | ||
getPublishUsers():Object
获取当前子频道的正在直播的主播列表。
| IVideo | ||
lock():Object
锁定视频直播。锁定后才能调用视频直播的其他API,同时当前YY的其他应用无法调用视频直播。
| IVideo | ||
setProperty(key:int, value:int):Object
设置发起直播时的视频属性。启用重新开始直播才生效。
| IVideo | ||
setPublishVideo_480x360():Object
设置直播的视频分辨率为480x360,需要重新开始直播才生效。
| IVideo | ||
setPublishVideo_640x480():Object
设置直播的视频分辨率为640x480,需要重新开始直播才生效。
| IVideo | ||
setPublishVideoWindowPosition(x:int, y:int, width:int, height:int):Object
调整主播直播视频窗口的大小和位置。
| IVideo | ||
setSubscribeVideoWindowPosition(x:int, y:int, width:int, height:int, uid:uint):Object
调整指定主播的视频订阅窗口的大小和位置。订阅多个视频的时候,可以对指定主播的视频窗口进行单独调整。
| IVideo | ||
setVideoWindowPosition(x:int, y:int, width:int, height:int):Object
调整视频直播窗口的大小和位置。
| IVideo | ||
startPublish(cameraIndex:uint):Object
开始视频直播。缺省的分辨率360x240
| IVideo | ||
startSubscribeVideo(uid:uint):Object
开始视频订阅,即收看指定主播的直播。如果已经订阅了一个直播,需要先停止后才能订阅新的直播。
| IVideo | ||
stopPublish():Object
结束视频直播。
| IVideo | ||
stopSubscribeVideo(uid:uint):Object
停止视频订阅,即关闭正在收看的视频。有效的主播uid才能停止订阅。
| IVideo | ||
unlock():Object
解锁视频直播,使其他应用可以使用摄像头视频。所有参数(例如直播分辨率)变为缺省值。
| IVideo |
Event | Summary | Defined By | ||
---|---|---|---|---|
摄像头状态变化事件。通知主播摄像头状态发生变化。 事件信息格式说明: eventData.status int类型 摄像头状态 0=摄像头就绪,1=摄像头就绪暂不可用(被别的程序占用),2=摄像头无法支持。 | IVideo | |||
主播直播结果事件。主播开始直播后,根据此事件判断直播是否是成功的。 事件信息格式说明: eventData.status int类型 直播结果 0=成功开始直播,1=直播失败。 | IVideo | |||
主播直播状态变化事件。当当前子频道有主播直播状态发生变化会触发,即主播开始直播或者结束直播的时候都会通知子频道中侦听此事件的用户。 事件信息格式说明: eventData.uid uint类型 直播状态发生变化的主播的uid。 eventData.status int类型 主播状态 0=主播开始直播,1=主播结束直播。 | IVideo |
getCameraList | () | method |
public function getCameraList():Object
获取当前计算机摄像头名称列表。
ReturnsObject — 返回摄像头列表,具体属性如下。
ret: uint类型 返回码 0=成功,非0值失败,具体请参考错误代码。 cameras: Array类型 摄像头名称列表。 |
使用示例: var result = YY.instance.video.getCameraList(); if(result.ret==0) { trace("本机摄像头为:" + result.cameras); } 成功的返回值示例:{ ret:0,cameras:["camera1","camera2"]} 失败的返回值示例:{ ret:984832}
getPublishUsers | () | method |
public function getPublishUsers():Object
获取当前子频道的正在直播的主播列表。
ReturnsObject — 返回主播uid列表,具体属性如下。
ret: uint类型 返回码 0=成功,非0值失败,具体请参考错误代码。 publishList: Array类型 主播uid列表。 |
使用示例: var result = YY.instance.video.getPublishUsers(); if(result.ret==0) { trace("正在直播的主播有:" + result.publishList); } 成功的返回值示例:{ ret:0,publishList:[909011223,909085545]} 失败的返回值示例:{ ret:984832}
lock | () | method |
public function lock():Object
锁定视频直播。锁定后才能调用视频直播的其他API,同时当前YY的其他应用无法调用视频直播。
ReturnsObject — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
setProperty | () | method |
public function setProperty(key:int, value:int):Object
设置发起直播时的视频属性。启用重新开始直播才生效。
Parameters
key:int — 视频属性Id。
| |
value:int — 属性值。
|
Object — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
setPublishVideo_480x360 | () | method |
public function setPublishVideo_480x360():Object
设置直播的视频分辨率为480x360,需要重新开始直播才生效。
ReturnsObject — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
setPublishVideo_640x480 | () | method |
public function setPublishVideo_640x480():Object
设置直播的视频分辨率为640x480,需要重新开始直播才生效。
ReturnsObject — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
setPublishVideoWindowPosition | () | method |
public function setPublishVideoWindowPosition(x:int, y:int, width:int, height:int):Object
调整主播直播视频窗口的大小和位置。
Parameters
x:int — 指定窗口位置的x值
| |
y:int — 指定窗口位置的y值
| |
width:int — 指定窗口的宽度
| |
height:int — 指定窗口的高度
|
Object — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
setSubscribeVideoWindowPosition | () | method |
public function setSubscribeVideoWindowPosition(x:int, y:int, width:int, height:int, uid:uint):Object
调整指定主播的视频订阅窗口的大小和位置。订阅多个视频的时候,可以对指定主播的视频窗口进行单独调整。
Parameters
x:int — 指定窗口位置的x值
| |
y:int — 指定窗口位置的y值
| |
width:int — 指定窗口的宽度
| |
height:int — 指定窗口的高度
| |
uid:uint — 指定主播的uid
|
Object — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
setVideoWindowPosition | () | method |
public function setVideoWindowPosition(x:int, y:int, width:int, height:int):Object
调整视频直播窗口的大小和位置。
Parameters
x:int — 指定窗口位置的x值
| |
y:int — 指定窗口位置的y值
| |
width:int — 指定窗口的宽度
| |
height:int — 指定窗口的高度
|
Object — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
startPublish | () | method |
public function startPublish(cameraIndex:uint):Object
开始视频直播。缺省的分辨率360x240
Parameters
cameraIndex:uint — 视频摄像头的索引,必须是有效的非负整数,如果计算机上有多个摄像头,索引分别为0,1,2...以此类推。
|
Object — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
startSubscribeVideo | () | method |
public function startSubscribeVideo(uid:uint):Object
开始视频订阅,即收看指定主播的直播。如果已经订阅了一个直播,需要先停止后才能订阅新的直播。
Parameters
uid:uint — 主播的uid,主播即开播视频直播的人,getPublishUsers可以获取当前正在直播的主播。
|
Object — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
stopPublish | () | method |
public function stopPublish():Object
结束视频直播。
ReturnsObject — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
stopSubscribeVideo | () | method |
public function stopSubscribeVideo(uid:uint):Object
停止视频订阅,即关闭正在收看的视频。有效的主播uid才能停止订阅。
Parameters
uid:uint — 要停止订阅的主播的uid,主播即开播视频直播的人,getPublishUsers以获取当前正在直播的主播。
|
Object — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
unlock | () | method |
public function unlock():Object
解锁视频直播,使其他应用可以使用摄像头视频。所有参数(例如直播分辨率)变为缺省值。
ReturnsObject — 返回调用是否成功,是一个Object对象,具体属性如下。
ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。 |
CAMERA_STATUS | Event |
yy.events.VideoEvent
yy.events.VideoEvent.CAMERA_STATUS
摄像头状态变化事件。通知主播摄像头状态发生变化。
事件信息格式说明:
eventData.status int类型 摄像头状态 0=摄像头就绪,1=摄像头就绪暂不可用(被别的程序占用),2=摄像头无法支持。
PUBLISH_STATUS | Event |
yy.events.VideoEvent
yy.events.VideoEvent.PUBLISH_STATUS
主播直播结果事件。主播开始直播后,根据此事件判断直播是否是成功的。
事件信息格式说明:
eventData.status int类型 直播结果 0=成功开始直播,1=直播失败。
SUBSCRIBE_STATUS | Event |
yy.events.VideoEvent
yy.events.VideoEvent.SUBSCRIBE_STATUS
主播直播状态变化事件。当当前子频道有主播直播状态发生变化会触发,即主播开始直播或者结束直播的时候都会通知子频道中侦听此事件的用户。
事件信息格式说明:
eventData.uid uint类型 直播状态发生变化的主播的uid。
eventData.status int类型 主播状态 0=主播开始直播,1=主播结束直播。