PreviewView

Added in 1.1.0

Kotlin |Java

public final class PreviewView extends FrameLayout

java.lang.Object
↳	android.view.View
	↳	android.view.ViewGroup
		↳	android.widget.FrameLayout
			↳	androidx.camera.view.PreviewView

Custom View that displays the camera feed for CameraX's Preview use case.

This class manages the preview Surface's lifecycle. It internally uses either a TextureView or SurfaceView to display the camera feed, and applies required transformations on them to correctly display the preview, this involves correcting their aspect ratio, scale and rotation.

If PreviewView uses a SurfaceView to display the preview stream, be careful when overlapping a View that's initially not visible (either INVISIBLE or GONE) on top of it. When the SurfaceView is attached to the display window, it calls requestTransparentRegion which requests a computation of the transparent regions on the display. At this point, the View isn't visible, causing the overlapped region between the SurfaceView and the View to be considered transparent. Later if the View becomes visible, it will not be displayed on top of SurfaceView. A way around this is to call requestTransparentRegion right after making the View visible, or initially hiding the View by setting its opacity to 0, then setting it to 1.0F to show it.

There are some limitations of transition animations to SurfaceView and TextureView, which applies to PreviewView as well.

See also
`Limitations`

Summary

Nested types
`public enum PreviewView.ImplementationMode` The implementation mode of a `PreviewView`.
`public enum PreviewView.ScaleType` Options for scaling the preview vis-à-vis its container `PreviewView`.
`public enum PreviewView.StreamState` Definitions for the preview stream state.

Public constructors
`@UiThread PreviewView(@NonNull Context context)`
`@UiThread PreviewView(@NonNull Context context, @Nullable AttributeSet attrs)`
`@UiThread PreviewView( @NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr )`
`@UiThread PreviewView( @NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr, int defStyleRes )`

Public methods
`@Nullable Bitmap`	`@UiThread getBitmap()` Returns a `Bitmap` representation of the content displayed on the `PreviewView`, or `null` if the camera preview hasn't started yet.
`@Nullable CameraController`	`@UiThread getController()` Get the `CameraController`.
`@NonNull PreviewView.ImplementationMode`	`@UiThread getImplementationMode()` Returns the `ImplementationMode`.
`@NonNull MeteringPointFactory`	`@UiThread getMeteringPointFactory()` Gets the `MeteringPointFactory` for the camera currently connected to the `PreviewView`, if any.
`@Nullable OutputTransform`	`getOutputTransform()` Gets the `OutputTransform` associated with the `PreviewView`.
`@NonNull LiveData<PreviewView.StreamState>`	`getPreviewStreamState()` Gets a `LiveData` for the preview `StreamState`.
`@NonNull PreviewView.ScaleType`	`@UiThread getScaleType()` Returns the `ScaleType` currently applied to the preview.
`@Nullable ImageCapture.ScreenFlash`	`@UiThread getScreenFlash()` Returns an `ImageCapture.ScreenFlash` implementation based on the `Window` instance set via `setScreenFlashWindow`.
`@Nullable Matrix`	`@UiThread getSensorToViewTransform()` Gets the transformation matrix from camera sensor to `PreviewView`.
`@NonNull Preview.SurfaceProvider`	`@UiThread getSurfaceProvider()` Gets a `Preview.SurfaceProvider` to be used with `setSurfaceProvider`.
`@Nullable ViewPort`	`@UiThread getViewPort()` Gets a `ViewPort` based on the current status of `PreviewView`.
`@Nullable ViewPort`	`@UiThread getViewPort(int targetRotation)` Gets a `ViewPort` with custom target rotation.
`boolean`	`onTouchEvent(@NonNull MotionEvent event)`
`boolean`	`performClick()`
`void`	`@UiThread setController(@Nullable CameraController cameraController)` Sets the `CameraController`.
`void`	`@UiThread setImplementationMode( @NonNull PreviewView.ImplementationMode implementationMode )` Sets the `ImplementationMode` for the `PreviewView`.
`void`	`@UiThread setScaleType(@NonNull PreviewView.ScaleType scaleType)` Applies a `ScaleType` to the preview.
`void`	`setScreenFlashOverlayColor(@ColorInt int color)` Sets the color of the top overlay view during screen flash.
`void`	`@UiThread setScreenFlashWindow(@Nullable Window screenFlashWindow)` Sets a `Window` instance for subsequent photo capture requests with `FLASH_MODE_SCREEN` set.

Protected methods
`void`	`onAttachedToWindow()`
`void`	`onDetachedFromWindow()`

Inherited Constants

From android.view.View

