Activity.EnterPictureInPictureMode Method

Definition

Namespace:: Android.App

Assembly:: Mono.Android.dll

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.

Overloads

Name	Description
EnterPictureInPictureMode()	Puts the activity in picture-in-picture mode if possible in the current system state.
EnterPictureInPictureMode(PictureInPictureParams)	Puts the activity in picture-in-picture mode if possible in the current system state.

EnterPictureInPictureMode()

Puts the activity in picture-in-picture mode if possible in the current system state.

[Android.Runtime.Register("enterPictureInPictureMode", "()V", "GetEnterPictureInPictureModeHandler", ApiSince=24)]
public virtual void EnterPictureInPictureMode();

[<Android.Runtime.Register("enterPictureInPictureMode", "()V", "GetEnterPictureInPictureModeHandler", ApiSince=24)>]
abstract member EnterPictureInPictureMode : unit -> unit
override this.EnterPictureInPictureMode : unit -> unit

Attributes: RegisterAttribute

Remarks

Puts the activity in picture-in-picture mode if possible in the current system state. Any prior calls to setPictureInPictureParams(PictureInPictureParams) will still apply when entering picture-in-picture through this call.

Applies to

EnterPictureInPictureMode(PictureInPictureParams)

Puts the activity in picture-in-picture mode if possible in the current system state.

[Android.Runtime.Register("enterPictureInPictureMode", "(Landroid/app/PictureInPictureParams;)Z", "GetEnterPictureInPictureMode_Landroid_app_PictureInPictureParams_Handler", ApiSince=26)]
public virtual bool EnterPictureInPictureMode(Android.App.PictureInPictureParams params);

[<Android.Runtime.Register("enterPictureInPictureMode", "(Landroid/app/PictureInPictureParams;)Z", "GetEnterPictureInPictureMode_Landroid_app_PictureInPictureParams_Handler", ApiSince=26)>]
abstract member EnterPictureInPictureMode : Android.App.PictureInPictureParams -> bool
override this.EnterPictureInPictureMode : Android.App.PictureInPictureParams -> bool

Parameters

params: PictureInPictureParams

PictureInPictureParams: non-null parameters to be combined with previously set parameters when entering picture-in-picture.

Returns

Boolean

true if the system successfully put this activity into picture-in-picture mode or was already in picture-in-picture mode (see isInPictureInPictureMode()). If the device does not support picture-in-picture, return false.

Attributes: RegisterAttribute

Remarks

Puts the activity in picture-in-picture mode if possible in the current system state. The set parameters in params will be combined with the parameters from prior calls to setPictureInPictureParams(PictureInPictureParams). The system may disallow entering picture-in-picture in various cases, including when the activity is not visible, if the screen is locked or if the user has an activity pinned. By default, system calculates the dimension of picture-in-picture window based on the given params. See Picture-in-picture Support on how to override this behavior.

Applies to