Language

PictureInPictureParams Class

Definition

Represents a set of parameters used to initialize and update an Activity in picture-in-picture mode.

[Android.Runtime.Register("android/app/PictureInPictureParams", ApiSince=26, DoNotGenerateAcw=true)]
public sealed class PictureInPictureParams : Java.Lang.Object, Android.OS.IParcelable, IDisposable
[<Android.Runtime.Register("android/app/PictureInPictureParams", ApiSince=26, DoNotGenerateAcw=true)>]
type PictureInPictureParams = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
Inheritance
PictureInPictureParams
Attributes
Implements

Remarks

Represents a set of parameters used to initialize and update an Activity in picture-in-picture mode.

Android reference for android.app.PictureInPictureParams.

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.

Properties

Name Description
Actions

Returns the list of user actions that are associated with the activity when in picture-in-picture mode.

AspectRatio

Returns the expected aspect ratio of the picture-in-picture window.

Class

Returns the runtime class of this Object.

(Inherited from Object)
CloseAction

Returns the action that is to replace the system close action.

Creator

Gets the creator that reconstructs picture-in-picture parameters from a parcel.

ExpandedAspectRatio

Returns the desired aspect ratio of the expanded picture-in-picture window.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
IsAutoEnterEnabled

Returns whether auto enter picture-in-picture is enabled.

IsSeamlessResizeEnabled

Returns whether seamless resize is enabled.

JniIdentityHashCode

Gets the identity hash code assigned to this Java peer by the interop runtime.

(Inherited from Object)
JniManagedPeerState

Gets the state flags last assigned by the runtime.

(Inherited from JavaObject)
JniPeerMembers

Provides JNI binding infrastructure for Android.App.PictureInPictureParams.

OverlayActions

Returns the set of overlay actions that are associated with the activity when in picture-in-picture mode.

PeerReference

Gets the JNI object reference for this Java peer.

(Inherited from Object)
PrimaryAction

Returns the action that is to be used as the primary action in the PiP menu.

PrimaryOverlayAction

Returns the primary overlay action that is associated with the activity when in picture-in-picture mode.

SourceRectHint

Returns the source rect hint.

Subtitle

Gets the subtitle supplied for the picture-in-picture window.

SubtitleFormatted

Returns the subtitle of the picture-in-picture window that may be displayed to the user.

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)
Title

Gets the title supplied for the picture-in-picture window.

TitleFormatted

Returns the title of the picture-in-picture window that may be displayed to the user.

Methods

Name Description
Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions)

Delegates construction of this peer to the runtime's value manager.

(Inherited from JavaObject)
DescribeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

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()

Asks the value manager to dispose this peer unless its mapping retains this same managed instance.

(Inherited from JavaObject)
Equals(Object)

Tests whether another managed peer refers to the same Java 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)
SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

Stores a reference value in the control block without creating a JNI reference copy.

(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 notified or interrupted.

(Inherited from Object)
Wait(Int64, Int32)

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.

(Inherited from Object)
Wait(Int64)

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.

(Inherited from Object)
WriteToParcel(Parcel, ParcelableWriteFlags)

Flatten this object in to a Parcel.

Explicit Interface Implementations

Name Description
IJavaPeerable.Disposed()

Marks this peer as disposed and calls Dispose with disposing set to true.

(Inherited from JavaObject)
IJavaPeerable.Finalized()

Marks this peer as disposed and calls Dispose with disposing set to false.

(Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

Gets the native control-block pointer used by this peer.

(Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

Stores the identity hash code supplied by the runtime.

(Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

Replaces the stored managed peer state flags.

(Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

Updates the peer reference and releases a disposed peer's control block when the reference is invalid.

(Inherited from JavaObject)
IJavaPeerable.UnregisterFromRuntime()

Removes this instance from the runtime's Java object lookup.

Extension Methods

Name Description
GetJniTypeName(IJavaPeerable)

Gets the JNI name of the type of the instance self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)

Reuses a compatible managed peer or obtains a wrapper of the requested type.

TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to