Rive Android/app.rive.runtime.kotlin/RiveAnimationView

RiveAnimationView

open class RiveAnimationView(context: Context, attrs: AttributeSet? = null) : RiveTextureView, Observable<RiveFileController.Listener>

This view aims to provide the most straightforward way to get Rive graphics into your application.

Simply add the view to your activity and you are good to go!

Very simple animations can be configured completely from a layout file. We also expose a thin API layer to allow more control over how animations are played.

All of this is built upon the C++ wrappers under the app.rive.runtime.kotlin.core namespace which can be used directly for the most flexibility.

Constructors

RiveAnimationView

constructor(context: Context, attrs: AttributeSet? = null)

constructor(builder: RiveAnimationView.Builder)

Types

Builder

class Builder(context: Context)

Companion

object Companion

RendererAttributes

class RendererAttributes(alignmentIndex: Int = alignmentIndexDefault, fitIndex: Int = fitIndexDefault, loopIndex: Int = loopIndexDefault, rendererIndex: Int = rendererIndexDefault, var autoplay: Boolean, var autoBind: Boolean = false, var riveTraceAnimations: Boolean = false, var artboardName: String?, var animationName: String?, var stateMachineName: String?, var resource: ResourceType?, var assetLoader: FileAssetLoader? = null)

Tracks the renderer attributes that need to be applied to this View within its lifecycle.

Properties

accessibilityClassName

open val accessibilityClassName: CharSequence?

accessibilityDelegate

open var accessibilityDelegate: View.AccessibilityDelegate?

accessibilityLiveRegion

open var accessibilityLiveRegion: Int

accessibilityNodeProvider

open val accessibilityNodeProvider: AccessibilityNodeProvider?

accessibilityPaneTitle

open var accessibilityPaneTitle: CharSequence?

accessibilityTraversalAfter

open var accessibilityTraversalAfter: Int

accessibilityTraversalBefore

open var accessibilityTraversalBefore: Int

alignment

var alignment: Alignment

allowedHandwritingDelegatePackageName

open val allowedHandwritingDelegatePackageName: String?

allowedHandwritingDelegatorPackageName

open val allowedHandwritingDelegatorPackageName: String?

alpha

open var alpha: Float

animation

open var animation: Animation?

animationMatrix

open var animationMatrix: Matrix?

animations

val animations: List<LinearAnimationInstance>

Get the currently loaded animation instances.

applicationWindowToken

open val applicationWindowToken: IBinder?

artboardName

var artboardName: String?

Getter/Setter for the currently loaded artboard name. Setting a new name will load the new artboard and, depending on autoplay, play them.

artboardRenderer

val artboardRenderer: RiveArtboardRenderer?

attributeSourceResourceMap

open val attributeSourceResourceMap: Map<Int?, Int?>

autofillHints

open val autofillHints: Array<out String?>??

autofillId

var autofillId: AutofillId?

autofillType

open val autofillType: Int

autofillValue

open val autofillValue: AutofillValue?

autoplay

var autoplay: Boolean

Getter/Setter for autoplay.

background

open var background: Drawable?

backgroundTintBlendMode

open var backgroundTintBlendMode: BlendMode?

backgroundTintList

open var backgroundTintList: ColorStateList?

backgroundTintMode

open var backgroundTintMode: PorterDuff.Mode?

baseline

open val baseline: Int

bitmap

open val bitmap: Bitmap?

bottom

var bottom: Int

cameraDistance

open var cameraDistance: Float

clipBounds

open var clipBounds: Rect?

clipToOutline

var clipToOutline: Boolean

contentCaptureSession

var contentCaptureSession: ContentCaptureSession?

contentDescription

open var contentDescription: CharSequence?

contentSensitivity

var contentSensitivity: Int

context

val context: Context?

controller

var controller: RiveFileController

defaultAutoplay

open val defaultAutoplay: Boolean = true

defaultFocusHighlightEnabled

var defaultFocusHighlightEnabled: Boolean

display

open val display: Display?

drawableState

val drawableState: IntArray?

drawingCache

open val drawingCache: Bitmap?

drawingCacheBackgroundColor

open var drawingCacheBackgroundColor: Int

drawingCacheQuality

open var drawingCacheQuality: Int

drawingTime

open val drawingTime: Long

elevation

open var elevation: Float

explicitStyle

open val explicitStyle: Int

file

val file: File?

Getter for the loaded Rive file.

filterTouchesWhenObscured

open var filterTouchesWhenObscured: Boolean

fit

var fit: Fit

fitsSystemWindows

open var fitsSystemWindows: Boolean

focusable

open var focusable: Int

foreground

open var foreground: Drawable?

foregroundGravity

open var foregroundGravity: Int

foregroundTintBlendMode

open var foregroundTintBlendMode: BlendMode?

foregroundTintList

open var foregroundTintList: ColorStateList?

foregroundTintMode

open var foregroundTintMode: PorterDuff.Mode?

frameContentVelocity

open var frameContentVelocity: Float

handler

open val handler: Handler?

handwritingBoundsOffsetBottom

open val handwritingBoundsOffsetBottom: Float

handwritingBoundsOffsetLeft

open val handwritingBoundsOffsetLeft: Float

handwritingBoundsOffsetRight

open val handwritingBoundsOffsetRight: Float

handwritingBoundsOffsetTop

open val handwritingBoundsOffsetTop: Float

handwritingDelegateFlags

open var handwritingDelegateFlags: Int

handwritingDelegatorCallback

open var handwritingDelegatorCallback: Runnable?

hasOverlappingRendering

val hasOverlappingRendering: Boolean

height

val height: Int

horizontalFadingEdgeLength

