DetailsParallax

Added in 1.1.0

Kotlin |Java

class DetailsParallax : RecyclerViewParallax

kotlin.Any
↳	androidx.leanback.widget.Parallax
	↳	androidx.leanback.widget.RecyclerViewParallax
		↳	androidx.leanback.widget.DetailsParallax

Subclass of Parallax object that tracks overview row's top and bottom edge in DetailsFragment or DetailsSupportFragment.

It can be used for both creating cover image parallax effect and controlling video playing when transitioning to/from half/full screen. A direct use case is androidx.leanback.app.DetailsFragmentBackgroundController.

See also
`getParallax`
`DetailsFragmentBackgroundController`
`getParallax`
`DetailsSupportFragmentBackgroundController`

Summary

Public constructors
`DetailsParallax()`

Public functions
`Parallax.IntProperty!`	`getOverviewRowBottom()` Returns the bottom of the details overview row.
`Parallax.IntProperty!`	`getOverviewRowTop()` Returns the top of the details overview row.

`ParallaxEffect!`	`addEffect(ranges: Array<Parallax.PropertyMarkerValue!>!)` Create a `ParallaxEffect` object that will track source variable changes within a provided set of ranges.
`PropertyT!`	`addProperty(name: String!)` Add a new IntProperty in the Parallax object.
`abstract PropertyT!`	`createProperty(name: String!, index: Int)` Create a new Property object.
`(Mutable)List<ParallaxEffect!>!`	`getEffects()` Returns a list of `ParallaxEffect` object which defines rules to perform mapping to multiple `ParallaxTarget`s.
`(Mutable)List<PropertyT!>!`	`getProperties()`
`Unit`	`removeAllEffects()` Remove all `ParallaxEffect` objects.
`Unit`	`removeEffect(effect: ParallaxEffect!)` Remove the `ParallaxEffect` object.

`RecyclerViewParallax.ChildPositionProperty!`	`createProperty(name: String!, index: Int)` Create a new Property object.
`Float`	`getMaxValue()` Return the max value which is typically size of parent visible area, e.g. RecyclerView's height if we are tracking Y position of a child.
`RecyclerView!`	`getRecyclerView()`
`Unit`	`setRecyclerView(recyclerView: RecyclerView!)` Set RecyclerView that this Parallax will register onScrollListener.
`Unit`	`updateValues()` Manually update values.

Added in 1.1.0

DetailsParallax()

Added in 1.1.0

fun getOverviewRowBottom(): Parallax.IntProperty!

Returns the bottom of the details overview row. This is tracked for implementing the parallax effect.

Added in 1.1.0

fun getOverviewRowTop(): Parallax.IntProperty!

Returns the top of the details overview row. This is tracked for implementing the parallax effect.