Activity.SetShouldDockBigOverlays(Boolean) Method

Definition

Specifies a preference to dock big overlays like the expanded picture-in-picture on TV (see PictureInPictureParams.Builder#setExpandedAspectRatio).

[Android.Runtime.Register("setShouldDockBigOverlays", "(Z)V", "GetSetShouldDockBigOverlays_ZHandler", ApiSince=33)]
public virtual void SetShouldDockBigOverlays (bool shouldDockBigOverlays);
[<Android.Runtime.Register("setShouldDockBigOverlays", "(Z)V", "GetSetShouldDockBigOverlays_ZHandler", ApiSince=33)>]
abstract member SetShouldDockBigOverlays : bool -> unit
override this.SetShouldDockBigOverlays : bool -> unit

Parameters

shouldDockBigOverlays
Boolean

indicates that big overlays should be docked next to the activity instead of overlay its content

Attributes

Remarks

Specifies a preference to dock big overlays like the expanded picture-in-picture on TV (see PictureInPictureParams.Builder#setExpandedAspectRatio). Docking puts the big overlay side-by-side next to this activity, so that both windows are fully visible to the user.

If unspecified, whether the overlay window will be docked or not, will be defined by the system.

If specified, the system will try to respect the preference, but it may be overridden by a user preference.

Java documentation for android.app.Activity.setShouldDockBigOverlays(boolean).

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