open val horizontalFadingEdgeLength: Int

horizontalScrollbarThumbDrawable

open var horizontalScrollbarThumbDrawable: Drawable?

horizontalScrollbarTrackDrawable

open var horizontalScrollbarTrackDrawable: Drawable?

open var id: Int

importantForAccessibility

open var importantForAccessibility: Int

importantForAutofill

open var importantForAutofill: Int

importantForContentCapture

open var importantForContentCapture: Int

isAccessibilityDataSensitive

open val isAccessibilityDataSensitive: Boolean

isAccessibilityFocused

open val isAccessibilityFocused: Boolean

isAccessibilityHeading

open var isAccessibilityHeading: Boolean

isActivated

open var isActivated: Boolean

isAttachedToWindow

open val isAttachedToWindow: Boolean

isAutoHandwritingEnabled

open var isAutoHandwritingEnabled: Boolean

isAvailable

open val isAvailable: Boolean

isClickable

open var isClickable: Boolean

isContentSensitive

val isContentSensitive: Boolean

isContextClickable

open var isContextClickable: Boolean

isCredential

open val isCredential: Boolean

isDirty

open val isDirty: Boolean

isDrawingCacheEnabled

open var isDrawingCacheEnabled: Boolean

isDuplicateParentStateEnabled

open var isDuplicateParentStateEnabled: Boolean

isEnabled

open var isEnabled: Boolean

isFocusable

var isFocusable: Boolean

isFocusableInTouchMode

var isFocusableInTouchMode: Boolean

isFocused

open val isFocused: Boolean

isFocusedByDefault

var isFocusedByDefault: Boolean

isForceDarkAllowed

open var isForceDarkAllowed: Boolean

isHandwritingDelegate

open val isHandwritingDelegate: Boolean

isHapticFeedbackEnabled

open var isHapticFeedbackEnabled: Boolean

isHardwareAccelerated

open val isHardwareAccelerated: Boolean

isHorizontalFadingEdgeEnabled

open var isHorizontalFadingEdgeEnabled: Boolean

isHorizontalScrollBarEnabled

open var isHorizontalScrollBarEnabled: Boolean

isHovered

open var isHovered: Boolean

isImportantForAccessibility

open val isImportantForAccessibility: Boolean

isImportantForAutofill

val isImportantForAutofill: Boolean

isImportantForContentCapture

val isImportantForContentCapture: Boolean

isInEditMode

open val isInEditMode: Boolean

isInLayout

open val isInLayout: Boolean

isInTouchMode

open val isInTouchMode: Boolean

isKeyboardNavigationCluster

var isKeyboardNavigationCluster: Boolean

isLaidOut

open val isLaidOut: Boolean

isLayoutDirectionResolved

open val isLayoutDirectionResolved: Boolean

isLayoutRequested

open val isLayoutRequested: Boolean

isLongClickable

open var isLongClickable: Boolean

isNestedScrollingEnabled

open var isNestedScrollingEnabled: Boolean

isOpaque

open var isOpaque: Boolean

isPaddingRelative

open val isPaddingRelative: Boolean

isPivotSet

open val isPivotSet: Boolean

isPlaying

val isPlaying: Boolean

Check if the animation is currently playing.

isPreferKeepClear

var isPreferKeepClear: Boolean

isPressed

open var isPressed: Boolean

isSaveEnabled

open var isSaveEnabled: Boolean

isSaveFromParentEnabled

open var isSaveFromParentEnabled: Boolean

isScreenReaderFocusable

open var isScreenReaderFocusable: Boolean

isScrollbarFadingEnabled

open var isScrollbarFadingEnabled: Boolean

isScrollContainer

open var isScrollContainer: Boolean

isSelected

open var isSelected: Boolean

isShowingLayoutBounds

val isShowingLayoutBounds: Boolean

isShown

open val isShown: Boolean

isSoundEffectsEnabled

open var isSoundEffectsEnabled: Boolean

isTemporarilyDetached

val isTemporarilyDetached: Boolean

isTextAlignmentResolved

open val isTextAlignmentResolved: Boolean

isTextDirectionResolved

open val isTextDirectionResolved: Boolean

isVerticalFadingEdgeEnabled

open var isVerticalFadingEdgeEnabled: Boolean

isVerticalScrollBarEnabled

open var isVerticalScrollBarEnabled: Boolean

keepScreenOn

open var keepScreenOn: Boolean

keyDispatcherState

open val keyDispatcherState: KeyEvent.DispatcherState?

labelFor

open var labelFor: Int

layerType

open val layerType: Int

layoutDirection

open var layoutDirection: Int

layoutParams

open var layoutParams: ViewGroup.LayoutParams?

layoutScaleFactor

var layoutScaleFactor: Float?

The scale factor to use for Fit.LAYOUT. If null, it will use a density determined by Rive (automatic).

layoutScaleFactorAutomatic

var layoutScaleFactorAutomatic: Float

The automatic scale factor set by Rive. This value will only be used if layoutScaleFactor is null.

left

var left: Int

matrix

open val matrix: Matrix?

measuredHeight

val measuredHeight: Int

measuredHeightAndState

val measuredHeightAndState: Int

measuredState

val measuredState: Int

measuredWidth

val measuredWidth: Int

measuredWidthAndState

val measuredWidthAndState: Int

minimumHeight

open var minimumHeight: Int

minimumWidth

open var minimumWidth: Int

multiTouchEnabled

open var multiTouchEnabled: Boolean

Whether multitouch is enabled. When false, only the primary pointer (index 0) will be processed; additional fingers will be ignored.

nextClusterForwardId

open var nextClusterForwardId: Int

nextFocusDownId