`static final int`	`ACCESSIBILITY_DATA_SENSITIVE_AUTO = 0`
`static final int`	`ACCESSIBILITY_DATA_SENSITIVE_NO = 2`
`static final int`	`ACCESSIBILITY_DATA_SENSITIVE_YES = 1`
`static final int`	`ACCESSIBILITY_LIVE_REGION_ASSERTIVE = 2`
`static final int`	`ACCESSIBILITY_LIVE_REGION_NONE = 0`
`static final int`	`ACCESSIBILITY_LIVE_REGION_POLITE = 1`
`static final Property<View, Float>`	`ALPHA`
`static final int`	`AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS = 1`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE = "creditCardExpirationDate"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY = "creditCardExpirationDay"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH = "creditCardExpirationMonth"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR = "creditCardExpirationYear"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_NUMBER = "creditCardNumber"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE = "creditCardSecurityCode"`
`static final String`	`AUTOFILL_HINT_EMAIL_ADDRESS = "emailAddress"`
`static final String`	`AUTOFILL_HINT_NAME = "name"`
`static final String`	`AUTOFILL_HINT_PASSWORD = "password"`
`static final String`	`AUTOFILL_HINT_PHONE = "phone"`
`static final String`	`AUTOFILL_HINT_POSTAL_ADDRESS = "postalAddress"`
`static final String`	`AUTOFILL_HINT_POSTAL_CODE = "postalCode"`
`static final String`	`AUTOFILL_HINT_USERNAME = "username"`
`static final int`	`AUTOFILL_TYPE_DATE = 4`
`static final int`	`AUTOFILL_TYPE_LIST = 3`
`static final int`	`AUTOFILL_TYPE_NONE = 0`
`static final int`	`AUTOFILL_TYPE_TEXT = 1`
`static final int`	`AUTOFILL_TYPE_TOGGLE = 2`
`static final int`	`CONTENT_SENSITIVITY_AUTO = 0`
`static final int`	`CONTENT_SENSITIVITY_NOT_SENSITIVE = 2`
`static final int`	`CONTENT_SENSITIVITY_SENSITIVE = 1`
`static final int`	`DRAG_FLAG_ACCESSIBILITY_ACTION = 1024`
`static final int`	`DRAG_FLAG_GLOBAL = 256`
`static final int`	`DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION = 64`
`static final int`	`DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION = 128`
`static final int`	`DRAG_FLAG_GLOBAL_SAME_APPLICATION = 4096`
`static final int`	`DRAG_FLAG_GLOBAL_URI_READ = 1`
`static final int`	`DRAG_FLAG_GLOBAL_URI_WRITE = 2`
`static final int`	`DRAG_FLAG_OPAQUE = 512`
`static final int`	`DRAG_FLAG_START_INTENT_SENDER_ON_UNHANDLED_DRAG = 8192`
`static final int`	`DRAWING_CACHE_QUALITY_AUTO = 0` This field is deprecated.
`static final int`	`DRAWING_CACHE_QUALITY_HIGH = 1048576` This field is deprecated.
`static final int`	`DRAWING_CACHE_QUALITY_LOW = 524288` This field is deprecated.
`static final int[]`	`EMPTY_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_SELECTED_STATE_SET`
`static final int[]`	`ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_STATE_SET`
`static final int[]`	`ENABLED_WINDOW_FOCUSED_STATE_SET`
`static final int`	`FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 2`
`static final int`	`FIND_VIEWS_WITH_TEXT = 1`
`static final int`	`FOCUSABLE = 1`
`static final int`	`FOCUSABLES_ALL = 0`
`static final int`	`FOCUSABLES_TOUCH_MODE = 1`
`static final int`	`FOCUSABLE_AUTO = 16`
`static final int[]`	`FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`FOCUSED_STATE_SET`
`static final int[]`	`FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int`	`FOCUS_BACKWARD = 1`
`static final int`	`FOCUS_DOWN = 130`
`static final int`	`FOCUS_FORWARD = 2`
`static final int`	`FOCUS_LEFT = 17`
`static final int`	`FOCUS_RIGHT = 66`
`static final int`	`FOCUS_UP = 33`
`static final int`	`GONE = 8`
`static final int`	`HAPTIC_FEEDBACK_ENABLED = 268435456`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_NO = 2`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS = 4`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_YES = 1`
`static final int`	`IMPORTANT_FOR_AUTOFILL_AUTO = 0`
`static final int`	`IMPORTANT_FOR_AUTOFILL_NO = 2`
`static final int`	`IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS = 8`
`static final int`	`IMPORTANT_FOR_AUTOFILL_YES = 1`
`static final int`	`IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS = 4`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_AUTO = 0`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_NO = 2`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS = 8`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_YES = 1`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS = 4`
`static final int`	`INVISIBLE = 4`
`static final int`	`KEEP_SCREEN_ON = 67108864`
`static final int`	`LAYER_TYPE_HARDWARE = 2`
`static final int`	`LAYER_TYPE_NONE = 0`
`static final int`	`LAYER_TYPE_SOFTWARE = 1`
`static final int`	`LAYOUT_DIRECTION_INHERIT = 2`
`static final int`	`LAYOUT_DIRECTION_LOCALE = 3`
`static final int`	`LAYOUT_DIRECTION_LTR = 0`
`static final int`	`LAYOUT_DIRECTION_RTL = 1`
`static final int`	`MEASURED_HEIGHT_STATE_SHIFT = 16`
`static final int`	`MEASURED_SIZE_MASK = 16777215`
`static final int`	`MEASURED_STATE_MASK = -16777216`
`static final int`	`MEASURED_STATE_TOO_SMALL = 16777216`
`static final int`	`NOT_FOCUSABLE = 0`
`static final int`	`NO_ID = -1`
`static final int`	`OVER_SCROLL_ALWAYS = 0`
`static final int`	`OVER_SCROLL_IF_CONTENT_SCROLLS = 1`
`static final int`	`OVER_SCROLL_NEVER = 2`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_STATE_SET`
`static final int[]`	`PRESSED_WINDOW_FOCUSED_STATE_SET`
`static final float`	`REQUESTED_FRAME_RATE_CATEGORY_DEFAULT`
`static final float`	`REQUESTED_FRAME_RATE_CATEGORY_HIGH = -4.0f`
`static final float`	`REQUESTED_FRAME_RATE_CATEGORY_LOW = -2.0f`
`static final float`	`REQUESTED_FRAME_RATE_CATEGORY_NORMAL = -3.0f`
`static final float`	`REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE = -1.0f`
`static final Property<View, Float>`	`ROTATION`
`static final Property<View, Float>`	`ROTATION_X`
`static final Property<View, Float>`	`ROTATION_Y`
`static final Property<View, Float>`	`SCALE_X`
`static final Property<View, Float>`	`SCALE_Y`
`static final int`	`SCREEN_STATE_OFF = 0`
`static final int`	`SCREEN_STATE_ON = 1`
`static final int`	`SCROLLBARS_INSIDE_INSET = 16777216`
`static final int`	`SCROLLBARS_INSIDE_OVERLAY = 0`
`static final int`	`SCROLLBARS_OUTSIDE_INSET = 50331648`
`static final int`	`SCROLLBARS_OUTSIDE_OVERLAY = 33554432`
`static final int`	`SCROLLBAR_POSITION_DEFAULT = 0`
`static final int`	`SCROLLBAR_POSITION_LEFT = 1`
`static final int`	`SCROLLBAR_POSITION_RIGHT = 2`
`static final int`	`SCROLL_AXIS_HORIZONTAL = 1`
`static final int`	`SCROLL_AXIS_NONE = 0`
`static final int`	`SCROLL_AXIS_VERTICAL = 2`
`static final int`	`SCROLL_CAPTURE_HINT_AUTO = 0`
`static final int`	`SCROLL_CAPTURE_HINT_EXCLUDE = 1`
`static final int`	`SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS = 4`
`static final int`	`SCROLL_CAPTURE_HINT_INCLUDE = 2`
`static final int`	`SCROLL_INDICATOR_BOTTOM = 2`
`static final int`	`SCROLL_INDICATOR_END = 32`
`static final int`	`SCROLL_INDICATOR_LEFT = 4`
`static final int`	`SCROLL_INDICATOR_RIGHT = 8`
`static final int`	`SCROLL_INDICATOR_START = 16`
`static final int`	`SCROLL_INDICATOR_TOP = 1`
`static final int[]`	`SELECTED_STATE_SET`
`static final int[]`	`SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int`	`SOUND_EFFECTS_ENABLED = 134217728`
`static final int`	`STATUS_BAR_HIDDEN = 1` This field is deprecated.
`static final int`	`STATUS_BAR_VISIBLE = 0` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_FULLSCREEN = 4` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_HIDE_NAVIGATION = 2` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_IMMERSIVE = 2048` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_IMMERSIVE_STICKY = 4096` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 1024` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 512` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LAYOUT_STABLE = 256` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR = 16` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LIGHT_STATUS_BAR = 8192` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LOW_PROFILE = 1` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_VISIBLE = 0` This field is deprecated.
`static final int`	`SYSTEM_UI_LAYOUT_FLAGS = 1536` This field is deprecated.
`static final int`	`TEXT_ALIGNMENT_CENTER = 4`
`static final int`	`TEXT_ALIGNMENT_GRAVITY = 1`
`static final int`	`TEXT_ALIGNMENT_INHERIT = 0`
`static final int`	`TEXT_ALIGNMENT_TEXT_END = 3`
`static final int`	`TEXT_ALIGNMENT_TEXT_START = 2`
`static final int`	`TEXT_ALIGNMENT_VIEW_END = 6`
`static final int`	`TEXT_ALIGNMENT_VIEW_START = 5`
`static final int`	`TEXT_DIRECTION_ANY_RTL = 2`
`static final int`	`TEXT_DIRECTION_FIRST_STRONG = 1`
`static final int`	`TEXT_DIRECTION_FIRST_STRONG_LTR = 6`
`static final int`	`TEXT_DIRECTION_FIRST_STRONG_RTL = 7`
`static final int`	`TEXT_DIRECTION_INHERIT = 0`
`static final int`	`TEXT_DIRECTION_LOCALE = 5`
`static final int`	`TEXT_DIRECTION_LTR = 3`
`static final int`	`TEXT_DIRECTION_RTL = 4`
`static final Property<View, Float>`	`TRANSLATION_X`
`static final Property<View, Float>`	`TRANSLATION_Y`
`static final Property<View, Float>`	`TRANSLATION_Z`
`static final String`	`VIEW_LOG_TAG = "View"`
`static final int`	`VISIBLE = 0`
`static final int[]`	`WINDOW_FOCUSED_STATE_SET`
`static final Property<View, Float>`	`X`
`static final Property<View, Float>`	`Y`
`static final Property<View, Float>`	`Z`

From android.view.ViewGroup

`static final int`	`CLIP_TO_PADDING_MASK = 34`
`static final int`	`FOCUS_AFTER_DESCENDANTS = 262144`
`static final int`	`FOCUS_BEFORE_DESCENDANTS = 131072`
`static final int`	`FOCUS_BLOCK_DESCENDANTS = 393216`
`static final int`	`LAYOUT_MODE_CLIP_BOUNDS = 0`
`static final int`	`LAYOUT_MODE_OPTICAL_BOUNDS = 1`
`static final int`	`PERSISTENT_ALL_CACHES = 3` This field is deprecated.
`static final int`	`PERSISTENT_ANIMATION_CACHE = 1` This field is deprecated.
`static final int`	`PERSISTENT_NO_CACHE = 0` This field is deprecated.
`static final int`	`PERSISTENT_SCROLLING_CACHE = 2` This field is deprecated.

Inherited methods

From android.widget.FrameLayout

`boolean`	`checkLayoutParams(ViewGroup.LayoutParams p)`
`FrameLayout.LayoutParams`	`generateDefaultLayoutParams()`
`FrameLayout.LayoutParams`	`generateLayoutParams(AttributeSet attrs)`
`CharSequence`	`getAccessibilityClassName()`
`boolean`	`getConsiderGoneChildrenWhenMeasuring()` This method is deprecated.
`boolean`	`getMeasureAllChildren()`
`void`	`onLayout(boolean changed, int left, int top, int right, int bottom)`
`void`	`onMeasure(int widthMeasureSpec, int heightMeasureSpec)`
`void`	`setForegroundGravity(int foregroundGravity)`
`void`	`setMeasureAllChildren(boolean measureAll)`
`boolean`	`shouldDelayChildPressedState()`

From android.view.View

