FLVPlaybackCaptioning  - AS3

确定 FLVPlaybackCaptioning 组件是否可以自动移动 TextField 对象并调整其大小以便添加字幕。

如果将 autoLayout 属性设置为 true，则在距 FLVPlayback 实例底部 10 个像素的位置显示包含字幕的 DisplayObject 实例或 TextField 对象。 加字幕区域覆盖 FLVPlayback 实例的宽度，在每边均保持 10 个像素的边距。

如果将该属性设置为 true，则直接在 FLVPlayback 实例上显示 DisplayObject 实例或 TextField 对象。 如果您创建自己的 TextField 对象，则应将 autoLayout 设置为 false。如果 wordWrap = false，则加字幕区域处于 FLVPlayback 实例之上的中心位置，但可以比 FLVPlayback 实例宽。

若要控制布局，您需要侦听 captionChange 事件，以确定创建 TextField 对象实例的时间。

默认值为 true。

相关 API 元素

定义 captionButton FLVPlayback 自定义 UI 组件实例，该实例提供打开和关闭字幕的切换功能。

captionButton 属性的功能与 FLVPlayback 属性 playButton、pauseButton、muteButton 等类似。

相关 API 元素

设置要在其中显示字幕的 DisplayObject 实例。

如果您将实例设置为 TextField 对象，则直接将其作为目标。 如果您将该实例设置为包含一个或多个 TextField 对象的 DisplayObjectContainer，则在具有最低显示索引的 TextField 对象中显示字幕。

DisplayObjectContainer 方法支持具有缩放 9 背景的影片剪辑类对象，该对象可以在 TextField 对象的尺寸发生更改时缩放。

若要实现更复杂的缩放和绘制，请编写代码让 DisplayObjectContainer 方法侦听 captionChange 事件。

注意：如果未设置 captionTargetName 或 captionTarget 属性，则 FLVPlaybackCaptioning 实例创建一个由 captionTarget 属性使用下列格式设置的文本字段：

• 黑色背景（background = true；backgroundColor = 0x000000；）
• 白色文本 (textColor = 0xFFFFFF)
• autoSize = TextFieldAutoSize.LEFT
• multiLine = true
• wordWrap = true
• font = "_sans"
• size = 12

若要自定义这些值，请侦听 captionTargetCreated 事件。

相关 API 元素

TextField 对象或包括包含字幕的 Textfield 对象的 MovieClip 的实例名称。

若要指定为无目标，请将该属性设置为空字符串（即无指定目标）或 auto。该属性主要用在组件检查器中。 如果您编写代码，请改用 captionTarget 属性。

默认值为 auto。

相关 API 元素

设置 FLVPlayback 实例以添加字幕。 FLVPlayback 实例必须与 FLVPlaybackCaptioning 实例具有相同的父级。

如果 flvPlaybackName 或 flvPlayback 属性未设置，则 FLVPlaybackCaptioning 实例将查找与之具有相同父级的 FLVPlayback 实例，并且将对找到的第一个实例加字幕。

相关 API 元素

为您要添加字幕的 FLVPlayback 实例设置一个 FLVPlayback 实例名称。

若要指定为无目标，请将其设置为空字符串或 auto。FLVPlayback 实例必须与 FLVPlaybackCaptioning 实例具有相同的父级。

FLVPlayback 实例名称主要用在组件检查器中。 如果您编写代码，请使用 flvPlayback 属性。

如果 flvPlaybackName 或 flvPlayback 属性未设置，或设置为 auto，则 FLVPlaybackCaptioning 实例将搜索与之具有相同父级的 FLVPlayback 实例，并且将对找到的第一个实例加字幕。

默认值为 auto。

相关 API 元素

用于显示字幕；true = 显示字幕，false = 不显示字幕。

如果您使用 captionButton 属性来允许用户打开和关闭字幕，请将 showCaptions 属性设置为 false。

默认值为 true。

相关 API 元素

