Added in API level 30

Summary: Nested Classes | Ctors | Methods | Protected Methods | Inherited Methods

SurfaceControlViewHost

Kotlin |Java

public class SurfaceControlViewHost
extends Object

java.lang.Object
↳	android.view.SurfaceControlViewHost

Utility class for adding a View hierarchy to a SurfaceControl. The View hierarchy will render in to a root SurfaceControl, and receive input based on the SurfaceControl's placement on-screen. The primary usage of this class is to embed a View hierarchy from one process in to another. After the SurfaceControlViewHost has been set up in the embedded content provider, we can send the SurfaceControlViewHost.SurfacePackage to the host process. The host process can then attach the hierarchy to a SurfaceView within its own by calling SurfaceView.setChildSurfacePackage.

Summary

Nested classes
`class`	`SurfaceControlViewHost.LayoutParams` Specifies the layout parameters for a `View` hosted by a `SurfaceControlViewHost`.
`class`	`SurfaceControlViewHost.SurfacePackage` Package encapsulating a Surface hierarchy which contains interactive view elements.

Public constructors
`SurfaceControlViewHost(Context context, Display display, IBinder hostToken)` Construct a new SurfaceControlViewHost.
`SurfaceControlViewHost(Context context, Display display, InputTransferToken hostInputTransferToken)` Construct a new SurfaceControlViewHost.

Public methods
`SurfaceControlViewHost.LayoutParams`	`getLayoutParams()` Returns the `LayoutParams` of the root view.
`SurfaceControlViewHost.SurfacePackage`	`getSurfacePackage()` Return a SurfacePackage for the root SurfaceControl of the embedded hierarchy.
`View`	`getView()`
`void`	`relayout(SurfaceControlViewHost.LayoutParams attrs)` Modifies the `LayoutParams` of the root view.
`void`	`relayout(int width, int height)` Modify the size of the root view.
`void`	`release()` Trigger the tear down of the embedded view hierarchy and release the SurfaceControl.
`void`	`setView(View view, int width, int height)` Set the root view of the SurfaceControlViewHost.
`void`	`setView(View view, SurfaceControlViewHost.LayoutParams attrs)` Sets the root view of the `SurfaceControlViewHost`.
`boolean`	`transferTouchGestureToHost()` This method was deprecated in API level 35. Use `WindowManager.transferTouchGesture(InputTransferToken, InputTransferToken)` instead.

Protected methods
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

SurfaceControlViewHost

Added in API level 30

public SurfaceControlViewHost (Context context, 
                Display display, 
                IBinder hostToken)

Construct a new SurfaceControlViewHost. The root Surface will be allocated internally and is accessible via getSurfacePackage(). The hostToken parameter, primarily used for ANR reporting, must be obtained from whomever will be hosting the embedded hierarchy. It's accessible from SurfaceView.getHostToken.

Parameters
`context`	`Context`: The Context object for your activity or application. This value cannot be `null`.
`display`	`Display`: The Display the hierarchy will be placed on. This value cannot be `null`.
`hostToken`	`IBinder`: The host token, as discussed above. This value may be `null`.

SurfaceControlViewHost

Added in API level 35

public SurfaceControlViewHost (Context context, 
                Display display, 
                InputTransferToken hostInputTransferToken)

Construct a new SurfaceControlViewHost. The root Surface will be allocated internally and is accessible via getSurfacePackage().

The hostInputTransferToken parameter allows the host and embedded to be associated with each other to allow transferring touch gesture and focus. This is also used for ANR reporting. It's accessible from AttachedSurfaceControl.getInputTransferToken().

Parameters
`context`	`Context`: The Context object for your activity or application. This value cannot be `null`.
`display`	`Display`: The Display the hierarchy will be placed on. This value cannot be `null`.
`hostInputTransferToken`	`InputTransferToken`: The host input transfer token, as discussed above. This value may be `null`.

Public methods

getLayoutParams

Added in API level 30

public SurfaceControlViewHost.LayoutParams getLayoutParams ()

Returns the LayoutParams of the root view.

Returns
`SurfaceControlViewHost.LayoutParams`	This value cannot be `null`.

getSurfacePackage

Added in API level 30

public SurfaceControlViewHost.SurfacePackage getSurfacePackage ()

Return a SurfacePackage for the root SurfaceControl of the embedded hierarchy. Rather than be directly reparented using SurfaceControl.Transaction this SurfacePackage should be passed to SurfaceView.setChildSurfacePackage which will not only reparent the Surface, but ensure the accessibility hierarchies are linked.

Returns
`SurfaceControlViewHost.SurfacePackage`	This value may be `null`.

getView

Added in API level 30

public View getView ()

Returns
`View`	The view passed to setView, or null if none has been passed.

relayout

Added in API level 30

public void relayout (SurfaceControlViewHost.LayoutParams attrs)

Modifies the LayoutParams of the root view.

Parameters
`attrs`	`SurfaceControlViewHost.LayoutParams`: This value cannot be `null`.

relayout

Added in API level 30

public void relayout (int width, 
                int height)

Modify the size of the root view.

Parameters
`width`	`int`: Width in pixels
`height`	`int`: Height in pixels

release

Added in API level 30

public void release ()

Trigger the tear down of the embedded view hierarchy and release the SurfaceControl. This will result in onDispatchedFromWindow being dispatched to the embedded view hierarchy and render the object unusable.

setView

Added in API level 30

public void setView (View view, 
                int width, 
                int height)

Set the root view of the SurfaceControlViewHost. This view will render in to the SurfaceControl, and receive input based on the SurfaceControls positioning on screen. It will be laid as if it were in a window of the passed in width and height.

Parameters
`view`	`View`: The View to add. This value cannot be `null`.
`width`	`int`: The width to layout the View within, in pixels.
`height`	`int`: The height to layout the View within, in pixels.

setView

Added in API level 30

public void setView (View view, 
                SurfaceControlViewHost.LayoutParams attrs)

Sets the root view of the SurfaceControlViewHost. This view will render in to the SurfaceControl, and receive input based on the SurfaceControl's positioning on screen. It will be laid out as if it were in a window of the passed in width and height.

Parameters
`view`	`View`: The `View` to add. This value cannot be `null`.
`attrs`	`SurfaceControlViewHost.LayoutParams`: The `LayoutParams` parameters for the `View`. This value cannot be `null`.

transferTouchGestureToHost

Added in API level 34
Deprecated in API level 35

public boolean transferTouchGestureToHost ()

This method was deprecated in API level 35.
Use WindowManager.transferTouchGesture(InputTransferToken, InputTransferToken) instead.

Transfer the currently in progress touch gesture to the parent (if any) of this SurfaceControlViewHost. This requires that the SurfaceControlViewHost was created with an associated host InputTransferToken.

Returns
`boolean`	Whether the touch stream was transferred.

Protected methods

finalize

protected void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Throws
`Throwable`

SurfaceControlViewHost

Summary

Nested classes

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

SurfaceControlViewHost

SurfaceControlViewHost

Public methods

getLayoutParams

getSurfacePackage

getView

relayout

relayout

release

setView

setView

transferTouchGestureToHost

Protected methods

finalize