VideoInputFramePlayer Class¶

This type is an EasyAR Sense API in C#: VideoInputFramePlayer . Some descriptions may not apply to Unity environment on this page.

This type is fully wrapped into Unity components: FramePlayer . There is no need to use this type directly.

Description¶

Input frame player.

There is an input frame output port. It can be used to get input frame from an EIF MKV file. Refer to Overview .

All members of this class is thread-safe.

Methods¶

isAvailable¶

C#: public static bool isAvailable()

Checks if the component is available. It returns true only on Windows.

output¶

C#: public virtual InputFrameSource output()

Output port.

accelerometerResultSource¶

C#: public virtual AccelerometerResultSource accelerometerResultSource()

Output port for accelerometer result. See also AccelerometerResultSource .

gyroscopeResultSource¶

C#: public virtual GyroscopeResultSource gyroscopeResultSource()

Output port for gyroscope result. See also GyroscopeResultSource .

attitudeSensorResultSource¶

C#: public virtual AttitudeSensorResultSource attitudeSensorResultSource()

Output port for attitude sensor. See also AttitudeSensorResultSource .

magnetometerResultSource¶

C#: public virtual MagnetometerResultSource magnetometerResultSource()

Output port for magnetometer. See also MagnetometerResultSource .

locationResultSource¶

C#: public virtual LocationResultSource locationResultSource()

Output port for location result. See also LocationResultSource .

proximityLocationResultSource¶

C#: public virtual ProximityLocationResultSource proximityLocationResultSource()

Output port for proximity location result. See also ProximityLocationResultSource .

create¶

C#: public static VideoInputFramePlayer create()

Creates an instance.

start¶

C#: public virtual bool start(string filePath)

Starts frame play.

stop¶

C#: public virtual void stop()

Stops frame play.

pause¶

C#: public virtual void pause()

Pauses frame play.

resume¶

C#: public virtual bool resume()

Resumes frame play.

totalTime¶

C#: public virtual Optional<double> totalTime()

Total expected playback time span. The unit is second. If recording halts improperly, it may be missing.

currentTime¶

C#: public virtual double currentTime()

Current playback time point. The unit is second. The initial value is 0.

isSeekable¶

C#: public virtual bool isSeekable()

Whether the current playback time point can be relocated. If recording halts improperly, index data to set playback time point may be missing.

seek¶

C#: public virtual bool seek(double time)

Sets current playback time point. The unit is second. If index data is missing, it returns false.

speed¶

C#: public virtual double speed()

Current playback speed. The initial value is 1.

setSpeed¶

C#: public virtual void setSpeed(double value)

Sets current playback speed.

initalScreenRotation¶

C#: public virtual int initalScreenRotation()

The initial screen rotation when recording data.

metadata¶

C#: public virtual string metadata()

The metadata when recording data.

isCompleted¶

C#: public virtual bool isCompleted()

Whether the playback is completed.