`void`	`addOnAttachStateChangeListener( View.OnAttachStateChangeListener listener )`
`void`	`addOnLayoutChangeListener(View.OnLayoutChangeListener listener)`
`void`	`addOnUnhandledKeyEventListener( View.OnUnhandledKeyEventListener listener )`
`ViewPropertyAnimator`	`animate()`
`void`	`announceForAccessibility(CharSequence text)`
`void`	`autofill(AutofillValue value)`
`boolean`	`awakenScrollBars()`
`void`	`bringToFront()`
`void`	`buildDrawingCache()` This method is deprecated.
`void`	`buildLayer()`
`boolean`	`callOnClick()`
`boolean`	`canResolveLayoutDirection()`
`boolean`	`canResolveTextAlignment()`
`boolean`	`canResolveTextDirection()`
`boolean`	`canScrollHorizontally(int direction)`
`boolean`	`canScrollVertically(int direction)`
`final void`	`cancelDragAndDrop()`
`void`	`cancelLongPress()`
`final void`	`cancelPendingInputEvents()`
`boolean`	`checkInputConnectionProxy(View view)`
`void`	`clearAnimation()`
`void`	`clearPendingCredentialRequest()`
`void`	`clearViewTranslationCallback()`
`static int`	`combineMeasuredStates(int curState, int newState)`
`int`	`computeHorizontalScrollExtent()`
`int`	`computeHorizontalScrollOffset()`
`int`	`computeHorizontalScrollRange()`
`void`	`computeScroll()`
`WindowInsets`	`computeSystemWindowInsets(WindowInsets in, Rect outLocalInsets)`
`int`	`computeVerticalScrollExtent()`
`int`	`computeVerticalScrollOffset()`
`int`	`computeVerticalScrollRange()`
`AccessibilityNodeInfo`	`createAccessibilityNodeInfo()`
`void`	`createContextMenu(ContextMenu menu)`
`void`	`destroyDrawingCache()` This method is deprecated.
`boolean`	`dispatchGenericMotionEvent(MotionEvent event)`
`boolean`	`dispatchNestedFling(float velocityX, float velocityY, boolean consumed)`
`boolean`	`dispatchNestedPreFling(float velocityX, float velocityY)`
`boolean`	`dispatchNestedPrePerformAccessibilityAction( int action, Bundle arguments )`
`boolean`	`dispatchNestedPreScroll( int dx, int dy, int[] consumed, int[] offsetInWindow )`
`boolean`	`dispatchNestedScroll( int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow )`
`boolean`	`dispatchPopulateAccessibilityEvent(AccessibilityEvent event)`
`void`	`draw(Canvas canvas)`
`void`	`drawableHotspotChanged(float x, float y)`
`final OnBackInvokedDispatcher`	`findOnBackInvokedDispatcher()`
`final T`	`<T extends View> findViewById(int id)`
`final T`	`<T extends View> findViewWithTag(Object tag)`
`boolean`	`fitSystemWindows(Rect insets)` This method is deprecated.
`void`	`forceHasOverlappingRendering(boolean hasOverlappingRendering)`
`void`	`forceLayout()`
`void`	`generateDisplayHash( String hashAlgorithm, Rect bounds, Executor executor, DisplayHashResultCallback callback )`
`static int`	`generateViewId()`
`View.AccessibilityDelegate`	`getAccessibilityDelegate()`
`int`	`getAccessibilityLiveRegion()`
`AccessibilityNodeProvider`	`getAccessibilityNodeProvider()`
`CharSequence`	`getAccessibilityPaneTitle()`
`int`	`getAccessibilityTraversalAfter()`
`int`	`getAccessibilityTraversalBefore()`
`String`	`getAllowedHandwritingDelegatePackageName()`
`String`	`getAllowedHandwritingDelegatorPackageName()`
`float`	`getAlpha()`
`Animation`	`getAnimation()`
`Matrix`	`getAnimationMatrix()`
`IBinder`	`getApplicationWindowToken()`
`int[]`	`getAttributeResolutionStack(int attribute)`
`Map<Integer, Integer>`	`getAttributeSourceResourceMap()`
`String[]`	`getAutofillHints()`
`final AutofillId`	`getAutofillId()`
`int`	`getAutofillType()`
`AutofillValue`	`getAutofillValue()`
`Drawable`	`getBackground()`
`BlendMode`	`getBackgroundTintBlendMode()`
`ColorStateList`	`getBackgroundTintList()`
`PorterDuff.Mode`	`getBackgroundTintMode()`
`int`	`getBaseline()`
`final int`	`getBottom()`
`float`	`getBottomFadingEdgeStrength()`
`int`	`getBottomPaddingOffset()`
`float`	`getCameraDistance()`
`Rect`	`getClipBounds()`
`boolean`	`getClipBounds(Rect outRect)`
`final boolean`	`getClipToOutline()`
`final ContentCaptureSession`	`getContentCaptureSession()`
`CharSequence`	`getContentDescription()`
`final int`	`getContentSensitivity()`
`final Context`	`getContext()`
`ContextMenu.ContextMenuInfo`	`getContextMenuInfo()`
`final boolean`	`getDefaultFocusHighlightEnabled()`
`static int`	`getDefaultSize(int size, int measureSpec)`
`Display`	`getDisplay()`
`final int[]`	`getDrawableState()`
`Bitmap`	`getDrawingCache()` This method is deprecated.
`int`	`getDrawingCacheBackgroundColor()` This method is deprecated.
`int`	`getDrawingCacheQuality()` This method is deprecated.
`void`	`getDrawingRect(Rect outRect)`
`long`	`getDrawingTime()`
`float`	`getElevation()`
`int`	`getExplicitStyle()`
`boolean`	`getFilterTouchesWhenObscured()`
`boolean`	`getFitsSystemWindows()`
`int`	`getFocusable()`
`ArrayList<View>`	`getFocusables(int direction)`
`void`	`getFocusedRect(Rect r)`
`Drawable`	`getForeground()`
`int`	`getForegroundGravity()`
`BlendMode`	`getForegroundTintBlendMode()`
`ColorStateList`	`getForegroundTintList()`
`PorterDuff.Mode`	`getForegroundTintMode()`
`float`	`getFrameContentVelocity()`
`boolean`	`getGlobalVisibleRect(Rect r, Point globalOffset)`
`Handler`	`getHandler()`
`float`	`getHandwritingBoundsOffsetBottom()`
`float`	`getHandwritingBoundsOffsetLeft()`
`float`	`getHandwritingBoundsOffsetRight()`
`float`	`getHandwritingBoundsOffsetTop()`
`int`	`getHandwritingDelegateFlags()`
`Runnable`	`getHandwritingDelegatorCallback()`
`final boolean`	`getHasOverlappingRendering()`
`final int`	`getHeight()`
`void`	`getHitRect(Rect outRect)`
`int`	`getHorizontalFadingEdgeLength()`
`int`	`getHorizontalScrollbarHeight()`
`Drawable`	`getHorizontalScrollbarThumbDrawable()`
`Drawable`	`getHorizontalScrollbarTrackDrawable()`
`int`	`getId()`
`int`	`getImportantForAccessibility()`
`int`	`getImportantForAutofill()`
`int`	`getImportantForContentCapture()`
`boolean`	`getKeepScreenOn()`
`KeyEvent.DispatcherState`	`getKeyDispatcherState()`
`int`	`getLabelFor()`
`int`	`getLayerType()`
`int`	`getLayoutDirection()`
`ViewGroup.LayoutParams`	`getLayoutParams()`
`final int`	`getLeft()`
`float`	`getLeftFadingEdgeStrength()`
`int`	`getLeftPaddingOffset()`
`final boolean`	`getLocalVisibleRect(Rect r)`
`void`	`getLocationInSurface(int[] location)`
`void`	`getLocationInWindow(int[] outLocation)`
`void`	`getLocationOnScreen(int[] outLocation)`
`Matrix`	`getMatrix()`
`final int`	`getMeasuredHeight()`
`final int`	`getMeasuredHeightAndState()`
`final int`	`getMeasuredState()`
`final int`	`getMeasuredWidth()`
`final int`	`getMeasuredWidthAndState()`
`int`	`getMinimumHeight()`
`int`	`getMinimumWidth()`
`int`	`getNextClusterForwardId()`
`int`	`getNextFocusDownId()`
`int`	`getNextFocusForwardId()`
`int`	`getNextFocusLeftId()`
`int`	`getNextFocusRightId()`
`int`	`getNextFocusUpId()`
`View.OnFocusChangeListener`	`getOnFocusChangeListener()`
`int`	`getOutlineAmbientShadowColor()`
`ViewOutlineProvider`	`getOutlineProvider()`
`int`	`getOutlineSpotShadowColor()`
`int`	`getOverScrollMode()`
`ViewOverlay`	`getOverlay()`
`int`	`getPaddingBottom()`
`int`	`getPaddingEnd()`
`int`	`getPaddingLeft()`
`int`	`getPaddingRight()`
`int`	`getPaddingStart()`
`int`	`getPaddingTop()`
`final ViewParent`	`getParent()`
`ViewParent`	`getParentForAccessibility()`
`final OutcomeReceiver<GetCredentialResponse, GetCredentialException>`	`getPendingCredentialCallback()`
`final GetCredentialRequest`	`getPendingCredentialRequest()`
`float`	`getPivotX()`
`float`	`getPivotY()`
`PointerIcon`	`getPointerIcon()`
`final List<Rect>`	`getPreferKeepClearRects()`
`String[]`	`getReceiveContentMimeTypes()`
`float`	`getRequestedFrameRate()`
`Resources`	`getResources()`
`final boolean`	`getRevealOnFocusHint()`
`final int`	`getRight()`
`float`	`getRightFadingEdgeStrength()`
`int`	`getRightPaddingOffset()`
`AttachedSurfaceControl`	`getRootSurfaceControl()`
`View`	`getRootView()`
`WindowInsets`	`getRootWindowInsets()`
`float`	`getRotation()`
`float`	`getRotationX()`
`float`	`getRotationY()`
`float`	`getScaleX()`
`float`	`getScaleY()`
`int`	`getScrollBarDefaultDelayBeforeFade()`
`int`	`getScrollBarFadeDuration()`
`int`	`getScrollBarSize()`
`int`	`getScrollBarStyle()`
`int`	`getScrollCaptureHint()`
`int`	`getScrollIndicators()`
`final int`	`getScrollX()`
`final int`	`getScrollY()`
`int`	`getSolidColor()`
`int`	`getSourceLayoutResId()`
`final CharSequence`	`getStateDescription()`
`StateListAnimator`	`getStateListAnimator()`
`int`	`getSuggestedMinimumHeight()`
`int`	`getSuggestedMinimumWidth()`
`List<Rect>`	`getSystemGestureExclusionRects()`
`int`	`getSystemUiVisibility()` This method is deprecated.
`Object`	`getTag()`
`int`	`getTextAlignment()`
`int`	`getTextDirection()`
`CharSequence`	`getTooltipText()`
`final int`	`getTop()`
`float`	`getTopFadingEdgeStrength()`
`int`	`getTopPaddingOffset()`
`TouchDelegate`	`getTouchDelegate()`
`ArrayList<View>`	`getTouchables()`
`float`	`getTransitionAlpha()`
`String`	`getTransitionName()`
`float`	`getTranslationX()`
`float`	`getTranslationY()`
`float`	`getTranslationZ()`
`long`	`getUniqueDrawingId()`
`int`	`getVerticalFadingEdgeLength()`
`int`	`getVerticalScrollbarPosition()`
`Drawable`	`getVerticalScrollbarThumbDrawable()`
`Drawable`	`getVerticalScrollbarTrackDrawable()`
`int`	`getVerticalScrollbarWidth()`
`ViewTranslationResponse`	`getViewTranslationResponse()`
`ViewTreeObserver`	`getViewTreeObserver()`
`int`	`getVisibility()`
`final int`	`getWidth()`
`int`	`getWindowAttachCount()`
`WindowId`	`getWindowId()`
`WindowInsetsController`	`getWindowInsetsController()`
`int`	`getWindowSystemUiVisibility()` This method is deprecated.
`IBinder`	`getWindowToken()`
`int`	`getWindowVisibility()`
`void`	`getWindowVisibleDisplayFrame(Rect outRect)`
`float`	`getX()`
`float`	`getY()`
`float`	`getZ()`
`boolean`	`hasExplicitFocusable()`
`boolean`	`hasFocusable()`
`boolean`	`hasNestedScrollingParent()`
`boolean`	`hasOnClickListeners()`
`boolean`	`hasOnLongClickListeners()`
`boolean`	`hasOverlappingRendering()`
`boolean`	`hasPointerCapture()`
`boolean`	`hasWindowFocus()`
`static View`	`inflate(Context context, int resource, ViewGroup root)`
`void`	`invalidate(Rect dirty)` This method is deprecated.
`void`	`invalidateDrawable(Drawable drawable)`
`void`	`invalidateOutline()`
`boolean`	`isAccessibilityDataSensitive()`
`boolean`	`isAccessibilityFocused()`
`boolean`	`isAccessibilityHeading()`
`boolean`	`isActivated()`
`boolean`	`isAttachedToWindow()`
`boolean`	`isAutoHandwritingEnabled()`
`boolean`	`isClickable()`
`final boolean`	`isContentSensitive()`
`boolean`	`isContextClickable()`
`boolean`	`isCredential()`
`boolean`	`isDirty()`
`boolean`	`isDrawingCacheEnabled()` This method is deprecated.
`boolean`	`isDuplicateParentStateEnabled()`
`boolean`	`isEnabled()`
`final boolean`	`isFocusable()`
`final boolean`	`isFocusableInTouchMode()`
`boolean`	`isFocused()`
`final boolean`	`isFocusedByDefault()`
`boolean`	`isForceDarkAllowed()`
`boolean`	`isHandwritingDelegate()`
`boolean`	`isHapticFeedbackEnabled()`
`boolean`	`isHardwareAccelerated()`
`boolean`	`isHorizontalFadingEdgeEnabled()`
`boolean`	`isHorizontalScrollBarEnabled()`
`boolean`	`isHovered()`
`boolean`	`isImportantForAccessibility()`
`final boolean`	`isImportantForAutofill()`
`final boolean`	`isImportantForContentCapture()`
`boolean`	`isInEditMode()`
`boolean`	`isInLayout()`
`boolean`	`isInTouchMode()`
`final boolean`	`isKeyboardNavigationCluster()`
`boolean`	`isLaidOut()`
`boolean`	`isLayoutDirectionResolved()`
`boolean`	`isLayoutRequested()`
`boolean`	`isLongClickable()`
`boolean`	`isNestedScrollingEnabled()`
`boolean`	`isOpaque()`
`boolean`	`isPaddingOffsetRequired()`
`boolean`	`isPaddingRelative()`
`boolean`	`isPivotSet()`
`final boolean`	`isPreferKeepClear()`
`boolean`	`isPressed()`
`boolean`	`isSaveEnabled()`
`boolean`	`isSaveFromParentEnabled()`
`boolean`	`isScreenReaderFocusable()`
`boolean`	`isScrollContainer()`
`boolean`	`isScrollbarFadingEnabled()`
`boolean`	`isSelected()`
`final boolean`	`isShowingLayoutBounds()`
`boolean`	`isShown()`
`boolean`	`isSoundEffectsEnabled()`
`final boolean`	`isTemporarilyDetached()`
`boolean`	`isTextAlignmentResolved()`
`boolean`	`isTextDirectionResolved()`
`boolean`	`isVerticalFadingEdgeEnabled()`
`boolean`	`isVerticalScrollBarEnabled()`
`boolean`	`isVisibleToUserForAutofill(int virtualId)`
`View`	`keyboardNavigationClusterSearch(View currentCluster, int direction)`
`final void`	`measure(int widthMeasureSpec, int heightMeasureSpec)`
`static int[]`	`mergeDrawableStates(int[] baseState, int[] additionalState)`
`void`	`offsetLeftAndRight(int offset)`
`void`	`offsetTopAndBottom(int offset)`
`void`	`onAnimationEnd()`
`void`	`onAnimationStart()`
`WindowInsets`	`onApplyWindowInsets(WindowInsets insets)`
`void`	`onCancelPendingInputEvents()`
`boolean`	`onCapturedPointerEvent(MotionEvent event)`
`boolean`	`onCheckIsTextEditor()`
`void`	`onConfigurationChanged(Configuration newConfig)`
`void`	`onCreateContextMenu(ContextMenu menu)`
`InputConnection`	`onCreateInputConnection(EditorInfo outAttrs)`
`void`	`onCreateViewTranslationRequest( int[] supportedFormats, Consumer<ViewTranslationRequest> requestsCollector )`
`void`	`onCreateVirtualViewTranslationRequests( long[] virtualIds, int[] supportedFormats, Consumer<ViewTranslationRequest> requestsCollector )`
`void`	`onDisplayHint(int hint)`
`boolean`	`onDragEvent(DragEvent event)`
`void`	`onDraw(Canvas canvas)`
`void`	`onDrawForeground(Canvas canvas)`
`final void`	`onDrawScrollBars(Canvas canvas)`
`boolean`	`onFilterTouchEventForSecurity(MotionEvent event)`
`void`	`onFinishInflate()`
`void`	`onFinishTemporaryDetach()`
`void`	`onFocusChanged( boolean gainFocus, int direction, Rect previouslyFocusedRect )`
`boolean`	`onGenericMotionEvent(MotionEvent event)`
`void`	`onHoverChanged(boolean hovered)`
`boolean`	`onHoverEvent(MotionEvent event)`
`void`	`onInitializeAccessibilityEvent(AccessibilityEvent event)`
`void`	`onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info)`
`boolean`	`onKeyDown(int keyCode, KeyEvent event)`
`boolean`	`onKeyLongPress(int keyCode, KeyEvent event)`
`boolean`	`onKeyMultiple(int keyCode, int repeatCount, KeyEvent event)`
`boolean`	`onKeyPreIme(int keyCode, KeyEvent event)`
`boolean`	`onKeyShortcut(int keyCode, KeyEvent event)`
`boolean`	`onKeyUp(int keyCode, KeyEvent event)`
`void`	`onOverScrolled( int scrollX, int scrollY, boolean clampedX, boolean clampedY )`
`void`	`onPointerCaptureChange(boolean hasCapture)`
`void`	`onPopulateAccessibilityEvent(AccessibilityEvent event)`
`void`	`onProvideAutofillStructure(ViewStructure structure, int flags)`
`void`	`onProvideAutofillVirtualStructure(ViewStructure structure, int flags)`
`void`	`onProvideContentCaptureStructure(ViewStructure structure, int flags)`
`void`	`onProvideStructure(ViewStructure structure)`
`void`	`onProvideVirtualStructure(ViewStructure structure)`
`ContentInfo`	`onReceiveContent(ContentInfo payload)`
`void`	`onRestoreInstanceState(Parcelable state)`
`void`	`onRtlPropertiesChanged(int layoutDirection)`
`Parcelable`	`onSaveInstanceState()`
`void`	`onScreenStateChanged(int screenState)`
`void`	`onScrollCaptureSearch( Rect localVisibleRect, Point windowOffset, Consumer<ScrollCaptureTarget> targets )`
`void`	`onScrollChanged(int l, int t, int oldl, int oldt)`
`boolean`	`onSetAlpha(int alpha)`
`void`	`onSizeChanged(int w, int h, int oldw, int oldh)`
`void`	`onStartTemporaryDetach()`
`boolean`	`onTrackballEvent(MotionEvent event)`
`void`	`onViewTranslationResponse(ViewTranslationResponse response)`
`void`	`onVirtualViewTranslationResponses( LongSparseArray<ViewTranslationResponse> response )`
`void`	`onVisibilityAggregated(boolean isVisible)`
`void`	`onVisibilityChanged(View changedView, int visibility)`
`void`	`onWindowFocusChanged(boolean hasWindowFocus)`
`void`	`onWindowSystemUiVisibilityChanged(int visible)` This method is deprecated.
`void`	`onWindowVisibilityChanged(int visibility)`
`boolean`	`overScrollBy( int deltaX, int deltaY, int scrollX, int scrollY, int scrollRangeX, int scrollRangeY, int maxOverScrollX, int maxOverScrollY, boolean isTouchEvent )`
`boolean`	`performAccessibilityAction(int action, Bundle arguments)`
`boolean`	`performContextClick(float x, float y)`
`boolean`	`performHapticFeedback(int feedbackConstant)`
`boolean`	`performLongClick()`
`ContentInfo`	`performReceiveContent(ContentInfo payload)`
`void`	`playSoundEffect(int soundConstant)`
`boolean`	`post(Runnable action)`
`boolean`	`postDelayed(Runnable action, long delayMillis)`
`void`	`postInvalidate()`
`void`	`postInvalidateDelayed(long delayMilliseconds)`
`void`	`postInvalidateOnAnimation()`
`void`	`postOnAnimation(Runnable action)`
`void`	`postOnAnimationDelayed(Runnable action, long delayMillis)`
`void`	`refreshDrawableState()`
`void`	`releasePointerCapture()`
`boolean`	`removeCallbacks(Runnable action)`
`void`	`removeOnAttachStateChangeListener( View.OnAttachStateChangeListener listener )`
`void`	`removeOnLayoutChangeListener(View.OnLayoutChangeListener listener)`
`void`	`removeOnUnhandledKeyEventListener( View.OnUnhandledKeyEventListener listener )`
`void`	`requestApplyInsets()`
`void`	`requestFitSystemWindows()` This method is deprecated.
`final boolean`	`requestFocusFromTouch()`
`void`	`requestLayout()`
`void`	`requestPointerCapture()`
`boolean`	`requestRectangleOnScreen(Rect rectangle)`
`final void`	`requestUnbufferedDispatch(MotionEvent event)`
`final T`	`<T extends View> requireViewById(int id)`
`void`	`resetPivot()`
`static int`	`resolveSize(int size, int measureSpec)`
`static int`	`resolveSizeAndState(int size, int measureSpec, int childMeasuredState)`
`void`	`restoreHierarchyState(SparseArray<Parcelable> container)`
`final void`	`saveAttributeDataForStyleable( Context context, int[] styleable, AttributeSet attrs, TypedArray t, int defStyleAttr, int defStyleRes )`
`void`	`saveHierarchyState(SparseArray<Parcelable> container)`
`void`	`scheduleDrawable(Drawable who, Runnable what, long when)`
`void`	`scrollBy(int x, int y)`
`void`	`scrollTo(int x, int y)`
`void`	`sendAccessibilityEvent(int eventType)`
`void`	`sendAccessibilityEventUnchecked(AccessibilityEvent event)`
`void`	`setAccessibilityDataSensitive(int accessibilityDataSensitive)`
`void`	`setAccessibilityDelegate(View.AccessibilityDelegate delegate)`
`void`	`setAccessibilityHeading(boolean isHeading)`
`void`	`setAccessibilityLiveRegion(int mode)`
`void`	`setAccessibilityPaneTitle(CharSequence accessibilityPaneTitle)`
`void`	`setAccessibilityTraversalAfter(int afterId)`
`void`	`setAccessibilityTraversalBefore(int beforeId)`
`void`	`setActivated(boolean activated)`
`void`	`setAllowClickWhenDisabled(boolean clickableWhenDisabled)`
`void`	`setAllowedHandwritingDelegatePackage(String allowedPackageName)`
`void`	`setAllowedHandwritingDelegatorPackage(String allowedPackageName)`
`void`	`setAlpha(float alpha)`
`void`	`setAnimation(Animation animation)`
`void`	`setAnimationMatrix(Matrix matrix)`
`void`	`setAutoHandwritingEnabled(boolean enabled)`
`void`	`setAutofillHints(String[] autofillHints)`
`void`	`setAutofillId(AutofillId id)`
`void`	`setBackground(Drawable background)`
`void`	`setBackgroundColor(int color)`
`void`	`setBackgroundDrawable(Drawable background)` This method is deprecated.
`void`	`setBackgroundResource(int resid)`
`void`	`setBackgroundTintBlendMode(BlendMode blendMode)`
`void`	`setBackgroundTintList(ColorStateList tint)`
`void`	`setBackgroundTintMode(PorterDuff.Mode tintMode)`
`final void`	`setBottom(int bottom)`
`void`	`setCameraDistance(float distance)`
`void`	`setClickable(boolean clickable)`
`void`	`setClipBounds(Rect clipBounds)`
`void`	`setClipToOutline(boolean clipToOutline)`
`void`	`setContentCaptureSession(ContentCaptureSession contentCaptureSession)`
`void`	`setContentDescription(CharSequence contentDescription)`
`final void`	`setContentSensitivity(int mode)`
`void`	`setContextClickable(boolean contextClickable)`
`void`	`setDefaultFocusHighlightEnabled(boolean defaultFocusHighlightEnabled)`
`void`	`setDrawingCacheBackgroundColor(int color)` This method is deprecated.
`void`	`setDrawingCacheEnabled(boolean enabled)` This method is deprecated.
`void`	`setDrawingCacheQuality(int quality)` This method is deprecated.
`void`	`setDuplicateParentStateEnabled(boolean enabled)`
`void`	`setElevation(float elevation)`
`void`	`setEnabled(boolean enabled)`
`void`	`setFadingEdgeLength(int length)`
`void`	`setFilterTouchesWhenObscured(boolean enabled)`
`void`	`setFitsSystemWindows(boolean fitSystemWindows)`
`void`	`setFocusable(boolean focusable)`
`void`	`setFocusableInTouchMode(boolean focusableInTouchMode)`
`void`	`setFocusedByDefault(boolean isFocusedByDefault)`
`void`	`setForceDarkAllowed(boolean allow)`
`void`	`setForeground(Drawable foreground)`
`void`	`setForegroundTintBlendMode(BlendMode blendMode)`
`void`	`setForegroundTintList(ColorStateList tint)`
`void`	`setForegroundTintMode(PorterDuff.Mode tintMode)`
`void`	`setFrameContentVelocity(float pixelsPerSecond)`
`void`	`setHandwritingBoundsOffsets( float offsetLeft, float offsetTop, float offsetRight, float offsetBottom )`
`void`	`setHandwritingDelegateFlags(int flags)`
`void`	`setHandwritingDelegatorCallback(Runnable callback)`
`void`	`setHapticFeedbackEnabled(boolean hapticFeedbackEnabled)`
`void`	`setHasTransientState(boolean hasTransientState)`
`void`	`setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled)`
`void`	`setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled)`
`void`	`setHorizontalScrollbarThumbDrawable(Drawable drawable)`
`void`	`setHorizontalScrollbarTrackDrawable(Drawable drawable)`
`void`	`setHovered(boolean hovered)`
`void`	`setId(int id)`
`void`	`setImportantForAccessibility(int mode)`
`void`	`setImportantForAutofill(int mode)`
`void`	`setImportantForContentCapture(int mode)`
`void`	`setIsCredential(boolean isCredential)`
`void`	`setIsHandwritingDelegate(boolean isHandwritingDelegate)`
`void`	`setKeepScreenOn(boolean keepScreenOn)`
`void`	`setKeyboardNavigationCluster(boolean isCluster)`
`void`	`setLabelFor(int id)`
`void`	`setLayerPaint(Paint paint)`
`void`	`setLayerType(int layerType, Paint paint)`
`void`	`setLayoutDirection(int layoutDirection)`
`void`	`setLayoutParams(ViewGroup.LayoutParams params)`
`final void`	`setLeft(int left)`
`final void`	`setLeftTopRightBottom(int left, int top, int right, int bottom)`
`void`	`setLongClickable(boolean longClickable)`
`final void`	`setMeasuredDimension(int measuredWidth, int measuredHeight)`
`void`	`setMinimumHeight(int minHeight)`
`void`	`setMinimumWidth(int minWidth)`
`void`	`setNestedScrollingEnabled(boolean enabled)`
`void`	`setNextClusterForwardId(int nextClusterForwardId)`
`void`	`setNextFocusDownId(int nextFocusDownId)`
`void`	`setNextFocusForwardId(int nextFocusForwardId)`
`void`	`setNextFocusLeftId(int nextFocusLeftId)`
`void`	`setNextFocusRightId(int nextFocusRightId)`
`void`	`setNextFocusUpId(int nextFocusUpId)`
`void`	`setOnApplyWindowInsetsListener( View.OnApplyWindowInsetsListener listener )`
`void`	`setOnCapturedPointerListener(View.OnCapturedPointerListener l)`
`void`	`setOnClickListener(View.OnClickListener l)`
`void`	`setOnContextClickListener(View.OnContextClickListener l)`
`void`	`setOnCreateContextMenuListener(View.OnCreateContextMenuListener l)`
`void`	`setOnDragListener(View.OnDragListener l)`
`void`	`setOnFocusChangeListener(View.OnFocusChangeListener l)`
`void`	`setOnGenericMotionListener(View.OnGenericMotionListener l)`
`void`	`setOnHoverListener(View.OnHoverListener l)`
`void`	`setOnKeyListener(View.OnKeyListener l)`
`void`	`setOnLongClickListener(View.OnLongClickListener l)`
`void`	`setOnReceiveContentListener( String[] mimeTypes, OnReceiveContentListener listener )`
`void`	`setOnScrollChangeListener(View.OnScrollChangeListener l)`
`void`	`setOnSystemUiVisibilityChangeListener( View.OnSystemUiVisibilityChangeListener l )` This method is deprecated.
`void`	`setOnTouchListener(View.OnTouchListener l)`
`void`	`setOutlineAmbientShadowColor(int color)`
`void`	`setOutlineProvider(ViewOutlineProvider provider)`
`void`	`setOutlineSpotShadowColor(int color)`
`void`	`setOverScrollMode(int overScrollMode)`
`void`	`setPadding(int left, int top, int right, int bottom)`
`void`	`setPaddingRelative(int start, int top, int end, int bottom)`
`void`	`setPendingCredentialRequest( GetCredentialRequest request, OutcomeReceiver<GetCredentialResponse, GetCredentialException> callback )`
`void`	`setPivotX(float pivotX)`
`void`	`setPivotY(float pivotY)`
`void`	`setPointerIcon(PointerIcon pointerIcon)`
`final void`	`setPreferKeepClear(boolean preferKeepClear)`
`final void`	`setPreferKeepClearRects(List<Rect> rects)`
`void`	`setPressed(boolean pressed)`
`void`	`setRenderEffect(RenderEffect renderEffect)`
`void`	`setRequestedFrameRate(float frameRate)`
`final void`	`setRevealOnFocusHint(boolean revealOnFocus)`
`final void`	`setRight(int right)`
`void`	`setRotation(float rotation)`
`void`	`setRotationX(float rotationX)`
`void`	`setRotationY(float rotationY)`
`void`	`setSaveEnabled(boolean enabled)`
`void`	`setSaveFromParentEnabled(boolean enabled)`
`void`	`setScaleX(float scaleX)`
`void`	`setScaleY(float scaleY)`
`void`	`setScreenReaderFocusable(boolean screenReaderFocusable)`
`void`	`setScrollBarDefaultDelayBeforeFade( int scrollBarDefaultDelayBeforeFade )`
`void`	`setScrollBarFadeDuration(int scrollBarFadeDuration)`
`void`	`setScrollBarSize(int scrollBarSize)`
`void`	`setScrollBarStyle(int style)`
`final void`	`setScrollCaptureCallback(ScrollCaptureCallback callback)`
`void`	`setScrollCaptureHint(int hint)`
`void`	`setScrollContainer(boolean isScrollContainer)`
`void`	`setScrollIndicators(int indicators)`
`void`	`setScrollX(int value)`
`void`	`setScrollY(int value)`
`void`	`setScrollbarFadingEnabled(boolean fadeScrollbars)`
`void`	`setSelected(boolean selected)`
`void`	`setSoundEffectsEnabled(boolean soundEffectsEnabled)`
`void`	`setStateDescription(CharSequence stateDescription)`
`void`	`setStateListAnimator(StateListAnimator stateListAnimator)`
`void`	`setSystemGestureExclusionRects(List<Rect> rects)`
`void`	`setSystemUiVisibility(int visibility)` This method is deprecated.
`void`	`setTag(Object tag)`
`void`	`setTextAlignment(int textAlignment)`
`void`	`setTextDirection(int textDirection)`
`void`	`setTooltipText(CharSequence tooltipText)`
`final void`	`setTop(int top)`
`void`	`setTouchDelegate(TouchDelegate delegate)`
`void`	`setTransitionAlpha(float alpha)`
`final void`	`setTransitionName(String transitionName)`
`void`	`setTransitionVisibility(int visibility)`
`void`	`setTranslationX(float translationX)`
`void`	`setTranslationY(float translationY)`
`void`	`setTranslationZ(float translationZ)`
`void`	`setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled)`
`void`	`setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled)`
`void`	`setVerticalScrollbarPosition(int position)`
`void`	`setVerticalScrollbarThumbDrawable(Drawable drawable)`
`void`	`setVerticalScrollbarTrackDrawable(Drawable drawable)`
`void`	`setViewTranslationCallback(ViewTranslationCallback callback)`
`void`	`setVisibility(int visibility)`
`void`	`setWillNotCacheDrawing(boolean willNotCacheDrawing)` This method is deprecated.
`void`	`setWillNotDraw(boolean willNotDraw)`
`void`	`setX(float x)`
`void`	`setY(float y)`
`void`	`setZ(float z)`
`boolean`	`showContextMenu()`
`ActionMode`	`startActionMode(ActionMode.Callback callback)`
`void`	`startAnimation(Animation animation)`
`final boolean`	`startDrag( ClipData data, View.DragShadowBuilder shadowBuilder, Object myLocalState, int flags )` This method is deprecated.
`final boolean`	`startDragAndDrop( ClipData data, View.DragShadowBuilder shadowBuilder, Object myLocalState, int flags )`
`boolean`	`startNestedScroll(int axes)`
`void`	`stopNestedScroll()`
`String`	`toString()`
`void`	`transformMatrixToGlobal(Matrix matrix)`
`void`	`transformMatrixToLocal(Matrix matrix)`
`void`	`unscheduleDrawable(Drawable who, Runnable what)`
`final void`	`updateDragShadow(View.DragShadowBuilder shadowBuilder)`
`boolean`	`verifyDrawable(Drawable who)`
`boolean`	`willNotCacheDrawing()` This method is deprecated.
`boolean`	`willNotDraw()`

