面向CRI Assets的视频播放组件更多...

继承自 CriManaMovieMaterialBase .

Public 类型
enum	MaxFrameDrop
	最大丢帧数类型

enum	RenderMode
	素材渲染模式类型更多...

Public 成员函数
delegate void	OnApplicationPauseCallback (CriManaMovieMaterialBase manaMovieMaterial, bool appPause)
	应用程序暂停时回调委托更多...

void	Play ()
	开始播放。更多...

void	Stop ()
	发出视频播放停止请求。更多...

void	Pause (bool sw)
	切换视频播放的暂停。更多...

void	PlayerManualInitialize ()
	Player初始化（手动用）更多...

void	PlayerManualFinalize ()
	结束Player（手动用）更多...

void	PlayerManualSetup ()
	Player准备（手动用）更多...

void	PlayerManualUpdate ()
	Player帧更新（手动用）更多...

Public 属性
bool	useOriginalMaterial
	无法使用视频帧时，是否显示原始的素材更多...

bool	playOnStart = false
	设置是否在 Start 时播放。更多...

bool	restartOnEnable = false
	设置在 OnEnable 时是否从开头进行播放。更多...

RenderMode	renderMode = RenderMode.Always
	素材渲染模式更多...

OnApplicationPauseCallback	onApplicationPauseCallback = null
	应用程序暂停时回调更多...

Protected 成员函数
virtual void	OnMaterialUpdated ()
	是在素材上汇入新的帧时调用的方法。更多...

属性
ICriManaMovieMaterialTarget	Target `[get, set]`
	MovieMaterial的设置对象。更多...

MaxFrameDrop	maxFrameDrop `[get, set]`
	设置最大丢帧数。更多...

bool	isMaterialAvailable `[get]`
	是否可以用 CriManaMovieMaterial::material 渲染视频帧更多...

CriMana.Player	player `[get]`
	播放控制Player 更多...

Material	material `[get, set]`
	设置要汇入视频的素材。更多...

详细描述

面向CRI Assets的视频播放组件

说明:: 该组件用于在场景中播放USM Asset。
视频将被作为该组件指定的 Renderer 或 Graphic 的材质进行播放。

成员枚举类型说明

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: 解除暂停)

说明:: 打开和关闭暂停。
如果指定true作为参数，则暂停播放；如果指定false，则恢复播放。
调用 CriManaMovieMaterial::Stop 函数会清除暂停状态。

virtual void OnMaterialUpdated ( )

inlineprotectedvirtualinherited

是在素材上汇入新的帧时调用的方法。

说明:: 是在素材上汇入新的帧时调用的方法。
假定在继承目标会被覆盖。

void PlayerManualInitialize ( )

inlineinherited

Player初始化（手动用）

说明:: 手动对Player进行初始化。

注意:: 通常情况下，会从Awake函数进行调用，因此无需单独调用本函数。
请只在编辑器扩展等，希望手动进行初始化时使用本函数。

void PlayerManualFinalize ( )

inlineinherited

结束Player（手动用）

说明:: 手动结束Player。

注意:: 本函数通常会被 OnDestroy 函数调用，不需要单独调用。
请仅在需要手动初始化时使用此函数，例如在编辑器扩展中。

void PlayerManualSetup ( )

inlineinherited

Player准备（手动用）

说明:: 手动准备Player。

注意:: 通常情况下，会从Start函数进行调用，因此无需单独调用本函数。
编辑器扩展等，希望手动准备时，请使用本函数。

void PlayerManualUpdate ( )

inlineinherited

Player帧更新（手动用）

说明:: 手动更新Player的帧。

注意:: 通常情况下，会从Update函数进行调用，因此无需单独调用本函数。
需要在编辑器扩展等手动更新帧时，请使用本函数。

类成员变量说明

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指定时)的动作是“开始时暂停，结束时重新开始(开始时已暂停中时保持暂停)”。
如果希望在应用程序侧的处理时更改上述动作，请在本属性中设置用户自己的回调处理。

属性说明

ICriManaMovieMaterialTarget Target

getset

MovieMaterial的设置对象。

说明:: MovieMaterial的设置对象的 ICriManaMovieMaterialTarget 。

MaxFrameDrop maxFrameDrop

getsetinherited

设置最大丢帧数。

说明:: 渲染帧的更新赶不上播放时，设置一次更新时要降低的最大帧数。
应用程序的帧率降低时，或者视频播放速度超过了帧率时可以按照自己意图来进行播放。

bool isMaterialAvailable

getinherited

是否可以用 CriManaMovieMaterial::material 渲染视频帧

说明:: 是否可以用 CriManaMovieMaterial::material 渲染视频帧。

CriMana.Player player

getinherited

播放控制Player

说明:: 用于对视频进行细微播放控制的Player属性。
如果想执行Start、Stop、Pause以外的操作，请通过本属性，使用 CriMana::Player API。

Material material

getsetinherited

设置要汇入视频的素材。

说明:: 如果设置素材，则所设置的素材内将会汇入视频。
如果不设置素材，则将会创建用于汇入视频的素材。

注意:: 如果设置素材，则需要在调用 Start 方法前进行设置。

该类的文档由以下文件生成:

CriManaMovieControllerForAsset.cs

Public 类型

Public 成员函数

Public 属性

Protected 成员函数

属性

详细描述

成员枚举类型说明

成员函数说明

类成员变量说明

属性说明