Share via


PictureInPictureUiState.IsStashed Property

Definition

Returns whether Picture-in-Picture is stashed or not.

public bool IsStashed { [Android.Runtime.Register("isStashed", "()Z", "", ApiSince=31)] get; }
[<get: Android.Runtime.Register("isStashed", "()Z", "", ApiSince=31)>]
member this.IsStashed : bool

Property Value

Attributes

Remarks

Returns whether Picture-in-Picture is stashed or not. A stashed PiP means it is only partially visible to the user, with some parts of it being off-screen. This is usually an UI state that is triggered by the user, such as flinging the PiP to the edge or letting go of PiP while dragging partially off-screen.

Developers can use this in conjunction with Activity#onPictureInPictureUiStateChanged(PictureInPictureUiState) to get a signal when the PiP stash state has changed. For example, if the state changed from false to true, developers can choose to temporarily pause video playback if PiP is of video content. Vice versa, if changing from true to false and video content is paused, developers can resumevideo playback.

Java documentation for android.app.PictureInPictureUiState.isStashed().

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