SurfaceCallback

interface SurfaceCallback


A callback for changes on the SurfaceContainer and its attributes.

Summary

Public functions

Unit
@RequiresCarApi(value = 5)
onClick(x: Float, y: Float)

Provides information about a click event on the car screen.

Unit
@RequiresCarApi(value = 2)
onFling(velocityX: Float, velocityY: Float)

Provides information about a fling touch event on the car screen.

Unit
@RequiresCarApi(value = 2)
onScale(focusX: Float, focusY: Float, scaleFactor: Float)

Provides information about a scale touch event on the car screen.

Unit
@RequiresCarApi(value = 2)
onScroll(distanceX: Float, distanceY: Float)

Provides information about a scroll touch event on the car screen.

Unit

Indicates that the stable area provided by the host has changed.

Unit

Provides a SurfaceContainer from the host which is ready for drawing.

Unit

Indicates that the SurfaceContainer provided by the host will be destroyed after this callback.

Unit
onVisibleAreaChanged(visibleArea: Rect)

Indicates that the visible area provided by the host has changed.

Public functions

onClick

Added in 1.2.0
@RequiresCarApi(value = 5)
fun onClick(x: Float, y: Float): Unit

Provides information about a click event on the car screen.

See androidx.car.app.navigation.model.NavigationTemplate class description for more details on how to receive this callback.

This method may not be called in some car systems.

Parameters
x: Float

x coordinate of the click in pixels

y: Float

y coordinate of the click in pixels

onFling

Added in 1.1.0
@RequiresCarApi(value = 2)
fun onFling(velocityX: Float, velocityY: Float): Unit

Provides information about a fling touch event on the car screen.

See androidx.car.app.navigation.model.NavigationTemplate class description for more details on how to receive this callback.

This method may not be called in some car systems.

Parameters
velocityX: Float

the velocity of this fling measured in pixels per second along the x axis

velocityY: Float

the velocity of this fling measured in pixels per second along the y axis

onScale

Added in 1.1.0
@RequiresCarApi(value = 2)
fun onScale(focusX: Float, focusY: Float, scaleFactor: Float): Unit

Provides information about a scale touch event on the car screen.

See androidx.car.app.navigation.model.NavigationTemplate class description for more details on how to receive this callback.

This method may not be called in some car systems.

Parameters
focusX: Float

x coordinate of the focal point in pixels. A negative value indicates that the focal point is unavailable.

focusY: Float

y coordinate of the focal point in pixels. A negative value indicates that the focal point is unavailable.

scaleFactor: Float

the scaling factor from the previous state to the current state during the scale event. This value is defined as (current state) / (previous state)

onScroll

Added in 1.1.0
@RequiresCarApi(value = 2)
fun onScroll(distanceX: Float, distanceY: Float): Unit

Provides information about a scroll touch event on the car screen.

See androidx.car.app.navigation.model.NavigationTemplate class description for more details on how to receive this callback.

Parameters
distanceX: Float

the distance in pixels along the X axis that has been scrolled since the last touch position during the scroll event

distanceY: Float

the distance in pixels along the Y axis that has been scrolled since the last touch position during the scroll event

onStableAreaChanged

Added in 1.0.0
fun onStableAreaChanged(stableArea: Rect): Unit

Indicates that the stable area provided by the host has changed.

The surface may be occluded for several reasons including status bar changes, overlays from other apps or dynamic UI within the template (also see onVisibleAreaChanged). The stable area is the visual area that accounts for these occlusions as if they were always present. If the app needs to show more persistent data that do not necessarily adjust based on these dynamic content changes, it should be bounded by this area.

Parameters
stableArea: Rect

inset rectangle of the surface space designated as stable. If isEmpty returns true for the stable area, then it is currently unknown

onSurfaceAvailable

Added in 1.0.0
fun onSurfaceAvailable(surfaceContainer: SurfaceContainer): Unit

Provides a SurfaceContainer from the host which is ready for drawing.

This method may be called multiple times if the surface changes characteristics. For instance, the size or DPI may change without the underlying surface being destroyed.

This method is guaranteed to be called before any other methods on this listener.

Important: every instance of android.view.Surface received through this method must be released by calling release.

Parameters
surfaceContainer: SurfaceContainer

the SurfaceContainer that is ready for drawing

onSurfaceDestroyed

Added in 1.0.0
fun onSurfaceDestroyed(surfaceContainer: SurfaceContainer): Unit

Indicates that the SurfaceContainer provided by the host will be destroyed after this callback.

Parameters
surfaceContainer: SurfaceContainer

the SurfaceContainer being destroyed

onVisibleAreaChanged

Added in 1.0.0
fun onVisibleAreaChanged(visibleArea: Rect): Unit

Indicates that the visible area provided by the host has changed.

The surface may be occluded for several reasons including status bar changes, overlays from other apps or dynamic UI within a template. visibleArea is the area currently guaranteed to not be occluded by any other UI. If the app needs to show critical data, it should be bounded by this area.

Parameters
visibleArea: Rect

the rectangle set to the surface area guaranteed to be visible. If isEmpty returns true for the visible area, then it is currently unknown