open var nextFocusDownId: Int

nextFocusForwardId

open var nextFocusForwardId: Int

nextFocusLeftId

open var nextFocusLeftId: Int

nextFocusRightId

open var nextFocusRightId: Int

nextFocusUpId

open var nextFocusUpId: Int

onFocusChangeListener

open var onFocusChangeListener: View.OnFocusChangeListener?

outlineAmbientShadowColor

open var outlineAmbientShadowColor: Int

outlineProvider

open var outlineProvider: ViewOutlineProvider?

outlineSpotShadowColor

open var outlineSpotShadowColor: Int

overlay

open val overlay: ViewOverlay?

overScrollMode

open var overScrollMode: Int

paddingBottom

open val paddingBottom: Int

paddingEnd

open val paddingEnd: Int

paddingLeft

open val paddingLeft: Int

paddingRight

open val paddingRight: Int

paddingStart

open val paddingStart: Int

paddingTop

open val paddingTop: Int

parent

val parent: ViewParent?

parentForAccessibility

open val parentForAccessibility: ViewParent?

pendingCredentialCallback

val pendingCredentialCallback: OutcomeReceiver<GetCredentialResponse?, GetCredentialException?>?

pendingCredentialRequest

val pendingCredentialRequest: GetCredentialRequest?

pivotX

open var pivotX: Float

pivotY

open var pivotY: Float

playingAnimations

val playingAnimations: HashSet<LinearAnimationInstance>

Get the currently playing animation instances.

playingStateMachines

val playingStateMachines: HashSet<StateMachineInstance>

Get the currently playing state machine instances.

pointerIcon

open var pointerIcon: PointerIcon?

preferKeepClearRects

var preferKeepClearRects: List<Rect?>

receiveContentMimeTypes

open val receiveContentMimeTypes: Array<out String?>??

rendererAttributes

@VisibleForTesting(otherwise = 2)

val rendererAttributes: RiveAnimationView.RendererAttributes

requestedFrameRate

open var requestedFrameRate: Float

resources

open val resources: Resources?

revealOnFocusHint

var revealOnFocusHint: Boolean

right

var right: Int

rootSurfaceControl

open val rootSurfaceControl: AttachedSurfaceControl?

rootView

open val rootView: View?

rootWindowInsets

open val rootWindowInsets: WindowInsets?

rotation

open var rotation: Float

rotationX

open var rotationX: Float

rotationY

open var rotationY: Float

scaleX

open var scaleX: Float

scaleY

open var scaleY: Float

scrollBarDefaultDelayBeforeFade

open var scrollBarDefaultDelayBeforeFade: Int

scrollBarFadeDuration

open var scrollBarFadeDuration: Int

scrollBarSize

open var scrollBarSize: Int

scrollBarStyle

open var scrollBarStyle: Int

scrollCaptureHint

open var scrollCaptureHint: Int

scrollIndicators

open var scrollIndicators: Int

scrollX

var scrollX: Int

scrollY

var scrollY: Int

solidColor

open val solidColor: Int

sourceLayoutResId

open val sourceLayoutResId: Int

stateDescription

var stateDescription: CharSequence?

stateListAnimator

open var stateListAnimator: StateListAnimator?

stateMachines

val stateMachines: List<StateMachineInstance>

Get the currently loaded state machine instances.

supplementalDescription

open var supplementalDescription: CharSequence?

surfaceTexture

open val surfaceTexture: SurfaceTexture?

surfaceTextureListener

open var surfaceTextureListener: TextureView.SurfaceTextureListener?

systemGestureExclusionRects

open var systemGestureExclusionRects: List<Rect?>

systemUiVisibility

open var systemUiVisibility: Int

tag

open var tag: Any?

textAlignment

open var textAlignment: Int

textDirection

open var textDirection: Int

tooltipText

open var tooltipText: CharSequence?

top

var top: Int

touchables

open val touchables: ArrayList<View?>?

touchDelegate

open var touchDelegate: TouchDelegate?

touchPassThrough

open var touchPassThrough: Boolean

Whether the view should absorb touch events. By default the view will not allow any touch events to views behind it. Set to true to allow for this behavior.

transitionAlpha

open var transitionAlpha: Float

transitionName

open var transitionName: String?

translationX

open var translationX: Float

translationY

open var translationY: Float

translationZ

open var translationZ: Float

uniqueDrawingId

open val uniqueDrawingId: Long

verticalFadingEdgeLength

open val verticalFadingEdgeLength: Int

verticalScrollbarPosition

open var verticalScrollbarPosition: Int

verticalScrollbarThumbDrawable

open var verticalScrollbarThumbDrawable: Drawable?

verticalScrollbarTrackDrawable

open var verticalScrollbarTrackDrawable: Drawable?

verticalScrollbarWidth

open val verticalScrollbarWidth: Int

viewTranslationResponse

open val viewTranslationResponse: ViewTranslationResponse?

viewTreeObserver

open val viewTreeObserver: ViewTreeObserver?

visibility

open var visibility: Int

width

val width: Int

windowId

open val windowId: WindowId?

windowInsetsController

open val windowInsetsController: WindowInsetsController?

windowSystemUiVisibility

open val windowSystemUiVisibility: Int

windowToken

open val windowToken: IBinder?

windowVisibility

open val windowVisibility: Int

open var x: Float

open var y: Float

open var z: Float

Functions

addChildrenForAccessibility

open fun addChildrenForAccessibility(outChildren: ArrayList<View?>?)

addEventListener

fun addEventListener(listener: RiveFileController.RiveEventListener)

Adds a RiveEventListener to get notified on RiveEvents.

addExtraDataToAccessibilityNodeInfo