当设置为 true 时，限制来自于 Timed Text 文件的格式设置指令。

如果将 simpleFormatting 属性设置为 true，则不支持下列样式：

• tts:backgroundColor
• tts:color
• tts:fontSize
• tts:fontFamily
• tts:wrapOption

如果将 simpleFormatting 属性设置为 true，则支持下列样式：

• tts:fontStyle
• tts:fontWeight
• tts:textAlign

包含字幕信息的 Timed Text XML 文件的 URL（必需属性）。

支持多语言轨道。

对 track 属性的最佳利用是支持具有嵌入提示点的多语言轨道。

您必须遵循 FLVPlaybackCaptioning 提示点支持的格式。

如果将 track 属性设置为除 0 以外的值，则 FLVPlaybackCaptioning 组件在提示点上搜索 text<n> 属性，其中，n 为轨道值。

例如，如果 track == 1，则 FLVPlayBackCaptioning 组件在提示点上搜索参数 text1。如果未找到匹配的参数，则使用提示点参数中的 text 属性。

默认值为 0。

将字幕功能连接到 FLVPlayback 组件中的特定 VideoPlayer。

如果您要在多个视频播放器中使用字幕功能（在 FLVPlayback 组件中使用 activeVideoPlayerIndex 和 visibleVideoPlayerIndex 属性），则应该为要使用的每个 VideoPlayer 创建一个 FLVPlaybackCaptioning 组件实例，并将该属性设置为与索引对应。

仅使用一个视频播放器时，VideoPlayer 索引默认为 0。

相关 API 元素

创建新的 FLVPlaybackCaptioning 实例。

返回那些字幕文本中包含搜索字符串的 FLVPlayback 组件提示点数组。

参数

返回包含字幕的 FLVPlayback 组件提示点数组。

将包含所有字幕的字符串作为一个 HTML 格式的文本返回。

每行字幕都包含在一个 p 标签中，并且该标签带有 class 属性“fl_video_caption”、一个以字符串“fl_video_caption_2_0_”开头的具有唯一性的 id 属性，以及一个用于指示字幕在视频中出现位置的时间码的 title 属性。

以下是返回的 HTML 的简单示例：

		 <div id="fl_video_transcript" class="fl_video_transcript">
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_1" title="0:00.50"><i>( speaking French ): </i><br/><b>George: </b> Bonjour, Marie.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_2" title="0:01.75"><b>Marie: </b> Bonjour, George.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_3" title="0:03.75">VoilÀ une sucette.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_4" title="0:05.50"><b>George: </b> C'est pour moi?</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_5" title="0:06.50"><b>Marie: </b> Oui, c'est pour toi.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_6" title="0:08.00"><b>George: </b> Merci, Marie!</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_7" title="0:09.50"><b>Marie: </b> De rien, George.</p>
		 </div>
		 

参数

返回时间码字符串形式的秒数。

参数

当添加字幕或从字幕目标文本字段中删除字幕时调度。

当下列条件具备时也会调度该事件：

• 未设置 captionTargetName 属性
• 未设置 captionTarget 属性
• FLVPlaybackCaptioning 实例自动创建一个 TextField 对象，用于添加字幕。

该 captionChange 事件具有常量 CaptionChangeEvent.CAPTION_CHANGE。

此事件具有以下属性：

相关 API 元素

在创建 captionTarget 属性之后，添加任何字幕之前（captionTarget 属性为空）调度。

如果使用自定义 DisplayObject 设置 captionTarget 属性，或设置了 captionTargetName 属性，则不调度该事件。

如果您自定义 TextField 对象的属性（例如 defaultTextFormat 属性），则侦听该事件。

该 captionTargetCreated 事件具有常量 CaptionTargetEvent.CAPTION_TARGET_CREATED。

此事件具有以下属性：

相关 API 元素

在所有 Timed Text XML 数据加载完之后调度。

此事件具有以下属性：

相关 API 元素

