Flash CS3 ドキュメンテーション

ActionScript 2.0 コンポーネントリファレンスガイド > FLVPlayback コンポーネント > FLVPlayback クラス > FLVPlayback.findNearestCuePoint()

FLVPlayback.findNearestCuePoint()

使用できるバージョン

Flash Player 8

エディション

Flash Professional 8

シンタックス

my_FLVplybk.findNearestCuePoint(time:Number[, type:String]):Object
my_FLVplybk.findNearestCuePoint(name:String[, type:String]):Object 
my_FLVplybk.findNearestCuePoint(cuePoint:Object[, type:String]):Object 

パラメータ

time 検索するキューポイントの時間を秒単位で示す数値。小数点以下 3 桁まで使用され、それ以下の桁を指定した場合は四捨五入されます。この時間に一致するキューポイント、または指定したタイプに最も近い前のキューポイントを返します。複数のキューポイントの時間が同じで、ActionScript キューポイント内のみでしか発生しない場合は、アルファベット順で最初のキューポイントの名前のみを返します。一致しなかった場合は null を返します。

name 検索するキューポイントの名前を表すストリング。この名前に一致する最初のキューポイントを返します。一致しなかった場合は null を返します。

cuePoint 検索対象の time プロパティおよび name プロパティを含むキューポイントオブジェクト。時間を指定し、name プロパティに値を指定しないか null を指定した場合、パラメータは検索対象の時間を表す数値であるものとして検索が実行されます。名前を指定し、time プロパティに値を指定しないか null または負の値を指定した場合、パラメータは検索対象の名前を含むストリングであるものとして検索が実行されます。time および name の両方のプロパティを指定した場合、それらの値に一致するキューポイントが存在すれば、一致するキューポイントを返します。時間と名前の両方に一致するキューポイントがない場合、名前が一致し、指定した時間以前にある最初のキューポイントを返します。指定した時間以前にその名前のキューポイントがない場合、名前が一致する最初のキューポイントを返します。それ以外の場合は、null を返します。

type オプション。検索するキューポイントのタイプを示すストリング。このパラメータに指定できる値は、"actionscript"、"all"、"event"、"flv"、または "navigation" です。これらの値は、FLVPlayback.ACTIONSCRIPT、FLVPlayback.ALL、FLVPlayback.EVENT、FLVPlayback.FLV、FLVPlayback.NAVIGATION の各クラスプロパティを使用して指定できます。このパラメータを指定しない場合のデフォルトは "all" で、すべてのキューポイントタイプを検索することを意味します。

戻り値

見つかったキューポイントオブジェクトのコピーであるオブジェクト。次に示すプロパティも返します。

array 検索されたキューポイントの配列。この配列内でオブジェクトを追加、削除、編集するとキューポイントが正常に動作しないので、この配列は読み取り専用として扱う必要があります。

index 返されたキューポイントの配列内のインデックス。

一致しなかった場合は null を返します。

説明

メソッド。指定したタイプで、指定した時間に一致するか、指定した時間以前にあるキューポイントを検索します。時間と名前の両方を指定した場合、指定した時間以前にその名前のキューポイントがなければ、名前が一致する最初のキューポイントを検索します。それ以外の場合は、null を返します。

検索には無効にされているキューポイントも含まれます。キューポイントが無効であるかどうかを判断するには、isFLVCuePointEnabled() メソッドを使用します。

時間が null、undefined、または負の値である値で、名前が null または undefined である場合は、VideoError エラー (1002) をスローします。

例

次の例では、FLV ファイルの 4.07 秒に ActionScript キューポイントを作成します。このキューポイントが発生すると、cuePoint イベントハンドラが findNearestCuePoint() メソッドを呼び出し、5 秒後に最も近い任意のタイプのキューポイントを検索します。[出力] パネルには、返されたキューポイントの名前、時間、およびタイプが表示されます。

FLVPlayback コンポーネントをステージにドラッグし、インスタンス名を my_FLVPlybk にします。続いて、次のコードをタイムラインのフレーム 1 の [アクション] パネルに追加します。

/**
 必須 :
  - my_FLVPlybk というインスタンス名の FLVPlayback コンポーネントがステージ上にあること
*/
import mx.video.*;
my_FLVPlybk.contentPath = "http://www.helpexamples.com/flash/video/cuepoints.flv";
var cuePt:Object = new Object(); // キューポイントオブジェクトを作成する
cuePt.time = 4.07;
cuePt.name = "ASpt1";
cuePt.type = "actionscript";
my_FLVPlybk.addASCuePoint(cuePt);  // AS キューポイントを追加する
function cuePoint(eventObject:Object):Void {    
    if (eventObject.info.name == "ASpt1") {
        var rtn_obj:Object = new Object();
        rtn_obj = my_FLVPlybk.findNearestCuePoint(eventObject.info.time + 5);
        trace("Cue point name is: " + rtn_obj.name);
        trace("Cue point time is: " + rtn_obj.time);
        trace("Cue point type is: " + rtn_obj.type);
    }
}
my_FLVPlybk.addEventListener("cuePoint", cuePoint);

関連項目

FLVPlayback.addASCuePoint(), FLVPlayback.cuePoints, FLVPlayback.findCuePoint(), FLVPlayback.findNextCuePointWithName(), FLVPlayback.isFLVCuePointEnabled(), FLVPlayback.removeASCuePoint(), FLVPlayback.seekToNavCuePoint(), FLVPlayback.seekToNextNavCuePoint(), FLVPlayback.seekToPrevNavCuePoint(), FLVPlayback.setFLVCuePointEnabled()

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flash/9.0_jp/main/00003009.html

コメントの追加