open fun addExtraDataToAccessibilityNodeInfo(info: AccessibilityNodeInfo, extraDataKey: String, arguments: Bundle?)

addFocusables

open fun addFocusables(views: ArrayList<View?>?, direction: Int)

open fun addFocusables(views: ArrayList<View?>?, direction: Int, focusableMode: Int)

addKeyboardNavigationClusters

open fun addKeyboardNavigationClusters(views: Collection<View?>, direction: Int)

addOnAttachStateChangeListener

open fun addOnAttachStateChangeListener(listener: View.OnAttachStateChangeListener?)

addOnLayoutChangeListener

open fun addOnLayoutChangeListener(listener: View.OnLayoutChangeListener?)

addOnUnhandledKeyEventListener

open fun addOnUnhandledKeyEventListener(listener: View.OnUnhandledKeyEventListener?)

addTouchables

open fun addTouchables(views: ArrayList<View?>?)

animate

open fun animate(): ViewPropertyAnimator?

announceForAccessibility

open fun ~~announceForAccessibility~~(text: CharSequence?)

autofill

open fun autofill(values: SparseArray<AutofillValue?>)

open fun autofill(value: AutofillValue?)

bringToFront

open fun bringToFront()

buildDrawingCache

open fun ~~buildDrawingCache~~()

open fun ~~buildDrawingCache~~(autoScale: Boolean)

buildLayer

open fun buildLayer()

callOnClick

open fun callOnClick(): Boolean

cancelDragAndDrop

fun cancelDragAndDrop()

cancelLongPress

open fun cancelLongPress()

cancelPendingInputEvents

fun cancelPendingInputEvents()

canResolveLayoutDirection

open fun canResolveLayoutDirection(): Boolean

canResolveTextAlignment

open fun canResolveTextAlignment(): Boolean

canResolveTextDirection

open fun canResolveTextDirection(): Boolean

canScrollHorizontally

open fun canScrollHorizontally(direction: Int): Boolean

canScrollVertically

open fun canScrollVertically(direction: Int): Boolean

checkInputConnectionProxy

open fun checkInputConnectionProxy(view: View?): Boolean

clearAnimation

open fun clearAnimation()

clearFocus

open fun clearFocus()

clearPendingCredentialRequest

open fun clearPendingCredentialRequest()

clearViewTranslationCallback

open fun clearViewTranslationCallback()

computeScroll

open fun computeScroll()

computeSystemWindowInsets

open fun computeSystemWindowInsets(in: WindowInsets?, outLocalInsets: Rect?): WindowInsets?

createAccessibilityNodeInfo

open fun createAccessibilityNodeInfo(): AccessibilityNodeInfo?

createContextMenu

open fun createContextMenu(menu: ContextMenu?)

destroyDrawingCache

open fun ~~destroyDrawingCache~~()

dispatchApplyWindowInsets

open fun dispatchApplyWindowInsets(insets: WindowInsets?): WindowInsets?

dispatchCapturedPointerEvent

open fun dispatchCapturedPointerEvent(event: MotionEvent?): Boolean

dispatchConfigurationChanged

open fun dispatchConfigurationChanged(newConfig: Configuration?)

dispatchCreateViewTranslationRequest

open fun dispatchCreateViewTranslationRequest(viewIds: Map<AutofillId?, LongArray?>, supportedFormats: IntArray, capability: TranslationCapability, requests: List<ViewTranslationRequest?>)

dispatchDisplayHint

open fun dispatchDisplayHint(hint: Int)

dispatchDragEvent

open fun dispatchDragEvent(event: DragEvent?): Boolean

dispatchDrawableHotspotChanged

open fun dispatchDrawableHotspotChanged(x: Float, y: Float)

dispatchFinishTemporaryDetach

open fun dispatchFinishTemporaryDetach()

dispatchGenericMotionEvent

open fun dispatchGenericMotionEvent(event: MotionEvent?): Boolean

dispatchKeyEvent

open fun dispatchKeyEvent(event: KeyEvent?): Boolean

dispatchKeyEventPreIme

open fun dispatchKeyEventPreIme(event: KeyEvent?): Boolean

dispatchKeyShortcutEvent

open fun dispatchKeyShortcutEvent(event: KeyEvent?): Boolean

dispatchNestedFling

open fun dispatchNestedFling(velocityX: Float, velocityY: Float, consumed: Boolean): Boolean

dispatchNestedPreFling

open fun dispatchNestedPreFling(velocityX: Float, velocityY: Float): Boolean

dispatchNestedPrePerformAccessibilityAction

open fun dispatchNestedPrePerformAccessibilityAction(action: Int, arguments: Bundle?): Boolean

dispatchNestedPreScroll

open fun dispatchNestedPreScroll(dx: Int, dy: Int, consumed: IntArray?, offsetInWindow: IntArray?): Boolean

dispatchNestedScroll

open fun dispatchNestedScroll(dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, offsetInWindow: IntArray?): Boolean

dispatchPointerCaptureChanged

open fun dispatchPointerCaptureChanged(hasCapture: Boolean)

dispatchPopulateAccessibilityEvent

open fun dispatchPopulateAccessibilityEvent(event: AccessibilityEvent?): Boolean

dispatchProvideAutofillStructure

open fun dispatchProvideAutofillStructure(structure: ViewStructure, flags: Int)

dispatchProvideStructure

open fun dispatchProvideStructure(structure: ViewStructure?)

dispatchScrollCaptureSearch

open fun dispatchScrollCaptureSearch(localVisibleRect: Rect, windowOffset: Point, targets: Consumer<ScrollCaptureTarget?>)

dispatchStartTemporaryDetach

