CaptionUI

new CooSDK.CaptionUI(props)

字幕UI组件。

Name Type Description
props Object

包含如下属性的Object：

Name Type Default Description
content String

字幕内容。
direction EnumDirection EnumDirection.UP optional

字幕运动方向。
isPlay Boolean true optional

播放状态。
playLength Number

字幕播放长度(像素)。
playSpeed Number

字幕播放速度(像素/帧)。
playTimes Number

字幕播放次数(次)。
startPos Vector2Obj

字幕播放起始位置(屏幕坐标)。
screen CooMap | ScreenObj null optional

所属窗口，默认为CooMap所拥有的主窗口。
textColor Vector3Obj new Vector3Obj(1,0,0) optional

字体颜色(RGB)。
textFont String "C:\\Windows\\Fonts\\DENG.ttf" optional

字幕所使用的字体的本地路径，若未显示文字，请配置系统上存在的字体文件路径。
textSize Number 10 optional

字体大小。
Example:
var captionUI = new CooSDK.CaptionUI({
     content: "测试文字",
     playSpeed: 1,
     playTimes: 10,
     playLength: 500,
     startPos: new CooSDK.Vector2Obj(100, 100)
});
Demo:

Members

content : String

获取或者设置字幕显示内容。

direction : EnumDirection

获取或者设置字幕运动方向。

Default Value: EnumDirection.UP

isPlay : Boolean

获取或者设置字幕播放开关。

Default Value: true

playLength : Number

获取或者设置字幕播放长度(像素)。

playSpeed : Number

获取或者设置字幕播放速度(像素/帧)。

playTimes : Number

获取或者设置字幕循环播放次数。

screen : CooMap|ScreenObj

获取或者设置所属窗口，默认为CooMap所拥有的主窗口。

Default Value: null

startPos : Vector2Obj

获取或者设置字幕播放起始屏幕位置。

textColor : Vector3Obj

获取或者设置字幕字体颜色(RGB)。

Default Value: new Vector3Obj(1,0,0)

textFont : String

获取或者设置字幕字体路径，若未显示文字，请配置系统上存在的字体文件路径。。

Default Value: "C:\\Windows\\Fonts\\DENG.ttf"

textSize : Number

获取或者设置字幕字体大小。

Default Value: 10

Methods

destroy()

从场景中销毁自身。

Returns:

null 空值。

Example:
// 销毁对象
captionUI = captionUI.destroy();

update(props)

更新单个或者多个对象属性，使之立即生效。

一般用于多个属性的同时更新，避免性能开销过大。

Name Type Description
props Object optional

包含如下属性的Object：

Name Type Description
content String optional

字幕内容。
direction EnumDirection optional

字幕运动方向。
isPlay Boolean optional

播放状态。
playLength Number optional

字幕播放长度(像素)。
playSpeed Number optional

字幕播放速度(像素/帧)。
playTimes Number optional

字幕播放次数(次)。
startPos Vector2Obj optional

字幕播放起始位置(屏幕坐标)。
textColor Vector3Obj optional

字体颜色(RGB)。
textFont String optional

字幕所使用的字体的本地路径，若未显示文字，请配置系统上存在的字体文件路径。。
textSize Number optional

字体大小。
Example:
captionUI.update({
   direction : EnumDirection.RIGHT,
   isPlay : true
});