Table of Contents

Class VideoInputFramePlayer

Namespace
easyar

Input frame player. It has an input frame output port used to extract input frames from EIF MKV files. All members of this class are thread-safe.

VideoInputFramePlayer

Methods

isAvailable

Checks whether it is available. Returns true only on Windows.

bool easyar_VideoInputFramePlayer_isAvailable(void)
static bool isAvailable()
public static boolean isAvailable()
companion object fun isAvailable(): Boolean
+ (bool)isAvailable
public static func isAvailable() -> Bool
public static bool isAvailable()

Returns

Type Description
Boolean

output

Output port.

void easyar_VideoInputFramePlayer_output(easyar_VideoInputFramePlayer * This, easyar_InputFrameSource * * Return)
std::shared_ptr<InputFrameSource> output()
public @Nonnull InputFrameSource output()
fun output(): InputFrameSource
- (easyar_InputFrameSource *)output
public func output() -> InputFrameSource
public virtual InputFrameSource output()

Returns

Type Description
InputFrameSource

accelerometerResultSource

Accelerometer result output port. See AccelerometerResultSource.

void easyar_VideoInputFramePlayer_accelerometerResultSource(easyar_VideoInputFramePlayer * This, easyar_AccelerometerResultSource * * Return)
std::shared_ptr<AccelerometerResultSource> accelerometerResultSource()
public @Nonnull AccelerometerResultSource accelerometerResultSource()
fun accelerometerResultSource(): AccelerometerResultSource
- (easyar_AccelerometerResultSource *)accelerometerResultSource
public func accelerometerResultSource() -> AccelerometerResultSource
public virtual AccelerometerResultSource accelerometerResultSource()

Returns

Type Description
AccelerometerResultSource

gyroscopeResultSource

Gyroscope result output port. See GyroscopeResultSource.

void easyar_VideoInputFramePlayer_gyroscopeResultSource(easyar_VideoInputFramePlayer * This, easyar_GyroscopeResultSource * * Return)
std::shared_ptr<GyroscopeResultSource> gyroscopeResultSource()
public @Nonnull GyroscopeResultSource gyroscopeResultSource()
fun gyroscopeResultSource(): GyroscopeResultSource
- (easyar_GyroscopeResultSource *)gyroscopeResultSource
public func gyroscopeResultSource() -> GyroscopeResultSource
public virtual GyroscopeResultSource gyroscopeResultSource()

Returns

Type Description
GyroscopeResultSource

attitudeSensorResultSource

Attitude sensor result output port. See AttitudeSensorResultSource.

void easyar_VideoInputFramePlayer_attitudeSensorResultSource(easyar_VideoInputFramePlayer * This, easyar_AttitudeSensorResultSource * * Return)
std::shared_ptr<AttitudeSensorResultSource> attitudeSensorResultSource()
public @Nonnull AttitudeSensorResultSource attitudeSensorResultSource()
fun attitudeSensorResultSource(): AttitudeSensorResultSource
- (easyar_AttitudeSensorResultSource *)attitudeSensorResultSource
public func attitudeSensorResultSource() -> AttitudeSensorResultSource
public virtual AttitudeSensorResultSource attitudeSensorResultSource()

Returns

Type Description
AttitudeSensorResultSource

magnetometerResultSource

Magnetometer result output port. See MagnetometerResultSource.

void easyar_VideoInputFramePlayer_magnetometerResultSource(easyar_VideoInputFramePlayer * This, easyar_MagnetometerResultSource * * Return)
std::shared_ptr<MagnetometerResultSource> magnetometerResultSource()
public @Nonnull MagnetometerResultSource magnetometerResultSource()
fun magnetometerResultSource(): MagnetometerResultSource
- (easyar_MagnetometerResultSource *)magnetometerResultSource
public func magnetometerResultSource() -> MagnetometerResultSource
public virtual MagnetometerResultSource magnetometerResultSource()

Returns

Type Description
MagnetometerResultSource

locationResultSource

Location result output port. See LocationResultSource.

void easyar_VideoInputFramePlayer_locationResultSource(easyar_VideoInputFramePlayer * This, easyar_LocationResultSource * * Return)
std::shared_ptr<LocationResultSource> locationResultSource()
public @Nonnull LocationResultSource locationResultSource()
fun locationResultSource(): LocationResultSource
- (easyar_LocationResultSource *)locationResultSource
public func locationResultSource() -> LocationResultSource
public virtual LocationResultSource locationResultSource()

Returns

Type Description
LocationResultSource

proximityLocationResultSource

Proximity location result output port. See ProximityLocationResultSource.

void easyar_VideoInputFramePlayer_proximityLocationResultSource(easyar_VideoInputFramePlayer * This, easyar_ProximityLocationResultSource * * Return)
std::shared_ptr<ProximityLocationResultSource> proximityLocationResultSource()
public @Nonnull ProximityLocationResultSource proximityLocationResultSource()
fun proximityLocationResultSource(): ProximityLocationResultSource
- (easyar_ProximityLocationResultSource *)proximityLocationResultSource
public func proximityLocationResultSource() -> ProximityLocationResultSource
public virtual ProximityLocationResultSource proximityLocationResultSource()

Returns

Type Description
ProximityLocationResultSource

create

Creates an instance.

