Unity UI上でムービを再生するためのコンポーネントです。 [詳解]

CriManaMovieControllerForUI の継承関係図

公開型
enum	MaxFrameDrop
	最大フレームドロップ数種別

enum	RenderMode
	マテリアル描画モード種別 [詳解]

公開メンバ関数
delegate void	OnApplicationPauseCallback (CriManaMovieMaterialBase manaMovieMaterial, bool appPause)
	アプリケーションポーズ時コールバックデリゲート [詳解]

void	Play ()
	再生を開始します。 [詳解]

void	Stop ()
	ムービ再生の停止要求を行います。 [詳解]

void	Pause (bool sw)
	ムービ再生のポーズ切り替えを行います。 [詳解]

void	PlayerManualInitialize ()
	プレーヤーの初期化（手動用） [詳解]

void	PlayerManualFinalize ()
	プレーヤーの終了（手動用） [詳解]

void	PlayerManualSetup ()
	プレーヤーの準備（手動用） [詳解]

void	PlayerManualUpdate ()
	プレーヤーのフレーム更新（手動用） [詳解]

公開変数類
UnityEngine.UI.Graphic	target
	ムービマテリアルの設定対象の UnityEngine.UI.Graphic です。 [詳解]

bool	useOriginalMaterial
	ムービフレームが使用できない場合にオリジナルのマテリアルを表示するか。 [詳解]

bool	playOnStart = false
	Start 時に再生を行うかを設定します。 [詳解]

bool	restartOnEnable = false
	OnEnable時に最初から再生するか否かの設定です。 [詳解]

RenderMode	renderMode = RenderMode.Always
	マテリアル描画モード [詳解]

OnApplicationPauseCallback	onApplicationPauseCallback = null
	アプリケーションポーズ時コールバック [詳解]

限定公開メンバ関数
virtual void	OnMaterialUpdated ()
	マテリアルに新しいフレームが流し込まれた際に呼び出されるメソッドです。 [詳解]

プロパティ
string	moviePath `[get, set]`
	Start 時のストリーミング再生用のファイルパスです。 [詳解]

bool	loop `[get, set]`
	Start 時のムービ再生のループ設定です。 [詳解]

bool	audioBaseConcatenation `[get, set]`
	Start時のオーディオ基準連結調整設定 [詳解]

bool	advancedAudio `[get, set]`
	Advanced Audio モードに切り替えます。 [詳解]

bool	ambisonics `[get, set]`
	Ambisonic 音声つきムービを再生可能な状態にします [詳解]

bool	additiveMode `[get, set]`
	Start 時の加算合成モード設定です。 [詳解]

bool	applyTargetAlpha `[get, set]`
	オブジェクトの透過度を適用するかを設定します。 [詳解]

bool	uiRenderMode `[get, set]`
	UIコンポーネント用のシェーダー設定を適用するかを設定します。 [詳解]

MaxFrameDrop	maxFrameDrop `[get, set]`
	最大フレームドロップ数を設定します。 [詳解]

bool	isMaterialAvailable `[get]`
	CriManaMovieMaterial::material でムービフレームが描画できるかどうか [詳解]

CriMana.Player	player `[get]`
	再生制御プレーヤ [詳解]

Material	material `[get, set]`
	ムービを流し込むマテリアルを設定します。 [詳解]

詳解

Unity UI上でムービを再生するためのコンポーネントです。

説明:: Unity UI上でムービを再生するためのコンポーネントです。
UnityEngine.UI.Graphic にマテリアルを設定することで、ムービを表示します。
CriManaMovieMaterial を継承しています。

注意:: 本クラスでは、再生・停止・ポーズの基本操作しか行えません。
複雑な再生制御を行う場合は、playerプロパティでコアプレーヤに対して操作を行って下さい。

列挙型メンバ詳解

enum RenderMode

stronginherited

マテリアル描画モード種別

説明:

動画をマテリアルに対してどのように描画するかの種別です。

Always: 毎フレーム描画を行います。
OnVisibility: GameObject が描画対象である(UI.Graphic ならアクティブである)場合に描画を行います。
Never: 描画を行いません。描画を行う場合、 CriManaMovieMaterial::RenderMovie を明示的に呼び出す必要があります。

関数詳解

delegate void OnApplicationPauseCallback	(	CriManaMovieMaterialBase	manaMovieMaterial,
		bool	appPause
	)

inherited

アプリケーションポーズ時コールバックデリゲート

説明:: サスペンド/レジューム時や、Editor実行中のポーズボタン押下などでアプリケーションがポーズした際に呼び出されるコールバックデリゲートです。

void Play ( )

inlineinherited

再生を開始します。