open fun dispatchStartTemporaryDetach()

dispatchSystemUiVisibilityChanged

open fun ~~dispatchSystemUiVisibilityChanged~~(visibility: Int)

dispatchTouchEvent

open fun dispatchTouchEvent(event: MotionEvent?): Boolean

dispatchTrackballEvent

open fun dispatchTrackballEvent(event: MotionEvent?): Boolean

dispatchUnhandledMove

open fun dispatchUnhandledMove(focused: View?, direction: Int): Boolean

dispatchWindowFocusChanged

open fun dispatchWindowFocusChanged(hasFocus: Boolean)

dispatchWindowInsetsAnimationEnd

open fun dispatchWindowInsetsAnimationEnd(animation: WindowInsetsAnimation)

dispatchWindowInsetsAnimationPrepare

open fun dispatchWindowInsetsAnimationPrepare(animation: WindowInsetsAnimation)

dispatchWindowInsetsAnimationProgress

open fun dispatchWindowInsetsAnimationProgress(insets: WindowInsets, runningAnimations: List<WindowInsetsAnimation?>): WindowInsets

dispatchWindowInsetsAnimationStart

open fun dispatchWindowInsetsAnimationStart(animation: WindowInsetsAnimation, bounds: WindowInsetsAnimation.Bounds): WindowInsetsAnimation.Bounds

dispatchWindowSystemUiVisiblityChanged

open fun ~~dispatchWindowSystemUiVisiblityChanged~~(visible: Int)

dispatchWindowVisibilityChanged

open fun dispatchWindowVisibilityChanged(visibility: Int)

draw

fun draw(canvas: Canvas)

drawableHotspotChanged

open fun drawableHotspotChanged(x: Float, y: Float)

findFocus

open fun findFocus(): View?

findOnBackInvokedDispatcher

fun findOnBackInvokedDispatcher(): OnBackInvokedDispatcher?

findViewById

fun <T : View?> findViewById(id: Int): T?

findViewsWithText

open fun findViewsWithText(outViews: ArrayList<View?>?, searched: CharSequence?, flags: Int)

findViewWithTag

fun <T : View?> findViewWithTag(tag: Any?): T?

fireState

fun fireState(stateMachineName: String, inputName: String)

Fire an SMITrigger input.

fireStateAtPath

fun fireStateAtPath(inputName: String, path: String)

Fire an SMITrigger input.

focusSearch

open fun focusSearch(direction: Int): View?

forceHasOverlappingRendering

open fun forceHasOverlappingRendering(hasOverlappingRendering: Boolean)

forceLayout

open fun forceLayout()

gatherTransparentRegion

open fun gatherTransparentRegion(region: Region?): Boolean

generateDisplayHash

open fun generateDisplayHash(hashAlgorithm: String, bounds: Rect?, executor: Executor, callback: DisplayHashResultCallback)

getAttributeResolutionStack

open fun getAttributeResolutionStack(attribute: Int): IntArray

getDrawingRect

open fun getDrawingRect(outRect: Rect?)

getFocusables

open fun getFocusables(direction: Int): ArrayList<View?>?

getFocusedRect

open fun getFocusedRect(r: Rect?)

getGlobalVisibleRect

fun getGlobalVisibleRect(r: Rect?): Boolean

open fun getGlobalVisibleRect(r: Rect?, globalOffset: Point?): Boolean

getHitRect

open fun getHitRect(outRect: Rect?)

getLocalVisibleRect

fun getLocalVisibleRect(r: Rect?): Boolean

getLocationInSurface

open fun getLocationInSurface(location: IntArray)

getLocationInWindow

open fun getLocationInWindow(outLocation: IntArray?)

getLocationOnScreen

open fun getLocationOnScreen(outLocation: IntArray?)

getTextRunValue

fun getTextRunValue(textRunName: String): String?

Get the current value for a text run named textRunName on the active artboard if it exists.

fun getTextRunValue(textRunName: String, path: String): String?

Get the text value for a text run named textRunName on the nested artboard represented at path.

getTransform

open fun getTransform(transform: Matrix?): Matrix

getVolume

fun getVolume(): Float?

Get the active Artboard's volume.

getWindowVisibleDisplayFrame

open fun getWindowVisibleDisplayFrame(outRect: Rect?)

hasExplicitFocusable

open fun hasExplicitFocusable(): Boolean

hasFocus

open fun hasFocus(): Boolean

hasFocusable

open fun hasFocusable(): Boolean

hasNestedScrollingParent

open fun hasNestedScrollingParent(): Boolean

hasOnClickListeners

open fun hasOnClickListeners(): Boolean

hasOnLongClickListeners

open fun hasOnLongClickListeners(): Boolean

hasOverlappingRendering

open fun hasOverlappingRendering(): Boolean

hasPointerCapture

open fun hasPointerCapture(): Boolean

hasTransientState

open fun hasTransientState(): Boolean

hasWindowFocus

open fun hasWindowFocus(): Boolean

invalidate

open fun invalidate()

open fun ~~invalidate~~(dirty: Rect?)

open fun ~~invalidate~~(l: Int, t: Int, r: Int, b: Int)

invalidateDrawable

open fun invalidateDrawable(drawable: Drawable)

invalidateOutline

open fun invalidateOutline()

isVisibleToUserForAutofill

open fun isVisibleToUserForAutofill(virtualId: Int): Boolean

jumpDrawablesToCurrentState

open fun jumpDrawablesToCurrentState()

keyboardNavigationClusterSearch

open fun keyboardNavigationClusterSearch(currentCluster: View?, direction: Int): View?

layout

open fun layout(l: Int, t: Int, r: Int, b: Int)

lockCanvas

