SurfaceControlViewHost.SurfacePackage Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Package encapsulating a Surface hierarchy which contains interactive view elements.
[Android.Runtime.Register("android/view/SurfaceControlViewHost$SurfacePackage", ApiSince=30, DoNotGenerateAcw=true)]
public sealed class SurfaceControlViewHost.SurfacePackage : Java.Lang.Object, Android.OS.IParcelable, IDisposable[<Android.Runtime.Register("android/view/SurfaceControlViewHost$SurfacePackage", ApiSince=30, DoNotGenerateAcw=true)>]
type SurfaceControlViewHost.SurfacePackage = class
inherit Object
interface IParcelable
interface IJavaObject
interface IDisposable
interface IJavaPeerable- Inheritance
- Attributes
- Implements
Remarks
Package encapsulating a Surface hierarchy which contains interactive view elements. It's expected to get this object from SurfaceControlViewHost#getSurfacePackage afterwards it can be embedded within a SurfaceView by calling SurfaceView#setChildSurfacePackage.
Note that each SurfacePackage must be released by calling SurfacePackage#release. However, if you use the recommended flow, the framework will automatically handle the lifetime for you.
1. When sending the package to the remote process, return it from an AIDL method or manually use FLAG_WRITE_RETURN_VALUE in writeToParcel. This will automatically release the package in the local process. 2. In the remote process, consume the package using SurfaceView. This way the SurfaceView will take over the lifetime and call SurfacePackage#release for the user.
One final note: The SurfacePackage lifetime is totally de-coupled from the lifetime of the underlying SurfaceControlViewHost. Regardless of the lifetime of the package the user should still call SurfaceControlViewHost#release when finished.
Java documentation for android.view.SurfaceControlViewHost.SurfacePackage.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Constructors
| Name | Description |
|---|---|
| SurfaceControlViewHost.SurfacePackage(SurfaceControlViewHost+SurfacePackage) |
Constructs a copy of SurfacePackage with an independent lifetime. The caller can use this to create an independent copy in situations where ownership of the SurfacePackage would be transferred elsewhere, such as attaching to a SurfaceView , returning as Binder result value, etc. The caller is responsible for releasing this copy when its done. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| Creator |
Gets the Parcelable creator used to reconstruct this type from a Parcel. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| InputTransferToken |
Gets an |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState | (Inherited from JavaObject) |
| JniPeerMembers |
Gets the JNI peer metadata used by the .NET for Android binding runtime. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| SurfaceControl |
Returns the |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
Methods
| Name | Description |
|---|---|
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| DescribeContents() |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int) , the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() | (Inherited from JavaObject) |
| Equals(Object) | (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Obsolete.
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| NotifyConfigurationChanged(Configuration) |
Forward a configuration to the remote SurfaceControlViewHost. |
| NotifyDetachedFromWindow() |
Tear down the remote SurfaceControlViewHost and cause View#onDetachedFromWindow to be invoked on the other side. |
| Release() |
Release the |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| WriteToParcel(Parcel, ParcelableWriteFlags) |
Writes this object's contents to the destination Parcel. |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() | (Inherited from JavaObject) |
| IJavaPeerable.Finalized() | (Inherited from JavaObject) |
| IJavaPeerable.JniObjectReferenceControlBlock | (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from JavaObject) |
| IJavaPeerable.UnregisterFromRuntime() | |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |