Package com.banuba.sdk.output

Class FrameOutput

java.lang.Object

com.banuba.sdk.player.VerifyCloseable

com.banuba.sdk.output.FrameOutput

All Implemented Interfaces:

IOrientable, IOutput, Closeable, AutoCloseable

public class FrameOutput
extends VerifyCloseable
implements IOutput, IOrientable

Representing a Frame as an Array of Pixels

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FrameOutput.IFramePixelBufferProvider	Interface for getting the processed frame as an array of pixels
static enum	FrameOutput.ReadBufferMode	Pixel reading mode

Field Summary

Fields inherited from class com.banuba.sdk.player.VerifyCloseable

mIsClosed, mTag

Constructor Summary

Constructors

Constructor	Description
FrameOutput(FrameOutput.IFramePixelBufferProvider callback)	Create a new instance of the FrameOutput with default SimpleDirectBufferAllocator and SYNC read mode
FrameOutput(FrameOutput.IFramePixelBufferProvider callback, FrameOutput.ReadBufferMode readMode)	Create a new instance of the FrameOutput with default SimpleDirectBufferAllocator
FrameOutput(FrameOutput.IFramePixelBufferProvider callback, IDirectBufferAllocator allocator)	Create a new instance of the FrameOutput with memory allocator and SYNC read mode The memory allocator helps avoid excessive memory usage, as well as increases performance and reduces the number of GarbageCollector hits.
FrameOutput(FrameOutput.IFramePixelBufferProvider callback, IDirectBufferAllocator allocator, FrameOutput.ReadBufferMode readMode)	Create a new instance of the FrameOutput with memory allocator.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the resource and frees memory
void	present(IRenderTargetPresentable renderTarget)	Presenting the processed frame to the surface
void	setFormat(FramePixelBufferFormat format)	Apply output frame format.
void	setOrientation(Orientation orientation, boolean mirroring)	Apply output frame orientation.
void	start()	Start using output by the Player
void	stop()	Stop using output by the Player

Methods inherited from class com.banuba.sdk.player.VerifyCloseable

finalize

Methods inherited from class java.lang.Object

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

Constructor Details

FrameOutput

public FrameOutput(@NonNull
 FrameOutput.IFramePixelBufferProvider callback)

Create a new instance of the FrameOutput with default SimpleDirectBufferAllocator and SYNC read mode

Parameters:

callback - the processed frame is sent here

See Also:

• SimpleDirectBufferAllocator

FrameOutput

public FrameOutput(@NonNull
 FrameOutput.IFramePixelBufferProvider callback,
 @NonNull
 FrameOutput.ReadBufferMode readMode)

Create a new instance of the FrameOutput with default SimpleDirectBufferAllocator

Parameters:

callback - the processed frame is sent here

readMode - pixels reading mode

See Also:

• SimpleDirectBufferAllocator

FrameOutput

public FrameOutput(@NonNull
 FrameOutput.IFramePixelBufferProvider callback,
 IDirectBufferAllocator allocator)

Create a new instance of the FrameOutput with memory allocator and SYNC read mode The memory allocator helps avoid excessive memory usage, as well as increases performance and reduces the number of GarbageCollector hits.

Parameters:

callback - the processed frame is sent here

allocator - allocator for the images

FrameOutput

public FrameOutput(@NonNull
 FrameOutput.IFramePixelBufferProvider callback,
 IDirectBufferAllocator allocator,
 @NonNull
 FrameOutput.ReadBufferMode readMode)

Create a new instance of the FrameOutput with memory allocator. The memory allocator helps avoid excessive memory usage, as well as increases performance and reduces the number of GarbageCollector hits.

Parameters:

callback - the processed frame is sent here

allocator - allocator for the images

readMode - pixels reading mode

Method Details

setFormat

public void setFormat(FramePixelBufferFormat format)

Apply output frame format. The nearest output frame will have this format.

Parameters:

format - desired output format of image

See Also:

• Available formats

setOrientation

public void setOrientation(Orientation orientation,
 boolean mirroring)

Apply output frame orientation. The nearest output frame will have this orientation.

Specified by:

setOrientation in interface IOrientable

Parameters:

orientation - rotation of output frame

mirroring - require mirroring

start

public void start()

Description copied from interface: IOutput

Start using output by the Player

Specified by:

start in interface IOutput

stop

public void stop()

Description copied from interface: IOutput

Stop using output by the Player

Specified by:

stop in interface IOutput

present

public void present(IRenderTargetPresentable renderTarget)

Presenting the processed frame to the surface

Specified by:

present in interface IOutput

Parameters:

renderTarget - provided by the Player

close

public void close()

Closes the resource and frees memory

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class VerifyCloseable