Share via


TvInputService.Session.SetOverlayViewEnabled(Boolean) Method

Definition

Enables or disables the overlay view.

[Android.Runtime.Register("setOverlayViewEnabled", "(Z)V", "GetSetOverlayViewEnabled_ZHandler")]
public virtual void SetOverlayViewEnabled (bool enable);
[<Android.Runtime.Register("setOverlayViewEnabled", "(Z)V", "GetSetOverlayViewEnabled_ZHandler")>]
abstract member SetOverlayViewEnabled : bool -> unit
override this.SetOverlayViewEnabled : bool -> unit

Parameters

enable
Boolean

true if you want to enable the overlay view. false otherwise.

Attributes

Remarks

Enables or disables the overlay view.

By default, the overlay view is disabled. Must be called explicitly after the session is created to enable the overlay view.

The TV input service can disable its overlay view when the size of the overlay view is insufficient to display the whole information, such as when used in Picture-in-picture. Override #onOverlayViewSizeChanged to get the size of the overlay view, which then can be used to determine whether to enable/disable the overlay view.

Java documentation for android.media.tv.TvInputService.Session.setOverlayViewEnabled(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