用于在Unity UI上播放视频的组件。
更多...
|
enum | MaxFrameDrop |
| 最大丢帧数类型
|
|
enum | RenderMode |
| 素材渲染模式类型 更多...
|
|
|
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帧更新(手动用) 更多...
|
|
|
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组件的Shader设置。 更多...
|
|
MaxFrameDrop | maxFrameDrop [get, set] |
| 设置最大丢帧数。 更多...
|
|
bool | isMaterialAvailable [get] |
| 是否可以用 CriManaMovieMaterial::material 渲染视频帧 更多...
|
|
CriMana.Player | player [get] |
| 播放控制Player 更多...
|
|
Material | material [get, set] |
| 设置要汇入视频的素材。 更多...
|
|
用于在Unity UI上播放视频的组件。
- 说明:
- 用于在Unity UI上播放视频的组件。
通过在 UnityEngine.UI.Graphic 设置素材,可以显示视频。
继承了 CriManaMovieMaterial。
- 注意:
- 在本类中,只能进行播放、停止、暂停的基本操作。
如果想要执行复杂的播放控制,请在player属性中针对核心Player进行操作。
素材渲染模式类型
- 说明:
- 是指针对素材渲染视频时的渲染类型。
- Always: 渲染每一帧。
- OnVisibility: GameObject 为渲染对象 (UI.Graphic 时,为活跃状态)时进行渲染。
- Never: 不进行渲染。进行渲染时,必须明确地调用 CriManaMovieMaterial::RenderMovie 。
delegate void OnApplicationPauseCallback |
( |
CriManaMovieMaterialBase |
manaMovieMaterial, |
|
|
bool |
appPause |
|
) |
| |
|
inherited |
应用程序暂停时回调委托
- 说明:
- 是暂停/继续时,或者按下Editor执行过程中的暂停按钮等 应用程序暂停时调用的回调委托。
切换视频播放的暂停。
- 参数
-
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函数进行调用,因此无需单独调用本函数。
需要在编辑器扩展等手动更新帧时,请使用本函数。
UnityEngine.UI.Graphic target |
视频素材设置对象的 UnityEngine.UI.Graphic。
- 说明:
- 视频素材设置对象的 UnityEngine.UI.Graphic。
未指定时,使用添加的游戏对象的 UnityEngine.UI.Graphic。
无法使用视频帧时,是否显示原始的素材
- 说明:
- 当不能使用视频帧数据时,是否显示原始素材。
true: 当帧数据不能使用时显示原始素材。
false: 当帧数据不能使用时,禁用 target 的渲染。
设置是否在 Start 时播放。
- 说明:
- 设置是否在Start时进行播放。预设值为false。
bool restartOnEnable = false |
|
inherited |
设置在 OnEnable 时是否从开头进行播放。
- 说明:
- 如果为true,当组件在播放过程中被禁用,然后被启用时,将从头开始播放。
预设值为false。
RenderMode renderMode = RenderMode.Always |
|
inherited |
素材渲染模式
- 说明:
- 设置针对素材如何渲染视频。
- 注意:
- 在某些平台(PC/iOS等)上,不论本设置如何,都会始终进行渲染。
OnApplicationPauseCallback onApplicationPauseCallback = null |
|
inherited |
应用程序暂停时回调
- 说明:
- 设置应用程序暂停,重新开始/时的处理。
未设置时(null指定时)的动作是“开始时暂停,结束时重新开始(开始时 已暂停中时保持暂停)”。
如果希望在应用程序侧的处理时更改上述动作,请在本属性中 设置用户自己的回调处理。
Start 时的串流播放用的文件路径。
- 参数
-
- 说明:
- Start 时的串流播放用的文件路径。
- 如果指定了相对路径,将会从 StreamingAssets 文件夹以相对路径来加载文件。
- 如果指定了绝对路径或URL,将会以所指定的路径来加载文件。
- 注意:
- 要设置从脚本的文件路径时,请在 player 属性的 CriMana::Player::SetFile 方法中 进行设置。
本属性用于在属性编辑器上设置 Start 时的串流播放用的文件路径。 即使在 Start 之后更改了本属性,下次播放时也不会适用。
Start 时的视频播放的循环设置。
- 说明:
- 视频播放循环设置(Start时应用)。预设值为false。
- 注意:
- 要设置脚本的循环时,请在 player 属性的 CriMana::Player::Loop 方法中进行设置。
本属性用于在属性编辑器上设置 Start 时的循环。
即使在 Start 之后更改了本属性,下次播放时也不会适用。
bool audioBaseConcatenation |
|
getsetinherited |
切换至Advanced Audio模式。
- 说明:
- 启用Advanced Audio(高级音频)模式可以实现高级的音频播放功能。预设值是true。
例如,播放带有Ambisonic音频的视频时,必须启用本模式。
将附带 Ambisonic 音频的视频设置为可播放的状态。
- 说明:
- 用于将附带 Ambisonic 音频的视频设置为可播放状态的属性。
仅在将 Advanced Audio 模式设置为有效时可以使用。
- 注意:
- 本模式为有效时,作为子对象,将会创建称为 Ambisonic Source 的 GameObject。
该 Ambisonic Source 对象上会添加 CriManaAmbisonicSource 组件。
Start 时的加算合成模式设置。
- 说明:
- 加法合成模式设置(Start时应用)。预设值为false。
- 注意:
- 要设置脚本的加算合成模式时,请在 player 属性的 CriMana::Player::additiveMode 属性中 进行设置。
本属性用于在属性编辑器上设置 Start 时的加算合成模式。
即使在 Start 之后更改了本属性,下次播放时也不会适用。
设置是否适用对象的透明度。
- 说明:
- 设置视频是否根据所挂载对象的透明度适用透明。
预设值是false。
指定是否应用UI组件的Shader设置。
- 说明:
- 设置是否将UI组件的渲染设置应用于渲染视频的Shader。
预设值为false。
MaxFrameDrop maxFrameDrop |
|
getsetinherited |
设置最大丢帧数。
- 说明:
- 渲染帧的更新赶不上播放时,设置一次更新时要降低的 最大帧数。
应用程序的帧率降低时,或者视频播放速度超过了帧率时 可以按照自己意图来进行播放。
是否可以用 CriManaMovieMaterial::material 渲染视频帧
- 说明:
- 是否可以用 CriManaMovieMaterial::material 渲染视频帧。
播放控制Player
- 说明:
- 用于对视频进行细微播放控制的Player属性。
如果想执行Start、Stop、Pause以外的操作,请通过本属性,使用 CriMana::Player API。
设置要汇入视频的素材。
- 说明:
- 如果设置素材,则所设置的素材内将会汇入视频。
如果不设置素材,则将会创建用于汇入视频的素材。
- 注意:
- 如果设置素材,则需要在调用 Start 方法前进行设置。
该类的文档由以下文件生成:
- CriManaMovieControllerForUI.cs