open fun lockCanvas(): Canvas?

open fun lockCanvas(dirty: Rect?): Canvas?

measure

fun measure(widthMeasureSpec: Int, heightMeasureSpec: Int)

offsetLeftAndRight

open fun offsetLeftAndRight(offset: Int)

offsetTopAndBottom

open fun offsetTopAndBottom(offset: Int)

onApplyWindowInsets

open fun onApplyWindowInsets(insets: WindowInsets?): WindowInsets?

onCancelPendingInputEvents

open fun onCancelPendingInputEvents()

onCapturedPointerEvent

open fun onCapturedPointerEvent(event: MotionEvent?): Boolean

onCheckIsTextEditor

open fun onCheckIsTextEditor(): Boolean

onCreateInputConnection

open fun onCreateInputConnection(outAttrs: EditorInfo?): InputConnection?

onCreateViewTranslationRequest

open fun onCreateViewTranslationRequest(supportedFormats: IntArray, requestsCollector: Consumer<ViewTranslationRequest?>)

onCreateVirtualViewTranslationRequests

open fun onCreateVirtualViewTranslationRequests(virtualIds: LongArray, supportedFormats: IntArray, requestsCollector: Consumer<ViewTranslationRequest?>)

onDragEvent

open fun onDragEvent(event: DragEvent?): Boolean

onDrawForeground

open fun onDrawForeground(canvas: Canvas)

onFilterTouchEventForSecurity

open fun onFilterTouchEventForSecurity(event: MotionEvent?): Boolean

onFinishTemporaryDetach

open fun onFinishTemporaryDetach()

onGenericMotionEvent

open fun onGenericMotionEvent(event: MotionEvent?): Boolean

onHoverChanged

open fun onHoverChanged(hovered: Boolean)

onHoverEvent

open fun onHoverEvent(event: MotionEvent?): Boolean

onInitializeAccessibilityEvent

open fun onInitializeAccessibilityEvent(event: AccessibilityEvent?)

onInitializeAccessibilityNodeInfo

open fun onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo?)

onKeyDown

open fun onKeyDown(keyCode: Int, event: KeyEvent?): Boolean

onKeyLongPress

open fun onKeyLongPress(keyCode: Int, event: KeyEvent?): Boolean

onKeyMultiple

open fun onKeyMultiple(keyCode: Int, repeatCount: Int, event: KeyEvent?): Boolean

onKeyPreIme

open fun onKeyPreIme(keyCode: Int, event: KeyEvent?): Boolean

onKeyShortcut

open fun onKeyShortcut(keyCode: Int, event: KeyEvent?): Boolean

onKeyUp

open fun onKeyUp(keyCode: Int, event: KeyEvent?): Boolean

onPointerCaptureChange

open fun onPointerCaptureChange(hasCapture: Boolean)

onPopulateAccessibilityEvent

open fun onPopulateAccessibilityEvent(event: AccessibilityEvent?)

onProvideAutofillStructure

open fun onProvideAutofillStructure(structure: ViewStructure?, flags: Int)

onProvideAutofillVirtualStructure

open fun onProvideAutofillVirtualStructure(structure: ViewStructure?, flags: Int)

onProvideContentCaptureStructure

open fun onProvideContentCaptureStructure(structure: ViewStructure, flags: Int)

onProvideStructure

open fun onProvideStructure(structure: ViewStructure?)

onProvideVirtualStructure

open fun onProvideVirtualStructure(structure: ViewStructure?)

onReceiveContent

open fun onReceiveContent(payload: ContentInfo): ContentInfo?

onResolvePointerIcon

open fun onResolvePointerIcon(event: MotionEvent?, pointerIndex: Int): PointerIcon?

onRtlPropertiesChanged

open fun onRtlPropertiesChanged(layoutDirection: Int)

onScreenStateChanged

open fun onScreenStateChanged(screenState: Int)

onScrollCaptureSearch

open fun onScrollCaptureSearch(localVisibleRect: Rect, windowOffset: Point, targets: Consumer<ScrollCaptureTarget?>)

onStartTemporaryDetach

open fun onStartTemporaryDetach()

onSurfaceTextureAvailable

open override fun onSurfaceTextureAvailable(surfaceTexture: SurfaceTexture, width: Int, height: Int)

onSurfaceTextureDestroyed

@CallSuper

open override fun onSurfaceTextureDestroyed(surface: SurfaceTexture): Boolean

onSurfaceTextureSizeChanged

open override fun onSurfaceTextureSizeChanged(surface: SurfaceTexture, width: Int, height: Int)

onSurfaceTextureUpdated

open override fun onSurfaceTextureUpdated(surface: SurfaceTexture)

onTouchEvent

open override fun onTouchEvent(event: MotionEvent): Boolean

onTrackballEvent

open fun onTrackballEvent(event: MotionEvent?): Boolean

onViewTranslationResponse

open fun onViewTranslationResponse(response: ViewTranslationResponse)

onVirtualViewTranslationResponses

open fun onVirtualViewTranslationResponses(response: LongSparseArray<ViewTranslationResponse?>)

onVisibilityAggregated

open fun onVisibilityAggregated(isVisible: Boolean)

onWindowFocusChanged

open fun onWindowFocusChanged(hasWindowFocus: Boolean)

onWindowSystemUiVisibilityChanged

open fun ~~onWindowSystemUiVisibilityChanged~~(visible: Int)

pause

fun pause()

Pauses all playing animation instances.

fun pause(animationName: String, isStateMachine: Boolean = false)

Pauses any animation instances called animationName.

fun pause(animationNames: List<String>, areStateMachines: Boolean = false)

Pauses any animation instances with any of the provided names.

