Engine

abstract class Engine<RENDERER : Any>(val master: Master, val playableCreator: PlayableCreator<RENDERER>)

Constructors

Engine

fun <RENDERER : Any> Engine(context: Context, playableCreator: PlayableCreator<RENDERER>)

Engine

fun <RENDERER : Any> Engine(master: Master, playableCreator: PlayableCreator<RENDERER>)

Functions

applyVolumeInfo

fun applyVolumeInfo( volumeInfo: VolumeInfo, target: Any, scope: Scope)

cancel

fun cancel(container: ViewGroup)

fun cancel(tag: Any)

cleanUp

@CallSuper

open fun cleanUp()

lockActivity

fun lockActivity(activity: FragmentActivity)

Locks all the Playbacks of a FragmentActivity. The locking Scope is equal to Scope.GROUP. Any call to unlock of smaller Scope (like Scope.MANAGER) will not unlock the Playbacks.

lockBucket

fun lockBucket(view: View)

Locks all the Playbacks of a Bucket whose Bucket.root is view. The locking Scope is equal to Scope.BUCKET. Any call to unlock of smaller Scope (like Scope.PLAYBACK) will not unlock the Playbacks.

lockManager

fun lockManager(manager: Manager)

Locks all the Playbacks of a Manager. The locking Scope is equal to Scope.MANAGER. Any call to unlock of smaller Scope (like Scope.BUCKET) will not unlock the Playbacks.

lockPlayback

fun lockPlayback(playback: Playback)

Locks all the Playbacks of a Playback. The locking Scope is equal to Scope.PLAYBACK.

prepare

abstract fun prepare(manager: Manager)

@JvmOverloads

fun register( fragment: Fragment, memoryMode: MemoryMode = LOW, activeLifecycleState: Lifecycle.State = STARTED): Manager

@JvmOverloads

fun register( activity: FragmentActivity, memoryMode: MemoryMode = LOW, activeLifecycleState: Lifecycle.State = STARTED): Manager

setUp

@JvmOverloads

inline fun setUp(uri: Uri, crossinline options: Binder.Options.() -> Unit = {}): Binder

@JvmOverloads

inline fun setUp(media: Media, crossinline options: Binder.Options.() -> Unit = {}): Binder

@JvmOverloads

inline fun setUp(url: String, crossinline options: Binder.Options.() -> Unit = {}): Binder

stick

fun stick(lifecycleOwner: LifecycleOwner)

fun stick(playback: Playback)

unlockActivity

fun unlockActivity(activity: FragmentActivity)

Unlock all the Playbacks of an FragmentActivity. The effective scope is Scope.GROUP. If it was locked by a call to higher Scope like Scope.GLOBAL, this method does nothing. Once unlocked, it will unlock all locked objects within Scope.GROUP: Playback, Bucket, Manager.

unlockBucket

fun unlockBucket(view: View)

Unlock all the Playbacks of a Bucket whose Bucket.root is view. The effective scope is Scope.BUCKET. If it was locked by a call to higher Scope like Scope.MANAGER, this method does nothing. Once unlocked, it will unlock all locked objects within Scope.BUCKET: Playback.

unlockManager

fun unlockManager(manager: Manager)

Unlock all the Playbacks of a Manager. The effective scope is Scope.MANAGER. If it was locked by a call to higher Scope like Scope.GROUP, this method does nothing. Once unlocked, it will unlock all locked objects within Scope.MANAGER: Playback, Bucket.

unlockPlayback

fun unlockPlayback(playback: Playback)

Unlock all the Playbacks of a Playback. The effective scope is Scope.PLAYBACK. If it was locked by a call to higher Scope like Scope.BUCKET, this method does nothing.

unstick

fun unstick(lifecycleOwner: LifecycleOwner)

fun unstick(playback: Playback)

Properties

master

val master: Master

playableCreator

val playableCreator: PlayableCreator<RENDERER>