MediaProjection.Callback.OnStop Method

Definition

Called when the MediaProjection session has been stopped and is no longer valid.

[Android.Runtime.Register("onStop", "()V", "GetOnStopHandler")]
public virtual void OnStop();
[<Android.Runtime.Register("onStop", "()V", "GetOnStopHandler")>]
abstract member OnStop : unit -> unit
override this.OnStop : unit -> unit
Attributes

Remarks

Called when the MediaProjection session has been stopped and is no longer valid.

Once a MediaProjection has been stopped, it's up to the application to release any resources it may be holding (e.g. releasing the VirtualDisplay and Surface). If the application is displaying any UI indicating the MediaProjection state it should be updated to indicate that MediaProjection is no longer active.

MediaProjection stopping can be a result of the system stopping the ongoing MediaProjection due to various reasons, such as another MediaProjection session starting, a user stopping the session via UI affordances in system-level UI, or the screen being locked.

After this callback any call to MediaProjection#createVirtualDisplay will fail, even if no such VirtualDisplay was ever created for this MediaProjection session.

Java documentation for android.media.projection.MediaProjection.Callback.onStop().

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