PreviewView

Added in 1.1.0

Kotlin |Java

class PreviewView : FrameLayout

kotlin.Any
↳	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

Summary

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

Public constructors
`@UiThread PreviewView(context: Context)`
`@UiThread PreviewView(context: Context, attrs: AttributeSet?)`
`@UiThread PreviewView(context: Context, attrs: AttributeSet?, defStyleAttr: Int)`
`@UiThread PreviewView( context: Context, attrs: AttributeSet?, defStyleAttr: Int, defStyleRes: Int )`

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

Protected functions
`Unit`	`onAttachedToWindow()`
`Unit`	`onDetachedFromWindow()`

Inherited Constants

From android.view.View

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

From android.view.ViewGroup

`const Int`	`CLIP_TO_PADDING_MASK = 34`
`const Int`	`FOCUS_AFTER_DESCENDANTS = 262144`
`const Int`	`FOCUS_BEFORE_DESCENDANTS = 131072`
`const Int`	`FOCUS_BLOCK_DESCENDANTS = 393216`
`const Int`	`LAYOUT_MODE_CLIP_BOUNDS = 0`
`const Int`	`LAYOUT_MODE_OPTICAL_BOUNDS = 1`
`const Int`	`PERSISTENT_ALL_CACHES = 3` This property is deprecated.
`const Int`	`PERSISTENT_ANIMATION_CACHE = 1` This property is deprecated.
`const Int`	`PERSISTENT_NO_CACHE = 0` This property is deprecated.
`const Int`	`PERSISTENT_SCROLLING_CACHE = 2` This property is deprecated.

Inherited functions

From android.widget.FrameLayout

`Boolean`	`checkLayoutParams(p: ViewGroup.LayoutParams!)`
`FrameLayout.LayoutParams!`	`generateDefaultLayoutParams()`
`FrameLayout.LayoutParams!`	`generateLayoutParams(attrs: AttributeSet!)`
`CharSequence!`	`getAccessibilityClassName()`
`Boolean`	`getConsiderGoneChildrenWhenMeasuring()` This function is deprecated.
`Boolean`	`getMeasureAllChildren()`
`Unit`	`onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int)`
`Unit`	`setForegroundGravity(foregroundGravity: Int)`
`Unit`	`setMeasureAllChildren(measureAll: Boolean)`
`Boolean`	`shouldDelayChildPressedState()`

From android.view.View

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

From android.view.ViewGroup

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

Public constructors

PreviewView

Added in 1.1.0

@UiThread
PreviewView(context: Context)

PreviewView

Added in 1.1.0

@UiThread
PreviewView(context: Context, attrs: AttributeSet?)

PreviewView

Added in 1.1.0

@UiThread
PreviewView(context: Context, attrs: AttributeSet?, defStyleAttr: Int)

PreviewView

Added in 1.1.0

@UiThread
PreviewView(
    context: Context,
    attrs: AttributeSet?,
    defStyleAttr: Int,
    defStyleRes: Int
)

Public functions

getBitmap

Added in 1.1.0

@UiThread
fun getBitmap(): Bitmap?

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
`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
fun getController(): CameraController?

Get the CameraController.

getImplementationMode

Added in 1.1.0

@UiThread
fun getImplementationMode(): PreviewView.ImplementationMode

Returns the ImplementationMode.

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

Returns
`PreviewView.ImplementationMode`	The `ImplementationMode` for `PreviewView`.

getMeteringPointFactory

Added in 1.1.0

@UiThread
fun getMeteringPointFactory(): MeteringPointFactory

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
`MeteringPointFactory`	a `MeteringPointFactory`

See also
`getPreviewStreamState`

getOutputTransform

Added in 1.1.0

fun getOutputTransform(): OutputTransform?

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
`OutputTransform?`	the transform applied on the preview by this `PreviewView`.

See also
`CoordinateTransform`

getPreviewStreamState

Added in 1.1.0

fun getPreviewStreamState(): LiveData<PreviewView.StreamState!>

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
`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
fun getScaleType(): PreviewView.ScaleType

Returns the ScaleType currently applied to the preview.

The default value is FILL_CENTER.

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

getScreenFlash

Added in 1.4.0

@ExperimentalPreviewViewScreenFlash
@UiThread
fun getScreenFlash(): ImageCapture.ScreenFlash?

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
`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
fun getSensorToViewTransform(): Matrix?

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
fun getSurfaceProvider(): Preview.SurfaceProvider

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
`Preview.SurfaceProvider`	A `Preview.SurfaceProvider` to attach to a `Preview` use case.

See also
`PreviewView.ImplementationMode`

getViewPort

Added in 1.1.0

@UiThread
fun getViewPort(): ViewPort?

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
`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
fun getViewPort(targetRotation: Int): ViewPort?

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
`targetRotation: Int`	A rotation value, expressed as one of `ROTATION_0`, `ROTATION_90`, `ROTATION_180`, or `ROTATION_270`.

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

See also
`PreviewView.ImplementationMode`

onTouchEvent

fun onTouchEvent(event: MotionEvent): Boolean

performClick

fun performClick(): Boolean

setController

Added in 1.1.0

@UiThread
fun setController(cameraController: CameraController?): Unit

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
fun setImplementationMode(
    implementationMode: PreviewView.ImplementationMode
): Unit

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
fun setScaleType(scaleType: PreviewView.ScaleType): Unit

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
`scaleType: PreviewView.ScaleType`	A `ScaleType` to apply to the preview.

setScreenFlashOverlayColor

Added in 1.4.0

@ExperimentalPreviewViewScreenFlash
fun setScreenFlashOverlayColor(color: @ColorInt Int): Unit

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

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

See also
`getScreenFlash`
`FLASH_MODE_SCREEN`

setScreenFlashWindow

Added in 1.4.0

@UiThread
fun setScreenFlashWindow(screenFlashWindow: Window?): Unit

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
`screenFlashWindow: Window?`	A `Window` instance that is used to change the brightness during screen flash photo capture.

Protected functions

onAttachedToWindow

protected fun onAttachedToWindow(): Unit

onDetachedFromWindow

protected fun onDetachedFromWindow(): Unit

PreviewView

Summary

Nested types

Public constructors

Public functions

Protected functions

Inherited Constants

Inherited functions

Public constructors

PreviewView

PreviewView

PreviewView

PreviewView

Public functions

getBitmap

getController

getImplementationMode

getMeteringPointFactory

getOutputTransform

getPreviewStreamState

getScaleType

getScreenFlash

getSensorToViewTransform

getSurfaceProvider

getViewPort

getViewPort

onTouchEvent

performClick

setController

setImplementationMode

setScaleType

setScreenFlashOverlayColor

setScreenFlashWindow

Protected functions

onAttachedToWindow

onDetachedFromWindow