From android.view.ViewGroup

`void`	`addChildrenForAccessibility(ArrayList<View> outChildren)`
`void`	`addExtraDataToAccessibilityNodeInfo( AccessibilityNodeInfo info, String extraDataKey, Bundle arguments )`
`void`	`addFocusables(ArrayList<View> views, int direction, int focusableMode)`
`void`	`addKeyboardNavigationClusters(Collection<View> views, int direction)`
`boolean`	`addStatesFromChildren()`
`void`	`addTouchables(ArrayList<View> views)`
`void`	`addView(View child)`
`boolean`	`addViewInLayout(View child, int index, ViewGroup.LayoutParams params)`
`void`	`attachLayoutAnimationParameters( View child, ViewGroup.LayoutParams params, int index, int count )`
`void`	`attachViewToParent(View child, int index, ViewGroup.LayoutParams params)`
`void`	`bringChildToFront(View child)`
`boolean`	`canAnimate()`
`void`	`childDrawableStateChanged(View child)`
`void`	`childHasTransientStateChanged( View child, boolean childHasTransientState )`
`void`	`cleanupLayoutState(View child)`
`void`	`clearChildFocus(View child)`
`void`	`clearDisappearingChildren()`
`void`	`clearFocus()`
`void`	`debug(int depth)`
`void`	`detachAllViewsFromParent()`
`void`	`detachViewFromParent(View child)`
`void`	`detachViewsFromParent(int start, int count)`
`WindowInsets`	`dispatchApplyWindowInsets(WindowInsets insets)`
`boolean`	`dispatchCapturedPointerEvent(MotionEvent event)`
`void`	`dispatchConfigurationChanged(Configuration newConfig)`
`void`	`dispatchCreateViewTranslationRequest( Map<AutofillId, long[]> viewIds, int[] supportedFormats, TranslationCapability capability, List<ViewTranslationRequest> requests )`
`void`	`dispatchDisplayHint(int hint)`
`boolean`	`dispatchDragEvent(DragEvent event)`
`void`	`dispatchDraw(Canvas canvas)`
`void`	`dispatchDrawableHotspotChanged(float x, float y)`
`void`	`dispatchFinishTemporaryDetach()`
`void`	`dispatchFreezeSelfOnly(SparseArray<Parcelable> container)`
`boolean`	`dispatchGenericFocusedEvent(MotionEvent event)`
`boolean`	`dispatchGenericPointerEvent(MotionEvent event)`
`boolean`	`dispatchHoverEvent(MotionEvent event)`
`boolean`	`dispatchKeyEvent(KeyEvent event)`
`boolean`	`dispatchKeyEventPreIme(KeyEvent event)`
`boolean`	`dispatchKeyShortcutEvent(KeyEvent event)`
`void`	`dispatchPointerCaptureChanged(boolean hasCapture)`
`void`	`dispatchProvideAutofillStructure(ViewStructure structure, int flags)`
`void`	`dispatchProvideStructure(ViewStructure structure)`
`void`	`dispatchRestoreInstanceState(SparseArray<Parcelable> container)`
`void`	`dispatchSaveInstanceState(SparseArray<Parcelable> container)`
`void`	`dispatchScrollCaptureSearch( Rect localVisibleRect, Point windowOffset, Consumer<ScrollCaptureTarget> targets )`
`void`	`dispatchSetActivated(boolean activated)`
`void`	`dispatchSetPressed(boolean pressed)`
`void`	`dispatchSetSelected(boolean selected)`
`void`	`dispatchStartTemporaryDetach()`
`void`	`dispatchSystemUiVisibilityChanged(int visible)` This method is deprecated.
`void`	`dispatchThawSelfOnly(SparseArray<Parcelable> container)`
`boolean`	`dispatchTouchEvent(MotionEvent ev)`
`boolean`	`dispatchTrackballEvent(MotionEvent event)`
`boolean`	`dispatchUnhandledMove(View focused, int direction)`
`void`	`dispatchVisibilityChanged(View changedView, int visibility)`
`void`	`dispatchWindowFocusChanged(boolean hasFocus)`
`void`	`dispatchWindowInsetsAnimationEnd(WindowInsetsAnimation animation)`
`void`	`dispatchWindowInsetsAnimationPrepare(WindowInsetsAnimation animation)`
`WindowInsets`	`dispatchWindowInsetsAnimationProgress( WindowInsets insets, List<WindowInsetsAnimation> runningAnimations )`
`WindowInsetsAnimation.Bounds`	`dispatchWindowInsetsAnimationStart( WindowInsetsAnimation animation, WindowInsetsAnimation.Bounds bounds )`
`void`	`dispatchWindowSystemUiVisiblityChanged(int visible)` This method is deprecated.
`void`	`dispatchWindowVisibilityChanged(int visibility)`
`boolean`	`drawChild(Canvas canvas, View child, long drawingTime)`
`void`	`drawableStateChanged()`
`void`	`endViewTransition(View view)`
`View`	`findFocus()`
`OnBackInvokedDispatcher`	`findOnBackInvokedDispatcherForChild(View child, View requester)`
`void`	`findViewsWithText( ArrayList<View> outViews, CharSequence text, int flags )`
`View`	`focusSearch(View focused, int direction)`
`void`	`focusableViewAvailable(View v)`
`boolean`	`gatherTransparentRegion(Region region)`
`View`	`getChildAt(int index)`
`int`	`getChildCount()`
`int`	`getChildDrawingOrder(int childCount, int drawingPosition)`
`static int`	`getChildMeasureSpec(int spec, int padding, int childDimension)`
`boolean`	`getChildStaticTransformation(View child, Transformation t)`
`boolean`	`getChildVisibleRect(View child, Rect r, Point offset)`
`boolean`	`getClipChildren()`
`boolean`	`getClipToPadding()`
`int`	`getDescendantFocusability()`
`View`	`getFocusedChild()`
`LayoutAnimationController`	`getLayoutAnimation()`
`Animation.AnimationListener`	`getLayoutAnimationListener()`
`int`	`getLayoutMode()`
`LayoutTransition`	`getLayoutTransition()`
`int`	`getNestedScrollAxes()`
`ViewGroupOverlay`	`getOverlay()`
`int`	`getPersistentDrawingCache()` This method is deprecated.
`boolean`	`getTouchscreenBlocksFocus()`
`boolean`	`hasFocus()`
`boolean`	`hasTransientState()`
`int`	`indexOfChild(View child)`
`final void`	`invalidateChild(View child, Rect dirty)` This method is deprecated.
`ViewParent`	`invalidateChildInParent(int[] location, Rect dirty)` This method is deprecated.
`boolean`	`isAlwaysDrawnWithCacheEnabled()` This method is deprecated.
`boolean`	`isAnimationCacheEnabled()` This method is deprecated.
`boolean`	`isChildrenDrawingOrderEnabled()`
`boolean`	`isChildrenDrawnWithCacheEnabled()` This method is deprecated.
`boolean`	`isLayoutSuppressed()`
`boolean`	`isMotionEventSplittingEnabled()`
`boolean`	`isTransitionGroup()`
`void`	`jumpDrawablesToCurrentState()`
`final void`	`layout(int l, int t, int r, int b)`
`void`	`measureChild( View child, int parentWidthMeasureSpec, int parentHeightMeasureSpec )`
`void`	`measureChildWithMargins( View child, int parentWidthMeasureSpec, int widthUsed, int parentHeightMeasureSpec, int heightUsed )`
`void`	`measureChildren(int widthMeasureSpec, int heightMeasureSpec)`
`void`	`notifySubtreeAccessibilityStateChanged( View child, View source, int changeType )`
`final void`	`offsetDescendantRectToMyCoords(View descendant, Rect rect)`
`final void`	`offsetRectIntoDescendantCoords(View descendant, Rect rect)`
`int[]`	`onCreateDrawableState(int extraSpace)`
`void`	`onDescendantInvalidated(View child, View target)`
`boolean`	`onInterceptHoverEvent(MotionEvent event)`
`boolean`	`onInterceptTouchEvent(MotionEvent ev)`
`boolean`	`onNestedFling( View target, float velocityX, float velocityY, boolean consumed )`
`boolean`	`onNestedPreFling(View target, float velocityX, float velocityY)`
`boolean`	`onNestedPrePerformAccessibilityAction( View target, int action, Bundle args )`
`void`	`onNestedPreScroll(View target, int dx, int dy, int[] consumed)`
`void`	`onNestedScroll( View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed )`
`void`	`onNestedScrollAccepted(View child, View target, int axes)`
`boolean`	`onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect)`
`boolean`	`onRequestSendAccessibilityEvent(View child, AccessibilityEvent event)`
`PointerIcon`	`onResolvePointerIcon(MotionEvent event, int pointerIndex)`
`boolean`	`onStartNestedScroll(View child, View target, int nestedScrollAxes)`
`void`	`onStopNestedScroll(View child)`
`void`	`onViewAdded(View child)`
`void`	`onViewRemoved(View child)`
`void`	`recomputeViewAttributes(View child)`
`void`	`removeAllViews()`
`void`	`removeAllViewsInLayout()`
`void`	`removeDetachedView(View child, boolean animate)`
`void`	`removeView(View view)`
`void`	`removeViewAt(int index)`
`void`	`removeViewInLayout(View view)`
`void`	`removeViews(int start, int count)`
`void`	`removeViewsInLayout(int start, int count)`
`void`	`requestChildFocus(View child, View focused)`
`boolean`	`requestChildRectangleOnScreen( View child, Rect rectangle, boolean immediate )`
`void`	`requestDisallowInterceptTouchEvent(boolean disallowIntercept)`
`boolean`	`requestFocus(int direction, Rect previouslyFocusedRect)`
`boolean`	`requestSendAccessibilityEvent(View child, AccessibilityEvent event)`
`void`	`requestTransparentRegion(View child)`
`boolean`	`restoreDefaultFocus()`
`void`	`scheduleLayoutAnimation()`
`void`	`setAddStatesFromChildren(boolean addsStates)`
`void`	`setAlwaysDrawnWithCacheEnabled(boolean always)` This method is deprecated.
`void`	`setAnimationCacheEnabled(boolean enabled)` This method is deprecated.
`void`	`setChildrenDrawingCacheEnabled(boolean enabled)` This method is deprecated.
`void`	`setChildrenDrawingOrderEnabled(boolean enabled)`
`void`	`setChildrenDrawnWithCacheEnabled(boolean enabled)` This method is deprecated.
`void`	`setClipChildren(boolean clipChildren)`
`void`	`setClipToPadding(boolean clipToPadding)`
`void`	`setDescendantFocusability(int focusability)`
`void`	`setLayoutAnimation(LayoutAnimationController controller)`
`void`	`setLayoutAnimationListener( Animation.AnimationListener animationListener )`
`void`	`setLayoutMode(int layoutMode)`
`void`	`setLayoutTransition(LayoutTransition transition)`
`void`	`setMotionEventSplittingEnabled(boolean split)`
`void`	`setOnHierarchyChangeListener( ViewGroup.OnHierarchyChangeListener listener )`
`void`	`setPersistentDrawingCache(int drawingCacheToKeep)` This method is deprecated.
`void`	`setStaticTransformationsEnabled(boolean enabled)`
`void`	`setTouchscreenBlocksFocus(boolean touchscreenBlocksFocus)`
`void`	`setTransitionGroup(boolean isTransitionGroup)`
`void`	`setWindowInsetsAnimationCallback( WindowInsetsAnimation.Callback callback )`
`boolean`	`showContextMenuForChild(View originalView)`
`ActionMode`	`startActionModeForChild( View originalView, ActionMode.Callback callback )`
`void`	`startLayoutAnimation()`
`void`	`startViewTransition(View view)`
`void`	`suppressLayout(boolean suppress)`
`void`	`updateViewLayout(View view, ViewGroup.LayoutParams params)`

