# ContentLauncherCommands

# ContentLauncherCommands


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ContentLauncherCommands
```

<br />

Known direct subclasses [ContentLauncher](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncher)

|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncher` | API for the ContentLauncher trait. |

*** ** * ** ***

Commands for the ContentLauncher trait.

## Summary

| ### Public functions |
|---|---|
| `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchContentCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherCommands#launchContent(com.google.home.matter.standard.ContentLauncherTrait.ContentSearchStruct,kotlin.Boolean,kotlin.Function1)( search: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.ContentSearchStruct, autoPlay: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchContentCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` Launch the specified content. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchContentCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherCommands#launchContentBatchable(com.google.home.matter.standard.ContentLauncherTrait.ContentSearchStruct,kotlin.Boolean,kotlin.Function1)( search: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.ContentSearchStruct, autoPlay: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchContentCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherCommands#launchContent(com.google.home.matter.standard.ContentLauncherTrait.ContentSearchStruct,kotlin.Boolean,kotlin.Function1)` command. |
| `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchUrlCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherCommands#launchUrl(kotlin.String,kotlin.Function1)(contentUrl: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchUrlCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Launch content from the specified URL. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchUrlCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherCommands#launchUrlBatchable(kotlin.String,kotlin.Function1)(contentUrl: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchUrlCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherCommands#launchUrl(kotlin.String,kotlin.Function1)` command. |

## 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: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.ContentSearchStruct` | The content to launch. |
| `autoPlay: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | Set to `true` to have the matching content play automatically. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchContentCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchContentCommand.Response` | The outcome of the `LaunchContent` command. |

### launchContentBatchable

```
fun launchContentBatchable(
    search: ContentLauncherTrait.ContentSearchStruct,
    autoPlay: Boolean,
    optionalArgs: ContentLauncherTrait.LaunchContentCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<ContentLauncherTrait.LaunchContentCommand.Response>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherCommands#launchContent(com.google.home.matter.standard.ContentLauncherTrait.ContentSearchStruct,kotlin.Boolean,kotlin.Function1)` command.

Launch the specified content.

| Parameters |
|---|---|
| `search: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.ContentSearchStruct` | The content to launch. |
| `autoPlay: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | Set to `true` to have the matching content play automatically. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchContentCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchContentCommand.Response>` | BatchableCommand |

### launchUrl

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

Launch content from the specified URL.

| Parameters |
|---|---|
| `contentUrl: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | The URL of the content to launch. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchUrlCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchUrlCommand.Response` | The outcome of the `LaunchUrl` command. |

### launchUrlBatchable

```
fun launchUrlBatchable(contentUrl: String, optionalArgs: ContentLauncherTrait.LaunchUrlCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<ContentLauncherTrait.LaunchUrlCommand.Response>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherCommands#launchUrl(kotlin.String,kotlin.Function1)` command.

Launch content from the specified URL.

| Parameters |
|---|---|
| `contentUrl: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | The URL of the content to launch. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchUrlCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ContentLauncherTrait.LaunchUrlCommand.Response>` | BatchableCommand |