Class VideoInputFrameRecorder

Namespace

easyar

Input Frame Recorder. There is an input frame input port and an input frame output port, which are used to save the passed input frames into EIF MKV files. All members of this class are thread-safe.

VideoInputFrameRecorder

Methods

isAvailable

Check if available. Returns true only on MacOS, iOS, Android.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

bool easyar_VideoInputFrameRecorder_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

Boolean

input

Input Port.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_input(easyar_VideoInputFrameRecorder * This, easyar_InputFrameSink * * Return)

std::shared_ptr<InputFrameSink> input()

public @Nonnull InputFrameSink input()

fun input(): InputFrameSink

- (easyar_InputFrameSink *)input

public func input() -> InputFrameSink

public virtual InputFrameSink input()

Returns

InputFrameSink

accelerometerResultSink

Optional. Accelerometer result input port. Reference AccelerometerResultSink.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_accelerometerResultSink(easyar_VideoInputFrameRecorder * This, easyar_AccelerometerResultSink * * Return)

std::shared_ptr<AccelerometerResultSink> accelerometerResultSink()

public @Nonnull AccelerometerResultSink accelerometerResultSink()

fun accelerometerResultSink(): AccelerometerResultSink

- (easyar_AccelerometerResultSink *)accelerometerResultSink

public func accelerometerResultSink() -> AccelerometerResultSink

public virtual AccelerometerResultSink accelerometerResultSink()

Returns

AccelerometerResultSink

gyroscopeResultSink

Optional. Gyroscope result input port. Reference GyroscopeResultSink.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_gyroscopeResultSink(easyar_VideoInputFrameRecorder * This, easyar_GyroscopeResultSink * * Return)

std::shared_ptr<GyroscopeResultSink> gyroscopeResultSink()

public @Nonnull GyroscopeResultSink gyroscopeResultSink()

fun gyroscopeResultSink(): GyroscopeResultSink

- (easyar_GyroscopeResultSink *)gyroscopeResultSink

public func gyroscopeResultSink() -> GyroscopeResultSink

public virtual GyroscopeResultSink gyroscopeResultSink()

Returns

GyroscopeResultSink

attitudeSensorResultSink

Optional. Attitude sensor result input port. Reference AttitudeSensorResultSink.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_attitudeSensorResultSink(easyar_VideoInputFrameRecorder * This, easyar_AttitudeSensorResultSink * * Return)

std::shared_ptr<AttitudeSensorResultSink> attitudeSensorResultSink()

public @Nonnull AttitudeSensorResultSink attitudeSensorResultSink()

fun attitudeSensorResultSink(): AttitudeSensorResultSink

- (easyar_AttitudeSensorResultSink *)attitudeSensorResultSink

public func attitudeSensorResultSink() -> AttitudeSensorResultSink

public virtual AttitudeSensorResultSink attitudeSensorResultSink()

Returns

AttitudeSensorResultSink

magnetometerResultSink

Optional. Magnetometer result input port. Reference MagnetometerResultSink.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_magnetometerResultSink(easyar_VideoInputFrameRecorder * This, easyar_MagnetometerResultSink * * Return)

std::shared_ptr<MagnetometerResultSink> magnetometerResultSink()

public @Nonnull MagnetometerResultSink magnetometerResultSink()

fun magnetometerResultSink(): MagnetometerResultSink

- (easyar_MagnetometerResultSink *)magnetometerResultSink

public func magnetometerResultSink() -> MagnetometerResultSink

public virtual MagnetometerResultSink magnetometerResultSink()

Returns

MagnetometerResultSink

locationResultSink

Optional. Location result input port. Reference LocationResultSink.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_locationResultSink(easyar_VideoInputFrameRecorder * This, easyar_LocationResultSink * * Return)

std::shared_ptr<LocationResultSink> locationResultSink()

public @Nonnull LocationResultSink locationResultSink()

fun locationResultSink(): LocationResultSink

- (easyar_LocationResultSink *)locationResultSink

public func locationResultSink() -> LocationResultSink

public virtual LocationResultSink locationResultSink()

Returns

LocationResultSink

proximityLocationResultSink

Optional. Proximity location result input port. Reference ProximityLocationResultSink.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_proximityLocationResultSink(easyar_VideoInputFrameRecorder * This, easyar_ProximityLocationResultSink * * Return)

std::shared_ptr<ProximityLocationResultSink> proximityLocationResultSink()

public @Nonnull ProximityLocationResultSink proximityLocationResultSink()

fun proximityLocationResultSink(): ProximityLocationResultSink

- (easyar_ProximityLocationResultSink *)proximityLocationResultSink

public func proximityLocationResultSink() -> ProximityLocationResultSink

public virtual ProximityLocationResultSink proximityLocationResultSink()

Returns

ProximityLocationResultSink

bufferRequirement

Current number of camera buffers occupied by the component.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_VideoInputFrameRecorder_bufferRequirement(easyar_VideoInputFrameRecorder * This)

int bufferRequirement()

public int bufferRequirement()

fun bufferRequirement(): Int

- (int)bufferRequirement