performAccessibilityAction

open fun performAccessibilityAction(action: Int, arguments: Bundle?): Boolean

performClick

open fun performClick(): Boolean

performContextClick

open fun performContextClick(): Boolean

open fun performContextClick(x: Float, y: Float): Boolean

performHapticFeedback

open fun performHapticFeedback(feedbackConstant: Int): Boolean

open fun performHapticFeedback(feedbackConstant: Int, flags: Int): Boolean

performLongClick

open fun performLongClick(): Boolean

open fun performLongClick(x: Float, y: Float): Boolean

performReceiveContent

open fun performReceiveContent(payload: ContentInfo): ContentInfo?

play

fun play(loop: Loop = Loop.AUTO, direction: Direction = Direction.AUTO, settleInitialState: Boolean = true)

Restarts paused animations. If no animations were playing it plays the first in the File.

fun play(animationName: String, loop: Loop = Loop.AUTO, direction: Direction = Direction.AUTO, isStateMachine: Boolean = false, settleInitialState: Boolean = true)

Plays any animation instances called animationName.

fun play(animationNames: List<String>, loop: Loop = Loop.AUTO, direction: Direction = Direction.AUTO, areStateMachines: Boolean = false, settleInitialState: Boolean = true)

Plays any animation instances with any of the provided names.

playSoundEffect

open fun playSoundEffect(soundConstant: Int)

post

open fun post(action: Runnable?): Boolean

postDelayed

open fun postDelayed(action: Runnable?, delayMillis: Long): Boolean

postInvalidate

open fun postInvalidate()

open fun postInvalidate(left: Int, top: Int, right: Int, bottom: Int)

postInvalidateDelayed

open fun postInvalidateDelayed(delayMilliseconds: Long)

open fun postInvalidateDelayed(delayMilliseconds: Long, left: Int, top: Int, right: Int, bottom: Int)

postInvalidateOnAnimation

open fun postInvalidateOnAnimation()

open fun postInvalidateOnAnimation(left: Int, top: Int, right: Int, bottom: Int)

postOnAnimation

open fun postOnAnimation(action: Runnable?)

postOnAnimationDelayed

open fun postOnAnimationDelayed(action: Runnable?, delayMillis: Long)

refreshDrawableState

open fun refreshDrawableState()

registerListener

open override fun registerListener(listener: RiveFileController.Listener)

releasePointerCapture

open fun releasePointerCapture()

removeCallbacks

open fun removeCallbacks(action: Runnable?): Boolean

removeEventListener

fun removeEventListener(listener: RiveFileController.RiveEventListener)

Removes the listener.

removeOnAttachStateChangeListener

open fun removeOnAttachStateChangeListener(listener: View.OnAttachStateChangeListener?)

removeOnLayoutChangeListener

open fun removeOnLayoutChangeListener(listener: View.OnLayoutChangeListener?)

removeOnUnhandledKeyEventListener

open fun removeOnUnhandledKeyEventListener(listener: View.OnUnhandledKeyEventListener?)

reportAppJankStats

open fun reportAppJankStats(appJankStats: AppJankStats)

requestApplyInsets

open fun requestApplyInsets()

requestFitSystemWindows

open fun ~~requestFitSystemWindows~~()

requestFocus

fun requestFocus(): Boolean

fun requestFocus(direction: Int): Boolean

open fun requestFocus(direction: Int, previouslyFocusedRect: Rect?): Boolean

requestFocusFromTouch

fun requestFocusFromTouch(): Boolean

requestLayout

open fun requestLayout()

requestPointerCapture

open fun requestPointerCapture()

requestRectangleOnScreen

open fun requestRectangleOnScreen(rectangle: Rect?): Boolean

open fun requestRectangleOnScreen(rectangle: Rect?, immediate: Boolean): Boolean

requestUnbufferedDispatch

fun requestUnbufferedDispatch(event: MotionEvent?)

fun requestUnbufferedDispatch(source: Int)

requireViewById

fun <T : View?> requireViewById(id: Int): T & Any

reset

fun reset()

Reset the view by resetting the current artboard before any animations have been applied.

resetPivot

open fun resetPivot()

restoreControllerState

fun restoreControllerState(state: ControllerState)

restoreDefaultFocus

open fun restoreDefaultFocus(): Boolean

restoreHierarchyState

open fun restoreHierarchyState(container: SparseArray<Parcelable?>?)

saveAttributeDataForStyleable

fun saveAttributeDataForStyleable(context: Context, styleable: IntArray, attrs: AttributeSet?, t: TypedArray, defStyleAttr: Int, defStyleRes: Int)

saveControllerState

fun saveControllerState(): ControllerState?

saveHierarchyState

open fun saveHierarchyState(container: SparseArray<Parcelable?>?)

scheduleDrawable

open fun scheduleDrawable(who: Drawable, what: Runnable, when: Long)

scrollBy

open fun scrollBy(x: Int, y: Int)

scrollTo

open fun scrollTo(x: Int, y: Int)

sendAccessibilityEvent

open fun sendAccessibilityEvent(eventType: Int)

sendAccessibilityEventUnchecked

open fun sendAccessibilityEventUnchecked(event: AccessibilityEvent?)

setAccessibilityDataSensitive

open fun setAccessibilityDataSensitive(accessibilityDataSensitive: Int)

setAllowClickWhenDisabled

open fun setAllowClickWhenDisabled(clickableWhenDisabled: Boolean)

setAllowedHandwritingDelegatePackage

open fun setAllowedHandwritingDelegatePackage(allowedPackageName: String?)

setAllowedHandwritingDelegatorPackage

open fun setAllowedHandwritingDelegatorPackage(allowedPackageName: String?)

