Preview

public final class Preview
extends UseCase

java.lang.Object
   ↳ androidx.camera.core.UseCase
     ↳ androidx.camera.core.Preview


A use case that provides a camera preview stream for displaying on-screen.

The preview stream is connected to the Surface provided via Preview.SurfaceProvider. The application decides how the Surface is shown, and is responsible for managing the Surface lifecycle after providing it.

To display the preview with the correct orientation, app needs to take different actions based on the source of the Surface. If the Surface is backed by a SurfaceView, it will always be in the device's display orientation. If the Surface is backed by ImageReader, MediaCodec or other objects, it's the application's responsibility to calculate the rotation. If the Surface is backed by a SurfaceTexture, SurfaceTexture.getTransformMatrix(float[]) can be used to transform the preview to natural orientation. The value is available after a frame is pushed to the SurfaceTexture and its SurfaceTexture.OnFrameAvailableListener.onFrameAvailable(SurfaceTexture) has been called. TextureView handles this automatically and always puts the preview in the natural orientation. To further transform the TextureView to display orientation, the app needs to apply the current display rotation. Example:

     
         switch (getWindowManager().getDefaultDisplay().getRotation()) {
             case Surface.ROTATION_0:
                 displayRotation = 0;
                 break;
             case Surface.ROTATION_90:
                 displayRotation = 90;
                 break;
             case Surface.ROTATION_180:
                 displayRotation = 180;
                 break;
             case Surface.ROTATION_270:
                 displayRotation = 270;
                 break;
             default:
                 throw new UnsupportedOperationException(
                         "Unsupported display rotation: " + displayRotation);
         }
         matrix.postRotate(-displayRotation, centerX, centerY);
         textureView.setTransform(matrix);
     
 

Summary

Nested classes

class Preview.Builder

Builder for a Preview

interface Preview.SurfaceProvider

A interface implemented by the application to provide a Surface for Preview

Public methods

ResolutionInfo getResolutionInfo()

Gets selected resolution information of the Preview.

int getTargetRotation()

Returns the rotation that the intended target resolution is expressed in.

void setSurfaceProvider(Executor executor, Preview.SurfaceProvider surfaceProvider)

Sets a Preview.SurfaceProvider to provide a Surface for Preview.

void setSurfaceProvider(Preview.SurfaceProvider surfaceProvider)

Sets a Preview.SurfaceProvider to provide a Surface for Preview.

void setTargetRotation(int targetRotation)

Sets the target rotation.

String toString()

Inherited methods

Public methods

getResolutionInfo

public ResolutionInfo getResolutionInfo ()

Gets selected resolution information of the Preview.

The returned ResolutionInfo will be expressed in the coordinates of the camera sensor. It will be the same as the resolution inside a SurfaceRequest to request a surface for Preview.

The resolution information might change if the use case is unbound and then rebound or setTargetRotation(int) is called to change the target rotation setting. The application needs to call getResolutionInfo() again to get the latest ResolutionInfo for the changes.

Returns
ResolutionInfo the resolution information if the use case has been bound by the ProcessCameraProvider.bindToLifecycle(LifecycleOwner, CameraSelector, UseCase) API, or null if the use case is not bound yet.

getTargetRotation

public int getTargetRotation ()

Returns the rotation that the intended target resolution is expressed in.

The rotation is set when constructing an Preview instance using Preview.Builder.setTargetRotation(int). If not set, the target rotation defaults to the value of Display.getRotation() of the default display at the time the use case is created. The use case is fully created once it has been attached to a camera.

Returns
int The rotation of the intended target.

setSurfaceProvider

public void setSurfaceProvider (Executor executor, 
                Preview.SurfaceProvider surfaceProvider)

Sets a Preview.SurfaceProvider to provide a Surface for Preview.

Setting the provider will signal to the camera that the use case is ready to receive data. If the provider is removed by calling this again with a null SurfaceProvider then the camera will stop producing data for this Preview instance.

Parameters
executor Executor: on which the surfaceProvider will be invoked.

surfaceProvider Preview.SurfaceProvider: SurfaceProvider that provides a Surface for Preview. This will replace the previous SurfaceProvider set either this method or setSurfaceProvider(SurfaceProvider).

setSurfaceProvider