Preview
class Preview : UseCase
A use case that provides a camera preview stream for displaying on-screen.
The preview stream is connected to the Surface provided via 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, getTransformMatrix can be used to transform the preview to natural orientation. The value is available after a frame is pushed to the SurfaceTexture and its onFrameAvailable 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 types |
|---|
class Preview.Builder : ExtendableBuilderBuilder for a |
interface Preview.SurfaceProviderA interface implemented by the application to provide a |
Public functions |
|
|---|---|
DynamicRange |
Returns the dynamic range. |
java-static PreviewCapabilities |
getPreviewCapabilities(cameraInfo: CameraInfo)Returns |
ResolutionInfo? |
Gets selected resolution information of the |
ResolutionSelector? |
Returns the resolution selector setting. |
Range<Int!> |
Returns the target frame rate range, in frames per second, for the associated Preview use case. |
Int |
Returns the rotation that the intended target resolution is expressed in. |
Boolean |
Returns whether video stabilization is enabled for preview stream. |
Unit |
@UiThreadSets a |
Unit |
@UiThreadSets a |
Unit |
setTargetRotation(targetRotation: Int)Sets the target rotation. |
String |
toString() |
Inherited functions |
||
|---|---|---|
|
Public functions
getDynamicRange
fun getDynamicRange(): DynamicRange
Returns the dynamic range.
The dynamic range is set by setDynamicRange. If the dynamic range set is not a fully defined dynamic range, such as HDR_UNSPECIFIED_10_BIT, then it will be returned just as provided, and will not be returned as a fully defined dynamic range. The fully defined dynamic range, which is determined by resolving the combination of requested dynamic ranges from other use cases according to the device capabilities, will be communicated to the Preview.SurfaceProvider via getDynamicRange}.
If the dynamic range was not provided to setDynamicRange, this will return the default of UNSPECIFIED
| Returns | |
|---|---|
DynamicRange |
the dynamic range set for this |
| See also | |
|---|---|
setDynamicRange |
getPreviewCapabilities
java-static fun getPreviewCapabilities(cameraInfo: CameraInfo): PreviewCapabilities
Returns PreviewCapabilities to query preview stream related device capability.
getResolutionInfo
fun getResolutionInfo(): ResolutionInfo?
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 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 |
getResolutionSelector
fun getResolutionSelector(): ResolutionSelector?
Returns the resolution selector setting.
This setting is set when constructing a Preview using setResolutionSelector.
getTargetFrameRate
fun getTargetFrameRate(): Range<Int!>
Returns the target frame rate range, in frames per second, for the associated Preview use case.
The target frame rate can be set prior to constructing a Preview using setTargetFrameRate. If not set, the target frame rate defaults to the value of FRAME_RATE_RANGE_UNSPECIFIED.
This is just the frame rate range requested by the user, and may not necessarily be equal to the range the camera is actually operating at.
getTargetRotation
fun getTargetRotation(): Int
Returns the rotation that the intended target resolution is expressed in.
The rotation is set when constructing an Preview instance using setTargetRotation. If not set, the target rotation defaults to the value of 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. |
isPreviewStabilizationEnabled
fun isPreviewStabilizationEnabled(): Boolean
Returns whether video stabilization is enabled for preview stream.
setSurfaceProvider
@UiThread
fun setSurfaceProvider(surfaceProvider: Preview.SurfaceProvider?): Unit
Sets a SurfaceProvider to provide a Surface for Preview.
Setting the provider will signal to the camera that the use case is ready to receive data. The provider will be triggered on main thread. 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 | |
|---|---|
surfaceProvider: Preview.SurfaceProvider? |
SurfaceProvider that provides a |
setSurfaceProvider
@UiThread
fun setSurfaceProvider(
executor: Executor,
surfaceProvider: Preview.SurfaceProvider?
): Unit
Sets a 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 |
setTargetRotation
fun setTargetRotation(targetRotation: Int): Unit
Sets the target rotation.
This adjust the getTargetRotation, which once applied will update the output to match target rotation specified here.
While rotation can also be set via setTargetRotation , using setTargetRotation allows the target rotation to be set without rebinding new use cases. When this function is called, value set by setTargetResolution will be updated automatically to make sure the suitable resolution can be selected when the use case is bound.
If not set here or by configuration, the target rotation will default to the value of 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.
| Parameters | |
|---|---|
targetRotation: Int |
Target rotation of the output image, expressed as one of |
| See also | |
|---|---|
setTargetRotation |