FLVPlaybackCaptioning  - AS3

判斷 FLVPlaybackCaptioning 組件是否會自動移動 TextField 物件並調整其大小，以便做為註解。

如果 autoLayout 屬性設定為 true，則包含註解的 DisplayObject 實體或 TextField 物件會從 FLVPlayback 實體底端起顯示 10 個像素。 註解區域會涵蓋 FLVPlayback 實體的寬度，並在每一邊都會維持 10 個像素寬的邊界。

當此屬性設定為 true 時，DisplayObject 實體或 TextField 物件會直接顯示在 FLVPlayback 實體上。 如果您要建立自己的 TextField 物件，則應該將 autoLayout 設定為 false。 如果 wordWrap = false，註解區會置中出現在 FLVPlayback 實體上，但是可能會比 FLVPlayback 實體還要寬。

若要控制配置，您必須偵聽 captionChange 事件，以判斷 TextField 物件實體是何時建立的。

預設值為 true。

相關 API 元素

會定義 captionButton FLVPlayback 的自訂使用者介面組件實體，此實體會提供開啟和關閉註解的切換功能。

captionButton 屬性的功能類似於 FLVPlayback 的 playButton、pauseButton、muteButton 等屬性。

相關 API 元素

會設定要在其中顯示註解的 DisplayObject 實體。

如果您將實體設定為 TextField 物件，即是直接以它為目標。 如果您將實體設定為包含一個或多個 TextField 物件的 DisplayObjectContainer，則註解會顯示在具有最小顯示索引的 TextField 物件中。

DisplayObjectContainer 方法支援像是有九宮格縮放 (Scale-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 值。

例如，如果 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 屬性是空的) 傳送。

如果 captionTarget 屬性是以自訂 DisplayObject 設定的，或者已設定 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 元素

在載入 Timed Text XML 檔的下載作業開始，並接著呼叫 URLLoader.load() 方法時傳送。

這個事件具有下列屬性：

相關 API 元素

隨著 Timed Text XML 檔下載進度接收資料時傳送。

這個事件具有下列屬性：

相關 API 元素

在對 URLLoader.load() 事件的呼叫嘗試從安全執行程序以外的伺服器載入 Timed Text XML 檔時，便會傳送此事件。

如果此事件不加以處理，便會擲回錯誤。

這個事件具有下列屬性：

相關 API 元素

狀態變數，指出組件的簡短版本號碼。 當您有 FLA 檔，並且需要知道組件版本時，版本號碼就會非常有用。 若要確定組件版本，請在 FLA 檔中輸入下列追蹤程式碼：

trace (FLVPlaybackCaptioning.SHORT_VERSION);

SHORT_VERSION 變數只包含主要和次要版本號碼，例如 2.0。VERSION 變數包含主要和次要版本號碼，以及修訂和組建編號，例如 2.0.0.xx。

相關 API 元素

狀態變數，指出組件的完整版本號碼。 當您有 FLA 檔，並且需要知道組件版本時，版本號碼就會非常有用。 若要確定組件版本，請在 FLA 檔中輸入下列追蹤程式碼：

trace (FLVPlaybackCaptioning.VERSION);

VERSION 變數包含主要和次要版本號碼，以及修訂和組建編號，例如 2.0.0.xx。 SHORT_VERSION 變數只包含主要和次要版本號碼，例如 2.0。

相關 API 元素

若要執行範例，請遵循下列步驟：

1. 開啟新的 Flash 檔案 (ActionScript 3.0)。
2. 將 FLVPlayback 組件放在「舞台」上 0,0 的位置，並提供實體名稱「player」。
3. 將 FLVPlaybackCaptioning 組件放在舞台上 0,0 的位置，並提供實體名稱「captioning」。
4. 將 CaptionButton 組件放在「舞台」上。
5. 儲存 FLA 檔並指定名稱，例如 captionEx。
6. 開啟新的 ActionScript 檔案。
7. 請將下列類別範例程式碼貼至新的 ActionScript 檔案，並且在您 FLA 檔所在的目錄中將它儲存為 FLVPlaybackCaptioningExample.as。
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;            
        }
    }
}