Package com.amazonaws.ivs.broadcast

Class ImagePreviewSurfaceTarget

java.lang.Object

com.amazonaws.ivs.broadcast.ImagePreviewSurfaceTarget

public class ImagePreviewSurfaceTarget
extends Object

A special kind of preview which is not an Android View. The application should supply an Android Surface through setSurface(Surface, int, int) and clear through clearSurface().

This preview is not a View, so it has no window attachment lifecycle. It remains valid until release() is called. Don't forget to call release() when done.

Method Summary

Modifier and Type	Method	Description
void	clearSurface()	Clears the surface, previews will not be rendered until {setSurface(Surface, int, int)} is called again
void	release()	Release this preview, after calling this method the preview is not valid anymore and you will need a new one
void	setMirrored(boolean isMirrored)	Flips the preview horizontally.
void	setSurface(android.view.Surface surface, int width, int height)	Specifies a new surface for rendering the preview

Methods inherited from class java.lang.Object

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

Method Details

setMirrored

public void setMirrored(boolean isMirrored)

Flips the preview horizontally. This will be true by default for the front facing camera, and false for everything else.

Parameters:

isMirrored - Whether this view should be mirrored horizontally.

Throws:

IllegalStateException - If the preview has already been released.

setSurface

public void setSurface(@NonNull
 android.view.Surface surface,
 int width,
 int height)

Specifies a new surface for rendering the preview

Parameters:

surface - An Android Surface to render to

width - Surface width

height - Surface height

Throws:

IllegalStateException - If the preview has already been released.

clearSurface

public void clearSurface()

Clears the surface, previews will not be rendered until {setSurface(Surface, int, int)} is called again

Throws:

IllegalStateException - If the preview has already been released.

release

public void release()

Release this preview, after calling this method the preview is not valid anymore and you will need a new one