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 カスタム UI コンポーネント）インスタンスを定義します。

captionButton プロパティは、FLVPlayback プロパティである playButton、pauseButton、muteButton などと同じように機能します。

関連する API エレメント

キャプションを表示する DisplayObject インスタンスを設定します。

このインスタンスに TextField オブジェクトを設定すると、それはそのままターゲットになります。このインスタンスに、1 つ以上の 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 == 1 である場合、FLVPlayBackCaptioning コンポーネントは、キューポイント上でパラメーター text1 を検索します。一致するパラメーターが見つからない場合は、キューポイントパラメーター内の text プロパティを使用します。

デフォルト値： 0。

FLVPlayback コンポーネントの特定の VideoPlayer にキャプションを接続します。

複数のビデオプレーヤー（FLVPlayback コンポーネント内で activeVideoPlayerIndex および visibleVideoPlayerIndex プロパティを使用）でキャプションを使用する場合は、使用する各 VideoPlayer について FLVPlaybackCaptioning コンポーネントのインスタンスを 1 つ作成し、このプロパティに対応するインデックスを設定する必要があります。

ビデオプレーヤーを 1 つだけ使用しているときは、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 (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）において、プロパティインスペクターでドキュメントクラスエントリを 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;            
        }
    }
}