Skip to main content

Offscreen Effect Player Android

Offscreen Effect Player briefly#

Offscreen Effect Player (OEP) allows to process an image using the Banuba SDK, no matter where it comes from: camera, file system or somewhere else. OEP is the camera independent solution that returns an processed image in the same form as it is received. It means that an input image orientation stays the same after Banuba SDK processing as it was before. Additionally OEP allows to draw the processed image on an external texture.

The entry point to Offscreen Effect Player is OffscreenEffectPlayer class. This class provides the following functionality:

  • Manage image processing โ€” processImage, processFullImageData, processFullImageDataNoSkip, setImageProcessListener.
  • Working with external texture = setSurfaceTexture.
  • Apply the effect to an processed image (e.g. camera frame image of image from disk) โ€” loadEffect, unloadEffect.
  • Calling any effect methods - callJsMethod.

offscreen module from banuba_sdk contains the following main classes:

  • OffscreenEffectPlayer - the main class of Offscreen Effect Player (OEP) module.
  • OffscreenEffectPlayerConfig - the Offscreen Effect Player configuration class.
  • BufferAllocator - the interface for buffer allocation. May be used in the application for retaining buffers.
  • ImageDebugUtils - the utility class that allow to save image for the debug purpose.
  • ImageOrientation - the class that helps to make proper image orientations parameters based on camera or image parameters.
  • ImageProcessResult - the class of processed image.

There are two cases of Offscreen Effect Player using: with or without surface texture. Surface texture is set by setSurfaceTexture method of OffscreenEffectPlayer class. Please, refer to OEP Android demo app section for more details about Offscreen Effect Player using by Demo application.

Last updated on