void easyar_VideoInputFramePlayer_create(easyar_VideoInputFramePlayer * * Return)
static std::shared_ptr<VideoInputFramePlayer> create()
public static @Nonnull VideoInputFramePlayer create()
companion object fun create(): VideoInputFramePlayer
+ (easyar_VideoInputFramePlayer *)create
public static func create() -> VideoInputFramePlayer
public static VideoInputFramePlayer create()

Returns

Type Description
VideoInputFramePlayer

start

Starts playback.

bool easyar_VideoInputFramePlayer_start(easyar_VideoInputFramePlayer * This, easyar_String * filePath)
bool start(std::string filePath)
public boolean start(java.lang.@Nonnull String filePath)
fun start(filePath: String): Boolean
- (bool)start:(NSString *)filePath
public func start(_ filePath: String) -> Bool
public virtual bool start(string filePath)

Parameters

Name Type Description
filePath String

Returns

Type Description
Boolean

stop

Stops playback.

void easyar_VideoInputFramePlayer_stop(easyar_VideoInputFramePlayer * This)
void stop()
public void stop()
fun stop(): Unit
- (void)stop
public func stop() -> Void
public virtual void stop()

Returns

Type Description
Void

pause

Pauses playback.

void easyar_VideoInputFramePlayer_pause(easyar_VideoInputFramePlayer * This)
void pause()
public void pause()
fun pause(): Unit
- (void)pause
public func pause() -> Void
public virtual void pause()

Returns

Type Description
Void

resume

Resumes playback.

bool easyar_VideoInputFramePlayer_resume(easyar_VideoInputFramePlayer * This)
bool resume()
public boolean resume()
fun resume(): Boolean
- (bool)resume
public func resume() -> Bool
public virtual bool resume()

Returns

Type Description
Boolean

totalTime

Expected total playback time, in seconds. It may be missing when recording is interrupted abnormally.

easyar_OptionalOfDouble easyar_VideoInputFramePlayer_totalTime(easyar_VideoInputFramePlayer * This)
std::optional<double> totalTime()
public java.lang.@Nullable Double totalTime()
fun totalTime(): Double?
- (NSNumber *)totalTime
public func totalTime() -> Double?
public virtual Optional<double> totalTime()

Returns

Type Description
Optional<Double>

currentTime

Current playback time, in seconds. The initial value is 0.

double easyar_VideoInputFramePlayer_currentTime(easyar_VideoInputFramePlayer * This)
double currentTime()
public double currentTime()
fun currentTime(): Double
- (double)currentTime
public func currentTime() -> Double
public virtual double currentTime()

Returns

Type Description
Double

isSeekable

Whether the current playback time can be seeked. When recording is interrupted abnormally, index data may be missing, making it impossible to set the current playback time.

bool easyar_VideoInputFramePlayer_isSeekable(const easyar_VideoInputFramePlayer * This)
bool isSeekable()
public boolean isSeekable()
fun isSeekable(): Boolean
- (bool)isSeekable
public func isSeekable() -> Bool
public virtual bool isSeekable()

Returns

Type Description
Boolean

seek

Sets the current playback time, in seconds. Returns false if index data is missing.

bool easyar_VideoInputFramePlayer_seek(easyar_VideoInputFramePlayer * This, double time)
bool seek(double time)
public boolean seek(double time)
fun seek(time: Double): Boolean
- (bool)seek:(double)time
public func seek(_ time: Double) -> Bool
public virtual bool seek(double time)

Parameters

Name Type Description
time Double

Returns

Type Description
Boolean

speed

Current playback speed. The initial value is 1.

double easyar_VideoInputFramePlayer_speed(const easyar_VideoInputFramePlayer * This)
double speed()
public double speed()
fun speed(): Double
- (double)speed
public func speed() -> Double
public virtual double speed()

Returns

Type Description
Double

setSpeed

Sets the current playback speed.

void easyar_VideoInputFramePlayer_setSpeed(easyar_VideoInputFramePlayer * This, double _value)
void setSpeed(double _value)
public void setSpeed(double value)
fun setSpeed(value: Double): Unit
- (void)setSpeed:(double)_value
public func setSpeed(_ value: Double) -> Void
public virtual void setSpeed(double @value)

Parameters

Name Type Description
value Double

Returns

Type Description
Void

initalScreenRotation

Initial screen rotation orientation when the data was recorded.

int easyar_VideoInputFramePlayer_initalScreenRotation(easyar_VideoInputFramePlayer * This)
int initalScreenRotation()
public int initalScreenRotation()
fun initalScreenRotation(): Int
- (int)initalScreenRotation
public func initalScreenRotation() -> Int32
public virtual int initalScreenRotation()

Returns

Type Description
Int32

metadata

Metadata when the data was recorded.

void easyar_VideoInputFramePlayer_metadata(easyar_VideoInputFramePlayer * This, easyar_String * * Return)
std::string metadata()
public java.lang.@Nonnull String metadata()
fun metadata(): String
- (NSString *)metadata
public func metadata() -> String
public virtual string metadata()

Returns

Type Description
String

isCompleted

Gets whether playback has completed.

bool easyar_VideoInputFramePlayer_isCompleted(easyar_VideoInputFramePlayer * This)
bool isCompleted()
public boolean isCompleted()
fun isCompleted(): Boolean
- (bool)isCompleted
public func isCompleted() -> Bool
public virtual bool isCompleted()

Returns

Type Description
Boolean