setAssetLoader

fun setAssetLoader(assetLoader: FileAssetLoader?)

Overrides the current asset loader. It increases the assetLoader ref count by one, but its ownership is still in the hands of the caller.

setAutofillHints

open fun setAutofillHints(vararg autofillHints: String?)

setBackgroundColor

open fun setBackgroundColor(color: Int)

setBackgroundDrawable

open fun setBackgroundDrawable(background: Drawable?)

setBackgroundResource

open fun setBackgroundResource(resid: Int)

setBooleanState

fun setBooleanState(stateMachineName: String, inputName: String, value: Boolean)

Update the state of an SMIBoolean input.

setBooleanStateAtPath

fun setBooleanStateAtPath(inputName: String, value: Boolean, path: String)

Update the state of an SMIBoolean input.

setFadingEdgeLength

open fun setFadingEdgeLength(length: Int)

setHandwritingBoundsOffsets

open fun setHandwritingBoundsOffsets(offsetLeft: Float, offsetTop: Float, offsetRight: Float, offsetBottom: Float)

setHasTransientState

open fun setHasTransientState(hasTransientState: Boolean)

setIsCredential

open fun setIsCredential(isCredential: Boolean)

setIsHandwritingDelegate

open fun setIsHandwritingDelegate(isHandwritingDelegate: Boolean)

setLayerPaint

open fun setLayerPaint(paint: Paint?)

setLayerType

open fun setLayerType(layerType: Int, paint: Paint?)

setLeftTopRightBottom

fun setLeftTopRightBottom(left: Int, top: Int, right: Int, bottom: Int)

setMultipleStates

fun setMultipleStates(vararg inputs: ChangedInput)

Update multiple states at once supplying one or more inputs.

setNumberState

fun setNumberState(stateMachineName: String, inputName: String, value: Float)

Update the state of an SMINumber input.

setNumberStateAtPath

fun setNumberStateAtPath(inputName: String, value: Float, path: String)

Update the state of an SMINumber input.

setOnApplyWindowInsetsListener

open fun setOnApplyWindowInsetsListener(listener: View.OnApplyWindowInsetsListener?)

setOnCapturedPointerListener

open fun setOnCapturedPointerListener(l: View.OnCapturedPointerListener?)

setOnClickListener

open fun setOnClickListener(l: View.OnClickListener?)

setOnContextClickListener

open fun setOnContextClickListener(l: View.OnContextClickListener?)

setOnCreateContextMenuListener

open fun setOnCreateContextMenuListener(l: View.OnCreateContextMenuListener?)

setOnDragListener

open fun setOnDragListener(l: View.OnDragListener?)

setOnGenericMotionListener

open fun setOnGenericMotionListener(l: View.OnGenericMotionListener?)

setOnHoverListener

open fun setOnHoverListener(l: View.OnHoverListener?)

setOnKeyListener

open fun setOnKeyListener(l: View.OnKeyListener?)

setOnLongClickListener

open fun setOnLongClickListener(l: View.OnLongClickListener?)

setOnReceiveContentListener

open fun setOnReceiveContentListener(mimeTypes: Array<out String?>??, listener: OnReceiveContentListener?)

setOnScrollChangeListener

open fun setOnScrollChangeListener(l: View.OnScrollChangeListener?)

setOnSystemUiVisibilityChangeListener

open fun ~~setOnSystemUiVisibilityChangeListener~~(l: View.OnSystemUiVisibilityChangeListener?)

setOnTouchListener

open fun setOnTouchListener(l: View.OnTouchListener?)

setPadding

open fun setPadding(left: Int, top: Int, right: Int, bottom: Int)

setPaddingRelative

open fun setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int)

setPendingCredentialRequest

open fun setPendingCredentialRequest(request: GetCredentialRequest, callback: OutcomeReceiver<GetCredentialResponse?, GetCredentialException?>)

setRenderEffect

open fun setRenderEffect(renderEffect: RenderEffect?)

setRiveBytes

fun setRiveBytes(bytes: ByteArray, artboardName: String? = null, animationName: String? = null, stateMachineName: String? = null, autoplay: Boolean = controller.autoplay, autoBind: Boolean = false, fit: Fit = Fit.fromIndex(fitIndexDefault), alignment: Alignment = Alignment.fromIndex(alignmentIndexDefault), loop: Loop = Loop.fromIndex(loopIndexDefault))

Create a Rive file from a byte array and load it into the view.

setRiveFile

fun setRiveFile(file: File, artboardName: String? = null, animationName: String? = null, stateMachineName: String? = null, autoplay: Boolean = controller.autoplay, autoBind: Boolean = false, fit: Fit = Fit.fromIndex(fitIndexDefault), alignment: Alignment = Alignment.fromIndex(alignmentIndexDefault), loop: Loop = Loop.fromIndex(loopIndexDefault))

Set this view to use the specified Rive file. The file must be initialized outside this scope and the caller is responsible for cleaning up its resources.

setRiveResource

fun setRiveResource(@RawRes resId: Int, artboardName: String? = null, animationName: String? = null, stateMachineName: String? = null, autoplay: Boolean = controller.autoplay, autoBind: Boolean = false, fit: Fit = Fit.fromIndex(fitIndexDefault), alignment: Alignment = Alignment.fromIndex(alignmentIndexDefault), loop: Loop = Loop.fromIndex(loopIndexDefault))

Load the resource ID as a Rive file into the view.

setScrollCaptureCallback

fun setScrollCaptureCallback(callback: ScrollCaptureCallback?)

setSurfaceTexture

open fun setSurfaceTexture(surfaceTexture: SurfaceTexture)

setTextRunValue