Rive Android/app.rive.runtime.kotlin.core/File

File

@OpenForTesting

class File(bytes: ByteArray, val rendererType: RendererType = Rive.defaultRendererType, fileAssetLoader: FileAssetLoader? = null) : NativeObject

Files are created in the Rive editor.

This object has a counterpart in C++, which implements much of its functionality. The base class's cppPointer keeps track of this relationship.

You can export .riv from the editor and use this class to load them. Files may contain multiple artboards.

If the given file cannot be loaded this will throw a RiveException. The Rive File format is evolving, and while we attempt to keep backwards (and forwards) compatibility where possible, there are times when this is not possible.

The Rive editor will always export your file in the latest runtime format.

⚠️ Important: If you create a File yourself using this constructor, you are responsible for calling release when you are done with it, otherwise it will leak memory.

Parameters

bytes

The bytes of the .riv file.

rendererType

The RendererType to use when rendering this file. This defaults to Rive.defaultRendererType, which is RendererType.Rive.

fileAssetLoader

An optional FileAssetLoader to use when loading external assets (images, fonts, audio) referenced by this file. If it is not provided you will not be able to load external assets.

Constructors

constructor(bytes: ByteArray, rendererType: RendererType = Rive.defaultRendererType, fileAssetLoader: FileAssetLoader? = null)

Types

data class Enum(val name: String, val values: List<String>)

The name and values of an enum, whether system or user defined.

Properties

val artboardCount: Int

Get the number of artboards in the file. Useful for index-based iteration.

val artboardNames: List<String>

Get the names of the artboards in the file.

var cppPointer: Long

Getter/Setter for the underlying C++ pointer value.

val dependencies: MutableList<RefCount>

val enums: List<File.Enum>

The available enums in the file.

val firstArtboard: Artboard

Get the first (i.e. the default) artboard in the file.

val hasCppObject: Boolean

Whether this objects underlying pointer is still valid.

val lock: ReentrantLock

Public compatibility alias for fileLock.

open val refCount: Int

override var refs: AtomicInteger

val rendererType: RendererType

val viewModelCount: Int

The number of ViewModels in the file. Useful for index-based iteration.

Functions

open override fun acquire(): Int

Increments the references for this counter. Cannot be used for initialization - use refs.incrementAndGet instead.

fun artboard(index: Int): Artboard

Get the artboard at a given index in the File.

fun artboard(name: String): Artboard

Get the artboard called name in the file.

open external override fun cppDelete(pointer: Long)

createBindableArtboardByName

fun createBindableArtboardByName(name: String, viewModelInstance: ViewModelInstance? = null): BindableArtboard

Create a BindableArtboard by name. This is can then be bound to a ViewModelArtboardProperty.

createDefaultBindableArtboard

fun createDefaultBindableArtboard(viewModelInstance: ViewModelInstance? = null): BindableArtboard

Create the default BindableArtboard, as marked in the Rive file. This is can then be bound to a ViewModelArtboardProperty.

defaultViewModelForArtboard

fun defaultViewModelForArtboard(artboard: Artboard): ViewModel

Get the default ViewModel for an Artboard. Usually this will be the ViewModel intended for use with this artboard.

getViewModelByIndex

fun getViewModelByIndex(viewModelIdx: Int): ViewModel

Get the ViewModel definition from the file.

getViewModelByName

fun getViewModelByName(viewModelName: String): ViewModel

Get the ViewModel definition from the file.

open override fun release(): Int

Decrements the reference counter.