blob: ad42b646b09aa5e93f0996ed18cd4d1c4a753028 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<apiPackage id="mx.controls.videoClasses"><apiName>mx.controls.videoClasses</apiName><apiDetail/><apiClassifier id="mx.controls.videoClasses:VideoError"><apiName>VideoError</apiName><shortdesc>
VideoError クラスは、VideoDisplay コントロールによってスローされたエラーのエラーコードを表します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>Error</apiBaseClassifier></apiClassifierDef><apiDesc>
VideoError クラスは、VideoDisplay コントロールによってスローされたエラーのエラーコードを表します。
</apiDesc></apiClassifierDetail><related-links><link href="mx.controls.xml#VideoDisplay"><linktext>mx.controls.VideoDisplay</linktext></link></related-links><apiConstructor id="mx.controls.videoClasses:VideoError:VideoError"><apiName>VideoError</apiName><shortdesc>
コンストラクターです。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>errCode</apiItemName><apiType value="uint"/><apiDesc>エラーコードです。
</apiDesc></apiParam><apiParam><apiItemName>msg</apiItemName><apiType value="String"/><apiData>null</apiData><apiDesc>エラーメッセージです。
</apiDesc></apiParam></apiConstructorDef><apiDesc>
コンストラクターです。
</apiDesc></apiConstructorDetail></apiConstructor><apiValue id="mx.controls.videoClasses:VideoError:DELETE_DEFAULT_PLAYER"><apiName>DELETE_DEFAULT_PLAYER</apiName><shortdesc>
デフォルトの VideoPlayer は削除できません。
</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiAccess value="public"/><apiStatic/><apiData>1007</apiData><apiType value="uint"/></apiValueDef><apiDesc>
デフォルトの VideoPlayer は削除できません。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.controls.videoClasses:VideoError:ILLEGAL_CUE_POINT"><apiName>ILLEGAL_CUE_POINT</apiName><shortdesc>
キューポイントが不正です。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiAccess value="public"/><apiStatic/><apiData>1002</apiData><apiType value="uint"/></apiValueDef><apiDesc>
キューポイントが不正です。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.controls.videoClasses:VideoError:INVALID_CONTENT_PATH"><apiName>INVALID_CONTENT_PATH</apiName><shortdesc>
コンテンツパスが無効です。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiAccess value="public"/><apiStatic/><apiData>1004</apiData><apiType value="uint"/></apiValueDef><apiDesc>
コンテンツパスが無効です。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.controls.videoClasses:VideoError:INVALID_SEEK"><apiName>INVALID_SEEK</apiName><shortdesc>
シークが無効です。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiAccess value="public"/><apiStatic/><apiData>1003</apiData><apiType value="uint"/></apiValueDef><apiDesc>
シークが無効です。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.controls.videoClasses:VideoError:INVALID_XML"><apiName>INVALID_XML</apiName><shortdesc>
XML が無効です。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiAccess value="public"/><apiStatic/><apiData>1005</apiData><apiType value="uint"/></apiValueDef><apiDesc>
XML が無効です。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.controls.videoClasses:VideoError:NO_BITRATE_MATCH"><apiName>NO_BITRATE_MATCH</apiName><shortdesc>
ビットレートが一致しません。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiAccess value="public"/><apiStatic/><apiData>1006</apiData><apiType value="uint"/></apiValueDef><apiDesc>
ビットレートが一致しません。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.controls.videoClasses:VideoError:NO_CONNECTION"><apiName>NO_CONNECTION</apiName><shortdesc>
サーバーに接続できない、またはサーバー上で FLV が見つかりません。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiAccess value="public"/><apiStatic/><apiData>1000</apiData><apiType value="uint"/></apiValueDef><apiDesc>
サーバーに接続できない、またはサーバー上で FLV が見つかりません。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.controls.videoClasses:VideoError:NO_CUE_POINT_MATCH"><apiName>NO_CUE_POINT_MATCH</apiName><shortdesc>
一致するキューポイントが見つかりませんでした。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiAccess value="public"/><apiStatic/><apiData>1001</apiData><apiType value="uint"/></apiValueDef><apiDesc>
一致するキューポイントが見つかりませんでした。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.controls.videoClasses:VideoError:code:get"><apiName>code</apiName><shortdesc>
エラーコードを含みます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="read"/><apiType value="uint"/></apiValueDef><apiDesc>
エラーコードを含みます。
</apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier id="mx.controls.videoClasses:CuePointManager"><apiName>CuePointManager</apiName><shortdesc>
CuePointManager クラスでは、ActionScript コードを使用して VideoDisplay コントロールに関連付けられたキューポイントを管理できます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>Object</apiBaseClassifier></apiClassifierDef><apiDesc>
CuePointManager クラスでは、ActionScript コードを使用して VideoDisplay コントロールに関連付けられたキューポイントを管理できます。
</apiDesc></apiClassifierDetail><related-links><link href="mx.controls.xml#VideoDisplay"><linktext>mx.controls.VideoDisplay</linktext></link></related-links><apiConstructor id="mx.controls.videoClasses:CuePointManager:CuePointManager"><apiName>CuePointManager</apiName><shortdesc>
コンストラクターです。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/><apiParam><apiItemName>owner</apiItemName><apiType value="mx.controls.videoClasses:VideoPlayer"/><apiDesc>この CuePointManager の親である VideoPlayer インスタンスです。
</apiDesc></apiParam><apiParam><apiItemName>id</apiItemName><apiType value="uint"/><apiData>0</apiData><apiDesc>このパラメーターは、後方互換性を維持するためだけに提供されているもので、無視されます。
</apiDesc></apiParam></apiConstructorDef><apiDesc>
コンストラクターです。
</apiDesc></apiConstructorDetail></apiConstructor><apiOperation id="mx.controls.videoClasses:CuePointManager:addCuePoint"><apiName>addCuePoint</apiName><shortdesc>
キューポイントを追加します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiException><apiDesc>引数が無効かどうかを示します。
</apiDesc><apiItemName>VideoError</apiItemName><apiOperationClassifier>mx.controls.videoClasses:VideoError</apiOperationClassifier></apiException><apiReturn><apiDesc>追加されるキューポイント Object のコピーです。 このコピーには、次の追加プロパティがあります。
<ul>
<li><codeph>array</codeph> - すべてのキューポイントの配列です。 この配列内でオブジェクトを追加、削除、編集するとキューポイントが正常に動作しないので、この配列は読み取り専用として扱う必要があります。</li>
<li><codeph>index</codeph> - 返されたキューポイントの配列内のインデックスです。</li>
</ul>
</apiDesc><apiType value="Object"/></apiReturn><apiParam><apiItemName>cuePoint</apiItemName><apiType value="Object"/><apiDesc>Object は、キューポイントを記述します。 <codeph>name:String</codeph> プロパティと <codeph>time:Number</codeph> プロパティ(秒単位)を含んでいる必要があります。 Object がこれらの規則に従っていない場合は、<codeph>VideoError</codeph> エラーがスローされます。
</apiDesc></apiParam></apiOperationDef><apiDesc>
キューポイントを追加します。
<p>名前と時刻が同じキューポイントを複数追加できます。 名前と時刻を指定して <codeph>removeCuePoint()</codeph> メソッドを呼び出すと、一致するキューポイントのうち最初に出現するものが削除されます。 一致するすべてのキューポイントを削除するには、<codeph>removeCuePoint()</codeph> メソッドを繰り返し呼び出す必要があります。</p>
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.videoClasses:CuePointManager:getCuePointByName"><apiName>getCuePointByName</apiName><shortdesc>
指定された名前のキューポイントを検索します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>一致するキューポイントが見つからない場合は <codeph>null</codeph> です。一致するキューポイントがある場合は、次の追加プロパティがあるキューポイント Object のコピーです。
<ul>
<li><codeph>array</codeph> - 検索されたキューポイントの配列です。 この配列内でオブジェクトを追加、削除、編集するとキューポイントが正常に動作しないので、この配列は読み取り専用として扱う必要があります。</li>
<li><codeph>index</codeph> - 返されたキューポイントの配列内のインデックスです。</li>
</ul>
</apiDesc><apiType value="Object"/></apiReturn><apiParam><apiItemName>name</apiItemName><apiType value="String"/><apiDesc>キューポイントの名前です。
</apiDesc></apiParam></apiOperationDef><apiDesc>
指定された名前のキューポイントを検索します。
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.videoClasses:CuePointManager:getCuePoints"><apiName>getCuePoints</apiName><shortdesc>
すべてのキューポイントの配列を返します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>キューポイントオブジェクトの配列です。 各キューポイントオブジェクトはキューポイントを記述し、<codeph>name:String</codeph> プロパティと <codeph>time:Number</codeph> プロパティ(秒単位)を含みます。
</apiDesc><apiType value="Array"/></apiReturn></apiOperationDef><apiDesc>
すべてのキューポイントの配列を返します。
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.videoClasses:CuePointManager:removeAllCuePoints"><apiName>removeAllCuePoints</apiName><shortdesc>
すべてのキューポイントを削除します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="void"/></apiReturn></apiOperationDef><apiDesc>
すべてのキューポイントを削除します。
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.videoClasses:CuePointManager:removeCuePoint"><apiName>removeCuePoint</apiName><shortdesc>
現在ロードされている FLV ファイルからキューポイントを削除します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiDesc>削除されたキューポイントを表すオブジェクトです。 一致するキューポイントがない場合は、<codeph>null</codeph> が返されます。
</apiDesc><apiType value="Object"/></apiReturn><apiParam><apiItemName>cuePoint</apiItemName><apiType value="Object"/><apiDesc>Object には、少なくとも <codeph>name:String</codeph> プロパティと <codeph>time:Number</codeph> プロパティのいずれかが含まれている必要があります。これにより、指定されたプロパティと一致するキューポイントが削除されます。
</apiDesc></apiParam></apiOperationDef><apiDesc>
現在ロードされている FLV ファイルからキューポイントを削除します。 削除するキューポイントを決定するには、<codeph>name</codeph> プロパティと <codeph>time</codeph> プロパティだけが <codeph>cuePoint</codeph> 引数から使用されます。
<p>複数のキューポイントが検索条件に一致する場合は、1 つだけが削除されます。 すべてのキューポイントを削除するには、<codeph>null</codeph> が返されるまで、同じ引数を使用して、この関数をループで繰り返し呼び出します。</p>
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.controls.videoClasses:CuePointManager:setCuePoints"><apiName>setCuePoints</apiName><shortdesc>
キューポイントの配列を設定します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>cuePointArray</apiItemName><apiType value="Array"/><apiDesc>キューポイントオブジェクトの配列です。 各キューポイントオブジェクトは、キューポイントを記述します。 <codeph>name:String</codeph> プロパティと <codeph>time:Number</codeph> プロパティ(秒単位)を含んでいる必要があります。
</apiDesc></apiParam></apiOperationDef><apiDesc>
キューポイントの配列を設定します。
<p>名前と時刻が同じキューポイントを複数追加できます。 名前を指定して <codeph>removeCuePoint()</codeph> メソッドを呼び出すと、最初に出現する同じ名前のキューポイントだけが削除されます。</p>
</apiDesc></apiOperationDetail></apiOperation></apiClassifier></apiPackage>