Public constructors

PreviewView

Added in 1.1.0

@UiThread
public PreviewView(@NonNull Context context)

PreviewView

Added in 1.1.0

@UiThread
public PreviewView(@NonNull Context context, @Nullable AttributeSet attrs)

PreviewView

Added in 1.1.0

@UiThread
public PreviewView(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr
)

PreviewView

Added in 1.1.0

@UiThread
public PreviewView(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr,
    int defStyleRes
)

Public methods

getBitmap

Added in 1.1.0

@UiThread
public @Nullable Bitmap getBitmap()

Returns a Bitmap representation of the content displayed on the PreviewView, or null if the camera preview hasn't started yet.

The returned Bitmap uses the ARGB_8888 pixel format and its dimensions are the same as this view's.

Do not invoke this method from a drawing method (onDraw for instance).

If an error occurs during the copy, an empty Bitmap will be returned.

If the preview hasn't started yet, the method may return null or an empty Bitmap. Use getPreviewStreamState to get the StreamState and wait for STREAMING to make sure the preview is started.

Returns
`@Nullable Bitmap`	A `ARGB_8888Bitmap` representing the content displayed on the `PreviewView`, or null if the camera preview hasn't started yet.

getController

Added in 1.1.0

@UiThread
public @Nullable CameraController getController()

