FramePlayer Class

Description

在场景中控制 InputFramePlayer 和 VideoInputFramePlayer 的 MonoBehaviour ,在Unity环境下提供功能扩展。

它将会在 AssembleOptions.FrameSourceAssembleOptions.FrameSourceSelection.FramePlayer 或者编辑器上在 DiagnosticsController inspector的'Session Validation Tool'中选择了'Frame Player' DiagnosticsController 时被使用。


Fields

FilePathType

C#

public WritablePathType FilePathType

路径类型。可以在 FramePlayer.Play 之前设置。

FilePath

C#

public string FilePath

文件路径。可以在 FramePlayer.Play 之前设置。


Properties

enabled

C#

public bool enabled { get; set; }

ARSession 运行时播放/暂停eif文件。在session启动后, MonoBehaviour .enabled为true时才会开始播放。

IsStarted

C#

public bool IsStarted { get; }

是否已启动播放。

IsCompleted

C#

public bool IsCompleted { get; }

是否已完成播放。

Length

C#

public Optional<double> Length { get; }

预期的总播放时间。单位为秒。

Time

C#

public double Time { get; }

已经播放的时间。

IsSeekable

C#

public bool IsSeekable { get; }

是否可定位当前播放时刻。录制过程非正常中断时,可能导致缺少索引数据,而无法设定当前播放时间。

IsSpeedChangeable

C#

public bool IsSpeedChangeable { get; }

是否可修改播放速度。

Speed

C#

public double Speed { get; set; }

当前的播放速度。

CameraCandidate

C#

public Camera CameraCandidate { get; set; }

FramePlayer.Camera 的备选,仅当未使用Unity XR Origin时有效,如未设置会使用Camera.main。


Methods

Play

C#

public bool Play()

播放eif文件。如果未手动调用 FramePlayer.PlayFramePlayer.StopARSession 启动后会自动 FramePlayer.Play

在session启动后才能使用。

Stop

C#

public void Stop()

停止播放eif文件。

Seek

C#

public bool Seek(double time)

设定当前播放时刻。单位为秒。如果缺少索引数据,则返回false。