FramePlayer Class¶

Description¶

在场景中控制 InputFramePlayer 的 MonoBehaviour ，在Unity环境下提供功能扩展。不需要直接使用 InputFramePlayer 。

MonoBehaviour Messages¶

protected override void Awake()

protected override void OnEnable()

protected override void OnDisable()

protected virtual void OnDestroy()

Fields¶

FilePathType¶

C#: public WritablePathType FilePathType

路径类型。可以在OnEnable或 ARSession.Start 之前设置。

FilePath¶

C#: public string FilePath

文件路径。可以在OnEnable或 ARSession.Start 之前设置。

Properties¶

IsAvailable¶

C#: public override Optional<bool> IsAvailable { get; }

当前frame source是否可用。

如果数值等于null，需要调用 FrameSource.CheckAvailability ，数值将在 Coroutine 结束后可以访问。这个属性会在 ARComponentPicker 选择frame source的时候使用。

AvailableCenterMode¶

C#: public override IReadOnlyList< ARSession.ARCenterMode > AvailableCenterMode { get; }

该frame source可以使用的中心模式。

IsCompleted¶

C#: public bool IsCompleted { get; }

是否已完成播放。

Length¶

C#: public float Length { get; }

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

Time¶

C#: public float Time { get; }

已经播放的时间。

WorldRoot¶

C#: public WorldRootController WorldRoot { get; set; }

相机运动的相对物体，如果没设置，将会自动从场景中获取或生成。

Origin¶

C#: public override GameObject Origin { get; }

ARSession 的原点，如果frame source可以输出运动跟踪数据。

每种运动跟踪frame source都有自己的方法来设置包含特定组件的原点物体。如果原点未设置，一些frame source会从场景中active的物体中自动选择可以使用的物体或创建一个新的物体。

Camera¶

C#: public virtual Camera Camera { get; set; }

在一个 ARSession 中被该frame source使用的 Camera 。

每种frame source都有自己的方法来检查camera是否可用，设置不可用的camera将会被拒绝。这个属性会在 ARComponentPicker 选择frame source时用来判断frame source是否可用。在这个过程中，如果数值没有设置，一些frame source会从场景中active的物体中自动选择可以使用的 Camera 。你可以在session start前设置可用的 Camera 。如果这个frame source被 ARSession 选用，这个数值将在session ready后无法修改。

Methods¶

Play¶

C#: public bool Play()

播放eif文件。

Stop¶

C#: public void Stop()

停止播放eif文件。

Pause¶

C#: public void Pause()

暂停播放eif文件。

CheckAvailability¶

C#: public virtual System.Collections.IEnumerator CheckAvailability()

FrameSource.IsAvailable 等于null时用于检查frame source是否可用的 Coroutine 。