Package com.banuba.sdk.offscreen

Class OffscreenEffectPlayerConfig.Builder

java.lang.Object

com.banuba.sdk.offscreen.OffscreenEffectPlayerConfig.Builder

Enclosing class:

OffscreenEffectPlayerConfig

public static class OffscreenEffectPlayerConfig.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
Builder(int width, int height, BufferAllocator allocator)

Method Summary

Modifier and Type	Method	Description
OffscreenEffectPlayerConfig	build()	Build the OffscreenEffectPlayerConfig object.
OffscreenEffectPlayerConfig.Builder	setDebugSaveFrames(boolean debugSaveFrames)	Set debug save frames flag.
OffscreenEffectPlayerConfig.Builder	setDebugSaveFramesDivider(int debugSaveFramesDivider)	Set debug save frames divider.
OffscreenEffectPlayerConfig.Builder	setRealtimeProcessorMode(com.banuba.sdk.effect_player.RealtimeProcessorMode mode)	Sets RealtimeProcessor mode.
OffscreenEffectPlayerConfig.Builder	setUseFutureFrameFilter(boolean use)	Enables the filter of future frames.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(int width,
               int height,
               @Nullable
               BufferAllocator allocator)

Method Detail

setDebugSaveFrames

@NonNull
public OffscreenEffectPlayerConfig.Builder setDebugSaveFrames(boolean debugSaveFrames)

Set debug save frames flag.

Parameters:

debugSaveFrames - debug save frames flag value.

Returns:

OffscreenEffectPlayerConfig.Builder instance.

setDebugSaveFramesDivider

@NonNull
public OffscreenEffectPlayerConfig.Builder setDebugSaveFramesDivider(int debugSaveFramesDivider)

Set debug save frames divider.

Parameters:

debugSaveFramesDivider - debug save frames divider value.

Returns:

OffscreenEffectPlayerConfig.Builder instance.

setRealtimeProcessorMode

@NonNull
public OffscreenEffectPlayerConfig.Builder setRealtimeProcessorMode(com.banuba.sdk.effect_player.RealtimeProcessorMode mode)

Sets RealtimeProcessor mode. See the definition of RealtimeProcessorMode for details. By default configured to RealtimeProcessorMode.SYNC_WHEN_EFFECT_LOADED. In this mode, the effect player does not wait for new results from the recognizer and renders the data collected for the previously processed frame. This improves the performance and reduces CPU usage.

Parameters:

mode - the desired realtime processor mode for the Effect Player.

Returns:

OffscreenEffectPlayerConfig.Builder instance.

setUseFutureFrameFilter

@NonNull
public OffscreenEffectPlayerConfig.Builder setUseFutureFrameFilter(boolean use)

Enables the filter of future frames. By default filter is disabled, If enabled, the OEP returns the previous frame for the rendering as an output, but overall reduces the jittering of the face mask via correction of data of the previous frame based on results collected for the current frame.

Parameters:

use - if true the future frame filter will be enabled for the Effect Player.

Returns:

OffscreenEffectPlayerConfig.Builder instance.

build

@NonNull
public OffscreenEffectPlayerConfig build()

Build the OffscreenEffectPlayerConfig object.

Returns:

OffscreenEffectPlayerConfig object.