public func bufferRequirement() -> Int32

public virtual int bufferRequirement()

Returns

Int32

output

Output Port.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_output(easyar_VideoInputFrameRecorder * 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

InputFrameSource

create

Create.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_create(easyar_VideoInputFrameRecorder * * Return)

static std::shared_ptr<VideoInputFrameRecorder> create()

public static @Nonnull VideoInputFrameRecorder create()

companion object fun create(): VideoInputFrameRecorder

+ (easyar_VideoInputFrameRecorder *)create

public static func create() -> VideoInputFrameRecorder

public static VideoInputFrameRecorder create()

Returns

VideoInputFrameRecorder

start

Start recording data. The definitions of cameraDeviceType, cameraOrientation, and initialScreenRotation are consistent with those in CameraParameters. initialScreenRotation is the initial screen rotation direction when recording data, and this direction is used as the reference for rendering during playback.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

bool easyar_VideoInputFrameRecorder_start(easyar_VideoInputFrameRecorder * This, easyar_String * filePath, easyar_CameraDeviceType cameraDeviceType, int cameraOrientation, int initialScreenRotation, easyar_VideoInputFrameRecorderVideoCodec codec, int width, int height, double frameRate, easyar_String * metadata)

bool start(std::string filePath, CameraDeviceType cameraDeviceType, int cameraOrientation, int initialScreenRotation, VideoInputFrameRecorderVideoCodec codec, int width, int height, double frameRate, std::string metadata)

public boolean start(java.lang.@Nonnull String filePath, int cameraDeviceType, int cameraOrientation, int initialScreenRotation, int codec, int width, int height, double frameRate, java.lang.@Nonnull String metadata)

fun start(filePath: String, cameraDeviceType: Int, cameraOrientation: Int, initialScreenRotation: Int, codec: Int, width: Int, height: Int, frameRate: Double, metadata: String): Boolean

- (bool)start:(NSString *)filePath cameraDeviceType:(easyar_CameraDeviceType)cameraDeviceType cameraOrientation:(int)cameraOrientation initialScreenRotation:(int)initialScreenRotation codec:(easyar_VideoInputFrameRecorderVideoCodec)codec width:(int)width height:(int)height frameRate:(double)frameRate metadata:(NSString *)metadata

public func start(_ filePath: String, _ cameraDeviceType: CameraDeviceType, _ cameraOrientation: Int32, _ initialScreenRotation: Int32, _ codec: VideoInputFrameRecorderVideoCodec, _ width: Int32, _ height: Int32, _ frameRate: Double, _ metadata: String) -> Bool

public virtual bool start(string filePath, CameraDeviceType cameraDeviceType, int cameraOrientation, int initialScreenRotation, VideoInputFrameRecorderVideoCodec codec, int width, int height, double frameRate, string metadata)

Parameters

filePath String

cameraDeviceType CameraDeviceType

cameraOrientation Int32

initialScreenRotation Int32

codec VideoInputFrameRecorderVideoCodec

width Int32

height Int32

frameRate Double

metadata String

Returns

Boolean

stop

Stop recording data. This method only stops recording, and the connection will not be affected.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_stop(easyar_VideoInputFrameRecorder * This)

void stop()

public void stop()

fun stop(): Unit

- (void)stop

public func stop() -> Void

public virtual void stop()

Returns

Void

setAutomaticCompletionCallback

Set auto-complete recording callback.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_VideoInputFrameRecorder_setAutomaticCompletionCallback(easyar_VideoInputFrameRecorder * This, easyar_CallbackScheduler * callbackScheduler, easyar_OptionalOfFunctorOfVoidFromVideoInputFrameRecorderCompletionReason automaticCompletionCallback)

void setAutomaticCompletionCallback(std::shared_ptr<CallbackScheduler> callbackScheduler, std::optional<std::function<void(VideoInputFrameRecorderCompletionReason)>> automaticCompletionCallback)

public void setAutomaticCompletionCallback(@Nonnull CallbackScheduler callbackScheduler, @Nullable FunctorOfVoidFromVideoInputFrameRecorderCompletionReason automaticCompletionCallback)

fun setAutomaticCompletionCallback(callbackScheduler: CallbackScheduler, automaticCompletionCallback: FunctorOfVoidFromVideoInputFrameRecorderCompletionReason?): Unit

- (void)setAutomaticCompletionCallback:(easyar_CallbackScheduler *)callbackScheduler automaticCompletionCallback:(void (^)(easyar_VideoInputFrameRecorderCompletionReason))automaticCompletionCallback

public func setAutomaticCompletionCallback(_ callbackScheduler: CallbackScheduler, _ automaticCompletionCallback: ((VideoInputFrameRecorderCompletionReason) -> Void)?) -> Void

public virtual void setAutomaticCompletionCallback(CallbackScheduler callbackScheduler, Optional<Action<VideoInputFrameRecorderCompletionReason>> automaticCompletionCallback)

Parameters

callbackScheduler CallbackScheduler

automaticCompletionCallback Optional<Action<VideoInputFrameRecorderCompletionReason>>

Returns

Void