System - Adobe ActionScript® 3（AS3 ）API リファレンス

パッケージ	flash.system
クラス	public final class System
継承	System Object

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9, Flash Lite 4

System クラスには、ローカル設定と操作に関連するプロパティが含まれています。これらのプロパティには、カメラとマイクの設定、共有オブジェクトの操作、クリップボードの使用に関するものがあります。

追加のプロパティとメソッドが、flash.system パッケージ内のその他のクラス（Capabilities クラス、IME クラス、Security クラス）にあります。

このクラスには、静的なメソッドとプロパティのみが含まれています。System クラスの新しいインスタンスは作成できません。

例を表示

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		freeMemory : Number [静的] [読み取り専用] Adobe® Flash® Player または Adobe® AIR® に割り当てられているが現在使用されていないメモリ量（バイト単位）です。	System
		ime : IME [静的] [読み取り専用] 現在インストールされているシステムの IME です。	System
		privateMemory : Number [静的] [読み取り専用] アプリケーションで使用されるメモリ量の合計（バイト単位）です。	System
		totalMemory : uint [静的] [読み取り専用] Flash Player または AIR によって直接割り当てられている現在使用中のメモリ量（バイト単位）です。	System
		totalMemoryNumber : Number [静的] [読み取り専用] Flash Player または AIR によって直接割り当てられている現在使用中のメモリ量（バイト単位）です。	System
		useCodePage : Boolean [静的] 外部テキストファイルを解釈するときにどのコードページを使用するかを決定するブール値です。	System

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		disposeXML(node:XML):void [静的] 指定した XML オブジェクトを即時にガベージコレクションで処理できるようにします。	System
		exit(code:uint):void [静的] Flash Player を閉じます。	System
		gc():void [静的] ガベージコレクションプロセスを強制します。	System
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		pause():void [静的] Flash Player または AIR Debug Launcher（ADL）を一時停止します。	System
		pauseForGCIfCollectionImminent(imminence:Number = 0.75):void [静的] ガベージコレクターの緊急度が関数の imminence パラメーターを上回った場合に、コレクターのインクリメンタルな収集サイクルを終了する必要があることをコレクターに指示します。	System
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		resume():void [静的] System.pause() を呼び出した後、アプリケーションを再開します。	System
		setClipboard(string:String):void [静的] クリップボードの内容を、指定されたテキストストリングで置き換えます。	System
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object

プロパティの詳細

freeMemory

プロパティ