説明:: ムービ再生を開始します。
再生が開始されると、状態( CriWare.CriMana::Player::Status) は Playing になります。

注意:: 本関数を呼び出し後、実際にムービの描画が開始されるまで数フレームかかります。
ムービ再生の頭出しを行いたい場合は本関数をを使わず、 player プロパティにアクセスし、 CriMana::Player::Prepare 関数で事前に再生準備を行ってください。

参照: CriManaMovieMaterial::Stop, CriMana::Player::Status

void Stop ( )

inlineinherited

ムービ再生の停止要求を行います。

説明:: ムービ再生の停止要求を出します。本関数は即時復帰関数です。
本関数を呼び出すと、描画は即座に終了しますが、再生はすぐには止まりません。

参照: CriMana::Player::Status

void Pause ( bool sw )

inlineinherited

ムービ再生のポーズ切り替えを行います。

引数

sw	ポーズスイッチ(true: ポーズ, false: ポーズ解除)

説明:: ポーズのON/OFFを切り替えます。
引数にtrueを指定する一時停止、falseを指定すると再生再開です。
CriManaMovieMaterial::Stop 関数を呼び出すと、ポーズ状態は解除されます

virtual void OnMaterialUpdated ( )

inlineprotectedvirtualinherited

マテリアルに新しいフレームが流し込まれた際に呼び出されるメソッドです。

説明:: マテリアルに新しいフレームが流し込まれた際に呼び出されるメソッドです。
継承先でオーバーライドすることを想定しています。

void PlayerManualInitialize ( )

inlineinherited

プレーヤーの初期化（手動用）

説明:: プレーヤーを手動で初期化します。

注意:: 通常はAwake関数から呼び出されるため、本関数を個別に呼ぶ必要はありません。
エディタ拡張などで、手動で初期化したい場合にのみ本関数を使用してください。

void PlayerManualFinalize ( )

inlineinherited

プレーヤーの終了（手動用）

説明:: プレーヤーを手動で終了します。

注意:: 通常はOnDestroy関数から呼び出されるため、本関数を個別に呼ぶ必要はありません。
エディタ拡張などで、手動で初期化したい場合にのみ本関数を使用してください。

void PlayerManualSetup ( )

inlineinherited

プレーヤーの準備（手動用）

説明:: プレーヤーを手動で準備します。

注意:: 通常はStart関数から呼び出されるため、本関数を個別に呼ぶ必要はありません。
エディタ拡張などで、手動で準備したい場合、本関数を使用してください。

void PlayerManualUpdate ( )

inlineinherited

プレーヤーのフレーム更新（手動用）

説明:: プレーヤーのフレームを手動で更新します。

注意:: 通常はUpdate関数から呼び出されるため、本関数を個別に呼ぶ必要はありません。
エディタ拡張などで、手動でフレームを更新したい場合、本関数を使用してください。

メンバ詳解

UnityEngine.UI.Graphic target

ムービマテリアルの設定対象の UnityEngine.UI.Graphic です。

説明:: ムービマテリアルの設定対象の UnityEngine.UI.Graphic です。
指定されていない場合はアタッチしているゲームオブジェクトの UnityEngine.UI.Graphic を使用します。

bool useOriginalMaterial

ムービフレームが使用できない場合にオリジナルのマテリアルを表示するか。

説明:: ムービフレームが使用できない場合にオリジナルのマテリアルを表示するか。
true : ムービフレームが使用できない場合、オリジナルのマテリアルを表示します。
false : ムービフレームが使用できない場合、target の描画を無効にします。

bool playOnStart = false

inherited

Start 時に再生を行うかを設定します。

説明:: Start 時に再生を行うかを設定します。デフォルトは false です。

bool restartOnEnable = false

inherited

OnEnable時に最初から再生するか否かの設定です。

説明:: trueの場合、再生中にコンポーネントが無効になった後に有効にされる時、最初から再生します。
デフォルト値は false です。

RenderMode renderMode = RenderMode.Always

inherited

マテリアル描画モード

説明:: 動画をマテリアルに対してどのように描画するかを設定します。

注意:: いくつかのプラットフォーム(PC/iOSなど)では、本設定に関わらず常に描画が行われます。

OnApplicationPauseCallback onApplicationPauseCallback = null

inherited

アプリケーションポーズ時コールバック

説明:: アプリケーションが一時停止/再開した際の処理を設定します。
未設定時(null指定時)の動作は「開始時に一時停止、終了時に再開(開始時にすでに一時停止中だった場合は一時停止のまま)」です。
アプリケーション側の処理で上記の動作を変更したい場合は、本プロパティに独自のコールバック処理を設定してください。

プロパティ詳解

string moviePath

getsetinherited

Start 時のストリーミング再生用のファイルパスです。

