com.avalancheevantage.android.camera3

Class PreviewHandler

java.lang.Object

com.avalancheevantage.android.camera3.PreviewHandler

public final class PreviewHandler
extends java.lang.Object

This class represents the configuration for a preview session. It is responsible for holding a reference to the preview TextureView and for allowing the user to optionally specify a custom preview request and callback. It should be created once and passed to Camera3.startCaptureSession(String, PreviewHandler, List) when the capture session is started.

Constructor Summary

Constructors

Constructor and Description
PreviewHandler(android.graphics.SurfaceTexture previewSurface, android.util.Size preferredSize)
PreviewHandler(android.graphics.SurfaceTexture previewSurface, android.util.Size preferredSize, CaptureRequestConfiguration requestConfig)
PreviewHandler(android.graphics.SurfaceTexture previewSurface, android.util.Size preferredSize, CaptureRequestConfiguration requestConfig, Camera3.PreviewSizeCallback previewSizeSelected) An alternative constructor that allows you to provide a SurfaceTexture instead of a TextureView.
PreviewHandler(android.view.TextureView previewTextureView)
PreviewHandler(android.view.TextureView previewTextureView, android.util.Size preferredSize)
PreviewHandler(android.view.TextureView previewTextureView, android.util.Size preferredSize, CaptureRequestConfiguration requestConfig)
PreviewHandler(android.view.TextureView previewTextureView, android.util.Size preferredSize, CaptureRequestConfiguration requestConfig, Camera3.PreviewSizeCallback previewSizeSelected)

Method Summary

Modifier and Type	Method and Description
android.util.Size	getPreferredSize()
android.graphics.SurfaceTexture	getSurfaceTexture()
void	updateRequestConfig(CaptureRequestConfiguration newConfig) Sets the preview config to the new value.

Methods inherited from class java.lang.Object

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

Constructor Detail

PreviewHandler

public PreviewHandler(@NonNull
                      android.graphics.SurfaceTexture previewSurface,
                      @NonNull
                      android.util.Size preferredSize)

See Also:

PreviewHandler(SurfaceTexture, Size, CaptureRequestConfiguration, Camera3.PreviewSizeCallback)

PreviewHandler

public PreviewHandler(@NonNull
                      android.graphics.SurfaceTexture previewSurface,
                      @NonNull
                      android.util.Size preferredSize,
                      @Nullable
                      CaptureRequestConfiguration requestConfig)

See Also:

PreviewHandler(SurfaceTexture, Size, CaptureRequestConfiguration, Camera3.PreviewSizeCallback)

PreviewHandler

public PreviewHandler(@NonNull
                      android.graphics.SurfaceTexture previewSurface,
                      @NonNull
                      android.util.Size preferredSize,
                      @Nullable
                      CaptureRequestConfiguration requestConfig,
                      @Nullable
                      Camera3.PreviewSizeCallback previewSizeSelected)

An alternative constructor that allows you to provide a SurfaceTexture instead of a TextureView. For a normal preview session, you will probably just want to use a TextureView. However, if you have a special use case, this constructor offers a bit more flexibility.

Parameters:

previewSurface - the surface on which to project the preview

preferredSize - the desired preview size. (required) see PreviewHandler(TextureView, Size, CaptureRequestConfiguration, Camera3.PreviewSizeCallback)

requestConfig - see PreviewHandler( TextureView, Size, CaptureRequestConfiguration, Camera3.PreviewSizeCallback)

previewSizeSelected - see PreviewHandler( TextureView, Size, CaptureRequestConfiguration, Camera3.PreviewSizeCallback)

See Also:

PreviewHandler(TextureView, Size, CaptureRequestConfiguration, Camera3.PreviewSizeCallback)

PreviewHandler

public PreviewHandler(@NonNull
                      android.view.TextureView previewTextureView)

See Also:

PreviewHandler(TextureView, Size, CaptureRequestConfiguration, Camera3.PreviewSizeCallback)

PreviewHandler

public PreviewHandler(@NonNull
                      android.view.TextureView previewTextureView,
                      @Nullable
                      android.util.Size preferredSize)

See Also:

PreviewHandler(TextureView, Size, CaptureRequestConfiguration, Camera3.PreviewSizeCallback)

PreviewHandler

public PreviewHandler(@NonNull
                      android.view.TextureView previewTextureView,
                      @Nullable
                      android.util.Size preferredSize,
                      @Nullable
                      CaptureRequestConfiguration requestConfig)

See Also:

PreviewHandler(TextureView, Size, CaptureRequestConfiguration, Camera3.PreviewSizeCallback)

PreviewHandler

public PreviewHandler(@NonNull
                      android.view.TextureView previewTextureView,
                      @Nullable
                      android.util.Size preferredSize,
                      @Nullable
                      CaptureRequestConfiguration requestConfig,
                      @Nullable
                      Camera3.PreviewSizeCallback previewSizeSelected)

Parameters:

previewTextureView - the texture to display the preview in

preferredSize - (optional) the preferred resolution for the preview. There is no grantee that this size will be used. Camera3 take this preference into account and pick a size form the list of available camera sizes. See Camera3.getAvailableImageSizes(String, int). If null, the size of previewTextureView will be used.

requestConfig - an optional custom configuration for the preview request. This allows you to specify custom attributes for the request like focus and exposure. Defaults are given by CameraDevice.TEMPLATE_PREVIEW. If null, the defaults are not altered. You should not specify a target for the builder or build it. See CaptureRequestConfiguration for more information.

previewSizeSelected - an optional callback if you want to be notified when an actual preview size is chosen (based on preferredSize or the size of previewTextureView). This can be useful if you want to adjust your UI (especially aspect ratio) accordingly. Hint: if you are using AutoFitTextureView, pass the selected size to AutoFitTextureView.setAspectRatio(int, int) here.

Method Detail

updateRequestConfig

public void updateRequestConfig(CaptureRequestConfiguration newConfig)

Sets the preview config to the new value. If the preview is running, it will be updated live. This fully replaces the old preview config, so it should include any special configuration you want in your preview, not just the changes.

Parameters:

newConfig - the new preview configuration to use

getPreferredSize

@Contract(pure=true)
 @NonNull
public android.util.Size getPreferredSize()

getSurfaceTexture

@Contract(pure=true)
 @NonNull
public android.graphics.SurfaceTexture getSurfaceTexture()