Get the CameraController.

getImplementationMode

Added in 1.1.0

@UiThread
public @NonNull PreviewView.ImplementationMode getImplementationMode()

Returns the ImplementationMode.

If nothing is set via setImplementationMode, the default value is PERFORMANCE.

Returns
`@NonNull PreviewView.ImplementationMode`	The `ImplementationMode` for `PreviewView`.

getMeteringPointFactory

Added in 1.1.0

@UiThread
public @NonNull MeteringPointFactory getMeteringPointFactory()

Gets the MeteringPointFactory for the camera currently connected to the PreviewView, if any.

The returned MeteringPointFactory is capable of creating MeteringPoints from (x, y) coordinates in the PreviewView. This conversion takes into account its ScaleType. The MeteringPointFactory is automatically adjusted if the PreviewView layout or the ScaleType changes.

The MeteringPointFactory returns invalid MeteringPoint if the preview is not ready, or the PreviewView dimension is zero. The invalid MeteringPoint will cause startFocusAndMetering to fail but it won't crash the application. Wait for the STREAMING state to make sure the preview is ready.

Returns
`@NonNull MeteringPointFactory`	a `MeteringPointFactory`

See also
`getPreviewStreamState`

getOutputTransform

Added in 1.1.0

public @Nullable OutputTransform getOutputTransform()