引数

filePath ファイルパス

説明:

Start 時のストリーミング再生用のファイルパスです。

相対パスを指定した場合は StreamingAssets フォルダからの相対でファイルをロードします。
絶対パス、あるいはURLを指定した場合には指定したパスでファイルをロードします。

注意:: スクリプトからのファイルパス設定は、 player プロパティの CriMana::Player::SetFile メソッドなどで行ってください。
本プロパティはインスペクタ上で Start 時のストリーミング再生用のファイルパスを設定するために用意されています。 Start より後に本プロパティを変更しても次回の再生には適用されません。

bool loop

getsetinherited

Start 時のムービ再生のループ設定です。

説明:: Start 時のムービ再生のループ設定です。デフォルトは false です。

注意:: スクリプトからのループ設定は、 player プロパティの CriMana::Player::Loop メソッドで行なってください。
本プロパティはインスペクタ上で Start 時のループ設定を行なうために用意されています。
Start より後に本プロパティを変更しても次回の再生には適用されません。

bool audioBaseConcatenation

getsetinherited

Start時のオーディオ基準連結調整設定

説明:: Start時に適用されるオーディオ基準連結調整の有効化フラグ値です。

注意:: スクリプトからのループ設定は、 player プロパティの CriMana.Player.SetAudioBaseConcatenation メソッドで行なってください。
本プロパティはインスペクタ上で Start 時のループ設定を行なうために用意されています。
Start より後に本プロパティを変更しても次回の再生には適用されません。

bool advancedAudio

getsetinherited

Advanced Audio モードに切り替えます。

説明:: Advanced Audio モードを有効化することで高度な音声再生機能が使用可能になります。デフォルト値は true です。
例えば Ambisonic 音声つきムービを再生する場合は、本モードを有効にしておく必要があります。

bool ambisonics

getsetinherited

Ambisonic 音声つきムービを再生可能な状態にします

説明:: Ambisonic 音声つきムービを再生可能な状態にするためのプロパティです。
Advanced Audio モードが有効な時にだけ使用可能です。

注意:: 本モードの有効化時、Ambisonic Source という GameObject が、子オブジェクトとして作成されます。
この Ambisonic Source オブジェクトには CriManaAmbisonicSource コンポーネントがアタッチされます。

bool additiveMode

getsetinherited

Start 時の加算合成モード設定です。

説明:: Start 時の加算合成モード設定です。デフォルトは false です。

注意:: スクリプトからの加算合成モード設定は、 player プロパティの CriMana::Player::additiveMode プロパティで行なってください。
本プロパティはインスペクタ上で Start 時の加算合成モード設定を行なうために用意されています。
Start より後に本プロパティを変更しても次回の再生には適用されません。

bool applyTargetAlpha

getsetinherited

オブジェクトの透過度を適用するかを設定します。

説明:: アタッチしたオブジェクトの透過度に応じて、ムービも透過させるかを設定します。
デフォルト値は false です。

bool uiRenderMode

getsetinherited

UIコンポーネント用のシェーダー設定を適用するかを設定します。

説明:: ムービを描画するシェーダーについて、UIコンポーネント用の描画設定を適用するかを設定します。
デフォルト値は false です。

MaxFrameDrop maxFrameDrop

getsetinherited

最大フレームドロップ数を設定します。

説明:: 再生に対して描画フレームの更新が間に合っていない場合に一度の更新でドロップするフレームの最大数を設定します。
アプリケーションのフレームレートが低下している場合や、フレームレート以上に動画の再生速度を上げた場合に、意図通りに再生が行えるようになります。

bool isMaterialAvailable

getinherited

CriManaMovieMaterial::material でムービフレームが描画できるかどうか

説明:: CriManaMovieMaterial::material でムービフレームが描画できるかどうかです。

CriMana.Player player

getinherited

再生制御プレーヤ

説明:: ムービの細やかな再生制御を行うためのプレーヤプロパティです。
Start・Stop・Pause以外の操作を行いたい場合、本プロパティ経由で、 CriMana::Player APIを使用してください。

Material material

getsetinherited

ムービを流し込むマテリアルを設定します。

説明:: マテリアルを設定すると、設定されたマテリアルにムービが流し込まれます。
マテリアルを設定しない場合は、ムービを流し込むマテリアルを生成します。

注意:: マテリアルを設定する場合、 Start メソッドが呼びだされる前に設定する必要があります。

このクラス詳解は次のファイルから抽出されました:

CriManaMovieControllerForUI.cs

公開型

公開メンバ関数

公開変数類

限定公開メンバ関数

プロパティ

詳解

列挙型メンバ詳解

関数詳解

メンバ詳解

プロパティ詳解