ProjectedDisplayController
class ProjectedDisplayController : AutoCloseable
Controller for the Projected device display.
Use create to create an instance of this class. Use close to clear the instance.
Summary
Nested types |
|---|
|
The PresentationMode represents how an app is currently able to present content to the user on a projected device. |
|
The PresentationModeFlags represents a collection of PresentationMode values that are currently active. |
Public companion functions |
|
|---|---|
suspend ProjectedDisplayController |
@RequiresApi(value = 34)Connects to the service providing features for Projected devices and returns the |
Public functions |
|
|---|---|
Unit |
Convenience function to set the flag bits as as per the |
Unit |
@ExperimentalProjectedApiAdds a callback to listen for updates to the PresentationModeFlags. |
open Unit |
close()Disconnects from the service providing features for Projected devices. |
Unit |
Convenience function to remove the flag bits as as per the |
Unit |
@ExperimentalProjectedApiRemove a listener to stop consuming |
Public companion functions
create
@RequiresApi(value = 34)
@ExperimentalProjectedApi
suspend fun create(activity: Activity): ProjectedDisplayController
Connects to the service providing features for Projected devices and returns the ProjectedDisplayController when the connection is established.
| Throws | |
|---|---|
kotlin.IllegalStateException |
if the projected service is not found or binding is not permitted |
kotlin.IllegalArgumentException |
if provided Activity is not running on a Projected device. |
Public functions
addLayoutParamsFlags
@ExperimentalProjectedApi
fun addLayoutParamsFlags(flags: Int): Unit
Convenience function to set the flag bits as as per the android.view.WindowManager.LayoutParams flags. Flags will be cleared automatically after the app stops.
Supported flags:
-
Note: Keeping the device's screen on can drain the battery quickly. Ordinarily, you should let the device turn the screen off if the user is not interacting with it. If you do need to keep the screen on, do so for as short a time as possible.
If an unsupported flag is passed, this method does nothing.
addPresentationModeChangedListener
@ExperimentalProjectedApi
@RequiresApi(value = 24)
fun addPresentationModeChangedListener(
executor: Executor = Dispatchers.Main.asExecutor(),
listener: Consumer<ProjectedDisplayController.PresentationModeFlags>
): Unit
Adds a callback to listen for updates to the PresentationModeFlags.
The PresentationMode represents how a content is being presented to a projected application (e.g. are visuals on). The callback will be called with the current state as soon as it is available. A listener cannot be added a second time without first being removed.
close
open fun close(): Unit
Disconnects from the service providing features for Projected devices. Methods from the ProjectedDisplayController shouldn't be called after this.
This method should be called in android.app.Activity.onDestroy.
removeLayoutParamsFlags
@ExperimentalProjectedApi
fun removeLayoutParamsFlags(flags: Int): Unit
Convenience function to remove the flag bits as as per the android.view.WindowManager.LayoutParams flags.
Supported flags:
If an unsupported flag is passed, this method does nothing.
removePresentationModeChangedListener
@ExperimentalProjectedApi
fun removePresentationModeChangedListener(
listener: Consumer<ProjectedDisplayController.PresentationModeFlags>
): Unit
Remove a listener to stop consuming PresentationModeFlags values. If the listener has already been removed then this is a no-op.