Gets the OutputTransform associated with the PreviewView.

Returns a OutputTransform object that represents the transform being applied to the associated Preview use case. Returns null if the transform info is not ready. For example, when the associated Preview has not been bound or the PreviewView's layout is not ready.

PreviewView needs to be in COMPATIBLE mode for the transform to work correctly. For example, the returned OutputTransform may not respect the value of getMatrix when PERFORMANCE mode is used.

Returns
`@Nullable OutputTransform`	the transform applied on the preview by this `PreviewView`.

See also
`CoordinateTransform`

getPreviewStreamState

Added in 1.1.0

public @NonNull LiveData<PreviewView.StreamState> getPreviewStreamState()

Gets a LiveData for the preview StreamState.

There are two preview stream states, IDLE and STREAMING. IDLE indicates the preview is currently not visible and streaming is stopped. STREAMING means the preview is streaming or is about to start streaming. This state guarantees the preview is visible only when the ImplementationMode is COMPATIBLE. When in PERFORMANCE mode, it is possible the preview becomes visible slightly after the state changes to STREAMING.

Apps that require a precise signal for when the preview starts should set the implementation mode to COMPATIBLE.

Returns
`@NonNull LiveData<PreviewView.StreamState>`	A `LiveData` of the preview's `StreamState`. Apps can get the current state with `getValue`, or register an observer with `observe` .

