ContentLauncherCommands

interface ContentLauncherCommands

Known direct subclasses
ContentLauncher

API for the ContentLauncher trait.


Summary

Public functions

suspend ContentLauncherTrait.LaunchContentCommand.Response

Launch the specified content.

suspend ContentLauncherTrait.LaunchUrlCommand.Response

Launch content from the specified URL.

Public functions

launchContent

suspend fun launchContent(
    search: ContentLauncherTrait.ContentSearchStruct,
    autoPlay: Boolean,
    optionalArgs: ContentLauncherTrait.LaunchContentCommand.OptionalArgs.() -> Unit = {}
): ContentLauncherTrait.LaunchContentCommand.Response

Launch the specified content.

Parameters
search: ContentLauncherTrait.ContentSearchStruct

The content to launch.

autoPlay: Boolean

Set to true to have the matching content play automatically.

optionalArgs: ContentLauncherTrait.LaunchContentCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

Returns
ContentLauncherTrait.LaunchContentCommand.Response

The outcome of the LaunchContent command.

launchUrl

suspend fun launchUrl(contentUrl: String, optionalArgs: ContentLauncherTrait.LaunchUrlCommand.OptionalArgs.() -> Unit = {}): ContentLauncherTrait.LaunchUrlCommand.Response

Launch content from the specified URL.

Parameters
contentUrl: String

The URL of the content to launch.

optionalArgs: ContentLauncherTrait.LaunchUrlCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

Returns
ContentLauncherTrait.LaunchUrlCommand.Response

The outcome of the LaunchUrl command.