若对 URLLoader.load() 事件的调用尝试通过 HTTP 访问 Timed Text XML 文件，并且当前的 Flash Player 环境能够检测并返回该请求的状态代码，则进行调度。

此事件具有以下属性：

相关 API 元素

若对 URLLoader.load() 事件的调用导致致命错误并因此终止了 Timed Text XML 文件的下载，则进行调度。

不处理该事件会引发错误。

此事件具有以下属性：

相关 API 元素

在调用 URLLoader.load() 方法之后开始下载操作以加载 Timed Text XML 文件时进行调度。

此事件具有以下属性：

相关 API 元素

在下载 Timed Text XML 文件的过程中收到数据时进行调度。

此事件具有以下属性：

相关 API 元素

若对 URLLoader.load() 事件的调用尝试从安全沙箱外部的服务器加载 Timed Text XML 文件，则进行调度。

不处理该事件会引发错误。

此事件具有以下属性：

相关 API 元素

指示组件短版本号的状态变量。 版本号在您有 FLA 文件并且需要知道组件版本时很有用。 要确定组件版本，请在 FLA 文件中键入下列 trace：

trace (FLVPlaybackCaptioning.SHORT_VERSION);

SHORT_VERSION 变量仅包含主版本号和次版本号，例如：2.0。version 变量包含主版本号和次版本号，以及修订版本号和生成版本号，例如：2.0.0.xx。

相关 API 元素

指示组件长版本号的状态变量。 版本号在您有 FLA 文件并且需要知道组件版本时很有用。 要确定组件版本，请在 FLA 文件中键入下列 trace：

trace (FLVPlaybackCaptioning.VERSION);

VERSION 变量包含主版本号和次版本号，以及修订版本号和生成版本号，例如：2.0.0.xx。 SHORT_VERSION 变量仅包含主版本号和次版本号，例如：2.0。

相关 API 元素

若要运行该示例，请按照下列步骤操作：

1. 打开一个新的 Flash 文件 (ActionScript 3.0)。
2. 在舞台的 (0,0) 坐标处放置 FLVPlayback 组件，并提供实例名称：“player”。
3. 在舞台的 (0,0) 坐标处放置 FLVPlaybackCaptioning 组件，并提供实例名称：“captioning”。
4. 将 CaptionButton 组件放在舞台上。
5. 保存 FLA 文件并为其指定一个名称，例如“captionEx”。
6. 打开一个新的 ActionScript 文件。
7. 将下面的类示例代码粘贴到一个新的 ActionScript 文件中，并将其作为 FLVPlaybackCaptioningExample.as 另存到 FLA 文件所在的同一目录中。
8. 在 FLA 文件（例如 captionEx）中，在“属性”检查器中将“Document”类条目设置为“FLVPlaybackCaptioningExample”。
9. 选择“控制”>“测试影片”。

package
{
    import fl.video.CaptionChangeEvent;
    import fl.video.FLVPlayback;
    import fl.video.FLVPlaybackCaptioning;
    import flash.display.Sprite;
    import flash.text.TextField;
    
    public class FLVPlaybackCaptioningExample extends Sprite {

        private var videoPath:String = "http://www.helpexamples.com/flash/video/caption_video.flv";
        private var captioningPath:String = "http://www.helpexamples.com/flash/video/caption_video.xml";
        
        public function FLVPlaybackCaptioningExample() {
            player.source = videoPath;
            player.skin = "SkinOverAllNoCaption.swf";
            player.skinBackgroundColor = 0x666666;
            player.skinBackgroundAlpha = 0.5;

            captioning.flvPlayback = player;
            captioning.source = captioningPath;
            captioning.autoLayout = false;            
            captioning.addEventListener(CaptionChangeEvent.CAPTION_CHANGE, onCaptionChange);
        }

        private function onCaptionChange(e:CaptionChangeEvent):void {
            var tf:* = e.target.captionTarget;
            var player:FLVPlayback = e.target.flvPlayback;

            // move the caption below the video
            tf.y = 210;            
        }
    }
}