freeMemory:Number [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10.1, AIR 2

Adobe^® Flash^® Player または Adobe^® AIR^® に割り当てられているが現在使用されていないメモリ量（バイト単位）です。この割り当て済みメモリの未使用領域（System.totalMemory）は、ガベージコレクションが行われると変動します。このプロパティを使用して、ガベージコレクションを監視します。

実装
public static function get freeMemory():Number

ime

プロパティ

ime:IME [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9, Flash Lite 4

現在インストールされているシステムの IME です。imeComposition イベントに登録するには、このインスタンスで addEventListener() を呼び出します。

実装
public static function get ime():IME

関連する API エレメント

IMEConversionMode

privateMemory

プロパティ

privateMemory:Number [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10.1, AIR 2

アプリケーションで使用されるメモリ量の合計（バイト単位）です。これは、プロセス全体の常駐プライベートメモリの量です。

AIR 開発者は、このプロパティを使用してアプリケーション全体のメモリ消費量を特定します。

Flash Player の場合は、Web ブラウザーなどのコンテナアプリケーションで使用されるメモリも含まれます。

実装
public static function get privateMemory():Number

totalMemory

プロパティ

totalMemory:uint [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9, Flash Lite 4

Flash Player または AIR によって直接割り当てられている現在使用中のメモリ量（バイト単位）です。

このプロパティは、Adobe AIR アプリケーション、または Flash Player コンテンツを含むアプリケーション（ブラウザーなど）によって使用されるすべてのメモリを返すわけではありません。ブラウザーまたはオペレーティングシステムは、これ以外にメモリを消費する可能性があります。System.privateMemory プロパティは、アプリケーションによって使用されるすべてのメモリを反映します。

割り当てられたメモリ量が、uint オブジェクトの最大値（uint.MAX_VALUE、または 4,294,967,295）よりも大きい場合、このプロパティは 0 に設定されます。System.totalMemoryNumber プロパティでは、より大きい値が許容されます。

実装
public static function get totalMemory():uint

totalMemoryNumber

プロパティ

totalMemoryNumber:Number [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10.1, AIR 2

Flash Player または AIR によって直接割り当てられている現在使用中のメモリ量（バイト単位）です。

このプロパティは、int 型の System.totalMemory プロパティよりも大きい値を許容する Number 型として表現されます。

実装
public static function get totalMemoryNumber():Number

関連する API エレメント

freeMemory
privateMemory
totalMemory

useCodePage

プロパティ

useCodePage:Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9, Flash Lite 4

外部テキストファイルを解釈するときにどのコードページを使用するかを決定するブール値です。このプロパティを false に設定すると、外部テキストファイルは Unicode として解釈されます。これらのファイルは、保存する際に Unicode でエンコードする必要があります。このプロパティを true に設定すると、アプリケーションを実行するオペレーティングシステムの通常のコードページを使用して外部テキストファイルが解釈されます。 useCodePage のデフォルト値は false です。

（Loader.load()、URLLoader クラスまたは URLStream を使用して）外部ファイルとしてロードするテキストを Unicode として認識するには、そのファイルを Unicode として保存しておく必要があります。外部ファイルを Unicode でエンコードするには、Unicode をサポートするアプリケーション（Windows のメモ帳など）でファイルを保存します。

Unicode でエンコードされていない外部テキストファイルをロードする際には、useCodePage を true に設定してください。次の行を、データをロードしているファイルのコードの最初の行として追加します（Flash Professional の場合は、最初のフレームに追加します）。

System.useCodePage = true;

このコードがあると、外部テキストは、オペレーティングシステムの通常のコードページを使用して解釈されます。例えば、一般に、英語の Windows オペレーティングシステムでは CP1252 が、日本語のオペレーティングシステムでは Shift-JIS が使用されます。

Flash Player 6 以降で useCodePage を true に設定すると、テキストは Flash Player 5 の場合と同様に扱われます。Flash Player 5 では、すべてのテキストは、Flash Player を実行するオペレーティングシステムの通常のコードページを使用して解釈されていました。

useCodePage を true に設定した場合、外部テキストファイル内で使用されている文字がアプリケーションを実行するオペレーティングシステムの通常のコードページに含まれていないと、そのテキストは表示されません。例えば、中国語を含む外部テキストファイルをロードする場合、CP1252 コードページを使用するシステムでは、これらの文字を表示できません。CP1252 コードページには中国語が含まれていないためです。

アプリケーションで使用する外部テキストファイルをすべてのプラットフォームのユーザーが表示できるようにするには、すべての外部テキストファイルを Unicode でエンコードし、useCodePage を false に設定します。これにより、アプリケーション（Flash Player 6 以降または AIR ）でテキストが Unicode として解釈されます。

実装
public static function get useCodePage():Boolean
public static function set useCodePage(value:Boolean):void

関連する API エレメント

flash.display.Loader.load()

メソッドの詳細

disposeXML

()

メソッド

public static function disposeXML(node:XML):void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10.1, AIR 1.5.2

指定した XML オブジェクトを即時にガベージコレクションで処理できるようにします。このメソッドを使用すると、指定した XML ノードに対するすべてのノード間の親接続と子接続が削除されます。

パラメーター

node:XML — ガベージコレクションで処理できるようにする XML 参照です。

exit

()

メソッド

public static function exit(code:uint):void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9.0.115.0

Flash Player を閉じます。

スタンドアローン Flash Player デバッグ版のみ。

AIR アプリケーションでは、アプリケーションを終了するために NativeApplication.exit() メソッドを呼び出す必要があります。

パラメーター

code:uint — オペレーティングシステムに渡す値です。通常、処理が正常に終了すると、値は 0 になります。

関連する API エレメント

flash.desktop.NativeApplication.exit()

gc

()

メソッド

public static function gc():void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9.0.115.0, Flash Lite 4

ガベージコレクションプロセスを強制します。

Flash Player デバッグ版および AIR アプリケーションのみ。AIR アプリケーションでは、System.gc() メソッドは AIR Debug Launcher（ADL）で実行しているコンテンツ、またはインストールされているアプリケーションではアプリケーションセキュリティサンドボックスのコンテンツでのみ有効になります。

pause

()

メソッド

public static function pause():void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9.0.115.0, Flash Lite 4

Flash Player または AIR Debug Launcher（ADL）を一時停止します。このメソッドを呼び出したときにアプリケーションで実行が続行されるのは、Socket イベントの配信だけです。

Flash Player デバッガー版または AIR Debug Launcher（ADL）のみに対応しています。

関連する API エレメント

resume()

pauseForGCIfCollectionImminent

()

メソッド

public static function pauseForGCIfCollectionImminent(imminence:Number = 0.75):void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 11, AIR 3

ガベージコレクターの緊急度が関数の imminence パラメーターを上回った場合に、コレクターのインクリメンタルな収集サイクルを終了する必要があることをコレクターに指示します。

Flash ランタイムガベージコレクターアルゴリズムは、インクリメンタルに実行しながら、使用中のメモリをマークします。メモリの未使用部分を収集中は、アプリケーションの実行を一時停止します。インクリメンタルな収集サイクルが終了したときに発生する一時停止の時間は、望ましい時間より長くなることがあり、プログラムによっては目や耳で感知できる場合があります。この関数により、アプリケーションからランタイムに対して、マークの完了と収集の実行に適したタイミングであることを知らせることができます。ユーザーが気付かないタイミングで一時停止をスケジュールすることは、ユーザーエクスペリエンスの向上につながります。例えば、ゲームでは、あるレベルが完了した時点でこの関数を呼び出せば、プレイ中に一時停止が発生する可能性が低くなります。

緊急度は、マーキングによるコレクターの判断、つまり、収集の一時停止をトリガーするタイミングがどこまで近付いているかで定義されます。この関数の imminence 引数はしきい値です。実際の緊急度がしきい値を超えた場合にのみ、ガベージコレクターは呼び出されます。それ以外の場合は、この関数は処理を行わずに直ちに返されます。

imminence に低い値を設定してこの関数を呼び出すと、比較的大量のマーキングを完了する必要があることをアプリケーションが許容できることが示されます。一方、imminence に高い値を設定すると、マーキングがほぼ完了した場合にのみアプリケーションの一時停止が必要なことが示されます。通常、後者よりも前者で一時停止の時間が長くなります。

解放されるメモリ量は、imminence パラメーターによって変化しません。解放可能なオブジェクト数のみによって変化します。アプリケーションが大きなデータ構造や多数のオブジェクトへの参照を解放したばかりの場合は、imminence パラメーターに低い値を設定すると、コレクション処理がトリガーされて、これらのオブジェクトがすぐに解放される傾向があります。

パラメーター

imminence:Number (default = 0.75) — 0 ～ 1 の数値。0 は緊急度が最も低く、1 は緊急度が最も高いことを表します。0 未満の値のデフォルトは 0.25、1.0 よりも大きな値のデフォルトは 1.0、NaN のデフォルトは 0.75 です。

resume

()

メソッド

public static function resume():void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9.0.115.0, Flash Lite 4

System.pause() を呼び出した後、アプリケーションを再開します。

Flash Player デバッガー版または AIR Debug Launcher（ADL）のみに対応しています。

関連する API エレメント

pause()

setClipboard

()

メソッド

public static function setClipboard(string:String):void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

クリップボードの内容を、指定されたテキストストリングで置き換えます。このメソッドは、キー入力や入力デバイスのクリックなどのユーザーイベントに応じて呼び出されたときに、任意のセキュリティコンテキストで動作します。

このメソッドは、Flash Player 9 で実行されている SWF コンテンツに提供されます。クリップボードへのストリング内容の追加のみが許可されます。

Flash Player 10 のコンテンツと AIR アプリケーションのアプリケーションセキュリティサンドボックスのコンテンツは、Clipboard.setData() メソッドを呼び出すことができます。

パラメーター

string:String — システムクリップボードの現在の内容（存在する場合）を置き換えるプレーンテキストストリング文字です。

関連する API エレメント

flash.desktop.Clipboard

例この例の使用方法

SystemExample.as

次の例は、システムの合計メモリに関する情報をシステムクリップボードにコピーする方法を示しています。System.setClipboard() メソッドの呼び出し内で System.totalMemory の呼び出しを使用します。

package {
    import flash.display.Sprite;
    import flash.system.System;

    public class SystemExample extends Sprite {
        public function SystemExample() {
            System.setClipboard("System.totalMemory: " + System.totalMemory);
        }
    }
}

法律上の注意 | プライバシーポリシー

System - AS3

パッケージx

言語エレメント

付録

パッケージ flash.system

freeMemory

ime

privateMemory

totalMemory

totalMemoryNumber

useCodePage

disposeXML

exit

gc

pause

pauseForGCIfCollectionImminent

resume

setClipboard