getScaleType

Added in 1.1.0

@UiThread
public @NonNull PreviewView.ScaleType getScaleType()

Returns the ScaleType currently applied to the preview.

The default value is FILL_CENTER.

Returns
`@NonNull PreviewView.ScaleType`	The `ScaleType` currently applied to the preview.

getScreenFlash

Added in 1.4.0

@UiThread
public @Nullable ImageCapture.ScreenFlash getScreenFlash()

Returns an ImageCapture.ScreenFlash implementation based on the Window instance set via setScreenFlashWindow.

This API uses an internally managed ScreenFlashView to provide the ImageCapture.ScreenFlash implementation which can be passed to the setScreenFlash API. The following example shows the API usage.

mPreviewView.setScreenFlashWindow(activity.getWindow());
mImageCapture.setScreenFlash(mPreviewView.getScreenFlash());
mImageCapture.setFlashMode(ImageCapture.FLASH_MODE_SCREEN);
mImageCapture.takePhoto(mCameraExecutor, mOnImageSavedCallback);

Returns
`@Nullable ImageCapture.ScreenFlash`	An `ImageCapture.ScreenFlash` implementation provided by `getScreenFlash` which can be null if a non-null `Window` instance hasn't been set.

See also
`getScreenFlash`
`FLASH_MODE_SCREEN`

getSensorToViewTransform

Added in 1.4.0

@UiThread
public @Nullable Matrix getSensorToViewTransform()

Gets the transformation matrix from camera sensor to PreviewView.

The value is a mapping from sensor coordinates to PreviewView coordinates, which is, from the rect of SENSOR_INFO_ACTIVE_ARRAY_SIZE to the rect defined by (0, 0, PreviewView#getWidth(), PreviewView#getHeight()). The app can use the matrix to map the coordinates from one UseCase to another. For example, detecting face with ImageAnalysis, and then highlighting the face in PreviewView.

This method returns null if the transformation is not ready. It happens when PreviewView layout has not been measured, or the associated Preview use case is not yet bound to a camera. For the former case, the app can listen to the layout change via e.g. addOnLayoutChangeListener. For the latter case, the app wait until the Preview or CameraController is bound and the LifecycleOwner is in the STARTED state. The app should call this method to get the latest value before performing coordinates transformation.

The return value does not include the custom transform applied by the app via methods like setScaleX.

See also
`getSensorToBufferTransform`
`getSensorToBufferTransformMatrix`

getSurfaceProvider

Added in 1.1.0

@UiThread
public @NonNull Preview.SurfaceProvider getSurfaceProvider()

Gets a Preview.SurfaceProvider to be used with setSurfaceProvider. This allows the camera feed to start when the Preview use case is bound to a lifecycle.

The returned Preview.SurfaceProvider will provide a preview Surface to the camera that's either managed by a TextureView or SurfaceView depending on the ImplementationMode and the device's attributes (e.g. API level, camera hardware support level).

Returns
`@NonNull Preview.SurfaceProvider`	A `Preview.SurfaceProvider` to attach to a `Preview` use case.

See also
`PreviewView.ImplementationMode`

getViewPort

Added in 1.1.0

@UiThread
public @Nullable ViewPort getViewPort()

Gets a ViewPort based on the current status of PreviewView.

Returns a ViewPort instance based on the PreviewView's current width, height, layout direction, scale type and display rotation. By using the ViewPort, all the UseCases in the UseCaseGroup will have the same output image that also matches the aspect ratio of the PreviewView.

Returns
`@Nullable ViewPort`	null if the view is not currently attached or the view's width/height is zero.

See also
`ViewPort`
`UseCaseGroup`

getViewPort

Added in 1.1.0

@UiThread
public @Nullable ViewPort getViewPort(int targetRotation)

Gets a ViewPort with custom target rotation.

Returns a ViewPort instance based on the PreviewView's current width, height, layout direction, scale type and the given target rotation.

Use this method if Preview's desired rotation is not the default display rotation. For example, when remote display is in use and the desired rotation for the remote display is based on the accelerometer reading. In that case, use android.view.OrientationEventListener to obtain the target rotation and create ViewPort as following:

ORIENTATION_UNKNOWN: orientation == -1

ROTATION_0: orientation >= 315 || orientation <45

ROTATION_90: orientation >= 225 &&orientation <315

ROTATION_180: orientation >= 135 &&orientation <225

ROTATION_270: orientation >= 45 &&orientation <135

Once the target rotation is obtained, use it with setTargetRotation to update the rotation. Example:

Preview preview = new Preview.Builder().setTargetRotation(targetRotation).build();
ViewPort viewPort = previewView.getViewPort(targetRotation);
UseCaseGroup useCaseGroup =
    new UseCaseGroup.Builder().setViewPort(viewPort).addUseCase(preview).build();
cameraProvider.bindToLifecycle(lifecycleOwner, cameraSelector, useCaseGroup);

Note that for non-display rotation to work, the mode must be set to COMPATIBLE.

Parameters
`int targetRotation`	A rotation value, expressed as one of `ROTATION_0`, `ROTATION_90`, `ROTATION_180`, or `ROTATION_270`.

Returns
`@Nullable ViewPort`	null if the view's width/height is zero.

See also
`PreviewView.ImplementationMode`

onTouchEvent

public boolean onTouchEvent(@NonNull MotionEvent event)

performClick

public boolean performClick()

setController

Added in 1.1.0

@UiThread
public void setController(@Nullable CameraController cameraController)

Sets the CameraController.

Once set, the controller will use PreviewView to display camera preview feed. It also uses the PreviewView's layout dimension to set the crop rect for all the use cases so that the output from other use cases match what the end user sees in PreviewView. It also enables features like tap-to-focus and pinch-to-zoom.

Setting it to null or to a different CameraController stops the previous CameraController from working. The previous CameraController will remain detached until it's set on the PreviewView again.

Throws
`java.lang.IllegalArgumentException`	If the `CameraController`'s camera selector is unable to resolve a camera to be used for the enabled use cases.

See also
`CameraController`

setImplementationMode

Added in 1.1.0

@UiThread
public void setImplementationMode(
    @NonNull PreviewView.ImplementationMode implementationMode
)

Sets the ImplementationMode for the PreviewView.

PreviewView displays the preview with a TextureView when the mode is COMPATIBLE, and tries to use a SurfaceView if it is PERFORMANCE when possible, which depends on the device's attributes (e.g. API level, camera hardware support level). If not set, the default mode is PERFORMANCE.

This method needs to be called before the Preview.SurfaceProvider is set on Preview. Once changed, Preview.SurfaceProvider needs to be set again. e.g. preview.setSurfaceProvider(previewView.getSurfaceProvider()).

setScaleType

Added in 1.1.0

@UiThread
public void setScaleType(@NonNull PreviewView.ScaleType scaleType)

Applies a ScaleType to the preview.

If a CameraController is attached to PreviewView, the change will take immediate effect. It also takes immediate effect if getViewPort is not set in the bound UseCaseGroup. Otherwise, the UseCases need to be bound again with the latest value of getViewPort.

This value can also be set in the layout XML file via the app:scaleType attribute.

The default value is FILL_CENTER.

name app:scaleType

Parameters
`@NonNull PreviewView.ScaleType scaleType`	A `ScaleType` to apply to the preview.

setScreenFlashOverlayColor

Added in 1.4.0

public void setScreenFlashOverlayColor(@ColorInt int color)

Sets the color of the top overlay view during screen flash.

Parameters
`@ColorInt int color`	The color value of the top overlay.

See also
`getScreenFlash`
`FLASH_MODE_SCREEN`

setScreenFlashWindow

Added in 1.4.0

@UiThread
public void setScreenFlashWindow(@Nullable Window screenFlashWindow)

Sets a Window instance for subsequent photo capture requests with FLASH_MODE_SCREEN set.

The calling of this API will take effect for FLASH_MODE_SCREEN only and the Window will be ignored for other flash modes. During screen flash photo capture, the window is used for the purpose of changing brightness.

If the implementation provided by the user is no longer valid (e.g. due to any android.app.Activity or android.view.View reference used in the implementation becoming invalid), user needs to re-set a new valid window or clear the previous one with setScreenFlashWindow(null), whichever appropriate.

For most app scenarios, a Window instance can be obtained from getWindow. In case of a fragment, getActivity can first be used to get the activity instance.

Parameters
`@Nullable Window screenFlashWindow`	A `Window` instance that is used to change the brightness during screen flash photo capture.

Protected methods

onAttachedToWindow

protected void onAttachedToWindow()

onDetachedFromWindow

protected void onDetachedFromWindow()

PreviewView

Summary

Nested types

Public constructors

Public methods

Protected methods

Inherited Constants

Inherited methods

Public constructors

PreviewView

PreviewView

PreviewView

PreviewView

Public methods

getBitmap

getController

getImplementationMode

getMeteringPointFactory

getOutputTransform

getPreviewStreamState

getScaleType

getScreenFlash

getSensorToViewTransform

getSurfaceProvider

getViewPort

getViewPort

onTouchEvent

performClick

setController

setImplementationMode

setScaleType

setScreenFlashOverlayColor

setScreenFlashWindow

Protected methods

onAttachedToWindow

onDetachedFromWindow