PictureInPictureParams.Builder.SetOverlayActions 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.

Sets the overlay actions and a primary overlay action.

[Android.Runtime.Register("setOverlayActions", "(Ljava/util/List;Landroid/app/RemoteAction;)Landroid/app/PictureInPictureParams$Builder;", "GetSetOverlayActions_Ljava_util_List_Landroid_app_RemoteAction_Handler", ApiSince=37)]
public virtual Android.App.PictureInPictureParams.Builder SetOverlayActions(System.Collections.Generic.IList<Android.App.RemoteAction>? overlayActions, Android.App.RemoteAction? primaryOverlayAction);

[<Android.Runtime.Register("setOverlayActions", "(Ljava/util/List;Landroid/app/RemoteAction;)Landroid/app/PictureInPictureParams$Builder;", "GetSetOverlayActions_Ljava_util_List_Landroid_app_RemoteAction_Handler", ApiSince=37)>]
abstract member SetOverlayActions : System.Collections.Generic.IList<Android.App.RemoteAction> * Android.App.RemoteAction -> Android.App.PictureInPictureParams.Builder
override this.SetOverlayActions : System.Collections.Generic.IList<Android.App.RemoteAction> * Android.App.RemoteAction -> Android.App.PictureInPictureParams.Builder

Parameters

overlayActions: IList<RemoteAction>

The actions to show in the picture-in-picture window overlay. Typically, for a media app, this action list can contain a Call-To-Action (CTA) and Skip action. This value may be null.

primaryOverlayAction: RemoteAction

The action to be used as the primary action in the picture-in-picture window overlay. This action MUST be one of the actions set via overlayActions. For instance, a media app can use this to highlight a Call-to-Action (CTA) button while an ad is playing. This value may be null.

Returns

PictureInPictureParams.Builder

this builder instance. This value cannot be null.

Attributes: RegisterAttribute

Remarks

Sets the overlay actions and a primary overlay action. If there are more than Activity.getMaxNumPictureInPictureOverlayActions() actions, then the input list will be truncated to that number.

Unlike the standard actions set via setActions(List), these actions are rendered prominently as an overlay and are visible without requiring the user to tap on the window to reveal the menu.

Android reference for android.app.PictureInPictureParams.Builder.setOverlayActions.

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.

Applies to