ScrollCaptureSession

public class ScrollCaptureSession
extends Object

java.lang.Object
   ↳ android.view.ScrollCaptureSession


A session represents the scope of interaction between a ScrollCaptureCallback and the system during an active scroll capture operation.

Summary

Public constructors

ScrollCaptureSession(Surface surface, Rect scrollBounds, Point positionInWindow)

Constructs a new session instance.

Public methods

Point getPositionInWindow()

Returns the offset of scroll bounds within the window.

Rect getScrollBounds()

Returns the scroll bounds, as provided by ScrollCaptureCallback#onScrollCaptureSearch.

Surface getSurface()

Returns a BufferQueue in the form of a Surface for transfer of image buffers.

Inherited methods

Public constructors

ScrollCaptureSession

Added in API level 31
public ScrollCaptureSession (Surface surface, 
                Rect scrollBounds, 
                Point positionInWindow)

Constructs a new session instance.

Parameters
surface Surface: the surface to consume generated images This value cannot be null.

scrollBounds Rect: the bounds of the capture area within the containing view This value cannot be null.

positionInWindow Point: the offset of scrollBounds within the window This value cannot be null.

Public methods

getPositionInWindow

Added in API level 31
public Point getPositionInWindow ()

Returns the offset of scroll bounds within the window.

Returns
Point the area of scrolling content within the containing view This value cannot be null.

getScrollBounds

Added in API level 31
public Rect getScrollBounds ()

Returns the scroll bounds, as provided by ScrollCaptureCallback#onScrollCaptureSearch.

Returns
Rect the area of scrolling content within the containing view This value cannot be null.

getSurface

Added in API level 31
public Surface getSurface ()

Returns a BufferQueue in the form of a Surface for transfer of image buffers.

The surface is guaranteed to remain valid until the session ends.

Returns
Surface the surface for transferring image buffers This value cannot be null.

Throws
IllegalStateException if the session has been closed