diff --git a/build.gradle.kts b/build.gradle.kts index 7ec44b61..f0ed91cb 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -14,6 +14,7 @@ dependencies { dokka(project(":core")) dokka(project(":devices")) dokka(project(":discover")) + dokka(project(":entertainment")) dokka(project(":events")) dokka(project(":grouped-lights")) dokka(project(":homekit")) diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/Arguments.kt b/cli/src/main/kotlin/inkapplications/shade/cli/Arguments.kt index 8fe60c61..b6a8050b 100644 --- a/cli/src/main/kotlin/inkapplications/shade/cli/Arguments.kt +++ b/cli/src/main/kotlin/inkapplications/shade/cli/Arguments.kt @@ -8,6 +8,8 @@ import com.github.ajalt.clikt.parameters.types.choice import com.github.ajalt.clikt.parameters.types.int import com.github.ajalt.colormath.Color import com.github.ajalt.colormath.parse +import inkapplications.shade.entertainment.parameters.ServiceLocationCreateParameters +import inkapplications.shade.entertainment.parameters.ServiceLocationUpdateParameters import inkapplications.shade.lights.structures.* import inkapplications.shade.structures.* import inkapplications.spondee.measure.ColorTemperature @@ -280,3 +282,54 @@ fun NullableOption.durations(): NullableOption, .map { it?.milliseconds } } } + + +/** + * Convert a string option into a list of service location create parameters. + * + * Format: id:x,y,z;id:x,y,z + * Example: abc-123:0.5,0.5,0.0;def-456:-0.5,0.5,0.0 + */ +fun NullableOption.entertainmentServiceLocations(): NullableOption, List> { + return convert { + it.split(";") + .map { location -> + val parts = location.split(":") + val id = parts[0].trim() + val coords = parts[1].split(",").map { c -> c.trim().toDouble() } + ServiceLocationCreateParameters( + service = ResourceReference( + id = ResourceId(id), + type = ResourceType.Entertainment, + ), + positions = listOf(Position(x = coords[0], y = coords[1], z = coords[2])), + ) + } + } +} + +/** + * Convert a string option into a list of service location update parameters. + * + * Format: id:x,y,z[:equalizationFactor];id:x,y,z[:equalizationFactor] + * Example: abc-123:0.5,0.5,0.0;def-456:-0.5,0.5,0.0:0.8 + */ +fun NullableOption.entertainmentServiceLocationsUpdate(): NullableOption, List> { + return convert { + it.split(";") + .map { location -> + val mainParts = location.split(":") + val id = mainParts[0].trim() + val coords = mainParts[1].split(",").map { c -> c.trim().toDouble() } + val equalizationFactor = if (mainParts.size > 2) mainParts[2].trim().toFloat() else null + ServiceLocationUpdateParameters( + service = ResourceReference( + id = ResourceId(id), + type = ResourceType.Entertainment, + ), + positions = listOf(Position(x = coords[0], y = coords[1], z = coords[2])), + equalizationFactor = equalizationFactor, + ) + } + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/Main.kt b/cli/src/main/kotlin/inkapplications/shade/cli/Main.kt index f8dee594..96ba2d52 100644 --- a/cli/src/main/kotlin/inkapplications/shade/cli/Main.kt +++ b/cli/src/main/kotlin/inkapplications/shade/cli/Main.kt @@ -7,6 +7,7 @@ import inkapplications.shade.cli.buttons.* import inkapplications.shade.cli.connection.AuthorizeCommand import inkapplications.shade.cli.connection.DiscoverCommand import inkapplications.shade.cli.devices.* +import inkapplications.shade.cli.entertainment.* import inkapplications.shade.cli.events.EventsCommand import inkapplications.shade.cli.groupedlights.GetGroupedLightCommand import inkapplications.shade.cli.groupedlights.ListGroupedLightsCommand @@ -26,10 +27,12 @@ class Main: NoOpCliktCommand() { init { subcommands( AuthorizeCommand, + CreateEntertainmentConfigurationCommand, CreateRoomCommand, CreateSceneCommand, CreateZoneCommand, DeleteDeviceCommand, + DeleteEntertainmentConfigurationCommand, DeleteRoomCommand, DeleteSceneCommand, DeleteZoneCommand, @@ -37,6 +40,7 @@ class Main: NoOpCliktCommand() { EventsCommand, GetButtonCommand, GetDeviceCommand, + GetEntertainmentConfigurationCommand, GetGroupedLightCommand, GetHomekitCommand, GetLightCommand, @@ -47,6 +51,8 @@ class Main: NoOpCliktCommand() { IdentifyDeviceCommand, ListButtonsCommand, ListDevicesCommand, + ListEntertainmentCommand, + ListEntertainmentConfigurationsCommand, ListGroupedLightsCommand, ListHomekitCommand, ListLightsCommand, @@ -57,6 +63,7 @@ class Main: NoOpCliktCommand() { ListZonesCommand, UpdateButtonCommand, UpdateDeviceCommand, + UpdateEntertainmentConfigurationCommand, UpdateGroupedLightCommand, UpdateHomekitCommand, UpdateLightCommand, diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/CreateEntertainmentConfigurationCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/CreateEntertainmentConfigurationCommand.kt new file mode 100644 index 00000000..732d972a --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/CreateEntertainmentConfigurationCommand.kt @@ -0,0 +1,54 @@ +package inkapplications.shade.cli.entertainment + +import com.github.ajalt.clikt.parameters.arguments.argument +import com.github.ajalt.clikt.parameters.options.option +import com.github.ajalt.clikt.parameters.types.enum +import inkapplications.shade.cli.AuthorizedShadeCommand +import inkapplications.shade.cli.entertainmentServiceLocations +import inkapplications.shade.entertainment.parameters.EntertainmentConfigurationCreateParameters +import inkapplications.shade.entertainment.parameters.EntertainmentLocationsCreateParameters +import inkapplications.shade.entertainment.structures.EntertainmentConfigurationMetadata +import inkapplications.shade.entertainment.structures.EntertainmentConfigurationType + +object CreateEntertainmentConfigurationCommand: AuthorizedShadeCommand( + help = "Create a new entertainment configuration on the Hue bridge" +) { + private val name by argument( + help = "A human-readable name for the entertainment configuration" + ) + + private val configurationType by argument( + help = "The type of entertainment configuration (screen, monitor, music, 3dspace, other)" + ).enum() + + private val serviceLocations by option( + help = "Service locations in format: id:x,y,z;id:x,y,z (e.g. abc-123:0.5,0.5,0.0;def-456:-0.5,0.5,0.0)" + ).entertainmentServiceLocations() + + override suspend fun runCommand(): Int { + val response = shade.entertainmentConfig.createConfiguration( + parameters = EntertainmentConfigurationCreateParameters( + metadata = EntertainmentConfigurationMetadata( + name = name, + ), + configurationType = configurationType.type, + locations = EntertainmentLocationsCreateParameters( + serviceLocations = serviceLocations.orEmpty(), + ), + ) + ) + + logger.debug("Got response: $response") + echo("Created entertainment configuration: ${response.id}") + + return 0 + } + + private enum class ConfigurationTypes(val type: EntertainmentConfigurationType) { + Screen(EntertainmentConfigurationType.Screen), + Monitor(EntertainmentConfigurationType.Monitor), + Music(EntertainmentConfigurationType.Music), + ThreeDSpace(EntertainmentConfigurationType.ThreeDSpace), + Other(EntertainmentConfigurationType.Other), + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/DeleteEntertainmentConfigurationCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/DeleteEntertainmentConfigurationCommand.kt new file mode 100644 index 00000000..9403950e --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/DeleteEntertainmentConfigurationCommand.kt @@ -0,0 +1,22 @@ +package inkapplications.shade.cli.entertainment + +import com.github.ajalt.clikt.parameters.arguments.argument +import inkapplications.shade.cli.AuthorizedShadeCommand +import inkapplications.shade.cli.resourceId + +object DeleteEntertainmentConfigurationCommand: AuthorizedShadeCommand( + help = "Delete an entertainment configuration from the Hue bridge" +) { + private val configurationId by argument( + help = "The ID of the entertainment configuration to delete" + ).resourceId() + + override suspend fun runCommand(): Int { + val response = shade.entertainmentConfig.deleteConfiguration(configurationId) + + logger.debug("Got response: $response") + echo("Deleted entertainment configuration: ${response.id}") + + return 0 + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/EntertainmentConfigurationOutput.kt b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/EntertainmentConfigurationOutput.kt new file mode 100644 index 00000000..063c8af5 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/EntertainmentConfigurationOutput.kt @@ -0,0 +1,32 @@ +package inkapplications.shade.cli.entertainment + +import com.github.ajalt.clikt.core.CliktCommand +import inkapplications.shade.entertainment.structures.EntertainmentConfiguration + +fun CliktCommand.echoEntertainmentConfiguration(config: EntertainmentConfiguration) { + echo("${config.id.value}:") + echo(" Name: ${config.metadata.name}") + echo(" Configuration Type: ${config.configurationType}") + echo(" Status: ${config.status}") + val activeStreamer = config.activeStreamer + if (activeStreamer != null) { + echo(" Active Streamer: $activeStreamer") + } + echo(" Stream Proxy Mode: ${config.streamProxy.mode}") + echo(" Stream Proxy Node: ${config.streamProxy.node}") + echo(" Channels:") + config.channels.forEach { channel -> + echo(" ${channel.channelId}:") + echo(" Position: (${channel.position.x}, ${channel.position.y}, ${channel.position.z})") + echo(" Members:") + channel.members.forEach { member -> + echo(" - ${member.service} [${member.index}]") + } + } + echo(" Locations:") + config.locations.serviceLocations.forEach { location -> + echo(" ${location.service}:") + echo(" Positions: ${location.positions.joinToString { "(${it.x}, ${it.y}, ${it.z})" }}") + echo(" Equalization Factor: ${location.equalizationFactor}") + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/EntertainmentOutput.kt b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/EntertainmentOutput.kt new file mode 100644 index 00000000..a27d686e --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/EntertainmentOutput.kt @@ -0,0 +1,29 @@ +package inkapplications.shade.cli.entertainment + +import com.github.ajalt.clikt.core.CliktCommand +import inkapplications.shade.entertainment.structures.Entertainment + +fun CliktCommand.echoEntertainment(entertainment: Entertainment) { + echo("${entertainment.id.value}:") + echo(" Owner: ${entertainment.owner}") + echo(" Renderer: ${entertainment.renderer}") + val renderReference = entertainment.rendererReference + if (renderReference != null) { + echo(" Renderer Reference: $renderReference") + } + echo(" Proxy: ${entertainment.proxy}") + echo(" Equalizer: ${entertainment.equalizer}") + val maxStreams = entertainment.maxStreams + if (maxStreams != null) { + echo(" Max Streams: $maxStreams") + } + entertainment.segments?.let { segments -> + echo(" Segments:") + echo(" Configurable: ${segments.configurable}") + echo(" Max Segments: ${segments.maxSegments}") + echo(" Ranges:") + segments.segmentRanges.forEach { range -> + echo(" - ${range.first}:${range.last}") + } + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/GetEntertainmentConfigurationCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/GetEntertainmentConfigurationCommand.kt new file mode 100644 index 00000000..3e397943 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/GetEntertainmentConfigurationCommand.kt @@ -0,0 +1,20 @@ +package inkapplications.shade.cli.entertainment + +import com.github.ajalt.clikt.parameters.arguments.argument +import inkapplications.shade.cli.AuthorizedShadeCommand +import inkapplications.shade.cli.resourceId + +object GetEntertainmentConfigurationCommand: AuthorizedShadeCommand( + help = "Get data for a specific entertainment configuration" +) { + private val configurationId by argument().resourceId() + + override suspend fun runCommand(): Int { + val configuration = shade.entertainmentConfig.getConfiguration(configurationId) + + logger.debug("Got Entertainment Configuration: $configuration") + echoEntertainmentConfiguration(configuration) + + return 0 + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/ListEntertainmentCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/ListEntertainmentCommand.kt new file mode 100644 index 00000000..278c81fd --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/ListEntertainmentCommand.kt @@ -0,0 +1,17 @@ +package inkapplications.shade.cli.entertainment + +import inkapplications.shade.cli.AuthorizedShadeCommand + +object ListEntertainmentCommand: AuthorizedShadeCommand( + help = "Get all of the entertainment resources configured on the Hue bridge" +) { + override suspend fun runCommand(): Int { + val entertainmentResources = shade.entertainment.listEntertainment() + + logger.debug("Got Entertainment: $entertainmentResources") + entertainmentResources.forEach(::echoEntertainment) + + return 0 + } +} + diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/ListEntertainmentConfigurationsCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/ListEntertainmentConfigurationsCommand.kt new file mode 100644 index 00000000..163eaa43 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/ListEntertainmentConfigurationsCommand.kt @@ -0,0 +1,16 @@ +package inkapplications.shade.cli.entertainment + +import inkapplications.shade.cli.AuthorizedShadeCommand + +object ListEntertainmentConfigurationsCommand: AuthorizedShadeCommand( + help = "Get all of the entertainment configurations on the Hue bridge" +) { + override suspend fun runCommand(): Int { + val configurations = shade.entertainmentConfig.listConfigurations() + + logger.debug("Got Entertainment Configurations: $configurations") + configurations.forEach(::echoEntertainmentConfiguration) + + return 0 + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/UpdateEntertainmentConfigurationCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/UpdateEntertainmentConfigurationCommand.kt new file mode 100644 index 00000000..8eba61c8 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/entertainment/UpdateEntertainmentConfigurationCommand.kt @@ -0,0 +1,80 @@ +package inkapplications.shade.cli.entertainment + +import com.github.ajalt.clikt.parameters.arguments.argument +import com.github.ajalt.clikt.parameters.options.option +import com.github.ajalt.clikt.parameters.types.enum +import inkapplications.shade.cli.AuthorizedShadeCommand +import inkapplications.shade.cli.entertainmentServiceLocationsUpdate +import inkapplications.shade.cli.resourceId +import inkapplications.shade.entertainment.parameters.EntertainmentConfigurationUpdateParameters +import inkapplications.shade.entertainment.parameters.EntertainmentLocationsUpdateParameters +import inkapplications.shade.entertainment.structures.EntertainmentConfigurationAction +import inkapplications.shade.entertainment.structures.EntertainmentConfigurationMetadata +import inkapplications.shade.entertainment.structures.EntertainmentConfigurationType + +object UpdateEntertainmentConfigurationCommand: AuthorizedShadeCommand( + help = "Update an existing entertainment configuration on the Hue bridge" +) { + private val configurationId by argument( + help = "The ID of the entertainment configuration to update" + ).resourceId() + + private val name by option( + help = "A human-readable name for the entertainment configuration" + ) + + private val configurationType by option( + help = "The type of entertainment configuration (screen, monitor, music, 3dspace, other)" + ).enum() + + private val action by option( + help = "Action to control streaming (start, stop)" + ).enum() + + private val serviceLocations by option( + help = "Service locations in format: id:x,y,z[:equalizationFactor];id:x,y,z[:equalizationFactor] (e.g. abc-123:0.5,0.5,0.0;def-456:-0.5,0.5,0.0:0.8)" + ).entertainmentServiceLocationsUpdate() + + override suspend fun runCommand(): Int { + val metadata = if (name != null) { + EntertainmentConfigurationMetadata(name = name!!) + } else { + null + } + + val locations = if (serviceLocations != null) { + EntertainmentLocationsUpdateParameters(serviceLocations = serviceLocations!!) + } else { + null + } + + val response = shade.entertainmentConfig.updateConfiguration( + id = configurationId, + parameters = EntertainmentConfigurationUpdateParameters( + metadata = metadata, + configurationType = configurationType?.type, + action = action?.action, + locations = locations, + ) + ) + + logger.debug("Got response: $response") + echo("Updated entertainment configuration: ${response.id}") + + return 0 + } + + private enum class ConfigurationTypes(val type: EntertainmentConfigurationType) { + Screen(EntertainmentConfigurationType.Screen), + Monitor(EntertainmentConfigurationType.Monitor), + Music(EntertainmentConfigurationType.Music), + ThreeDSpace(EntertainmentConfigurationType.ThreeDSpace), + Other(EntertainmentConfigurationType.Other), + } + + private enum class StreamActions(val action: EntertainmentConfigurationAction) { + Start(EntertainmentConfigurationAction.Start), + Stop(EntertainmentConfigurationAction.Stop), + } +} + diff --git a/core/api/core.api b/core/api/core.api index f128c073..16abe835 100644 --- a/core/api/core.api +++ b/core/api/core.api @@ -11,6 +11,8 @@ public final class inkapplications/shade/core/Shade { public final fun getButtons ()Linkapplications/shade/button/ButtonControls; public final fun getConfiguration ()Linkapplications/shade/structures/HueConfigurationContainer; public final fun getDevices ()Linkapplications/shade/devices/DeviceControls; + public final fun getEntertainment ()Linkapplications/shade/entertainment/EntertainmentControls; + public final fun getEntertainmentConfig ()Linkapplications/shade/entertainment/EntertainmentConfigurationControls; public final fun getGroupedLights ()Linkapplications/shade/groupedlights/GroupedLightControls; public final fun getHomekit ()Linkapplications/shade/homekit/HomekitControls; public final fun getLightLevels ()Linkapplications/shade/lightlevel/LightLevelControls; diff --git a/core/build.gradle.kts b/core/build.gradle.kts index 8735e248..ef4363b6 100644 --- a/core/build.gradle.kts +++ b/core/build.gradle.kts @@ -11,6 +11,7 @@ kotlin { api(projects.auth) api(projects.button) api(projects.discover) + api(projects.entertainment) api(projects.devices) api(projects.events) api(projects.groupedLights) diff --git a/core/src/commonMain/kotlin/inkapplications/shade/core/Shade.kt b/core/src/commonMain/kotlin/inkapplications/shade/core/Shade.kt index 7d764954..ea207b6d 100644 --- a/core/src/commonMain/kotlin/inkapplications/shade/core/Shade.kt +++ b/core/src/commonMain/kotlin/inkapplications/shade/core/Shade.kt @@ -4,6 +4,7 @@ import inkapplications.shade.auth.AuthModule import inkapplications.shade.button.ShadeButtonsModule import inkapplications.shade.devices.ShadeDevicesModule import inkapplications.shade.discover.DiscoverModule +import inkapplications.shade.entertainment.ShadeEntertainmentModule import inkapplications.shade.events.EventsModule import inkapplications.shade.groupedlights.ShadeGroupedLightsModule import inkapplications.shade.homekit.ShadeHomekitModule @@ -46,6 +47,7 @@ class Shade( configurationContainer = configuration, logger = logger, ) + private val entertainmentModule = ShadeEntertainmentModule(internalsModule) internal val eventsModule = EventsModule(internalsModule, logger) val onlineDiscovery = DiscoverModule().onlineDiscovery @@ -55,6 +57,8 @@ class Shade( ).bridgeAuth val buttons = ShadeButtonsModule(internalsModule).buttons val devices = ShadeDevicesModule(internalsModule).devices + val entertainment = entertainmentModule.entertainment + val entertainmentConfig = entertainmentModule.configurations val lights = ShadeLightsModule(internalsModule, eventsModule).lights val lightLevels = ShadeLightLevelModule(internalsModule).lightLevels val rooms = ShadeRoomsModule(internalsModule).rooms diff --git a/docs/reference/latest/auth/navigation.html b/docs/reference/latest/auth/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/auth/navigation.html +++ b/docs/reference/latest/auth/navigation.html @@ -224,6 +224,166 @@ +
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/button/navigation.html b/docs/reference/latest/button/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/button/navigation.html +++ b/docs/reference/latest/button/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/core/inkapplications.shade.core/-shade/entertainment-config.html b/docs/reference/latest/core/inkapplications.shade.core/-shade/entertainment-config.html new file mode 100644 index 00000000..45801b81 --- /dev/null +++ b/docs/reference/latest/core/inkapplications.shade.core/-shade/entertainment-config.html @@ -0,0 +1,118 @@ + + + + + entertainmentConfig + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

entertainmentConfig

+
+ +
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/core/inkapplications.shade.core/-shade/entertainment.html b/docs/reference/latest/core/inkapplications.shade.core/-shade/entertainment.html new file mode 100644 index 00000000..5280ff94 --- /dev/null +++ b/docs/reference/latest/core/inkapplications.shade.core/-shade/entertainment.html @@ -0,0 +1,118 @@ + + + + + entertainment + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

entertainment

+
+ +
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/core/inkapplications.shade.core/-shade/index.html b/docs/reference/latest/core/inkapplications.shade.core/-shade/index.html index 1b981bce..2f6ea417 100644 --- a/docs/reference/latest/core/inkapplications.shade.core/-shade/index.html +++ b/docs/reference/latest/core/inkapplications.shade.core/-shade/index.html @@ -188,6 +188,36 @@

Properties

+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
diff --git a/docs/reference/latest/core/navigation.html b/docs/reference/latest/core/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/core/navigation.html +++ b/docs/reference/latest/core/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/devices/navigation.html b/docs/reference/latest/devices/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/devices/navigation.html +++ b/docs/reference/latest/devices/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/discover/navigation.html b/docs/reference/latest/discover/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/discover/navigation.html +++ b/docs/reference/latest/discover/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/entertainment/index.html b/docs/reference/latest/entertainment/index.html new file mode 100644 index 00000000..f756d946 --- /dev/null +++ b/docs/reference/latest/entertainment/index.html @@ -0,0 +1,173 @@ + + + + + entertainment + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

entertainment

+
+

Packages

+
+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
common
+
+
+
+
+
+
+ +
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
common
+
+
+
+
+
+
+ +
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
common
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/-entertainment-configuration-create-parameters.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/-entertainment-configuration-create-parameters.html new file mode 100644 index 00000000..880756f3 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/-entertainment-configuration-create-parameters.html @@ -0,0 +1,118 @@ + + + + + EntertainmentConfigurationCreateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationCreateParameters

+
+ +
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/configuration-type.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/configuration-type.html new file mode 100644 index 00000000..5764b5c7 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/configuration-type.html @@ -0,0 +1,118 @@ + + + + + configurationType + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

configurationType

+
+
@SerialName(value = "configuration_type")
val configurationType: EntertainmentConfigurationType

Defines for which type of application this channel assignment was optimized.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/index.html new file mode 100644 index 00000000..7c0bd0ba --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/index.html @@ -0,0 +1,206 @@ + + + + + EntertainmentConfigurationCreateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationCreateParameters

+

Data used for creating a new entertainment configuration via the bridge.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "configuration_type")
val configurationType: EntertainmentConfigurationType

Defines for which type of application this channel assignment was optimized.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Entertainment service locations for lights in the zone.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Metadata containing the friendly name of the entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "stream_proxy")
val streamProxy: StreamProxyCreateParameters?

Stream proxy configuration for this entertainment group.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/locations.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/locations.html new file mode 100644 index 00000000..30340181 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/locations.html @@ -0,0 +1,118 @@ + + + + + locations + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

locations

+
+

Entertainment service locations for lights in the zone.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/metadata.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/metadata.html new file mode 100644 index 00000000..e59c4d49 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/metadata.html @@ -0,0 +1,118 @@ + + + + + metadata + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

metadata

+
+

Metadata containing the friendly name of the entertainment configuration.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/stream-proxy.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/stream-proxy.html new file mode 100644 index 00000000..90e0a327 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-create-parameters/stream-proxy.html @@ -0,0 +1,118 @@ + + + + + streamProxy + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

streamProxy

+
+
@SerialName(value = "stream_proxy")
val streamProxy: StreamProxyCreateParameters?

Stream proxy configuration for this entertainment group.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/-entertainment-configuration-update-parameters.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/-entertainment-configuration-update-parameters.html new file mode 100644 index 00000000..df526e19 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/-entertainment-configuration-update-parameters.html @@ -0,0 +1,118 @@ + + + + + EntertainmentConfigurationUpdateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationUpdateParameters

+
+
constructor(metadata: EntertainmentConfigurationMetadata? = null, configurationType: EntertainmentConfigurationType? = null, action: EntertainmentConfigurationAction? = null, streamProxy: StreamProxyCreateParameters? = null, locations: EntertainmentLocationsUpdateParameters? = null)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/action.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/action.html new file mode 100644 index 00000000..577066ba --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/action.html @@ -0,0 +1,118 @@ + + + + + action + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

action

+
+

Action to control streaming.

If status is "inactive" -> write start to start streaming. If status is "active" -> write "stop" to end the current streaming. In order to start streaming when other application is already streaming, first write "stop" and then "start".

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/configuration-type.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/configuration-type.html new file mode 100644 index 00000000..53198300 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/configuration-type.html @@ -0,0 +1,118 @@ + + + + + configurationType + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

configurationType

+
+
@SerialName(value = "configuration_type")
val configurationType: EntertainmentConfigurationType?

Defines for which type of application this channel assignment was optimized.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/index.html new file mode 100644 index 00000000..739cb846 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/index.html @@ -0,0 +1,221 @@ + + + + + EntertainmentConfigurationUpdateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationUpdateParameters

+
@Serializable
data class EntertainmentConfigurationUpdateParameters(val metadata: EntertainmentConfigurationMetadata? = null, val configurationType: EntertainmentConfigurationType? = null, val action: EntertainmentConfigurationAction? = null, val streamProxy: StreamProxyCreateParameters? = null, val locations: EntertainmentLocationsUpdateParameters? = null)

Data used for updating an existing entertainment configuration via the bridge.

All properties are optional - only the specified fields will be updated.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(metadata: EntertainmentConfigurationMetadata? = null, configurationType: EntertainmentConfigurationType? = null, action: EntertainmentConfigurationAction? = null, streamProxy: StreamProxyCreateParameters? = null, locations: EntertainmentLocationsUpdateParameters? = null)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Action to control streaming.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "configuration_type")
val configurationType: EntertainmentConfigurationType?

Defines for which type of application this channel assignment was optimized.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Entertainment service locations for lights in the zone.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Metadata containing the friendly name of the entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "stream_proxy")
val streamProxy: StreamProxyCreateParameters?

Stream proxy configuration for this entertainment group.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/locations.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/locations.html new file mode 100644 index 00000000..04ede927 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/locations.html @@ -0,0 +1,118 @@ + + + + + locations + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

locations

+
+

Entertainment service locations for lights in the zone.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/metadata.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/metadata.html new file mode 100644 index 00000000..90e34e96 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/metadata.html @@ -0,0 +1,118 @@ + + + + + metadata + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

metadata

+
+

Metadata containing the friendly name of the entertainment configuration.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/stream-proxy.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/stream-proxy.html new file mode 100644 index 00000000..dba703ca --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-configuration-update-parameters/stream-proxy.html @@ -0,0 +1,118 @@ + + + + + streamProxy + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

streamProxy

+
+
@SerialName(value = "stream_proxy")
val streamProxy: StreamProxyCreateParameters?

Stream proxy configuration for this entertainment group.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-create-parameters/-entertainment-locations-create-parameters.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-create-parameters/-entertainment-locations-create-parameters.html new file mode 100644 index 00000000..be177460 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-create-parameters/-entertainment-locations-create-parameters.html @@ -0,0 +1,118 @@ + + + + + EntertainmentLocationsCreateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentLocationsCreateParameters

+
+
constructor(serviceLocations: List<ServiceLocationCreateParameters>)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-create-parameters/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-create-parameters/index.html new file mode 100644 index 00000000..6a5bbfeb --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-create-parameters/index.html @@ -0,0 +1,161 @@ + + + + + EntertainmentLocationsCreateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentLocationsCreateParameters

+
@Serializable
data class EntertainmentLocationsCreateParameters(val serviceLocations: List<ServiceLocationCreateParameters>)

Entertainment service locations for creating an entertainment configuration.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(serviceLocations: List<ServiceLocationCreateParameters>)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "service_locations")
val serviceLocations: List<ServiceLocationCreateParameters>

List of service locations for lights in the entertainment zone.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-create-parameters/service-locations.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-create-parameters/service-locations.html new file mode 100644 index 00000000..3ff5ecb5 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-create-parameters/service-locations.html @@ -0,0 +1,118 @@ + + + + + serviceLocations + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

serviceLocations

+
+
@SerialName(value = "service_locations")
val serviceLocations: List<ServiceLocationCreateParameters>

List of service locations for lights in the entertainment zone.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-update-parameters/-entertainment-locations-update-parameters.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-update-parameters/-entertainment-locations-update-parameters.html new file mode 100644 index 00000000..7d9b0f8a --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-update-parameters/-entertainment-locations-update-parameters.html @@ -0,0 +1,118 @@ + + + + + EntertainmentLocationsUpdateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentLocationsUpdateParameters

+
+
constructor(serviceLocations: List<ServiceLocationUpdateParameters>)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-update-parameters/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-update-parameters/index.html new file mode 100644 index 00000000..f33593fa --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-update-parameters/index.html @@ -0,0 +1,161 @@ + + + + + EntertainmentLocationsUpdateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentLocationsUpdateParameters

+
@Serializable
data class EntertainmentLocationsUpdateParameters(val serviceLocations: List<ServiceLocationUpdateParameters>)

Entertainment service locations for updating an entertainment configuration.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(serviceLocations: List<ServiceLocationUpdateParameters>)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "service_locations")
val serviceLocations: List<ServiceLocationUpdateParameters>

List of service locations for lights in the entertainment zone.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-update-parameters/service-locations.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-update-parameters/service-locations.html new file mode 100644 index 00000000..ef7bfc63 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-entertainment-locations-update-parameters/service-locations.html @@ -0,0 +1,118 @@ + + + + + serviceLocations + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

serviceLocations

+
+
@SerialName(value = "service_locations")
val serviceLocations: List<ServiceLocationUpdateParameters>

List of service locations for lights in the entertainment zone.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/-service-location-create-parameters.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/-service-location-create-parameters.html new file mode 100644 index 00000000..f5d2f885 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/-service-location-create-parameters.html @@ -0,0 +1,118 @@ + + + + + ServiceLocationCreateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

ServiceLocationCreateParameters

+
+
constructor(service: ResourceReference, positions: List<Position>)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/index.html new file mode 100644 index 00000000..51299165 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/index.html @@ -0,0 +1,176 @@ + + + + + ServiceLocationCreateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

ServiceLocationCreateParameters

+
@Serializable
data class ServiceLocationCreateParameters(val service: ResourceReference, val positions: List<Position>)

Service location for creating an entertainment configuration.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(service: ResourceReference, positions: List<Position>)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Describes the location(s) of the service.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Reference to the entertainment service.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/positions.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/positions.html new file mode 100644 index 00000000..f0bd1827 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/positions.html @@ -0,0 +1,118 @@ + + + + + positions + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

positions

+
+

Describes the location(s) of the service.

Can contain 1-2 positions.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/service.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/service.html new file mode 100644 index 00000000..97380e46 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-create-parameters/service.html @@ -0,0 +1,118 @@ + + + + + service + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

service

+
+

Reference to the entertainment service.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/-service-location-update-parameters.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/-service-location-update-parameters.html new file mode 100644 index 00000000..785410eb --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/-service-location-update-parameters.html @@ -0,0 +1,118 @@ + + + + + ServiceLocationUpdateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

ServiceLocationUpdateParameters

+
+
constructor(service: ResourceReference, positions: List<Position>, equalizationFactor: Float? = null)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/equalization-factor.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/equalization-factor.html new file mode 100644 index 00000000..b3732bc3 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/equalization-factor.html @@ -0,0 +1,118 @@ + + + + + equalizationFactor + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

equalizationFactor

+
+
@SerialName(value = "equalization_factor")
val equalizationFactor: Float?

Relative equalization factor applied to the entertainment service, to compensate for differences in brightness in the entertainment configuration.

Value cannot be 0, writing 0 changes it to lowest possible value. Default value is 1, maximum is 1.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/index.html new file mode 100644 index 00000000..1ede12a8 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/index.html @@ -0,0 +1,191 @@ + + + + + ServiceLocationUpdateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

ServiceLocationUpdateParameters

+
@Serializable
data class ServiceLocationUpdateParameters(val service: ResourceReference, val positions: List<Position>, val equalizationFactor: Float? = null)

Service location for updating an entertainment configuration.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(service: ResourceReference, positions: List<Position>, equalizationFactor: Float? = null)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "equalization_factor")
val equalizationFactor: Float?

Relative equalization factor applied to the entertainment service, to compensate for differences in brightness in the entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Describes the location(s) of the service.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Reference to the entertainment service.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/positions.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/positions.html new file mode 100644 index 00000000..79059da2 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/positions.html @@ -0,0 +1,118 @@ + + + + + positions + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

positions

+
+

Describes the location(s) of the service.

Can contain 1-2 positions.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/service.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/service.html new file mode 100644 index 00000000..459f5dd5 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-service-location-update-parameters/service.html @@ -0,0 +1,118 @@ + + + + + service + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

service

+
+

Reference to the entertainment service.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/-stream-proxy-create-parameters.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/-stream-proxy-create-parameters.html new file mode 100644 index 00000000..d9153aa6 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/-stream-proxy-create-parameters.html @@ -0,0 +1,118 @@ + + + + + StreamProxyCreateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

StreamProxyCreateParameters

+
+
constructor(mode: StreamProxyMode, node: ResourceReference? = null)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/index.html new file mode 100644 index 00000000..8ad0fb93 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/index.html @@ -0,0 +1,176 @@ + + + + + StreamProxyCreateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

StreamProxyCreateParameters

+
@Serializable
data class StreamProxyCreateParameters(val mode: StreamProxyMode, val node: ResourceReference? = null)

Stream proxy configuration for creating an entertainment configuration.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(mode: StreamProxyMode, node: ResourceReference? = null)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Proxy mode used for this group.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Reference to the device acting as proxy.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/mode.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/mode.html new file mode 100644 index 00000000..68a1d69e --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/mode.html @@ -0,0 +1,118 @@ + + + + + mode + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

mode

+
+

Proxy mode used for this group.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/node.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/node.html new file mode 100644 index 00000000..8d8fb473 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/-stream-proxy-create-parameters/node.html @@ -0,0 +1,118 @@ + + + + + node + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

node

+
+

Reference to the device acting as proxy.

The proxy node relays entertainment traffic and should be located in or close to all entertainment lamps in this group. Writing this property sets the proxy mode to "manual". Can be a BridgeDevice or ZigbeeDevice type. Not allowed to be combined with mode "auto".

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/index.html new file mode 100644 index 00000000..ea7c594e --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.parameters/index.html @@ -0,0 +1,231 @@ + + + + + inkapplications.shade.entertainment.parameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Package-level declarations

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Data used for creating a new entertainment configuration via the bridge.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class EntertainmentConfigurationUpdateParameters(val metadata: EntertainmentConfigurationMetadata? = null, val configurationType: EntertainmentConfigurationType? = null, val action: EntertainmentConfigurationAction? = null, val streamProxy: StreamProxyCreateParameters? = null, val locations: EntertainmentLocationsUpdateParameters? = null)

Data used for updating an existing entertainment configuration via the bridge.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class EntertainmentLocationsCreateParameters(val serviceLocations: List<ServiceLocationCreateParameters>)

Entertainment service locations for creating an entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class EntertainmentLocationsUpdateParameters(val serviceLocations: List<ServiceLocationUpdateParameters>)

Entertainment service locations for updating an entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class ServiceLocationCreateParameters(val service: ResourceReference, val positions: List<Position>)

Service location for creating an entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class ServiceLocationUpdateParameters(val service: ResourceReference, val positions: List<Position>, val equalizationFactor: Float? = null)

Service location for updating an entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class StreamProxyCreateParameters(val mode: StreamProxyMode, val node: ResourceReference? = null)

Stream proxy configuration for creating an entertainment configuration.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/-entertainment-channel-id.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/-entertainment-channel-id.html new file mode 100644 index 00000000..a1fe447e --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/-entertainment-channel-id.html @@ -0,0 +1,118 @@ + + + + + EntertainmentChannelId + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentChannelId

+
+
constructor(value: Int)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/index.html new file mode 100644 index 00000000..fdfe2262 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/index.html @@ -0,0 +1,180 @@ + + + + + EntertainmentChannelId + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentChannelId

+
@Serializable
value class EntertainmentChannelId(val value: Int)

Identifier for an entertainment channel.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(value: Int)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val value: Int
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/to-string.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/to-string.html new file mode 100644 index 00000000..3a41afca --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/to-string.html @@ -0,0 +1,118 @@ + + + + + toString + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

toString

+
+
open override fun toString(): String
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/value.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/value.html new file mode 100644 index 00000000..ec72b1fe --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel-id/value.html @@ -0,0 +1,118 @@ + + + + + value + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

value

+
+
val value: Int
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/-entertainment-channel.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/-entertainment-channel.html new file mode 100644 index 00000000..95a6f18a --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/-entertainment-channel.html @@ -0,0 +1,118 @@ + + + + + EntertainmentChannel + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentChannel

+
+
constructor(channelId: EntertainmentChannelId, position: Position, members: List<SegmentReference>)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/channel-id.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/channel-id.html new file mode 100644 index 00000000..c85cede9 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/channel-id.html @@ -0,0 +1,118 @@ + + + + + channelId + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

channelId

+
+
@SerialName(value = "channel_id")
val channelId: EntertainmentChannelId

Channel identifier assigned by the bridge upon creation.

This is the number to be used by the HueStream API when addressing the channel.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/index.html new file mode 100644 index 00000000..2ca9adad --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/index.html @@ -0,0 +1,191 @@ + + + + + EntertainmentChannel + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentChannel

+
@Serializable
data class EntertainmentChannel(val channelId: EntertainmentChannelId, val position: Position, val members: List<SegmentReference>)

A channel in an entertainment configuration.

Each channel groups segments of one or different lights.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(channelId: EntertainmentChannelId, position: Position, members: List<SegmentReference>)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "channel_id")
val channelId: EntertainmentChannelId

Channel identifier assigned by the bridge upon creation.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

List of segment references that are members of this channel.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

XYZ position of this channel.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/members.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/members.html new file mode 100644 index 00000000..7d95ace9 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/members.html @@ -0,0 +1,118 @@ + + + + + members + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

members

+
+

List of segment references that are members of this channel.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/position.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/position.html new file mode 100644 index 00000000..3296b754 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-channel/position.html @@ -0,0 +1,118 @@ + + + + + position + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

position

+
+

XYZ position of this channel.

It is the average position of its members.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-companion/-start.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-companion/-start.html new file mode 100644 index 00000000..21f21bf8 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-companion/-start.html @@ -0,0 +1,118 @@ + + + + + Start + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Start

+
+

Start the entertainment stream.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-companion/-stop.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-companion/-stop.html new file mode 100644 index 00000000..c6a79d53 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-companion/-stop.html @@ -0,0 +1,118 @@ + + + + + Stop + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Stop

+
+

Stop the entertainment stream.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-companion/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-companion/index.html new file mode 100644 index 00000000..9e26e869 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-companion/index.html @@ -0,0 +1,157 @@ + + + + + Companion + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Companion

+
object Companion
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Start the entertainment stream.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Stop the entertainment stream.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-entertainment-configuration-action.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-entertainment-configuration-action.html new file mode 100644 index 00000000..622d4c88 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/-entertainment-configuration-action.html @@ -0,0 +1,118 @@ + + + + + EntertainmentConfigurationAction + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationAction

+
+
constructor(key: String)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/index.html new file mode 100644 index 00000000..f1c15476 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/index.html @@ -0,0 +1,199 @@ + + + + + EntertainmentConfigurationAction + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationAction

+
@Serializable
value class EntertainmentConfigurationAction(val key: String)

Action that can be taken on an entertainment configuration to control streaming.

If status is "inactive" -> write start to start streaming. Writing start when it's already active does not change the ownership of the streaming. If status is "active" -> write "stop" to end the current streaming. In order to start streaming when other application is already streaming, first write "stop" and then "start".

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(key: String)
+
+
+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
object Companion
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val key: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/key.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/key.html new file mode 100644 index 00000000..faf780fc --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/key.html @@ -0,0 +1,118 @@ + + + + + key + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

key

+
+
val key: String
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/to-string.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/to-string.html new file mode 100644 index 00000000..972ee919 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-action/to-string.html @@ -0,0 +1,118 @@ + + + + + toString + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

toString

+
+
open override fun toString(): String
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-metadata/-entertainment-configuration-metadata.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-metadata/-entertainment-configuration-metadata.html new file mode 100644 index 00000000..18817af9 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-metadata/-entertainment-configuration-metadata.html @@ -0,0 +1,118 @@ + + + + + EntertainmentConfigurationMetadata + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationMetadata

+
+
constructor(name: String)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-metadata/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-metadata/index.html new file mode 100644 index 00000000..187b5ce9 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-metadata/index.html @@ -0,0 +1,161 @@ + + + + + EntertainmentConfigurationMetadata + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationMetadata

+
@Serializable
data class EntertainmentConfigurationMetadata(val name: String)

Metadata for an entertainment configuration.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(name: String)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Friendly name of the entertainment configuration.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-metadata/name.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-metadata/name.html new file mode 100644 index 00000000..e0202a32 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-metadata/name.html @@ -0,0 +1,118 @@ + + + + + name + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

name

+
+

Friendly name of the entertainment configuration.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-monitor.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-monitor.html new file mode 100644 index 00000000..ac0d9bd8 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-monitor.html @@ -0,0 +1,118 @@ + + + + + Monitor + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Monitor

+
+

Channels are organized around content from one or several monitors.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-music.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-music.html new file mode 100644 index 00000000..b57cdade --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-music.html @@ -0,0 +1,118 @@ + + + + + Music + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Music

+
+

Channels are organized for music synchronization.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-other.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-other.html new file mode 100644 index 00000000..a6bcf0c8 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-other.html @@ -0,0 +1,118 @@ + + + + + Other + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Other

+
+ +
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-screen.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-screen.html new file mode 100644 index 00000000..5cdf4120 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-screen.html @@ -0,0 +1,118 @@ + + + + + Screen + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Screen

+
+

Channels are organized around content from a screen.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-three-d-space.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-three-d-space.html new file mode 100644 index 00000000..895c9a2e --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/-three-d-space.html @@ -0,0 +1,118 @@ + + + + + ThreeDSpace + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

ThreeDSpace

+
+

Channels are organized to provide 3D spatial effects.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/index.html new file mode 100644 index 00000000..192af35f --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-companion/index.html @@ -0,0 +1,202 @@ + + + + + Companion + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Companion

+
object Companion
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Channels are organized around content from one or several monitors.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Channels are organized for music synchronization.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Channels are organized around content from a screen.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Channels are organized to provide 3D spatial effects.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-entertainment-configuration-type.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-entertainment-configuration-type.html new file mode 100644 index 00000000..8697405b --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/-entertainment-configuration-type.html @@ -0,0 +1,118 @@ + + + + + EntertainmentConfigurationType + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationType

+
+
constructor(key: String)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/index.html new file mode 100644 index 00000000..a7e6b1da --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/index.html @@ -0,0 +1,199 @@ + + + + + EntertainmentConfigurationType + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationType

+
@Serializable
value class EntertainmentConfigurationType(val key: String)

Defines for which type of application an entertainment configuration channel assignment was optimized for.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(key: String)
+
+
+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
object Companion
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val key: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/key.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/key.html new file mode 100644 index 00000000..64d11031 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/key.html @@ -0,0 +1,118 @@ + + + + + key + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

key

+
+
val key: String
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/to-string.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/to-string.html new file mode 100644 index 00000000..014914e5 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration-type/to-string.html @@ -0,0 +1,118 @@ + + + + + toString + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

toString

+
+
open override fun toString(): String
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/-entertainment-configuration.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/-entertainment-configuration.html new file mode 100644 index 00000000..8813417a --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/-entertainment-configuration.html @@ -0,0 +1,118 @@ + + + + + EntertainmentConfiguration + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfiguration

+
+
constructor(id: ResourceId, type: ResourceType = ResourceType.EntertainmentConfiguration, metadata: EntertainmentConfigurationMetadata, configurationType: EntertainmentConfigurationType, status: EntertainmentStatus, activeStreamer: ResourceReference? = null, streamProxy: StreamProxy, channels: List<EntertainmentChannel>, locations: EntertainmentLocations)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/active-streamer.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/active-streamer.html new file mode 100644 index 00000000..310332cb --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/active-streamer.html @@ -0,0 +1,118 @@ + + + + + activeStreamer + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

activeStreamer

+
+
@SerialName(value = "active_streamer")
val activeStreamer: ResourceReference?

Reference to the application streaming to this configuration.

Only available if status is EntertainmentStatus.Active. Expected value is a ResourceIdentifier of type auth_v1 (an application ID).

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/channels.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/channels.html new file mode 100644 index 00000000..50b261f8 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/channels.html @@ -0,0 +1,118 @@ + + + + + channels + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

channels

+
+

Channels in the entertainment configuration.

Each channel groups segments of one or different lights.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/configuration-type.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/configuration-type.html new file mode 100644 index 00000000..94d5695c --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/configuration-type.html @@ -0,0 +1,118 @@ + + + + + configurationType + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

configurationType

+
+
@SerialName(value = "configuration_type")
val configurationType: EntertainmentConfigurationType

Defines for which type of application this channel assignment was optimized.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/id.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/id.html new file mode 100644 index 00000000..d4f825ec --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/id.html @@ -0,0 +1,118 @@ + + + + + id + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

id

+
+

Unique identifier representing a specific entertainment configuration instance.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/index.html new file mode 100644 index 00000000..eaef0cca --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/index.html @@ -0,0 +1,281 @@ + + + + + EntertainmentConfiguration + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfiguration

+
@Serializable
data class EntertainmentConfiguration(val id: ResourceId, val type: ResourceType = ResourceType.EntertainmentConfiguration, val metadata: EntertainmentConfigurationMetadata, val configurationType: EntertainmentConfigurationType, val status: EntertainmentStatus, val activeStreamer: ResourceReference? = null, val streamProxy: StreamProxy, val channels: List<EntertainmentChannel>, val locations: EntertainmentLocations)

Configuration for Hue Entertainment functionality.

Entertainment configurations manage the setup for entertainment streaming, including channel assignments and light positions.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(id: ResourceId, type: ResourceType = ResourceType.EntertainmentConfiguration, metadata: EntertainmentConfigurationMetadata, configurationType: EntertainmentConfigurationType, status: EntertainmentStatus, activeStreamer: ResourceReference? = null, streamProxy: StreamProxy, channels: List<EntertainmentChannel>, locations: EntertainmentLocations)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "active_streamer")
val activeStreamer: ResourceReference?

Reference to the application streaming to this configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Channels in the entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "configuration_type")
val configurationType: EntertainmentConfigurationType

Defines for which type of application this channel assignment was optimized.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Unique identifier representing a specific entertainment configuration instance.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Entertainment service locations for lights in the zone.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Metadata containing the friendly name of the entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Read-only field reporting if the stream is active or not.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "stream_proxy")
val streamProxy: StreamProxy

Stream proxy configuration for this entertainment group.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Type of the resource (always entertainment_configuration).

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/locations.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/locations.html new file mode 100644 index 00000000..2cd3a8d4 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/locations.html @@ -0,0 +1,118 @@ + + + + + locations + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

locations

+
+

Entertainment service locations for lights in the zone.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/metadata.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/metadata.html new file mode 100644 index 00000000..06591404 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/metadata.html @@ -0,0 +1,118 @@ + + + + + metadata + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

metadata

+
+

Metadata containing the friendly name of the entertainment configuration.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/status.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/status.html new file mode 100644 index 00000000..4fbcbcad --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/status.html @@ -0,0 +1,118 @@ + + + + + status + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

status

+
+

Read-only field reporting if the stream is active or not.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/stream-proxy.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/stream-proxy.html new file mode 100644 index 00000000..46e8f409 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/stream-proxy.html @@ -0,0 +1,118 @@ + + + + + streamProxy + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

streamProxy

+
+
@SerialName(value = "stream_proxy")
val streamProxy: StreamProxy

Stream proxy configuration for this entertainment group.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/type.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/type.html new file mode 100644 index 00000000..9ed8807e --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-configuration/type.html @@ -0,0 +1,118 @@ + + + + + type + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

type

+
+

Type of the resource (always entertainment_configuration).

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-locations/-entertainment-locations.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-locations/-entertainment-locations.html new file mode 100644 index 00000000..a3e87c92 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-locations/-entertainment-locations.html @@ -0,0 +1,118 @@ + + + + + EntertainmentLocations + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentLocations

+
+
constructor(serviceLocations: List<ServiceLocation>)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-locations/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-locations/index.html new file mode 100644 index 00000000..97c7ff70 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-locations/index.html @@ -0,0 +1,161 @@ + + + + + EntertainmentLocations + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentLocations

+
@Serializable
data class EntertainmentLocations(val serviceLocations: List<ServiceLocation>)

Locations of entertainment services within an entertainment configuration.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(serviceLocations: List<ServiceLocation>)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "service_locations")
val serviceLocations: List<ServiceLocation>

List of service locations for lights in the entertainment zone.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-locations/service-locations.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-locations/service-locations.html new file mode 100644 index 00000000..6e4b1c7f --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-locations/service-locations.html @@ -0,0 +1,118 @@ + + + + + serviceLocations + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

serviceLocations

+
+
@SerialName(value = "service_locations")
val serviceLocations: List<ServiceLocation>

List of service locations for lights in the entertainment zone.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-companion/-active.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-companion/-active.html new file mode 100644 index 00000000..793691d2 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-companion/-active.html @@ -0,0 +1,118 @@ + + + + + Active + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Active

+
+

The entertainment stream is currently active.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-companion/-inactive.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-companion/-inactive.html new file mode 100644 index 00000000..cf592c70 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-companion/-inactive.html @@ -0,0 +1,118 @@ + + + + + Inactive + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Inactive

+
+

The entertainment stream is currently inactive.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-companion/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-companion/index.html new file mode 100644 index 00000000..8e839af3 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-companion/index.html @@ -0,0 +1,157 @@ + + + + + Companion + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Companion

+
object Companion
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

The entertainment stream is currently active.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The entertainment stream is currently inactive.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-entertainment-status.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-entertainment-status.html new file mode 100644 index 00000000..31b7aa24 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/-entertainment-status.html @@ -0,0 +1,118 @@ + + + + + EntertainmentStatus + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentStatus

+
+
constructor(key: String)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/index.html new file mode 100644 index 00000000..7d225e25 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/index.html @@ -0,0 +1,199 @@ + + + + + EntertainmentStatus + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentStatus

+
@Serializable
value class EntertainmentStatus(val key: String)

Reports if an entertainment stream is active or not.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(key: String)
+
+
+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
object Companion
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val key: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/key.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/key.html new file mode 100644 index 00000000..fc71e240 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/key.html @@ -0,0 +1,118 @@ + + + + + key + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

key

+
+
val key: String
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/to-string.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/to-string.html new file mode 100644 index 00000000..db9ea0fb --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment-status/to-string.html @@ -0,0 +1,118 @@ + + + + + toString + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

toString

+
+
open override fun toString(): String
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/-entertainment.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/-entertainment.html new file mode 100644 index 00000000..95ffd627 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/-entertainment.html @@ -0,0 +1,118 @@ + + + + + Entertainment + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Entertainment

+
+
constructor(id: ResourceId, owner: ResourceReference, renderer: Boolean, rendererReference: ResourceReference? = null, proxy: Boolean, equalizer: Boolean, maxStreams: Int? = null, segments: Segments? = null)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/equalizer.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/equalizer.html new file mode 100644 index 00000000..b5746c29 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/equalizer.html @@ -0,0 +1,118 @@ + + + + + equalizer + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

equalizer

+
+

Indicates if a lamp can handle the equalization factor to dimming maximum brightness in a stream.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/id.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/id.html new file mode 100644 index 00000000..cf4a5aa5 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/id.html @@ -0,0 +1,118 @@ + + + + + id + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

id

+
+

Unique identifier representing a specific entertainment resource instance.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/index.html new file mode 100644 index 00000000..d28a0fc7 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/index.html @@ -0,0 +1,266 @@ + + + + + Entertainment + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Entertainment

+
@Serializable
data class Entertainment(val id: ResourceId, val owner: ResourceReference, val renderer: Boolean, val rendererReference: ResourceReference? = null, val proxy: Boolean, val equalizer: Boolean, val maxStreams: Int? = null, val segments: Segments? = null)

State and capabilities of an entertainment resource.

Entertainment resources represent the entertainment streaming capabilities of a light or device in the Hue system.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(id: ResourceId, owner: ResourceReference, renderer: Boolean, rendererReference: ResourceReference? = null, proxy: Boolean, equalizer: Boolean, maxStreams: Int? = null, segments: Segments? = null)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Indicates if a lamp can handle the equalization factor to dimming maximum brightness in a stream.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Unique identifier representing a specific entertainment resource instance.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "max_streams")
val maxStreams: Int?

Indicates the maximum number of parallel streaming sessions the bridge supports.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Owner of the service.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Indicates if a lamp can be used for entertainment streaming as a proxy node.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Indicates if a lamp can be used for entertainment streaming as a renderer.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "renderer_reference")
val rendererReference: ResourceReference?

Indicates which light service is linked to this entertainment service.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Holds all parameters concerning the segmentation capabilities of a device.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/max-streams.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/max-streams.html new file mode 100644 index 00000000..5e850e04 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/max-streams.html @@ -0,0 +1,118 @@ + + + + + maxStreams + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

maxStreams

+
+
@SerialName(value = "max_streams")
val maxStreams: Int?

Indicates the maximum number of parallel streaming sessions the bridge supports.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/owner.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/owner.html new file mode 100644 index 00000000..89be8eab --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/owner.html @@ -0,0 +1,118 @@ + + + + + owner + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

owner

+
+

Owner of the service.

In case the owner service is deleted, the service also gets deleted.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/proxy.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/proxy.html new file mode 100644 index 00000000..ba268de7 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/proxy.html @@ -0,0 +1,118 @@ + + + + + proxy + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

proxy

+
+

Indicates if a lamp can be used for entertainment streaming as a proxy node.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/renderer-reference.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/renderer-reference.html new file mode 100644 index 00000000..0a6ec3df --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/renderer-reference.html @@ -0,0 +1,118 @@ + + + + + rendererReference + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

rendererReference

+
+
@SerialName(value = "renderer_reference")
val rendererReference: ResourceReference?

Indicates which light service is linked to this entertainment service.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/renderer.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/renderer.html new file mode 100644 index 00000000..6353523b --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/renderer.html @@ -0,0 +1,118 @@ + + + + + renderer + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

renderer

+
+

Indicates if a lamp can be used for entertainment streaming as a renderer.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/segments.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/segments.html new file mode 100644 index 00000000..64ad7668 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-entertainment/segments.html @@ -0,0 +1,118 @@ + + + + + segments + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

segments

+
+

Holds all parameters concerning the segmentation capabilities of a device.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/--index--.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/--index--.html new file mode 100644 index 00000000..97bfefdb --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/--index--.html @@ -0,0 +1,118 @@ + + + + + index + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

index

+
+
val index: Int

Index of the segment within the entertainment service.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/-segment-reference.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/-segment-reference.html new file mode 100644 index 00000000..d671b1cb --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/-segment-reference.html @@ -0,0 +1,118 @@ + + + + + SegmentReference + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

SegmentReference

+
+
constructor(service: ResourceReference, index: Int)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/index.html new file mode 100644 index 00000000..fd4ef797 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/index.html @@ -0,0 +1,176 @@ + + + + + SegmentReference + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

SegmentReference

+
@Serializable
data class SegmentReference(val service: ResourceReference, val index: Int)

Reference to a segment that is a member of an entertainment channel.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(service: ResourceReference, index: Int)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val index: Int

Index of the segment within the entertainment service.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Reference to the entertainment service containing the segment.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/service.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/service.html new file mode 100644 index 00000000..35516433 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segment-reference/service.html @@ -0,0 +1,118 @@ + + + + + service + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

service

+
+

Reference to the entertainment service containing the segment.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/-segments.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/-segments.html new file mode 100644 index 00000000..e6317136 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/-segments.html @@ -0,0 +1,118 @@ + + + + + Segments + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Segments

+
+
constructor(configurable: Boolean, maxSegments: Int, segmentRanges: List<@Serializable(with = SegmentRangeSerializer::class) IntRange>)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/configurable.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/configurable.html new file mode 100644 index 00000000..0c045e4d --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/configurable.html @@ -0,0 +1,118 @@ + + + + + configurable + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

configurable

+
+

Defines if the segmentation of the device is configurable or not.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/index.html new file mode 100644 index 00000000..3fe61604 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/index.html @@ -0,0 +1,191 @@ + + + + + Segments + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Segments

+
@Serializable
data class Segments(val configurable: Boolean, val maxSegments: Int, val segmentRanges: List<@Serializable(with = SegmentRangeSerializer::class) IntRange>)

Holds all parameters concerning the segmentation capabilities of a device.

Segmentation allows a device to be divided into multiple independently controllable sections for entertainment purposes.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(configurable: Boolean, maxSegments: Int, segmentRanges: List<@Serializable(with = SegmentRangeSerializer::class) IntRange>)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Defines if the segmentation of the device is configurable or not.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "max_segments")
val maxSegments: Int

Maximum number of segments the device supports.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "segments")
val segmentRanges: List<@Serializable(with = SegmentRangeSerializer::class) IntRange>

Contains the segments configuration of the device for entertainment purposes.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/max-segments.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/max-segments.html new file mode 100644 index 00000000..55c900f7 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/max-segments.html @@ -0,0 +1,118 @@ + + + + + maxSegments + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

maxSegments

+
+
@SerialName(value = "max_segments")
val maxSegments: Int

Maximum number of segments the device supports.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/segment-ranges.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/segment-ranges.html new file mode 100644 index 00000000..20494479 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-segments/segment-ranges.html @@ -0,0 +1,118 @@ + + + + + segmentRanges + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

segmentRanges

+
+
@SerialName(value = "segments")
val segmentRanges: List<@Serializable(with = SegmentRangeSerializer::class) IntRange>

Contains the segments configuration of the device for entertainment purposes.

A device can be segmented in a single way.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/-service-location.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/-service-location.html new file mode 100644 index 00000000..e6ee2c2f --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/-service-location.html @@ -0,0 +1,118 @@ + + + + + ServiceLocation + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

ServiceLocation

+
+
constructor(service: ResourceReference, positions: List<Position>, equalizationFactor: Double)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/equalization-factor.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/equalization-factor.html new file mode 100644 index 00000000..9d9915ab --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/equalization-factor.html @@ -0,0 +1,118 @@ + + + + + equalizationFactor + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

equalizationFactor

+
+
@SerialName(value = "equalization_factor")
val equalizationFactor: Double

Relative equalization factor applied to the entertainment service.

This compensates for differences in brightness in the entertainment configuration. Value cannot be 0; writing 0 changes it to the lowest possible value.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/index.html new file mode 100644 index 00000000..208d14a4 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/index.html @@ -0,0 +1,191 @@ + + + + + ServiceLocation + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

ServiceLocation

+
@Serializable
data class ServiceLocation(val service: ResourceReference, val positions: List<Position>, val equalizationFactor: Double)

Location information for an entertainment service within a configuration.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(service: ResourceReference, positions: List<Position>, equalizationFactor: Double)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "equalization_factor")
val equalizationFactor: Double

Relative equalization factor applied to the entertainment service.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Describes the location(s) of the service.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Reference to the entertainment service.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/positions.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/positions.html new file mode 100644 index 00000000..c4f4da31 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/positions.html @@ -0,0 +1,118 @@ + + + + + positions + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

positions

+
+

Describes the location(s) of the service.

Can contain 1-2 positions.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/service.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/service.html new file mode 100644 index 00000000..b196274b --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-service-location/service.html @@ -0,0 +1,118 @@ + + + + + service + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

service

+
+

Reference to the entertainment service.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-companion/-auto.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-companion/-auto.html new file mode 100644 index 00000000..9b0a2d3f --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-companion/-auto.html @@ -0,0 +1,118 @@ + + + + + Auto + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Auto

+
+

The bridge will select a proxy node automatically.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-companion/-manual.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-companion/-manual.html new file mode 100644 index 00000000..f16b9484 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-companion/-manual.html @@ -0,0 +1,118 @@ + + + + + Manual + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Manual

+
+

The proxy node has been set manually.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-companion/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-companion/index.html new file mode 100644 index 00000000..0f24cdc9 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-companion/index.html @@ -0,0 +1,157 @@ + + + + + Companion + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Companion

+
object Companion
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

The bridge will select a proxy node automatically.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The proxy node has been set manually.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-stream-proxy-mode.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-stream-proxy-mode.html new file mode 100644 index 00000000..8633408e --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/-stream-proxy-mode.html @@ -0,0 +1,118 @@ + + + + + StreamProxyMode + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

StreamProxyMode

+
+
constructor(key: String)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/index.html new file mode 100644 index 00000000..022f7f32 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/index.html @@ -0,0 +1,199 @@ + + + + + StreamProxyMode + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

StreamProxyMode

+
@Serializable
value class StreamProxyMode(val key: String)

Proxy mode used for an entertainment configuration group.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(key: String)
+
+
+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
object Companion
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val key: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/key.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/key.html new file mode 100644 index 00000000..78462861 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/key.html @@ -0,0 +1,118 @@ + + + + + key + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

key

+
+
val key: String
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/to-string.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/to-string.html new file mode 100644 index 00000000..07297fcf --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy-mode/to-string.html @@ -0,0 +1,118 @@ + + + + + toString + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

toString

+
+
open override fun toString(): String
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/-stream-proxy.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/-stream-proxy.html new file mode 100644 index 00000000..bcbfdc29 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/-stream-proxy.html @@ -0,0 +1,118 @@ + + + + + StreamProxy + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

StreamProxy

+
+
constructor(mode: StreamProxyMode, node: ResourceReference)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/index.html new file mode 100644 index 00000000..e2de0496 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/index.html @@ -0,0 +1,176 @@ + + + + + StreamProxy + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

StreamProxy

+
@Serializable
data class StreamProxy(val mode: StreamProxyMode, val node: ResourceReference)

Stream proxy configuration for an entertainment configuration.

The proxy node relays entertainment traffic and should be located in or close to all entertainment lamps in the group.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(mode: StreamProxyMode, node: ResourceReference)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Proxy mode used for this group.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Reference to the device acting as proxy.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/mode.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/mode.html new file mode 100644 index 00000000..8e631905 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/mode.html @@ -0,0 +1,118 @@ + + + + + mode + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

mode

+
+

Proxy mode used for this group.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/node.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/node.html new file mode 100644 index 00000000..bd5c7758 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/-stream-proxy/node.html @@ -0,0 +1,118 @@ + + + + + node + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

node

+
+

Reference to the device acting as proxy.

The proxy node set by the application (manual) or selected by the bridge (auto). Writing this property sets the proxy mode to "manual". Can be a BridgeDevice or ZigbeeDevice type.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/index.html new file mode 100644 index 00000000..3a4776ae --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment.structures/index.html @@ -0,0 +1,336 @@ + + + + + inkapplications.shade.entertainment.structures + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Package-level declarations

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class Entertainment(val id: ResourceId, val owner: ResourceReference, val renderer: Boolean, val rendererReference: ResourceReference? = null, val proxy: Boolean, val equalizer: Boolean, val maxStreams: Int? = null, val segments: Segments? = null)

State and capabilities of an entertainment resource.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class EntertainmentChannel(val channelId: EntertainmentChannelId, val position: Position, val members: List<SegmentReference>)

A channel in an entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
value class EntertainmentChannelId(val value: Int)

Identifier for an entertainment channel.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class EntertainmentConfiguration(val id: ResourceId, val type: ResourceType = ResourceType.EntertainmentConfiguration, val metadata: EntertainmentConfigurationMetadata, val configurationType: EntertainmentConfigurationType, val status: EntertainmentStatus, val activeStreamer: ResourceReference? = null, val streamProxy: StreamProxy, val channels: List<EntertainmentChannel>, val locations: EntertainmentLocations)

Configuration for Hue Entertainment functionality.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
value class EntertainmentConfigurationAction(val key: String)

Action that can be taken on an entertainment configuration to control streaming.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class EntertainmentConfigurationMetadata(val name: String)

Metadata for an entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
value class EntertainmentConfigurationType(val key: String)

Defines for which type of application an entertainment configuration channel assignment was optimized for.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class EntertainmentLocations(val serviceLocations: List<ServiceLocation>)

Locations of entertainment services within an entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
value class EntertainmentStatus(val key: String)

Reports if an entertainment stream is active or not.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class SegmentReference(val service: ResourceReference, val index: Int)

Reference to a segment that is a member of an entertainment channel.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class Segments(val configurable: Boolean, val maxSegments: Int, val segmentRanges: List<@Serializable(with = SegmentRangeSerializer::class) IntRange>)

Holds all parameters concerning the segmentation capabilities of a device.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class ServiceLocation(val service: ResourceReference, val positions: List<Position>, val equalizationFactor: Double)

Location information for an entertainment service within a configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class StreamProxy(val mode: StreamProxyMode, val node: ResourceReference)

Stream proxy configuration for an entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
value class StreamProxyMode(val key: String)

Proxy mode used for an entertainment configuration group.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/create-configuration.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/create-configuration.html new file mode 100644 index 00000000..c2de680c --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/create-configuration.html @@ -0,0 +1,118 @@ + + + + + createConfiguration + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

createConfiguration

+
+

Create a new entertainment configuration on the hue bridge.

Return

A reference to the newly created resource.

Parameters

parameters

Data for the new entertainment configuration.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/delete-configuration.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/delete-configuration.html new file mode 100644 index 00000000..3000a987 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/delete-configuration.html @@ -0,0 +1,118 @@ + + + + + deleteConfiguration + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

deleteConfiguration

+
+

Delete an existing entertainment configuration from the hue bridge.

Return

A reference to the deleted resource.

Parameters

id

The resource ID of the entertainment configuration to delete.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/get-configuration.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/get-configuration.html new file mode 100644 index 00000000..bb0ee8ea --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/get-configuration.html @@ -0,0 +1,118 @@ + + + + + getConfiguration + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

getConfiguration

+
+

Get the state of a single entertainment configuration.

Parameters

id

The resource ID of the entertainment configuration to fetch.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/index.html new file mode 100644 index 00000000..7bc5392f --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/index.html @@ -0,0 +1,202 @@ + + + + + EntertainmentConfigurationControls + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentConfigurationControls

+

Actions to get entertainment configuration resources in the hue system.

Entertainment configurations manage the setup for Hue Entertainment functionality, including channel assignments, light positions, and streaming settings.

+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Create a new entertainment configuration on the hue bridge.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Delete an existing entertainment configuration from the hue bridge.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Get the state of a single entertainment configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Get a list of entertainment configurations on the hue service.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Update an existing entertainment configuration on the hue bridge.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/list-configurations.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/list-configurations.html new file mode 100644 index 00000000..25ab2c37 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/list-configurations.html @@ -0,0 +1,118 @@ + + + + + listConfigurations + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

listConfigurations

+
+

Get a list of entertainment configurations on the hue service.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/update-configuration.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/update-configuration.html new file mode 100644 index 00000000..ac3ec78a --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-configuration-controls/update-configuration.html @@ -0,0 +1,118 @@ + + + + + updateConfiguration + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

updateConfiguration

+
+

Update an existing entertainment configuration on the hue bridge.

Return

A reference to the updated resource.

Parameters

id

The resource ID of the entertainment configuration to update.

parameters

Data to update on the entertainment configuration.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-controls/get-entertainment.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-controls/get-entertainment.html new file mode 100644 index 00000000..d7f34216 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-controls/get-entertainment.html @@ -0,0 +1,118 @@ + + + + + getEntertainment + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

getEntertainment

+
+
abstract suspend fun getEntertainment(id: ResourceId): Entertainment

Get the state of a single entertainment resource.

Parameters

id

The resource ID of the entertainment resource to fetch data for.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-controls/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-controls/index.html new file mode 100644 index 00000000..b25ee4cc --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-controls/index.html @@ -0,0 +1,157 @@ + + + + + EntertainmentControls + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

EntertainmentControls

+

Actions to get entertainment resources in the hue system.

Entertainment resources represent the entertainment streaming capabilities of lights and devices.

+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract suspend fun getEntertainment(id: ResourceId): Entertainment

Get the state of a single entertainment resource.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract suspend fun listEntertainment(): List<Entertainment>

Get a list of entertainment resources configured on the hue service.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-controls/list-entertainment.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-controls/list-entertainment.html new file mode 100644 index 00000000..760789f2 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-entertainment-controls/list-entertainment.html @@ -0,0 +1,118 @@ + + + + + listEntertainment + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

listEntertainment

+
+
abstract suspend fun listEntertainment(): List<Entertainment>

Get a list of entertainment resources configured on the hue service.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/-shade-entertainment-module.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/-shade-entertainment-module.html new file mode 100644 index 00000000..6234245f --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/-shade-entertainment-module.html @@ -0,0 +1,118 @@ + + + + + ShadeEntertainmentModule + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

ShadeEntertainmentModule

+
+
constructor(internalsModule: InternalsModule)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/configurations.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/configurations.html new file mode 100644 index 00000000..26da37b7 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/configurations.html @@ -0,0 +1,118 @@ + + + + + configurations + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

configurations

+
+

Controls for entertainment configurations (Hue Entertainment functionality setup).

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/entertainment.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/entertainment.html new file mode 100644 index 00000000..cebedabc --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/entertainment.html @@ -0,0 +1,118 @@ + + + + + entertainment + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

entertainment

+
+

Management for entertainment services.

These are offered by devices with color lighting capabilities.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/index.html new file mode 100644 index 00000000..ec05a84e --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/-shade-entertainment-module/index.html @@ -0,0 +1,176 @@ + + + + + ShadeEntertainmentModule + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

ShadeEntertainmentModule

+

Provides access to entertainment control services.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(internalsModule: InternalsModule)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Controls for entertainment configurations (Hue Entertainment functionality setup).

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Management for entertainment services.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/inkapplications.shade.entertainment/index.html b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/index.html new file mode 100644 index 00000000..529313d3 --- /dev/null +++ b/docs/reference/latest/entertainment/inkapplications.shade.entertainment/index.html @@ -0,0 +1,171 @@ + + + + + inkapplications.shade.entertainment + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Package-level declarations

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

Actions to get entertainment configuration resources in the hue system.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Actions to get entertainment resources in the hue system.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Provides access to entertainment control services.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/entertainment/navigation.html b/docs/reference/latest/entertainment/navigation.html new file mode 100644 index 00000000..4b78116b --- /dev/null +++ b/docs/reference/latest/entertainment/navigation.html @@ -0,0 +1,1582 @@ +
+ + + + + + + + + + + +
+ + + + +
+ + +
+
+ AlertInfo +
+
+
+
+ ColorInfo +
+
+
+ +
+ + + + +
+ +
+
+ +
+
+ +
+ +
+
+ Gamut +
+
+ +
+
+ Gradient +
+
+ +
+ +
+
+ +
+
+
+ Light +
+
+
+ +
+ + + +
+ +
+
+ Custom +
+
+
+ +
+
+
+ Powerfail +
+
+
+
+ Safety +
+
+
+ +
+ +
+ +
+ +
+
+ Color +
+
+ +
+
+ Previous +
+
+
+ +
+ +
+
+ Previous +
+
+
+ +
+
+
+ Toggle +
+
+
+ + + +
+
+ + + + + + +
diff --git a/docs/reference/latest/events/navigation.html b/docs/reference/latest/events/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/events/navigation.html +++ b/docs/reference/latest/events/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/grouped-lights/navigation.html b/docs/reference/latest/grouped-lights/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/grouped-lights/navigation.html +++ b/docs/reference/latest/grouped-lights/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/homekit/navigation.html b/docs/reference/latest/homekit/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/homekit/navigation.html +++ b/docs/reference/latest/homekit/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/index.html b/docs/reference/latest/index.html index 765150a0..9e43ec9b 100644 --- a/docs/reference/latest/index.html +++ b/docs/reference/latest/index.html @@ -133,6 +133,17 @@

All modules:

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
diff --git a/docs/reference/latest/internals/navigation.html b/docs/reference/latest/internals/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/internals/navigation.html +++ b/docs/reference/latest/internals/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/lightlevel/navigation.html b/docs/reference/latest/lightlevel/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/lightlevel/navigation.html +++ b/docs/reference/latest/lightlevel/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/lights/navigation.html b/docs/reference/latest/lights/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/lights/navigation.html +++ b/docs/reference/latest/lights/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/navigation.html b/docs/reference/latest/navigation.html index 8d13426c..6ec84c4b 100644 --- a/docs/reference/latest/navigation.html +++ b/docs/reference/latest/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/package-list b/docs/reference/latest/package-list index 5c09f51f..2c2d1d2c 100644 --- a/docs/reference/latest/package-list +++ b/docs/reference/latest/package-list @@ -17,6 +17,10 @@ inkapplications.shade.devices.structures module:discover inkapplications.shade.discover inkapplications.shade.discover.structures +module:entertainment +inkapplications.shade.entertainment +inkapplications.shade.entertainment.parameters +inkapplications.shade.entertainment.structures module:events inkapplications.shade.events shade.events diff --git a/docs/reference/latest/resources/navigation.html b/docs/reference/latest/resources/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/resources/navigation.html +++ b/docs/reference/latest/resources/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/rooms/navigation.html b/docs/reference/latest/rooms/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/rooms/navigation.html +++ b/docs/reference/latest/rooms/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/scenes/navigation.html b/docs/reference/latest/scenes/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/scenes/navigation.html +++ b/docs/reference/latest/scenes/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/scripts/pages.json b/docs/reference/latest/scripts/pages.json index 3eaeb4d6..fdcb02bb 100644 --- a/docs/reference/latest/scripts/pages.json +++ b/docs/reference/latest/scripts/pages.json @@ -1 +1 @@ -[{"name":"abstract suspend fun getDevices(): List","description":"inkapplications.shade.discover.BridgeDiscovery.getDevices","location":"discover/inkapplications.shade.discover/-bridge-discovery/get-devices.html","searchKeys":["getDevices","abstract suspend fun getDevices(): List","inkapplications.shade.discover.BridgeDiscovery.getDevices"]},{"name":"class DiscoverModule","description":"inkapplications.shade.discover.DiscoverModule","location":"discover/inkapplications.shade.discover/-discover-module/index.html","searchKeys":["DiscoverModule","class DiscoverModule","inkapplications.shade.discover.DiscoverModule"]},{"name":"constructor()","description":"inkapplications.shade.discover.DiscoverModule.DiscoverModule","location":"discover/inkapplications.shade.discover/-discover-module/-discover-module.html","searchKeys":["DiscoverModule","constructor()","inkapplications.shade.discover.DiscoverModule.DiscoverModule"]},{"name":"constructor(id: BridgeId, localIp: String, port: Int = 80)","description":"inkapplications.shade.discover.structures.Bridge.Bridge","location":"discover/inkapplications.shade.discover.structures/-bridge/-bridge.html","searchKeys":["Bridge","constructor(id: BridgeId, localIp: String, port: Int = 80)","inkapplications.shade.discover.structures.Bridge.Bridge"]},{"name":"constructor(value: String)","description":"inkapplications.shade.discover.structures.BridgeId.BridgeId","location":"discover/inkapplications.shade.discover.structures/-bridge-id/-bridge-id.html","searchKeys":["BridgeId","constructor(value: String)","inkapplications.shade.discover.structures.BridgeId.BridgeId"]},{"name":"data class Bridge(val id: BridgeId, val localIp: String, val port: Int = 80)","description":"inkapplications.shade.discover.structures.Bridge","location":"discover/inkapplications.shade.discover.structures/-bridge/index.html","searchKeys":["Bridge","data class Bridge(val id: BridgeId, val localIp: String, val port: Int = 80)","inkapplications.shade.discover.structures.Bridge"]},{"name":"interface BridgeDiscovery","description":"inkapplications.shade.discover.BridgeDiscovery","location":"discover/inkapplications.shade.discover/-bridge-discovery/index.html","searchKeys":["BridgeDiscovery","interface BridgeDiscovery","inkapplications.shade.discover.BridgeDiscovery"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.discover.structures.BridgeId.toString","location":"discover/inkapplications.shade.discover.structures/-bridge-id/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.discover.structures.BridgeId.toString"]},{"name":"val id: BridgeId","description":"inkapplications.shade.discover.structures.Bridge.id","location":"discover/inkapplications.shade.discover.structures/-bridge/id.html","searchKeys":["id","val id: BridgeId","inkapplications.shade.discover.structures.Bridge.id"]},{"name":"val localIp: String","description":"inkapplications.shade.discover.structures.Bridge.localIp","location":"discover/inkapplications.shade.discover.structures/-bridge/local-ip.html","searchKeys":["localIp","val localIp: String","inkapplications.shade.discover.structures.Bridge.localIp"]},{"name":"val onlineDiscovery: BridgeDiscovery","description":"inkapplications.shade.discover.DiscoverModule.onlineDiscovery","location":"discover/inkapplications.shade.discover/-discover-module/online-discovery.html","searchKeys":["onlineDiscovery","val onlineDiscovery: BridgeDiscovery","inkapplications.shade.discover.DiscoverModule.onlineDiscovery"]},{"name":"val port: Int","description":"inkapplications.shade.discover.structures.Bridge.port","location":"discover/inkapplications.shade.discover.structures/-bridge/port.html","searchKeys":["port","val port: Int","inkapplications.shade.discover.structures.Bridge.port"]},{"name":"val value: String","description":"inkapplications.shade.discover.structures.BridgeId.value","location":"discover/inkapplications.shade.discover.structures/-bridge-id/value.html","searchKeys":["value","val value: String","inkapplications.shade.discover.structures.BridgeId.value"]},{"name":"value class BridgeId(val value: String)","description":"inkapplications.shade.discover.structures.BridgeId","location":"discover/inkapplications.shade.discover.structures/-bridge-id/index.html","searchKeys":["BridgeId","value class BridgeId(val value: String)","inkapplications.shade.discover.structures.BridgeId"]},{"name":"abstract suspend fun createRoom(parameters: RoomCreateParameters): ResourceReference","description":"inkapplications.shade.rooms.RoomControls.createRoom","location":"rooms/inkapplications.shade.rooms/-room-controls/create-room.html","searchKeys":["createRoom","abstract suspend fun createRoom(parameters: RoomCreateParameters): ResourceReference","inkapplications.shade.rooms.RoomControls.createRoom"]},{"name":"abstract suspend fun deleteRoom(id: ResourceId): ResourceReference","description":"inkapplications.shade.rooms.RoomControls.deleteRoom","location":"rooms/inkapplications.shade.rooms/-room-controls/delete-room.html","searchKeys":["deleteRoom","abstract suspend fun deleteRoom(id: ResourceId): ResourceReference","inkapplications.shade.rooms.RoomControls.deleteRoom"]},{"name":"abstract suspend fun getRoom(id: ResourceId): Room","description":"inkapplications.shade.rooms.RoomControls.getRoom","location":"rooms/inkapplications.shade.rooms/-room-controls/get-room.html","searchKeys":["getRoom","abstract suspend fun getRoom(id: ResourceId): Room","inkapplications.shade.rooms.RoomControls.getRoom"]},{"name":"abstract suspend fun listRooms(): List","description":"inkapplications.shade.rooms.RoomControls.listRooms","location":"rooms/inkapplications.shade.rooms/-room-controls/list-rooms.html","searchKeys":["listRooms","abstract suspend fun listRooms(): List","inkapplications.shade.rooms.RoomControls.listRooms"]},{"name":"abstract suspend fun updateRoom(id: ResourceId, parameters: RoomUpdateParameters): ResourceReference","description":"inkapplications.shade.rooms.RoomControls.updateRoom","location":"rooms/inkapplications.shade.rooms/-room-controls/update-room.html","searchKeys":["updateRoom","abstract suspend fun updateRoom(id: ResourceId, parameters: RoomUpdateParameters): ResourceReference","inkapplications.shade.rooms.RoomControls.updateRoom"]},{"name":"class ShadeRoomsModule(internalsModule: InternalsModule)","description":"inkapplications.shade.rooms.ShadeRoomsModule","location":"rooms/inkapplications.shade.rooms/-shade-rooms-module/index.html","searchKeys":["ShadeRoomsModule","class ShadeRoomsModule(internalsModule: InternalsModule)","inkapplications.shade.rooms.ShadeRoomsModule"]},{"name":"constructor(id: ResourceId, services: List, metadata: SegmentMetadata, children: List)","description":"inkapplications.shade.rooms.structures.Room.Room","location":"rooms/inkapplications.shade.rooms.structures/-room/-room.html","searchKeys":["Room","constructor(id: ResourceId, services: List, metadata: SegmentMetadata, children: List)","inkapplications.shade.rooms.structures.Room.Room"]},{"name":"constructor(internalsModule: InternalsModule)","description":"inkapplications.shade.rooms.ShadeRoomsModule.ShadeRoomsModule","location":"rooms/inkapplications.shade.rooms/-shade-rooms-module/-shade-rooms-module.html","searchKeys":["ShadeRoomsModule","constructor(internalsModule: InternalsModule)","inkapplications.shade.rooms.ShadeRoomsModule.ShadeRoomsModule"]},{"name":"constructor(metadata: SegmentMetadata, children: List)","description":"inkapplications.shade.rooms.parameters.RoomCreateParameters.RoomCreateParameters","location":"rooms/inkapplications.shade.rooms.parameters/-room-create-parameters/-room-create-parameters.html","searchKeys":["RoomCreateParameters","constructor(metadata: SegmentMetadata, children: List)","inkapplications.shade.rooms.parameters.RoomCreateParameters.RoomCreateParameters"]},{"name":"constructor(metadata: SegmentMetadataUpdate? = null, children: List? = null)","description":"inkapplications.shade.rooms.parameters.RoomUpdateParameters.RoomUpdateParameters","location":"rooms/inkapplications.shade.rooms.parameters/-room-update-parameters/-room-update-parameters.html","searchKeys":["RoomUpdateParameters","constructor(metadata: SegmentMetadataUpdate? = null, children: List? = null)","inkapplications.shade.rooms.parameters.RoomUpdateParameters.RoomUpdateParameters"]},{"name":"data class Room(val id: ResourceId, val services: List, val metadata: SegmentMetadata, val children: List)","description":"inkapplications.shade.rooms.structures.Room","location":"rooms/inkapplications.shade.rooms.structures/-room/index.html","searchKeys":["Room","data class Room(val id: ResourceId, val services: List, val metadata: SegmentMetadata, val children: List)","inkapplications.shade.rooms.structures.Room"]},{"name":"data class RoomCreateParameters(val metadata: SegmentMetadata, val children: List)","description":"inkapplications.shade.rooms.parameters.RoomCreateParameters","location":"rooms/inkapplications.shade.rooms.parameters/-room-create-parameters/index.html","searchKeys":["RoomCreateParameters","data class RoomCreateParameters(val metadata: SegmentMetadata, val children: List)","inkapplications.shade.rooms.parameters.RoomCreateParameters"]},{"name":"data class RoomUpdateParameters(val metadata: SegmentMetadataUpdate? = null, val children: List? = null)","description":"inkapplications.shade.rooms.parameters.RoomUpdateParameters","location":"rooms/inkapplications.shade.rooms.parameters/-room-update-parameters/index.html","searchKeys":["RoomUpdateParameters","data class RoomUpdateParameters(val metadata: SegmentMetadataUpdate? = null, val children: List? = null)","inkapplications.shade.rooms.parameters.RoomUpdateParameters"]},{"name":"interface RoomControls","description":"inkapplications.shade.rooms.RoomControls","location":"rooms/inkapplications.shade.rooms/-room-controls/index.html","searchKeys":["RoomControls","interface RoomControls","inkapplications.shade.rooms.RoomControls"]},{"name":"val children: List","description":"inkapplications.shade.rooms.parameters.RoomCreateParameters.children","location":"rooms/inkapplications.shade.rooms.parameters/-room-create-parameters/children.html","searchKeys":["children","val children: List","inkapplications.shade.rooms.parameters.RoomCreateParameters.children"]},{"name":"val children: List","description":"inkapplications.shade.rooms.structures.Room.children","location":"rooms/inkapplications.shade.rooms.structures/-room/children.html","searchKeys":["children","val children: List","inkapplications.shade.rooms.structures.Room.children"]},{"name":"val children: List?","description":"inkapplications.shade.rooms.parameters.RoomUpdateParameters.children","location":"rooms/inkapplications.shade.rooms.parameters/-room-update-parameters/children.html","searchKeys":["children","val children: List?","inkapplications.shade.rooms.parameters.RoomUpdateParameters.children"]},{"name":"val id: ResourceId","description":"inkapplications.shade.rooms.structures.Room.id","location":"rooms/inkapplications.shade.rooms.structures/-room/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.rooms.structures.Room.id"]},{"name":"val metadata: SegmentMetadata","description":"inkapplications.shade.rooms.parameters.RoomCreateParameters.metadata","location":"rooms/inkapplications.shade.rooms.parameters/-room-create-parameters/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadata","inkapplications.shade.rooms.parameters.RoomCreateParameters.metadata"]},{"name":"val metadata: SegmentMetadata","description":"inkapplications.shade.rooms.structures.Room.metadata","location":"rooms/inkapplications.shade.rooms.structures/-room/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadata","inkapplications.shade.rooms.structures.Room.metadata"]},{"name":"val metadata: SegmentMetadataUpdate?","description":"inkapplications.shade.rooms.parameters.RoomUpdateParameters.metadata","location":"rooms/inkapplications.shade.rooms.parameters/-room-update-parameters/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadataUpdate?","inkapplications.shade.rooms.parameters.RoomUpdateParameters.metadata"]},{"name":"val rooms: RoomControls","description":"inkapplications.shade.rooms.ShadeRoomsModule.rooms","location":"rooms/inkapplications.shade.rooms/-shade-rooms-module/rooms.html","searchKeys":["rooms","val rooms: RoomControls","inkapplications.shade.rooms.ShadeRoomsModule.rooms"]},{"name":"val services: List","description":"inkapplications.shade.rooms.structures.Room.services","location":"rooms/inkapplications.shade.rooms.structures/-room/services.html","searchKeys":["services","val services: List","inkapplications.shade.rooms.structures.Room.services"]},{"name":"abstract suspend fun awaitToken(appId: AppId, retries: Int = 50, timeout: Duration = 5.seconds): AuthToken","description":"inkapplications.shade.auth.BridgeAuth.awaitToken","location":"auth/inkapplications.shade.auth/-bridge-auth/await-token.html","searchKeys":["awaitToken","abstract suspend fun awaitToken(appId: AppId, retries: Int = 50, timeout: Duration = 5.seconds): AuthToken","inkapplications.shade.auth.BridgeAuth.awaitToken"]},{"name":"class AuthModule(internalsModule: InternalsModule, logger: KimchiLogger)","description":"inkapplications.shade.auth.AuthModule","location":"auth/inkapplications.shade.auth/-auth-module/index.html","searchKeys":["AuthModule","class AuthModule(internalsModule: InternalsModule, logger: KimchiLogger)","inkapplications.shade.auth.AuthModule"]},{"name":"constructor(appName: String, instanceName: String)","description":"inkapplications.shade.auth.structures.AppId.AppId","location":"auth/inkapplications.shade.auth.structures/-app-id/-app-id.html","searchKeys":["AppId","constructor(appName: String, instanceName: String)","inkapplications.shade.auth.structures.AppId.AppId"]},{"name":"constructor(internalsModule: InternalsModule, logger: KimchiLogger)","description":"inkapplications.shade.auth.AuthModule.AuthModule","location":"auth/inkapplications.shade.auth/-auth-module/-auth-module.html","searchKeys":["AuthModule","constructor(internalsModule: InternalsModule, logger: KimchiLogger)","inkapplications.shade.auth.AuthModule.AuthModule"]},{"name":"data class AppId(val appName: String, val instanceName: String)","description":"inkapplications.shade.auth.structures.AppId","location":"auth/inkapplications.shade.auth.structures/-app-id/index.html","searchKeys":["AppId","data class AppId(val appName: String, val instanceName: String)","inkapplications.shade.auth.structures.AppId"]},{"name":"interface BridgeAuth","description":"inkapplications.shade.auth.BridgeAuth","location":"auth/inkapplications.shade.auth/-bridge-auth/index.html","searchKeys":["BridgeAuth","interface BridgeAuth","inkapplications.shade.auth.BridgeAuth"]},{"name":"val appName: String","description":"inkapplications.shade.auth.structures.AppId.appName","location":"auth/inkapplications.shade.auth.structures/-app-id/app-name.html","searchKeys":["appName","val appName: String","inkapplications.shade.auth.structures.AppId.appName"]},{"name":"val bridgeAuth: BridgeAuth","description":"inkapplications.shade.auth.AuthModule.bridgeAuth","location":"auth/inkapplications.shade.auth/-auth-module/bridge-auth.html","searchKeys":["bridgeAuth","val bridgeAuth: BridgeAuth","inkapplications.shade.auth.AuthModule.bridgeAuth"]},{"name":"val instanceName: String","description":"inkapplications.shade.auth.structures.AppId.instanceName","location":"auth/inkapplications.shade.auth.structures/-app-id/instance-name.html","searchKeys":["instanceName","val instanceName: String","inkapplications.shade.auth.structures.AppId.instanceName"]},{"name":"abstract suspend fun deleteDevice(deviceId: ResourceId): ResourceReference","description":"inkapplications.shade.devices.DeviceControls.deleteDevice","location":"devices/inkapplications.shade.devices/-device-controls/delete-device.html","searchKeys":["deleteDevice","abstract suspend fun deleteDevice(deviceId: ResourceId): ResourceReference","inkapplications.shade.devices.DeviceControls.deleteDevice"]},{"name":"abstract suspend fun getDevice(deviceId: ResourceId): Device","description":"inkapplications.shade.devices.DeviceControls.getDevice","location":"devices/inkapplications.shade.devices/-device-controls/get-device.html","searchKeys":["getDevice","abstract suspend fun getDevice(deviceId: ResourceId): Device","inkapplications.shade.devices.DeviceControls.getDevice"]},{"name":"abstract suspend fun identifyDevice(deviceId: ResourceId): ResourceReference","description":"inkapplications.shade.devices.DeviceControls.identifyDevice","location":"devices/inkapplications.shade.devices/-device-controls/identify-device.html","searchKeys":["identifyDevice","abstract suspend fun identifyDevice(deviceId: ResourceId): ResourceReference","inkapplications.shade.devices.DeviceControls.identifyDevice"]},{"name":"abstract suspend fun listDevices(): List","description":"inkapplications.shade.devices.DeviceControls.listDevices","location":"devices/inkapplications.shade.devices/-device-controls/list-devices.html","searchKeys":["listDevices","abstract suspend fun listDevices(): List","inkapplications.shade.devices.DeviceControls.listDevices"]},{"name":"abstract suspend fun updateDevice(deviceId: ResourceId, parameters: UpdateDeviceParameters): ResourceReference","description":"inkapplications.shade.devices.DeviceControls.updateDevice","location":"devices/inkapplications.shade.devices/-device-controls/update-device.html","searchKeys":["updateDevice","abstract suspend fun updateDevice(deviceId: ResourceId, parameters: UpdateDeviceParameters): ResourceReference","inkapplications.shade.devices.DeviceControls.updateDevice"]},{"name":"class ShadeDevicesModule(internalsModule: InternalsModule)","description":"inkapplications.shade.devices.ShadeDevicesModule","location":"devices/inkapplications.shade.devices/-shade-devices-module/index.html","searchKeys":["ShadeDevicesModule","class ShadeDevicesModule(internalsModule: InternalsModule)","inkapplications.shade.devices.ShadeDevicesModule"]},{"name":"constructor(id: ResourceId, v1Id: String? = null, productData: ProductData, metadata: ProductMetadata, services: List)","description":"inkapplications.shade.devices.structures.Device.Device","location":"devices/inkapplications.shade.devices.structures/-device/-device.html","searchKeys":["Device","constructor(id: ResourceId, v1Id: String? = null, productData: ProductData, metadata: ProductMetadata, services: List)","inkapplications.shade.devices.structures.Device.Device"]},{"name":"constructor(internalsModule: InternalsModule)","description":"inkapplications.shade.devices.ShadeDevicesModule.ShadeDevicesModule","location":"devices/inkapplications.shade.devices/-shade-devices-module/-shade-devices-module.html","searchKeys":["ShadeDevicesModule","constructor(internalsModule: InternalsModule)","inkapplications.shade.devices.ShadeDevicesModule.ShadeDevicesModule"]},{"name":"constructor(key: String)","description":"inkapplications.shade.devices.structures.ProductArchetype.ProductArchetype","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-product-archetype.html","searchKeys":["ProductArchetype","constructor(key: String)","inkapplications.shade.devices.structures.ProductArchetype.ProductArchetype"]},{"name":"constructor(metadata: DeviceMetadataParameters? = null)","description":"inkapplications.shade.devices.parameters.UpdateDeviceParameters.UpdateDeviceParameters","location":"devices/inkapplications.shade.devices.parameters/-update-device-parameters/-update-device-parameters.html","searchKeys":["UpdateDeviceParameters","constructor(metadata: DeviceMetadataParameters? = null)","inkapplications.shade.devices.parameters.UpdateDeviceParameters.UpdateDeviceParameters"]},{"name":"constructor(modelId: ModelId, manufacturerName: String, productName: String, productArchetype: ProductArchetype, certified: Boolean, softwareVersion: VersionString, hardwarePlatformType: HardwarePlatformType? = null)","description":"inkapplications.shade.devices.structures.ProductData.ProductData","location":"devices/inkapplications.shade.devices.structures/-product-data/-product-data.html","searchKeys":["ProductData","constructor(modelId: ModelId, manufacturerName: String, productName: String, productArchetype: ProductArchetype, certified: Boolean, softwareVersion: VersionString, hardwarePlatformType: HardwarePlatformType? = null)","inkapplications.shade.devices.structures.ProductData.ProductData"]},{"name":"constructor(name: String, archetype: ProductArchetype)","description":"inkapplications.shade.devices.structures.ProductMetadata.ProductMetadata","location":"devices/inkapplications.shade.devices.structures/-product-metadata/-product-metadata.html","searchKeys":["ProductMetadata","constructor(name: String, archetype: ProductArchetype)","inkapplications.shade.devices.structures.ProductMetadata.ProductMetadata"]},{"name":"constructor(name: String? = null, archetype: ProductArchetype? = null)","description":"inkapplications.shade.devices.parameters.DeviceMetadataParameters.DeviceMetadataParameters","location":"devices/inkapplications.shade.devices.parameters/-device-metadata-parameters/-device-metadata-parameters.html","searchKeys":["DeviceMetadataParameters","constructor(name: String? = null, archetype: ProductArchetype? = null)","inkapplications.shade.devices.parameters.DeviceMetadataParameters.DeviceMetadataParameters"]},{"name":"constructor(value: String)","description":"inkapplications.shade.devices.structures.HardwarePlatformType.HardwarePlatformType","location":"devices/inkapplications.shade.devices.structures/-hardware-platform-type/-hardware-platform-type.html","searchKeys":["HardwarePlatformType","constructor(value: String)","inkapplications.shade.devices.structures.HardwarePlatformType.HardwarePlatformType"]},{"name":"constructor(value: String)","description":"inkapplications.shade.devices.structures.ModelId.ModelId","location":"devices/inkapplications.shade.devices.structures/-model-id/-model-id.html","searchKeys":["ModelId","constructor(value: String)","inkapplications.shade.devices.structures.ModelId.ModelId"]},{"name":"data class Device(val id: ResourceId, val v1Id: String? = null, val productData: ProductData, val metadata: ProductMetadata, val services: List)","description":"inkapplications.shade.devices.structures.Device","location":"devices/inkapplications.shade.devices.structures/-device/index.html","searchKeys":["Device","data class Device(val id: ResourceId, val v1Id: String? = null, val productData: ProductData, val metadata: ProductMetadata, val services: List)","inkapplications.shade.devices.structures.Device"]},{"name":"data class DeviceMetadataParameters(val name: String? = null, val archetype: ProductArchetype? = null)","description":"inkapplications.shade.devices.parameters.DeviceMetadataParameters","location":"devices/inkapplications.shade.devices.parameters/-device-metadata-parameters/index.html","searchKeys":["DeviceMetadataParameters","data class DeviceMetadataParameters(val name: String? = null, val archetype: ProductArchetype? = null)","inkapplications.shade.devices.parameters.DeviceMetadataParameters"]},{"name":"data class ProductData(val modelId: ModelId, val manufacturerName: String, val productName: String, val productArchetype: ProductArchetype, val certified: Boolean, val softwareVersion: VersionString, val hardwarePlatformType: HardwarePlatformType? = null)","description":"inkapplications.shade.devices.structures.ProductData","location":"devices/inkapplications.shade.devices.structures/-product-data/index.html","searchKeys":["ProductData","data class ProductData(val modelId: ModelId, val manufacturerName: String, val productName: String, val productArchetype: ProductArchetype, val certified: Boolean, val softwareVersion: VersionString, val hardwarePlatformType: HardwarePlatformType? = null)","inkapplications.shade.devices.structures.ProductData"]},{"name":"data class ProductMetadata(val name: String, val archetype: ProductArchetype)","description":"inkapplications.shade.devices.structures.ProductMetadata","location":"devices/inkapplications.shade.devices.structures/-product-metadata/index.html","searchKeys":["ProductMetadata","data class ProductMetadata(val name: String, val archetype: ProductArchetype)","inkapplications.shade.devices.structures.ProductMetadata"]},{"name":"data class UpdateDeviceParameters","description":"inkapplications.shade.devices.parameters.UpdateDeviceParameters","location":"devices/inkapplications.shade.devices.parameters/-update-device-parameters/index.html","searchKeys":["UpdateDeviceParameters","data class UpdateDeviceParameters","inkapplications.shade.devices.parameters.UpdateDeviceParameters"]},{"name":"interface DeviceControls","description":"inkapplications.shade.devices.DeviceControls","location":"devices/inkapplications.shade.devices/-device-controls/index.html","searchKeys":["DeviceControls","interface DeviceControls","inkapplications.shade.devices.DeviceControls"]},{"name":"object Companion","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/index.html","searchKeys":["Companion","object Companion","inkapplications.shade.devices.structures.ProductArchetype.Companion"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.devices.structures.HardwarePlatformType.toString","location":"devices/inkapplications.shade.devices.structures/-hardware-platform-type/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.devices.structures.HardwarePlatformType.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.devices.structures.ModelId.toString","location":"devices/inkapplications.shade.devices.structures/-model-id/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.devices.structures.ModelId.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.devices.structures.ProductArchetype.toString","location":"devices/inkapplications.shade.devices.structures/-product-archetype/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.devices.structures.ProductArchetype.toString"]},{"name":"val Bollard: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.Bollard","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-bollard.html","searchKeys":["Bollard","val Bollard: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.Bollard"]},{"name":"val BridgeV2: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.BridgeV2","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-bridge-v2.html","searchKeys":["BridgeV2","val BridgeV2: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.BridgeV2"]},{"name":"val CandleBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.CandleBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-candle-bulb.html","searchKeys":["CandleBulb","val CandleBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.CandleBulb"]},{"name":"val CeilingHorizontal: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingHorizontal","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ceiling-horizontal.html","searchKeys":["CeilingHorizontal","val CeilingHorizontal: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingHorizontal"]},{"name":"val CeilingRound: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingRound","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ceiling-round.html","searchKeys":["CeilingRound","val CeilingRound: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingRound"]},{"name":"val CeilingSquare: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingSquare","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ceiling-square.html","searchKeys":["CeilingSquare","val CeilingSquare: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingSquare"]},{"name":"val CeilingTube: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingTube","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ceiling-tube.html","searchKeys":["CeilingTube","val CeilingTube: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingTube"]},{"name":"val ChristmasTree: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.ChristmasTree","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-christmas-tree.html","searchKeys":["ChristmasTree","val ChristmasTree: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.ChristmasTree"]},{"name":"val ClassicBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.ClassicBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-classic-bulb.html","searchKeys":["ClassicBulb","val ClassicBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.ClassicBulb"]},{"name":"val DoubleSpot: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.DoubleSpot","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-double-spot.html","searchKeys":["DoubleSpot","val DoubleSpot: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.DoubleSpot"]},{"name":"val EdisonBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.EdisonBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-edison-bulb.html","searchKeys":["EdisonBulb","val EdisonBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.EdisonBulb"]},{"name":"val EllipseBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.EllipseBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ellipse-bulb.html","searchKeys":["EllipseBulb","val EllipseBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.EllipseBulb"]},{"name":"val FlexibleLamp: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.FlexibleLamp","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-flexible-lamp.html","searchKeys":["FlexibleLamp","val FlexibleLamp: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.FlexibleLamp"]},{"name":"val FloodBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.FloodBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-flood-bulb.html","searchKeys":["FloodBulb","val FloodBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.FloodBulb"]},{"name":"val FloorLantern: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.FloorLantern","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-floor-lantern.html","searchKeys":["FloorLantern","val FloorLantern: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.FloorLantern"]},{"name":"val FloorShade: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.FloorShade","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-floor-shade.html","searchKeys":["FloorShade","val FloorShade: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.FloorShade"]},{"name":"val GroundSpot: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.GroundSpot","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ground-spot.html","searchKeys":["GroundSpot","val GroundSpot: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.GroundSpot"]},{"name":"val HueBloom: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueBloom","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-bloom.html","searchKeys":["HueBloom","val HueBloom: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueBloom"]},{"name":"val HueCentris: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueCentris","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-centris.html","searchKeys":["HueCentris","val HueCentris: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueCentris"]},{"name":"val HueGo: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueGo","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-go.html","searchKeys":["HueGo","val HueGo: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueGo"]},{"name":"val HueIris: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueIris","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-iris.html","searchKeys":["HueIris","val HueIris: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueIris"]},{"name":"val HueLightstrip: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstrip","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-lightstrip.html","searchKeys":["HueLightstrip","val HueLightstrip: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstrip"]},{"name":"val HueLightstripPc: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstripPc","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-lightstrip-pc.html","searchKeys":["HueLightstripPc","val HueLightstripPc: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstripPc"]},{"name":"val HueLightstripTv: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstripTv","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-lightstrip-tv.html","searchKeys":["HueLightstripTv","val HueLightstripTv: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstripTv"]},{"name":"val HuePlay: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HuePlay","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-play.html","searchKeys":["HuePlay","val HuePlay: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HuePlay"]},{"name":"val HueSigne: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueSigne","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-signe.html","searchKeys":["HueSigne","val HueSigne: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueSigne"]},{"name":"val HueTube: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueTube","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-tube.html","searchKeys":["HueTube","val HueTube: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueTube"]},{"name":"val LargeGlobeBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.LargeGlobeBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-large-globe-bulb.html","searchKeys":["LargeGlobeBulb","val LargeGlobeBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.LargeGlobeBulb"]},{"name":"val LusterBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.LusterBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-luster-bulb.html","searchKeys":["LusterBulb","val LusterBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.LusterBulb"]},{"name":"val PendantLong: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantLong","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-pendant-long.html","searchKeys":["PendantLong","val PendantLong: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantLong"]},{"name":"val PendantRound: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantRound","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-pendant-round.html","searchKeys":["PendantRound","val PendantRound: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantRound"]},{"name":"val PendantSpot: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantSpot","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-pendant-spot.html","searchKeys":["PendantSpot","val PendantSpot: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantSpot"]},{"name":"val Plug: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.Plug","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-plug.html","searchKeys":["Plug","val Plug: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.Plug"]},{"name":"val RecessedCeiling: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.RecessedCeiling","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-recessed-ceiling.html","searchKeys":["RecessedCeiling","val RecessedCeiling: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.RecessedCeiling"]},{"name":"val RecessedFloor: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.RecessedFloor","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-recessed-floor.html","searchKeys":["RecessedFloor","val RecessedFloor: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.RecessedFloor"]},{"name":"val SingleSpot: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.SingleSpot","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-single-spot.html","searchKeys":["SingleSpot","val SingleSpot: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.SingleSpot"]},{"name":"val SmallGlobeBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.SmallGlobeBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-small-globe-bulb.html","searchKeys":["SmallGlobeBulb","val SmallGlobeBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.SmallGlobeBulb"]},{"name":"val SpotBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.SpotBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-spot-bulb.html","searchKeys":["SpotBulb","val SpotBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.SpotBulb"]},{"name":"val StringLight: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.StringLight","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-string-light.html","searchKeys":["StringLight","val StringLight: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.StringLight"]},{"name":"val SultanBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.SultanBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-sultan-bulb.html","searchKeys":["SultanBulb","val SultanBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.SultanBulb"]},{"name":"val TableShade: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.TableShade","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-table-shade.html","searchKeys":["TableShade","val TableShade: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.TableShade"]},{"name":"val TableWash: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.TableWash","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-table-wash.html","searchKeys":["TableWash","val TableWash: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.TableWash"]},{"name":"val TriangleBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.TriangleBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-triangle-bulb.html","searchKeys":["TriangleBulb","val TriangleBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.TriangleBulb"]},{"name":"val UnknownArchetype: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.UnknownArchetype","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-unknown-archetype.html","searchKeys":["UnknownArchetype","val UnknownArchetype: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.UnknownArchetype"]},{"name":"val VintageBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.VintageBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-vintage-bulb.html","searchKeys":["VintageBulb","val VintageBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.VintageBulb"]},{"name":"val VintageCandleBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.VintageCandleBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-vintage-candle-bulb.html","searchKeys":["VintageCandleBulb","val VintageCandleBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.VintageCandleBulb"]},{"name":"val WallLantern: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.WallLantern","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-wall-lantern.html","searchKeys":["WallLantern","val WallLantern: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.WallLantern"]},{"name":"val WallShade: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.WallShade","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-wall-shade.html","searchKeys":["WallShade","val WallShade: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.WallShade"]},{"name":"val WallSpot: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.WallSpot","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-wall-spot.html","searchKeys":["WallSpot","val WallSpot: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.WallSpot"]},{"name":"val WallWasher: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.WallWasher","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-wall-washer.html","searchKeys":["WallWasher","val WallWasher: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.WallWasher"]},{"name":"val archetype: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductMetadata.archetype","location":"devices/inkapplications.shade.devices.structures/-product-metadata/archetype.html","searchKeys":["archetype","val archetype: ProductArchetype","inkapplications.shade.devices.structures.ProductMetadata.archetype"]},{"name":"val archetype: ProductArchetype?","description":"inkapplications.shade.devices.parameters.DeviceMetadataParameters.archetype","location":"devices/inkapplications.shade.devices.parameters/-device-metadata-parameters/archetype.html","searchKeys":["archetype","val archetype: ProductArchetype?","inkapplications.shade.devices.parameters.DeviceMetadataParameters.archetype"]},{"name":"val certified: Boolean","description":"inkapplications.shade.devices.structures.ProductData.certified","location":"devices/inkapplications.shade.devices.structures/-product-data/certified.html","searchKeys":["certified","val certified: Boolean","inkapplications.shade.devices.structures.ProductData.certified"]},{"name":"val devices: DeviceControls","description":"inkapplications.shade.devices.ShadeDevicesModule.devices","location":"devices/inkapplications.shade.devices/-shade-devices-module/devices.html","searchKeys":["devices","val devices: DeviceControls","inkapplications.shade.devices.ShadeDevicesModule.devices"]},{"name":"val hardwarePlatformType: HardwarePlatformType?","description":"inkapplications.shade.devices.structures.ProductData.hardwarePlatformType","location":"devices/inkapplications.shade.devices.structures/-product-data/hardware-platform-type.html","searchKeys":["hardwarePlatformType","val hardwarePlatformType: HardwarePlatformType?","inkapplications.shade.devices.structures.ProductData.hardwarePlatformType"]},{"name":"val id: ResourceId","description":"inkapplications.shade.devices.structures.Device.id","location":"devices/inkapplications.shade.devices.structures/-device/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.devices.structures.Device.id"]},{"name":"val key: String","description":"inkapplications.shade.devices.structures.ProductArchetype.key","location":"devices/inkapplications.shade.devices.structures/-product-archetype/key.html","searchKeys":["key","val key: String","inkapplications.shade.devices.structures.ProductArchetype.key"]},{"name":"val manufacturerName: String","description":"inkapplications.shade.devices.structures.ProductData.manufacturerName","location":"devices/inkapplications.shade.devices.structures/-product-data/manufacturer-name.html","searchKeys":["manufacturerName","val manufacturerName: String","inkapplications.shade.devices.structures.ProductData.manufacturerName"]},{"name":"val metadata: DeviceMetadataParameters?","description":"inkapplications.shade.devices.parameters.UpdateDeviceParameters.metadata","location":"devices/inkapplications.shade.devices.parameters/-update-device-parameters/metadata.html","searchKeys":["metadata","val metadata: DeviceMetadataParameters?","inkapplications.shade.devices.parameters.UpdateDeviceParameters.metadata"]},{"name":"val metadata: ProductMetadata","description":"inkapplications.shade.devices.structures.Device.metadata","location":"devices/inkapplications.shade.devices.structures/-device/metadata.html","searchKeys":["metadata","val metadata: ProductMetadata","inkapplications.shade.devices.structures.Device.metadata"]},{"name":"val modelId: ModelId","description":"inkapplications.shade.devices.structures.ProductData.modelId","location":"devices/inkapplications.shade.devices.structures/-product-data/model-id.html","searchKeys":["modelId","val modelId: ModelId","inkapplications.shade.devices.structures.ProductData.modelId"]},{"name":"val name: String","description":"inkapplications.shade.devices.structures.ProductMetadata.name","location":"devices/inkapplications.shade.devices.structures/-product-metadata/name.html","searchKeys":["name","val name: String","inkapplications.shade.devices.structures.ProductMetadata.name"]},{"name":"val name: String?","description":"inkapplications.shade.devices.parameters.DeviceMetadataParameters.name","location":"devices/inkapplications.shade.devices.parameters/-device-metadata-parameters/name.html","searchKeys":["name","val name: String?","inkapplications.shade.devices.parameters.DeviceMetadataParameters.name"]},{"name":"val productArchetype: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductData.productArchetype","location":"devices/inkapplications.shade.devices.structures/-product-data/product-archetype.html","searchKeys":["productArchetype","val productArchetype: ProductArchetype","inkapplications.shade.devices.structures.ProductData.productArchetype"]},{"name":"val productData: ProductData","description":"inkapplications.shade.devices.structures.Device.productData","location":"devices/inkapplications.shade.devices.structures/-device/product-data.html","searchKeys":["productData","val productData: ProductData","inkapplications.shade.devices.structures.Device.productData"]},{"name":"val productName: String","description":"inkapplications.shade.devices.structures.ProductData.productName","location":"devices/inkapplications.shade.devices.structures/-product-data/product-name.html","searchKeys":["productName","val productName: String","inkapplications.shade.devices.structures.ProductData.productName"]},{"name":"val services: List","description":"inkapplications.shade.devices.structures.Device.services","location":"devices/inkapplications.shade.devices.structures/-device/services.html","searchKeys":["services","val services: List","inkapplications.shade.devices.structures.Device.services"]},{"name":"val softwareVersion: VersionString","description":"inkapplications.shade.devices.structures.ProductData.softwareVersion","location":"devices/inkapplications.shade.devices.structures/-product-data/software-version.html","searchKeys":["softwareVersion","val softwareVersion: VersionString","inkapplications.shade.devices.structures.ProductData.softwareVersion"]},{"name":"val v1Id: String?","description":"inkapplications.shade.devices.structures.Device.v1Id","location":"devices/inkapplications.shade.devices.structures/-device/v1-id.html","searchKeys":["v1Id","val v1Id: String?","inkapplications.shade.devices.structures.Device.v1Id"]},{"name":"val value: String","description":"inkapplications.shade.devices.structures.HardwarePlatformType.value","location":"devices/inkapplications.shade.devices.structures/-hardware-platform-type/value.html","searchKeys":["value","val value: String","inkapplications.shade.devices.structures.HardwarePlatformType.value"]},{"name":"val value: String","description":"inkapplications.shade.devices.structures.ModelId.value","location":"devices/inkapplications.shade.devices.structures/-model-id/value.html","searchKeys":["value","val value: String","inkapplications.shade.devices.structures.ModelId.value"]},{"name":"value class HardwarePlatformType(val value: String)","description":"inkapplications.shade.devices.structures.HardwarePlatformType","location":"devices/inkapplications.shade.devices.structures/-hardware-platform-type/index.html","searchKeys":["HardwarePlatformType","value class HardwarePlatformType(val value: String)","inkapplications.shade.devices.structures.HardwarePlatformType"]},{"name":"value class ModelId(val value: String)","description":"inkapplications.shade.devices.structures.ModelId","location":"devices/inkapplications.shade.devices.structures/-model-id/index.html","searchKeys":["ModelId","value class ModelId(val value: String)","inkapplications.shade.devices.structures.ModelId"]},{"name":"value class ProductArchetype(val key: String)","description":"inkapplications.shade.devices.structures.ProductArchetype","location":"devices/inkapplications.shade.devices.structures/-product-archetype/index.html","searchKeys":["ProductArchetype","value class ProductArchetype(val key: String)","inkapplications.shade.devices.structures.ProductArchetype"]},{"name":"abstract fun toLux(): Lux","description":"inkapplications.shade.structures.Illuminance.toLux","location":"structures/inkapplications.shade.structures/-illuminance/to-lux.html","searchKeys":["toLux","abstract fun toLux(): Lux","inkapplications.shade.structures.Illuminance.toLux"]},{"name":"abstract suspend fun setAuthToken(token: AuthToken?)","description":"inkapplications.shade.structures.HueConfigurationContainer.setAuthToken","location":"structures/inkapplications.shade.structures/-hue-configuration-container/set-auth-token.html","searchKeys":["setAuthToken","abstract suspend fun setAuthToken(token: AuthToken?)","inkapplications.shade.structures.HueConfigurationContainer.setAuthToken"]},{"name":"abstract suspend fun setHostname(hostname: String?)","description":"inkapplications.shade.structures.HueConfigurationContainer.setHostname","location":"structures/inkapplications.shade.structures/-hue-configuration-container/set-hostname.html","searchKeys":["setHostname","abstract suspend fun setHostname(hostname: String?)","inkapplications.shade.structures.HueConfigurationContainer.setHostname"]},{"name":"abstract suspend fun setSecurityStrategy(securityStrategy: SecurityStrategy)","description":"inkapplications.shade.structures.HueConfigurationContainer.setSecurityStrategy","location":"structures/inkapplications.shade.structures/-hue-configuration-container/set-security-strategy.html","searchKeys":["setSecurityStrategy","abstract suspend fun setSecurityStrategy(securityStrategy: SecurityStrategy)","inkapplications.shade.structures.HueConfigurationContainer.setSecurityStrategy"]},{"name":"abstract val authToken: StateFlow","description":"inkapplications.shade.structures.HueConfigurationContainer.authToken","location":"structures/inkapplications.shade.structures/-hue-configuration-container/auth-token.html","searchKeys":["authToken","abstract val authToken: StateFlow","inkapplications.shade.structures.HueConfigurationContainer.authToken"]},{"name":"abstract val hostname: StateFlow","description":"inkapplications.shade.structures.HueConfigurationContainer.hostname","location":"structures/inkapplications.shade.structures/-hue-configuration-container/hostname.html","searchKeys":["hostname","abstract val hostname: StateFlow","inkapplications.shade.structures.HueConfigurationContainer.hostname"]},{"name":"abstract val securityStrategy: StateFlow","description":"inkapplications.shade.structures.HueConfigurationContainer.securityStrategy","location":"structures/inkapplications.shade.structures/-hue-configuration-container/security-strategy.html","searchKeys":["securityStrategy","abstract val securityStrategy: StateFlow","inkapplications.shade.structures.HueConfigurationContainer.securityStrategy"]},{"name":"annotation class UndocumentedApi","description":"inkapplications.shade.structures.UndocumentedApi","location":"structures/inkapplications.shade.structures/-undocumented-api/index.html","searchKeys":["UndocumentedApi","annotation class UndocumentedApi","inkapplications.shade.structures.UndocumentedApi"]},{"name":"class ApiError(code: Int, errors: List) : ApiStatusError","description":"inkapplications.shade.structures.ApiError","location":"structures/inkapplications.shade.structures/-api-error/index.html","searchKeys":["ApiError","class ApiError(code: Int, errors: List) : ApiStatusError","inkapplications.shade.structures.ApiError"]},{"name":"class HueCa(ip: String, deviceId: String) : SecurityStrategy.CustomCa","description":"inkapplications.shade.structures.SecurityStrategy.HueCa","location":"structures/inkapplications.shade.structures/-security-strategy/-hue-ca/index.html","searchKeys":["HueCa","class HueCa(ip: String, deviceId: String) : SecurityStrategy.CustomCa","inkapplications.shade.structures.SecurityStrategy.HueCa"]},{"name":"class InMemoryConfigurationContainer(initialHostname: String? = null, initialAuthToken: AuthToken? = null, initialSecurityStrategy: SecurityStrategy = SecurityStrategy.PlatformTrust) : HueConfigurationContainer","description":"inkapplications.shade.structures.InMemoryConfigurationContainer","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/index.html","searchKeys":["InMemoryConfigurationContainer","class InMemoryConfigurationContainer(initialHostname: String? = null, initialAuthToken: AuthToken? = null, initialSecurityStrategy: SecurityStrategy = SecurityStrategy.PlatformTrust) : HueConfigurationContainer","inkapplications.shade.structures.InMemoryConfigurationContainer"]},{"name":"class Insecure(val hostname: String) : SecurityStrategy","description":"inkapplications.shade.structures.SecurityStrategy.Insecure","location":"structures/inkapplications.shade.structures/-security-strategy/-insecure/index.html","searchKeys":["Insecure","class Insecure(val hostname: String) : SecurityStrategy","inkapplications.shade.structures.SecurityStrategy.Insecure"]},{"name":"class InvalidConfigurationException(message: String) : UserError","description":"inkapplications.shade.structures.InvalidConfigurationException","location":"structures/inkapplications.shade.structures/-invalid-configuration-exception/index.html","searchKeys":["InvalidConfigurationException","class InvalidConfigurationException(message: String) : UserError","inkapplications.shade.structures.InvalidConfigurationException"]},{"name":"class NetworkException(message: String, cause: Throwable) : ShadeException","description":"inkapplications.shade.structures.NetworkException","location":"structures/inkapplications.shade.structures/-network-exception/index.html","searchKeys":["NetworkException","class NetworkException(message: String, cause: Throwable) : ShadeException","inkapplications.shade.structures.NetworkException"]},{"name":"class PropertiesFileConfiguration(file: File = File(\n System.getProperty(\"user.home\")\n .takeIf { it.isNullOrEmpty() == false },\n \".shade-cli.properties\"\n )) : HueConfigurationContainer","description":"inkapplications.shade.structures.PropertiesFileConfiguration","location":"structures/inkapplications.shade.structures/-properties-file-configuration/index.html","searchKeys":["PropertiesFileConfiguration","class PropertiesFileConfiguration(file: File = File(\n System.getProperty(\"user.home\")\n .takeIf { it.isNullOrEmpty() == false },\n \".shade-cli.properties\"\n )) : HueConfigurationContainer","inkapplications.shade.structures.PropertiesFileConfiguration"]},{"name":"class SerializationError(message: String, cause: Throwable?) : InternalErrorException","description":"inkapplications.shade.structures.SerializationError","location":"structures/inkapplications.shade.structures/-serialization-error/index.html","searchKeys":["SerializationError","class SerializationError(message: String, cause: Throwable?) : InternalErrorException","inkapplications.shade.structures.SerializationError"]},{"name":"class UnauthorizedException(cause: Throwable? = null) : ShadeException","description":"inkapplications.shade.structures.UnauthorizedException","location":"structures/inkapplications.shade.structures/-unauthorized-exception/index.html","searchKeys":["UnauthorizedException","class UnauthorizedException(cause: Throwable? = null) : ShadeException","inkapplications.shade.structures.UnauthorizedException"]},{"name":"class UnexpectedStateException(message: String, cause: Throwable? = null) : InternalErrorException","description":"inkapplications.shade.structures.UnexpectedStateException","location":"structures/inkapplications.shade.structures/-unexpected-state-exception/index.html","searchKeys":["UnexpectedStateException","class UnexpectedStateException(message: String, cause: Throwable? = null) : InternalErrorException","inkapplications.shade.structures.UnexpectedStateException"]},{"name":"constructor(applicationKey: String, clientKey: String? = null)","description":"inkapplications.shade.structures.AuthToken.AuthToken","location":"structures/inkapplications.shade.structures/-auth-token/-auth-token.html","searchKeys":["AuthToken","constructor(applicationKey: String, clientKey: String? = null)","inkapplications.shade.structures.AuthToken.AuthToken"]},{"name":"constructor(archetype: SegmentArchetype, name: String)","description":"inkapplications.shade.structures.SegmentMetadata.SegmentMetadata","location":"structures/inkapplications.shade.structures/-segment-metadata/-segment-metadata.html","searchKeys":["SegmentMetadata","constructor(archetype: SegmentArchetype, name: String)","inkapplications.shade.structures.SegmentMetadata.SegmentMetadata"]},{"name":"constructor(archetype: SegmentArchetype? = null, name: String? = null)","description":"inkapplications.shade.structures.SegmentMetadataUpdate.SegmentMetadataUpdate","location":"structures/inkapplications.shade.structures/-segment-metadata-update/-segment-metadata-update.html","searchKeys":["SegmentMetadataUpdate","constructor(archetype: SegmentArchetype? = null, name: String? = null)","inkapplications.shade.structures.SegmentMetadataUpdate.SegmentMetadataUpdate"]},{"name":"constructor(cause: Throwable? = null)","description":"inkapplications.shade.structures.UnauthorizedException.UnauthorizedException","location":"structures/inkapplications.shade.structures/-unauthorized-exception/-unauthorized-exception.html","searchKeys":["UnauthorizedException","constructor(cause: Throwable? = null)","inkapplications.shade.structures.UnauthorizedException.UnauthorizedException"]},{"name":"constructor(certificatePem: String, hostname: String, ip: String)","description":"inkapplications.shade.structures.SecurityStrategy.CustomCa.CustomCa","location":"structures/inkapplications.shade.structures/-security-strategy/-custom-ca/-custom-ca.html","searchKeys":["CustomCa","constructor(certificatePem: String, hostname: String, ip: String)","inkapplications.shade.structures.SecurityStrategy.CustomCa.CustomCa"]},{"name":"constructor(code: Int, errors: List)","description":"inkapplications.shade.structures.ApiError.ApiError","location":"structures/inkapplications.shade.structures/-api-error/-api-error.html","searchKeys":["ApiError","constructor(code: Int, errors: List)","inkapplications.shade.structures.ApiError.ApiError"]},{"name":"constructor(code: Int, message: String = \"API Responded with code \")","description":"inkapplications.shade.structures.ApiStatusError.ApiStatusError","location":"structures/inkapplications.shade.structures/-api-status-error/-api-status-error.html","searchKeys":["ApiStatusError","constructor(code: Int, message: String = \"API Responded with code \")","inkapplications.shade.structures.ApiStatusError.ApiStatusError"]},{"name":"constructor(file: File = File(\n System.getProperty(\"user.home\")\n .takeIf { it.isNullOrEmpty() == false },\n \".shade-cli.properties\"\n ))","description":"inkapplications.shade.structures.PropertiesFileConfiguration.PropertiesFileConfiguration","location":"structures/inkapplications.shade.structures/-properties-file-configuration/-properties-file-configuration.html","searchKeys":["PropertiesFileConfiguration","constructor(file: File = File(\n System.getProperty(\"user.home\")\n .takeIf { it.isNullOrEmpty() == false },\n \".shade-cli.properties\"\n ))","inkapplications.shade.structures.PropertiesFileConfiguration.PropertiesFileConfiguration"]},{"name":"constructor(full: String)","description":"inkapplications.shade.structures.VersionString.VersionString","location":"structures/inkapplications.shade.structures/-version-string/-version-string.html","searchKeys":["VersionString","constructor(full: String)","inkapplications.shade.structures.VersionString.VersionString"]},{"name":"constructor(hostname: String)","description":"inkapplications.shade.structures.SecurityStrategy.Insecure.Insecure","location":"structures/inkapplications.shade.structures/-security-strategy/-insecure/-insecure.html","searchKeys":["Insecure","constructor(hostname: String)","inkapplications.shade.structures.SecurityStrategy.Insecure.Insecure"]},{"name":"constructor(id: ResourceId, type: ResourceType)","description":"inkapplications.shade.structures.ResourceReference.ResourceReference","location":"structures/inkapplications.shade.structures/-resource-reference/-resource-reference.html","searchKeys":["ResourceReference","constructor(id: ResourceId, type: ResourceType)","inkapplications.shade.structures.ResourceReference.ResourceReference"]},{"name":"constructor(initialHostname: String? = null, initialAuthToken: AuthToken? = null, initialSecurityStrategy: SecurityStrategy = SecurityStrategy.PlatformTrust)","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.InMemoryConfigurationContainer","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/-in-memory-configuration-container.html","searchKeys":["InMemoryConfigurationContainer","constructor(initialHostname: String? = null, initialAuthToken: AuthToken? = null, initialSecurityStrategy: SecurityStrategy = SecurityStrategy.PlatformTrust)","inkapplications.shade.structures.InMemoryConfigurationContainer.InMemoryConfigurationContainer"]},{"name":"constructor(ip: String, deviceId: String)","description":"inkapplications.shade.structures.SecurityStrategy.HueCa.HueCa","location":"structures/inkapplications.shade.structures/-security-strategy/-hue-ca/-hue-ca.html","searchKeys":["HueCa","constructor(ip: String, deviceId: String)","inkapplications.shade.structures.SecurityStrategy.HueCa.HueCa"]},{"name":"constructor(key: String)","description":"inkapplications.shade.structures.ResourceType.ResourceType","location":"structures/inkapplications.shade.structures/-resource-type/-resource-type.html","searchKeys":["ResourceType","constructor(key: String)","inkapplications.shade.structures.ResourceType.ResourceType"]},{"name":"constructor(key: String)","description":"inkapplications.shade.structures.SegmentArchetype.SegmentArchetype","location":"structures/inkapplications.shade.structures/-segment-archetype/-segment-archetype.html","searchKeys":["SegmentArchetype","constructor(key: String)","inkapplications.shade.structures.SegmentArchetype.SegmentArchetype"]},{"name":"constructor(message: String)","description":"inkapplications.shade.structures.InvalidConfigurationException.InvalidConfigurationException","location":"structures/inkapplications.shade.structures/-invalid-configuration-exception/-invalid-configuration-exception.html","searchKeys":["InvalidConfigurationException","constructor(message: String)","inkapplications.shade.structures.InvalidConfigurationException.InvalidConfigurationException"]},{"name":"constructor(message: String, cause: Throwable)","description":"inkapplications.shade.structures.NetworkException.NetworkException","location":"structures/inkapplications.shade.structures/-network-exception/-network-exception.html","searchKeys":["NetworkException","constructor(message: String, cause: Throwable)","inkapplications.shade.structures.NetworkException.NetworkException"]},{"name":"constructor(message: String, cause: Throwable? = null)","description":"inkapplications.shade.structures.UnexpectedStateException.UnexpectedStateException","location":"structures/inkapplications.shade.structures/-unexpected-state-exception/-unexpected-state-exception.html","searchKeys":["UnexpectedStateException","constructor(message: String, cause: Throwable? = null)","inkapplications.shade.structures.UnexpectedStateException.UnexpectedStateException"]},{"name":"constructor(message: String, cause: Throwable?)","description":"inkapplications.shade.structures.SerializationError.SerializationError","location":"structures/inkapplications.shade.structures/-serialization-error/-serialization-error.html","searchKeys":["SerializationError","constructor(message: String, cause: Throwable?)","inkapplications.shade.structures.SerializationError.SerializationError"]},{"name":"constructor(on: Boolean)","description":"inkapplications.shade.structures.PowerInfo.PowerInfo","location":"structures/inkapplications.shade.structures/-power-info/-power-info.html","searchKeys":["PowerInfo","constructor(on: Boolean)","inkapplications.shade.structures.PowerInfo.PowerInfo"]},{"name":"constructor(on: Boolean)","description":"inkapplications.shade.structures.PowerValue.PowerValue","location":"structures/inkapplications.shade.structures/-power-value/-power-value.html","searchKeys":["PowerValue","constructor(on: Boolean)","inkapplications.shade.structures.PowerValue.PowerValue"]},{"name":"constructor(on: Boolean? = null)","description":"inkapplications.shade.structures.parameters.PowerParameters.PowerParameters","location":"structures/inkapplications.shade.structures.parameters/-power-parameters/-power-parameters.html","searchKeys":["PowerParameters","constructor(on: Boolean? = null)","inkapplications.shade.structures.parameters.PowerParameters.PowerParameters"]},{"name":"constructor(type: String, json: String)","description":"inkapplications.shade.structures.UnknownEvent.UnknownEvent","location":"structures/inkapplications.shade.structures/-unknown-event/-unknown-event.html","searchKeys":["UnknownEvent","constructor(type: String, json: String)","inkapplications.shade.structures.UnknownEvent.UnknownEvent"]},{"name":"constructor(value: Number)","description":"inkapplications.shade.structures.FootCandles.FootCandles","location":"structures/inkapplications.shade.structures/-foot-candles/-foot-candles.html","searchKeys":["FootCandles","constructor(value: Number)","inkapplications.shade.structures.FootCandles.FootCandles"]},{"name":"constructor(value: Number)","description":"inkapplications.shade.structures.Lux.Lux","location":"structures/inkapplications.shade.structures/-lux/-lux.html","searchKeys":["Lux","constructor(value: Number)","inkapplications.shade.structures.Lux.Lux"]},{"name":"constructor(value: Number)","description":"inkapplications.shade.structures.ScaledLux.ScaledLux","location":"structures/inkapplications.shade.structures/-scaled-lux/-scaled-lux.html","searchKeys":["ScaledLux","constructor(value: Number)","inkapplications.shade.structures.ScaledLux.ScaledLux"]},{"name":"constructor(value: String)","description":"inkapplications.shade.structures.ResourceId.ResourceId","location":"structures/inkapplications.shade.structures/-resource-id/-resource-id.html","searchKeys":["ResourceId","constructor(value: String)","inkapplications.shade.structures.ResourceId.ResourceId"]},{"name":"data class AuthToken(val applicationKey: String, val clientKey: String? = null)","description":"inkapplications.shade.structures.AuthToken","location":"structures/inkapplications.shade.structures/-auth-token/index.html","searchKeys":["AuthToken","data class AuthToken(val applicationKey: String, val clientKey: String? = null)","inkapplications.shade.structures.AuthToken"]},{"name":"data class PowerInfo(val on: Boolean)","description":"inkapplications.shade.structures.PowerInfo","location":"structures/inkapplications.shade.structures/-power-info/index.html","searchKeys":["PowerInfo","data class PowerInfo(val on: Boolean)","inkapplications.shade.structures.PowerInfo"]},{"name":"data class PowerParameters(val on: Boolean? = null)","description":"inkapplications.shade.structures.parameters.PowerParameters","location":"structures/inkapplications.shade.structures.parameters/-power-parameters/index.html","searchKeys":["PowerParameters","data class PowerParameters(val on: Boolean? = null)","inkapplications.shade.structures.parameters.PowerParameters"]},{"name":"data class PowerValue(val on: Boolean)","description":"inkapplications.shade.structures.PowerValue","location":"structures/inkapplications.shade.structures/-power-value/index.html","searchKeys":["PowerValue","data class PowerValue(val on: Boolean)","inkapplications.shade.structures.PowerValue"]},{"name":"data class ResourceReference(val id: ResourceId, val type: ResourceType)","description":"inkapplications.shade.structures.ResourceReference","location":"structures/inkapplications.shade.structures/-resource-reference/index.html","searchKeys":["ResourceReference","data class ResourceReference(val id: ResourceId, val type: ResourceType)","inkapplications.shade.structures.ResourceReference"]},{"name":"data class SegmentMetadata(val archetype: SegmentArchetype, val name: String)","description":"inkapplications.shade.structures.SegmentMetadata","location":"structures/inkapplications.shade.structures/-segment-metadata/index.html","searchKeys":["SegmentMetadata","data class SegmentMetadata(val archetype: SegmentArchetype, val name: String)","inkapplications.shade.structures.SegmentMetadata"]},{"name":"data class SegmentMetadataUpdate(val archetype: SegmentArchetype? = null, val name: String? = null)","description":"inkapplications.shade.structures.SegmentMetadataUpdate","location":"structures/inkapplications.shade.structures/-segment-metadata-update/index.html","searchKeys":["SegmentMetadataUpdate","data class SegmentMetadataUpdate(val archetype: SegmentArchetype? = null, val name: String? = null)","inkapplications.shade.structures.SegmentMetadataUpdate"]},{"name":"data class UnknownEvent(val type: String, val json: String)","description":"inkapplications.shade.structures.UnknownEvent","location":"structures/inkapplications.shade.structures/-unknown-event/index.html","searchKeys":["UnknownEvent","data class UnknownEvent(val type: String, val json: String)","inkapplications.shade.structures.UnknownEvent"]},{"name":"fun Illuminance.toFootCandle(): FootCandles","description":"inkapplications.shade.structures.toFootCandle","location":"structures/inkapplications.shade.structures/to-foot-candle.html","searchKeys":["toFootCandle","fun Illuminance.toFootCandle(): FootCandles","inkapplications.shade.structures.toFootCandle"]},{"name":"fun Illuminance.toScaledLux(): ScaledLux","description":"inkapplications.shade.structures.toScaledLux","location":"structures/inkapplications.shade.structures/to-scaled-lux.html","searchKeys":["toScaledLux","fun Illuminance.toScaledLux(): ScaledLux","inkapplications.shade.structures.toScaledLux"]},{"name":"fun valueOf(key: String): ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.valueOf","location":"structures/inkapplications.shade.structures/-resource-type/-companion/value-of.html","searchKeys":["valueOf","fun valueOf(key: String): ResourceType","inkapplications.shade.structures.ResourceType.Companion.valueOf"]},{"name":"fun valueOf(key: String): SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.valueOf","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/value-of.html","searchKeys":["valueOf","fun valueOf(key: String): SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.valueOf"]},{"name":"fun values(): Array","description":"inkapplications.shade.structures.ResourceType.Companion.values","location":"structures/inkapplications.shade.structures/-resource-type/-companion/values.html","searchKeys":["values","fun values(): Array","inkapplications.shade.structures.ResourceType.Companion.values"]},{"name":"fun values(): Array","description":"inkapplications.shade.structures.SegmentArchetype.Companion.values","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/values.html","searchKeys":["values","fun values(): Array","inkapplications.shade.structures.SegmentArchetype.Companion.values"]},{"name":"interface HueConfigurationContainer","description":"inkapplications.shade.structures.HueConfigurationContainer","location":"structures/inkapplications.shade.structures/-hue-configuration-container/index.html","searchKeys":["HueConfigurationContainer","interface HueConfigurationContainer","inkapplications.shade.structures.HueConfigurationContainer"]},{"name":"interface Illuminance","description":"inkapplications.shade.structures.Illuminance","location":"structures/inkapplications.shade.structures/-illuminance/index.html","searchKeys":["Illuminance","interface Illuminance","inkapplications.shade.structures.Illuminance"]},{"name":"object AuthorizationTimeoutException : ShadeException","description":"inkapplications.shade.structures.AuthorizationTimeoutException","location":"structures/inkapplications.shade.structures/-authorization-timeout-exception/index.html","searchKeys":["AuthorizationTimeoutException","object AuthorizationTimeoutException : ShadeException","inkapplications.shade.structures.AuthorizationTimeoutException"]},{"name":"object Companion","description":"inkapplications.shade.structures.ResourceType.Companion","location":"structures/inkapplications.shade.structures/-resource-type/-companion/index.html","searchKeys":["Companion","object Companion","inkapplications.shade.structures.ResourceType.Companion"]},{"name":"object Companion","description":"inkapplications.shade.structures.SegmentArchetype.Companion","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/index.html","searchKeys":["Companion","object Companion","inkapplications.shade.structures.SegmentArchetype.Companion"]},{"name":"object HostnameNotSetException : UserError","description":"inkapplications.shade.structures.HostnameNotSetException","location":"structures/inkapplications.shade.structures/-hostname-not-set-exception/index.html","searchKeys":["HostnameNotSetException","object HostnameNotSetException : UserError","inkapplications.shade.structures.HostnameNotSetException"]},{"name":"object PlatformTrust : SecurityStrategy","description":"inkapplications.shade.structures.SecurityStrategy.PlatformTrust","location":"structures/inkapplications.shade.structures/-security-strategy/-platform-trust/index.html","searchKeys":["PlatformTrust","object PlatformTrust : SecurityStrategy","inkapplications.shade.structures.SecurityStrategy.PlatformTrust"]},{"name":"object ScaledLuxSerializer : KSerializer ","description":"inkapplications.shade.structures.ScaledLuxSerializer","location":"structures/inkapplications.shade.structures/-scaled-lux-serializer/index.html","searchKeys":["ScaledLuxSerializer","object ScaledLuxSerializer : KSerializer ","inkapplications.shade.structures.ScaledLuxSerializer"]},{"name":"open class ApiStatusError(val code: Int, message: String = \"API Responded with code \") : ShadeException","description":"inkapplications.shade.structures.ApiStatusError","location":"structures/inkapplications.shade.structures/-api-status-error/index.html","searchKeys":["ApiStatusError","open class ApiStatusError(val code: Int, message: String = \"API Responded with code \") : ShadeException","inkapplications.shade.structures.ApiStatusError"]},{"name":"open class CustomCa(val certificatePem: String, val hostname: String, val ip: String) : SecurityStrategy","description":"inkapplications.shade.structures.SecurityStrategy.CustomCa","location":"structures/inkapplications.shade.structures/-security-strategy/-custom-ca/index.html","searchKeys":["CustomCa","open class CustomCa(val certificatePem: String, val hostname: String, val ip: String) : SecurityStrategy","inkapplications.shade.structures.SecurityStrategy.CustomCa"]},{"name":"open class InternalErrorException : ShadeException","description":"inkapplications.shade.structures.InternalErrorException","location":"structures/inkapplications.shade.structures/-internal-error-exception/index.html","searchKeys":["InternalErrorException","open class InternalErrorException : ShadeException","inkapplications.shade.structures.InternalErrorException"]},{"name":"open class SecurityStrategy","description":"inkapplications.shade.structures.SecurityStrategy","location":"structures/inkapplications.shade.structures/-security-strategy/index.html","searchKeys":["SecurityStrategy","open class SecurityStrategy","inkapplications.shade.structures.SecurityStrategy"]},{"name":"open class ShadeException : RuntimeException","description":"inkapplications.shade.structures.ShadeException","location":"structures/inkapplications.shade.structures/-shade-exception/index.html","searchKeys":["ShadeException","open class ShadeException : RuntimeException","inkapplications.shade.structures.ShadeException"]},{"name":"open class UserError : ShadeException","description":"inkapplications.shade.structures.UserError","location":"structures/inkapplications.shade.structures/-user-error/index.html","searchKeys":["UserError","open class UserError : ShadeException","inkapplications.shade.structures.UserError"]},{"name":"open override fun deserialize(decoder: Decoder): ScaledLux","description":"inkapplications.shade.structures.ScaledLuxSerializer.deserialize","location":"structures/inkapplications.shade.structures/-scaled-lux-serializer/deserialize.html","searchKeys":["deserialize","open override fun deserialize(decoder: Decoder): ScaledLux","inkapplications.shade.structures.ScaledLuxSerializer.deserialize"]},{"name":"open override fun serialize(encoder: Encoder, value: Illuminance)","description":"inkapplications.shade.structures.ScaledLuxSerializer.serialize","location":"structures/inkapplications.shade.structures/-scaled-lux-serializer/serialize.html","searchKeys":["serialize","open override fun serialize(encoder: Encoder, value: Illuminance)","inkapplications.shade.structures.ScaledLuxSerializer.serialize"]},{"name":"open override fun toLux(): Lux","description":"inkapplications.shade.structures.FootCandles.toLux","location":"structures/inkapplications.shade.structures/-foot-candles/to-lux.html","searchKeys":["toLux","open override fun toLux(): Lux","inkapplications.shade.structures.FootCandles.toLux"]},{"name":"open override fun toLux(): Lux","description":"inkapplications.shade.structures.Lux.toLux","location":"structures/inkapplications.shade.structures/-lux/to-lux.html","searchKeys":["toLux","open override fun toLux(): Lux","inkapplications.shade.structures.Lux.toLux"]},{"name":"open override fun toLux(): Lux","description":"inkapplications.shade.structures.ScaledLux.toLux","location":"structures/inkapplications.shade.structures/-scaled-lux/to-lux.html","searchKeys":["toLux","open override fun toLux(): Lux","inkapplications.shade.structures.ScaledLux.toLux"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.AuthToken.toString","location":"structures/inkapplications.shade.structures/-auth-token/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.AuthToken.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.FootCandles.toString","location":"structures/inkapplications.shade.structures/-foot-candles/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.FootCandles.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.Lux.toString","location":"structures/inkapplications.shade.structures/-lux/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.Lux.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.ResourceId.toString","location":"structures/inkapplications.shade.structures/-resource-id/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.ResourceId.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.ResourceReference.toString","location":"structures/inkapplications.shade.structures/-resource-reference/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.ResourceReference.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.ResourceType.toString","location":"structures/inkapplications.shade.structures/-resource-type/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.ResourceType.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.ScaledLux.toString","location":"structures/inkapplications.shade.structures/-scaled-lux/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.ScaledLux.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.SegmentArchetype.toString","location":"structures/inkapplications.shade.structures/-segment-archetype/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.SegmentArchetype.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.VersionString.toString","location":"structures/inkapplications.shade.structures/-version-string/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.VersionString.toString"]},{"name":"open override fun withValue(value: Number): FootCandles","description":"inkapplications.shade.structures.FootCandles.withValue","location":"structures/inkapplications.shade.structures/-foot-candles/with-value.html","searchKeys":["withValue","open override fun withValue(value: Number): FootCandles","inkapplications.shade.structures.FootCandles.withValue"]},{"name":"open override fun withValue(value: Number): Lux","description":"inkapplications.shade.structures.Lux.withValue","location":"structures/inkapplications.shade.structures/-lux/with-value.html","searchKeys":["withValue","open override fun withValue(value: Number): Lux","inkapplications.shade.structures.Lux.withValue"]},{"name":"open override fun withValue(value: Number): ScaledLux","description":"inkapplications.shade.structures.ScaledLux.withValue","location":"structures/inkapplications.shade.structures/-scaled-lux/with-value.html","searchKeys":["withValue","open override fun withValue(value: Number): ScaledLux","inkapplications.shade.structures.ScaledLux.withValue"]},{"name":"open override val authToken: StateFlow","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.authToken","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/auth-token.html","searchKeys":["authToken","open override val authToken: StateFlow","inkapplications.shade.structures.InMemoryConfigurationContainer.authToken"]},{"name":"open override val authToken: StateFlow","description":"inkapplications.shade.structures.PropertiesFileConfiguration.authToken","location":"structures/inkapplications.shade.structures/-properties-file-configuration/auth-token.html","searchKeys":["authToken","open override val authToken: StateFlow","inkapplications.shade.structures.PropertiesFileConfiguration.authToken"]},{"name":"open override val descriptor: SerialDescriptor","description":"inkapplications.shade.structures.ScaledLuxSerializer.descriptor","location":"structures/inkapplications.shade.structures/-scaled-lux-serializer/descriptor.html","searchKeys":["descriptor","open override val descriptor: SerialDescriptor","inkapplications.shade.structures.ScaledLuxSerializer.descriptor"]},{"name":"open override val hostname: StateFlow","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.hostname","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/hostname.html","searchKeys":["hostname","open override val hostname: StateFlow","inkapplications.shade.structures.InMemoryConfigurationContainer.hostname"]},{"name":"open override val hostname: StateFlow","description":"inkapplications.shade.structures.PropertiesFileConfiguration.hostname","location":"structures/inkapplications.shade.structures/-properties-file-configuration/hostname.html","searchKeys":["hostname","open override val hostname: StateFlow","inkapplications.shade.structures.PropertiesFileConfiguration.hostname"]},{"name":"open override val securityStrategy: StateFlow","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.securityStrategy","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/security-strategy.html","searchKeys":["securityStrategy","open override val securityStrategy: StateFlow","inkapplications.shade.structures.InMemoryConfigurationContainer.securityStrategy"]},{"name":"open override val securityStrategy: StateFlow","description":"inkapplications.shade.structures.PropertiesFileConfiguration.securityStrategy","location":"structures/inkapplications.shade.structures/-properties-file-configuration/security-strategy.html","searchKeys":["securityStrategy","open override val securityStrategy: StateFlow","inkapplications.shade.structures.PropertiesFileConfiguration.securityStrategy"]},{"name":"open override val symbol: String","description":"inkapplications.shade.structures.FootCandles.symbol","location":"structures/inkapplications.shade.structures/-foot-candles/symbol.html","searchKeys":["symbol","open override val symbol: String","inkapplications.shade.structures.FootCandles.symbol"]},{"name":"open override val symbol: String","description":"inkapplications.shade.structures.Lux.symbol","location":"structures/inkapplications.shade.structures/-lux/symbol.html","searchKeys":["symbol","open override val symbol: String","inkapplications.shade.structures.Lux.symbol"]},{"name":"open override val symbol: String","description":"inkapplications.shade.structures.ScaledLux.symbol","location":"structures/inkapplications.shade.structures/-scaled-lux/symbol.html","searchKeys":["symbol","open override val symbol: String","inkapplications.shade.structures.ScaledLux.symbol"]},{"name":"open override val value: Number","description":"inkapplications.shade.structures.FootCandles.value","location":"structures/inkapplications.shade.structures/-foot-candles/value.html","searchKeys":["value","open override val value: Number","inkapplications.shade.structures.FootCandles.value"]},{"name":"open override val value: Number","description":"inkapplications.shade.structures.Lux.value","location":"structures/inkapplications.shade.structures/-lux/value.html","searchKeys":["value","open override val value: Number","inkapplications.shade.structures.Lux.value"]},{"name":"open override val value: Number","description":"inkapplications.shade.structures.ScaledLux.value","location":"structures/inkapplications.shade.structures/-scaled-lux/value.html","searchKeys":["value","open override val value: Number","inkapplications.shade.structures.ScaledLux.value"]},{"name":"open suspend override fun setAuthToken(key: AuthToken?)","description":"inkapplications.shade.structures.PropertiesFileConfiguration.setAuthToken","location":"structures/inkapplications.shade.structures/-properties-file-configuration/set-auth-token.html","searchKeys":["setAuthToken","open suspend override fun setAuthToken(key: AuthToken?)","inkapplications.shade.structures.PropertiesFileConfiguration.setAuthToken"]},{"name":"open suspend override fun setAuthToken(token: AuthToken?)","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.setAuthToken","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/set-auth-token.html","searchKeys":["setAuthToken","open suspend override fun setAuthToken(token: AuthToken?)","inkapplications.shade.structures.InMemoryConfigurationContainer.setAuthToken"]},{"name":"open suspend override fun setHostname(hostname: String?)","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.setHostname","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/set-hostname.html","searchKeys":["setHostname","open suspend override fun setHostname(hostname: String?)","inkapplications.shade.structures.InMemoryConfigurationContainer.setHostname"]},{"name":"open suspend override fun setHostname(hostname: String?)","description":"inkapplications.shade.structures.PropertiesFileConfiguration.setHostname","location":"structures/inkapplications.shade.structures/-properties-file-configuration/set-hostname.html","searchKeys":["setHostname","open suspend override fun setHostname(hostname: String?)","inkapplications.shade.structures.PropertiesFileConfiguration.setHostname"]},{"name":"open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.setSecurityStrategy","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/set-security-strategy.html","searchKeys":["setSecurityStrategy","open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","inkapplications.shade.structures.InMemoryConfigurationContainer.setSecurityStrategy"]},{"name":"open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","description":"inkapplications.shade.structures.PropertiesFileConfiguration.setSecurityStrategy","location":"structures/inkapplications.shade.structures/-properties-file-configuration/set-security-strategy.html","searchKeys":["setSecurityStrategy","open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","inkapplications.shade.structures.PropertiesFileConfiguration.setSecurityStrategy"]},{"name":"val Attic: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Attic","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-attic.html","searchKeys":["Attic","val Attic: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Attic"]},{"name":"val AuthV1: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.AuthV1","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-auth-v1.html","searchKeys":["AuthV1","val AuthV1: ResourceType","inkapplications.shade.structures.ResourceType.Companion.AuthV1"]},{"name":"val Balcony: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Balcony","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-balcony.html","searchKeys":["Balcony","val Balcony: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Balcony"]},{"name":"val Barbecue: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Barbecue","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-barbecue.html","searchKeys":["Barbecue","val Barbecue: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Barbecue"]},{"name":"val Bathroom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Bathroom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-bathroom.html","searchKeys":["Bathroom","val Bathroom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Bathroom"]},{"name":"val Bedroom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Bedroom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-bedroom.html","searchKeys":["Bedroom","val Bedroom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Bedroom"]},{"name":"val BehaviorInstance: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.BehaviorInstance","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-behavior-instance.html","searchKeys":["BehaviorInstance","val BehaviorInstance: ResourceType","inkapplications.shade.structures.ResourceType.Companion.BehaviorInstance"]},{"name":"val BehaviorScript: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.BehaviorScript","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-behavior-script.html","searchKeys":["BehaviorScript","val BehaviorScript: ResourceType","inkapplications.shade.structures.ResourceType.Companion.BehaviorScript"]},{"name":"val Bridge: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Bridge","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-bridge.html","searchKeys":["Bridge","val Bridge: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Bridge"]},{"name":"val BridgeHome: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.BridgeHome","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-bridge-home.html","searchKeys":["BridgeHome","val BridgeHome: ResourceType","inkapplications.shade.structures.ResourceType.Companion.BridgeHome"]},{"name":"val Button: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Button","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-button.html","searchKeys":["Button","val Button: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Button"]},{"name":"val Carport: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Carport","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-carport.html","searchKeys":["Carport","val Carport: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Carport"]},{"name":"val Closet: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Closet","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-closet.html","searchKeys":["Closet","val Closet: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Closet"]},{"name":"val Computer: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Computer","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-computer.html","searchKeys":["Computer","val Computer: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Computer"]},{"name":"val Device: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Device","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-device.html","searchKeys":["Device","val Device: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Device"]},{"name":"val DevicePower: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.DevicePower","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-device-power.html","searchKeys":["DevicePower","val DevicePower: ResourceType","inkapplications.shade.structures.ResourceType.Companion.DevicePower"]},{"name":"val Dining: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Dining","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-dining.html","searchKeys":["Dining","val Dining: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Dining"]},{"name":"val Downstairs: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Downstairs","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-downstairs.html","searchKeys":["Downstairs","val Downstairs: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Downstairs"]},{"name":"val Driveway: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Driveway","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-driveway.html","searchKeys":["Driveway","val Driveway: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Driveway"]},{"name":"val Entertainment: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Entertainment","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-entertainment.html","searchKeys":["Entertainment","val Entertainment: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Entertainment"]},{"name":"val EntertainmentConfiguration: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.EntertainmentConfiguration","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-entertainment-configuration.html","searchKeys":["EntertainmentConfiguration","val EntertainmentConfiguration: ResourceType","inkapplications.shade.structures.ResourceType.Companion.EntertainmentConfiguration"]},{"name":"val FootCandle: FootCandles","description":"inkapplications.shade.structures.FootCandle","location":"structures/inkapplications.shade.structures/-foot-candle.html","searchKeys":["FootCandle","val FootCandle: FootCandles","inkapplications.shade.structures.FootCandle"]},{"name":"val FrontDoor: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.FrontDoor","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-front-door.html","searchKeys":["FrontDoor","val FrontDoor: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.FrontDoor"]},{"name":"val Garage: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Garage","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-garage.html","searchKeys":["Garage","val Garage: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Garage"]},{"name":"val Garden: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Garden","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-garden.html","searchKeys":["Garden","val Garden: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Garden"]},{"name":"val Geofence: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Geofence","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-geofence.html","searchKeys":["Geofence","val Geofence: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Geofence"]},{"name":"val GeofenceClient: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.GeofenceClient","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-geofence-client.html","searchKeys":["GeofenceClient","val GeofenceClient: ResourceType","inkapplications.shade.structures.ResourceType.Companion.GeofenceClient"]},{"name":"val Geolocation: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Geolocation","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-geolocation.html","searchKeys":["Geolocation","val Geolocation: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Geolocation"]},{"name":"val GroupedLight: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.GroupedLight","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-grouped-light.html","searchKeys":["GroupedLight","val GroupedLight: ResourceType","inkapplications.shade.structures.ResourceType.Companion.GroupedLight"]},{"name":"val GuestRoom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.GuestRoom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-guest-room.html","searchKeys":["GuestRoom","val GuestRoom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.GuestRoom"]},{"name":"val Gym: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Gym","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-gym.html","searchKeys":["Gym","val Gym: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Gym"]},{"name":"val Hallway: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Hallway","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-hallway.html","searchKeys":["Hallway","val Hallway: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Hallway"]},{"name":"val Home: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Home","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-home.html","searchKeys":["Home","val Home: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Home"]},{"name":"val Homekit: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Homekit","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-homekit.html","searchKeys":["Homekit","val Homekit: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Homekit"]},{"name":"val KidsBedroom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.KidsBedroom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-kids-bedroom.html","searchKeys":["KidsBedroom","val KidsBedroom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.KidsBedroom"]},{"name":"val Kitchen: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Kitchen","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-kitchen.html","searchKeys":["Kitchen","val Kitchen: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Kitchen"]},{"name":"val LaundryRoom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.LaundryRoom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-laundry-room.html","searchKeys":["LaundryRoom","val LaundryRoom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.LaundryRoom"]},{"name":"val Light: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Light","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-light.html","searchKeys":["Light","val Light: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Light"]},{"name":"val LightLevel: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.LightLevel","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-light-level.html","searchKeys":["LightLevel","val LightLevel: ResourceType","inkapplications.shade.structures.ResourceType.Companion.LightLevel"]},{"name":"val LivingRoom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.LivingRoom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-living-room.html","searchKeys":["LivingRoom","val LivingRoom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.LivingRoom"]},{"name":"val Lounge: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Lounge","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-lounge.html","searchKeys":["Lounge","val Lounge: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Lounge"]},{"name":"val ManCave: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.ManCave","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-man-cave.html","searchKeys":["ManCave","val ManCave: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.ManCave"]},{"name":"val Motion: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Motion","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-motion.html","searchKeys":["Motion","val Motion: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Motion"]},{"name":"val Music: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Music","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-music.html","searchKeys":["Music","val Music: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Music"]},{"name":"val Number.footCandles: FootCandles","description":"inkapplications.shade.structures.footCandles","location":"structures/inkapplications.shade.structures/foot-candles.html","searchKeys":["footCandles","val Number.footCandles: FootCandles","inkapplications.shade.structures.footCandles"]},{"name":"val Number.lux: Lux","description":"inkapplications.shade.structures.lux","location":"structures/inkapplications.shade.structures/lux.html","searchKeys":["lux","val Number.lux: Lux","inkapplications.shade.structures.lux"]},{"name":"val Number.scaledLux: ScaledLux","description":"inkapplications.shade.structures.scaledLux","location":"structures/inkapplications.shade.structures/scaled-lux.html","searchKeys":["scaledLux","val Number.scaledLux: ScaledLux","inkapplications.shade.structures.scaledLux"]},{"name":"val Nursery: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Nursery","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-nursery.html","searchKeys":["Nursery","val Nursery: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Nursery"]},{"name":"val Office: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Office","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-office.html","searchKeys":["Office","val Office: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Office"]},{"name":"val Other: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Other","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-other.html","searchKeys":["Other","val Other: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Other"]},{"name":"val Pool: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Pool","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-pool.html","searchKeys":["Pool","val Pool: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Pool"]},{"name":"val Porch: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Porch","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-porch.html","searchKeys":["Porch","val Porch: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Porch"]},{"name":"val PublicImage: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.PublicImage","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-public-image.html","searchKeys":["PublicImage","val PublicImage: ResourceType","inkapplications.shade.structures.ResourceType.Companion.PublicImage"]},{"name":"val Reading: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Reading","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-reading.html","searchKeys":["Reading","val Reading: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Reading"]},{"name":"val Recreation: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Recreation","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-recreation.html","searchKeys":["Recreation","val Recreation: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Recreation"]},{"name":"val Room: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Room","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-room.html","searchKeys":["Room","val Room: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Room"]},{"name":"val Scene: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Scene","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-scene.html","searchKeys":["Scene","val Scene: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Scene"]},{"name":"val Staircase: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Staircase","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-staircase.html","searchKeys":["Staircase","val Staircase: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Staircase"]},{"name":"val Storage: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Storage","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-storage.html","searchKeys":["Storage","val Storage: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Storage"]},{"name":"val Studio: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Studio","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-studio.html","searchKeys":["Studio","val Studio: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Studio"]},{"name":"val Temperature: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Temperature","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-temperature.html","searchKeys":["Temperature","val Temperature: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Temperature"]},{"name":"val Terrace: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Terrace","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-terrace.html","searchKeys":["Terrace","val Terrace: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Terrace"]},{"name":"val Toilet: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Toilet","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-toilet.html","searchKeys":["Toilet","val Toilet: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Toilet"]},{"name":"val TopFloor: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.TopFloor","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-top-floor.html","searchKeys":["TopFloor","val TopFloor: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.TopFloor"]},{"name":"val Tv: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Tv","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-tv.html","searchKeys":["Tv","val Tv: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Tv"]},{"name":"val Upstairs: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Upstairs","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-upstairs.html","searchKeys":["Upstairs","val Upstairs: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Upstairs"]},{"name":"val ZgpConnectivity: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.ZgpConnectivity","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-zgp-connectivity.html","searchKeys":["ZgpConnectivity","val ZgpConnectivity: ResourceType","inkapplications.shade.structures.ResourceType.Companion.ZgpConnectivity"]},{"name":"val ZigbeeBridgeConnectivity: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.ZigbeeBridgeConnectivity","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-zigbee-bridge-connectivity.html","searchKeys":["ZigbeeBridgeConnectivity","val ZigbeeBridgeConnectivity: ResourceType","inkapplications.shade.structures.ResourceType.Companion.ZigbeeBridgeConnectivity"]},{"name":"val ZigbeeConnectivity: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.ZigbeeConnectivity","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-zigbee-connectivity.html","searchKeys":["ZigbeeConnectivity","val ZigbeeConnectivity: ResourceType","inkapplications.shade.structures.ResourceType.Companion.ZigbeeConnectivity"]},{"name":"val Zone: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Zone","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-zone.html","searchKeys":["Zone","val Zone: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Zone"]},{"name":"val applicationKey: String","description":"inkapplications.shade.structures.AuthToken.applicationKey","location":"structures/inkapplications.shade.structures/-auth-token/application-key.html","searchKeys":["applicationKey","val applicationKey: String","inkapplications.shade.structures.AuthToken.applicationKey"]},{"name":"val archetype: SegmentArchetype","description":"inkapplications.shade.structures.SegmentMetadata.archetype","location":"structures/inkapplications.shade.structures/-segment-metadata/archetype.html","searchKeys":["archetype","val archetype: SegmentArchetype","inkapplications.shade.structures.SegmentMetadata.archetype"]},{"name":"val archetype: SegmentArchetype?","description":"inkapplications.shade.structures.SegmentMetadataUpdate.archetype","location":"structures/inkapplications.shade.structures/-segment-metadata-update/archetype.html","searchKeys":["archetype","val archetype: SegmentArchetype?","inkapplications.shade.structures.SegmentMetadataUpdate.archetype"]},{"name":"val certificatePem: String","description":"inkapplications.shade.structures.SecurityStrategy.CustomCa.certificatePem","location":"structures/inkapplications.shade.structures/-security-strategy/-custom-ca/certificate-pem.html","searchKeys":["certificatePem","val certificatePem: String","inkapplications.shade.structures.SecurityStrategy.CustomCa.certificatePem"]},{"name":"val clientKey: String?","description":"inkapplications.shade.structures.AuthToken.clientKey","location":"structures/inkapplications.shade.structures/-auth-token/client-key.html","searchKeys":["clientKey","val clientKey: String?","inkapplications.shade.structures.AuthToken.clientKey"]},{"name":"val code: Int","description":"inkapplications.shade.structures.ApiStatusError.code","location":"structures/inkapplications.shade.structures/-api-status-error/code.html","searchKeys":["code","val code: Int","inkapplications.shade.structures.ApiStatusError.code"]},{"name":"val full: String","description":"inkapplications.shade.structures.VersionString.full","location":"structures/inkapplications.shade.structures/-version-string/full.html","searchKeys":["full","val full: String","inkapplications.shade.structures.VersionString.full"]},{"name":"val hostname: String","description":"inkapplications.shade.structures.SecurityStrategy.CustomCa.hostname","location":"structures/inkapplications.shade.structures/-security-strategy/-custom-ca/hostname.html","searchKeys":["hostname","val hostname: String","inkapplications.shade.structures.SecurityStrategy.CustomCa.hostname"]},{"name":"val hostname: String","description":"inkapplications.shade.structures.SecurityStrategy.Insecure.hostname","location":"structures/inkapplications.shade.structures/-security-strategy/-insecure/hostname.html","searchKeys":["hostname","val hostname: String","inkapplications.shade.structures.SecurityStrategy.Insecure.hostname"]},{"name":"val id: ResourceId","description":"inkapplications.shade.structures.ResourceReference.id","location":"structures/inkapplications.shade.structures/-resource-reference/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.structures.ResourceReference.id"]},{"name":"val ip: String","description":"inkapplications.shade.structures.SecurityStrategy.CustomCa.ip","location":"structures/inkapplications.shade.structures/-security-strategy/-custom-ca/ip.html","searchKeys":["ip","val ip: String","inkapplications.shade.structures.SecurityStrategy.CustomCa.ip"]},{"name":"val json: String","description":"inkapplications.shade.structures.UnknownEvent.json","location":"structures/inkapplications.shade.structures/-unknown-event/json.html","searchKeys":["json","val json: String","inkapplications.shade.structures.UnknownEvent.json"]},{"name":"val key: String","description":"inkapplications.shade.structures.ResourceType.key","location":"structures/inkapplications.shade.structures/-resource-type/key.html","searchKeys":["key","val key: String","inkapplications.shade.structures.ResourceType.key"]},{"name":"val key: String","description":"inkapplications.shade.structures.SegmentArchetype.key","location":"structures/inkapplications.shade.structures/-segment-archetype/key.html","searchKeys":["key","val key: String","inkapplications.shade.structures.SegmentArchetype.key"]},{"name":"val major: MatchGroup?","description":"inkapplications.shade.structures.VersionString.major","location":"structures/inkapplications.shade.structures/-version-string/major.html","searchKeys":["major","val major: MatchGroup?","inkapplications.shade.structures.VersionString.major"]},{"name":"val minor: MatchGroup?","description":"inkapplications.shade.structures.VersionString.minor","location":"structures/inkapplications.shade.structures/-version-string/minor.html","searchKeys":["minor","val minor: MatchGroup?","inkapplications.shade.structures.VersionString.minor"]},{"name":"val name: String","description":"inkapplications.shade.structures.SegmentMetadata.name","location":"structures/inkapplications.shade.structures/-segment-metadata/name.html","searchKeys":["name","val name: String","inkapplications.shade.structures.SegmentMetadata.name"]},{"name":"val name: String?","description":"inkapplications.shade.structures.SegmentMetadataUpdate.name","location":"structures/inkapplications.shade.structures/-segment-metadata-update/name.html","searchKeys":["name","val name: String?","inkapplications.shade.structures.SegmentMetadataUpdate.name"]},{"name":"val on: Boolean","description":"inkapplications.shade.structures.PowerInfo.on","location":"structures/inkapplications.shade.structures/-power-info/on.html","searchKeys":["on","val on: Boolean","inkapplications.shade.structures.PowerInfo.on"]},{"name":"val on: Boolean","description":"inkapplications.shade.structures.PowerValue.on","location":"structures/inkapplications.shade.structures/-power-value/on.html","searchKeys":["on","val on: Boolean","inkapplications.shade.structures.PowerValue.on"]},{"name":"val on: Boolean?","description":"inkapplications.shade.structures.parameters.PowerParameters.on","location":"structures/inkapplications.shade.structures.parameters/-power-parameters/on.html","searchKeys":["on","val on: Boolean?","inkapplications.shade.structures.parameters.PowerParameters.on"]},{"name":"val patch: MatchGroup?","description":"inkapplications.shade.structures.VersionString.patch","location":"structures/inkapplications.shade.structures/-version-string/patch.html","searchKeys":["patch","val patch: MatchGroup?","inkapplications.shade.structures.VersionString.patch"]},{"name":"val type: ResourceType","description":"inkapplications.shade.structures.ResourceReference.type","location":"structures/inkapplications.shade.structures/-resource-reference/type.html","searchKeys":["type","val type: ResourceType","inkapplications.shade.structures.ResourceReference.type"]},{"name":"val type: String","description":"inkapplications.shade.structures.UnknownEvent.type","location":"structures/inkapplications.shade.structures/-unknown-event/type.html","searchKeys":["type","val type: String","inkapplications.shade.structures.UnknownEvent.type"]},{"name":"val value: String","description":"inkapplications.shade.structures.ResourceId.value","location":"structures/inkapplications.shade.structures/-resource-id/value.html","searchKeys":["value","val value: String","inkapplications.shade.structures.ResourceId.value"]},{"name":"value class FootCandles(val value: Number) : Illuminance, Dimension ","description":"inkapplications.shade.structures.FootCandles","location":"structures/inkapplications.shade.structures/-foot-candles/index.html","searchKeys":["FootCandles","value class FootCandles(val value: Number) : Illuminance, Dimension ","inkapplications.shade.structures.FootCandles"]},{"name":"value class Lux(val value: Number) : Illuminance, Dimension ","description":"inkapplications.shade.structures.Lux","location":"structures/inkapplications.shade.structures/-lux/index.html","searchKeys":["Lux","value class Lux(val value: Number) : Illuminance, Dimension ","inkapplications.shade.structures.Lux"]},{"name":"value class ResourceId(val value: String)","description":"inkapplications.shade.structures.ResourceId","location":"structures/inkapplications.shade.structures/-resource-id/index.html","searchKeys":["ResourceId","value class ResourceId(val value: String)","inkapplications.shade.structures.ResourceId"]},{"name":"value class ResourceType(val key: String)","description":"inkapplications.shade.structures.ResourceType","location":"structures/inkapplications.shade.structures/-resource-type/index.html","searchKeys":["ResourceType","value class ResourceType(val key: String)","inkapplications.shade.structures.ResourceType"]},{"name":"value class ScaledLux(val value: Number) : Illuminance, Dimension ","description":"inkapplications.shade.structures.ScaledLux","location":"structures/inkapplications.shade.structures/-scaled-lux/index.html","searchKeys":["ScaledLux","value class ScaledLux(val value: Number) : Illuminance, Dimension ","inkapplications.shade.structures.ScaledLux"]},{"name":"value class SegmentArchetype(val key: String)","description":"inkapplications.shade.structures.SegmentArchetype","location":"structures/inkapplications.shade.structures/-segment-archetype/index.html","searchKeys":["SegmentArchetype","value class SegmentArchetype(val key: String)","inkapplications.shade.structures.SegmentArchetype"]},{"name":"value class VersionString(val full: String)","description":"inkapplications.shade.structures.VersionString","location":"structures/inkapplications.shade.structures/-version-string/index.html","searchKeys":["VersionString","value class VersionString(val full: String)","inkapplications.shade.structures.VersionString"]},{"name":"abstract suspend fun listResources(): List","description":"inkapplications.shade.resources.ResourceControls.listResources","location":"resources/inkapplications.shade.resources/-resource-controls/list-resources.html","searchKeys":["listResources","abstract suspend fun listResources(): List","inkapplications.shade.resources.ResourceControls.listResources"]},{"name":"class ShadeResourcesModule(internalsModule: InternalsModule)","description":"inkapplications.shade.resources.ShadeResourcesModule","location":"resources/inkapplications.shade.resources/-shade-resources-module/index.html","searchKeys":["ShadeResourcesModule","class ShadeResourcesModule(internalsModule: InternalsModule)","inkapplications.shade.resources.ShadeResourcesModule"]},{"name":"constructor(id: ResourceId, type: ResourceType? = null, v1Id: String? = null)","description":"inkapplications.shade.resources.structures.Resource.Resource","location":"resources/inkapplications.shade.resources.structures/-resource/-resource.html","searchKeys":["Resource","constructor(id: ResourceId, type: ResourceType? = null, v1Id: String? = null)","inkapplications.shade.resources.structures.Resource.Resource"]},{"name":"constructor(internalsModule: InternalsModule)","description":"inkapplications.shade.resources.ShadeResourcesModule.ShadeResourcesModule","location":"resources/inkapplications.shade.resources/-shade-resources-module/-shade-resources-module.html","searchKeys":["ShadeResourcesModule","constructor(internalsModule: InternalsModule)","inkapplications.shade.resources.ShadeResourcesModule.ShadeResourcesModule"]},{"name":"data class Resource(val id: ResourceId, val type: ResourceType? = null, val v1Id: String? = null)","description":"inkapplications.shade.resources.structures.Resource","location":"resources/inkapplications.shade.resources.structures/-resource/index.html","searchKeys":["Resource","data class Resource(val id: ResourceId, val type: ResourceType? = null, val v1Id: String? = null)","inkapplications.shade.resources.structures.Resource"]},{"name":"interface ResourceControls","description":"inkapplications.shade.resources.ResourceControls","location":"resources/inkapplications.shade.resources/-resource-controls/index.html","searchKeys":["ResourceControls","interface ResourceControls","inkapplications.shade.resources.ResourceControls"]},{"name":"val id: ResourceId","description":"inkapplications.shade.resources.structures.Resource.id","location":"resources/inkapplications.shade.resources.structures/-resource/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.resources.structures.Resource.id"]},{"name":"val resources: ResourceControls","description":"inkapplications.shade.resources.ShadeResourcesModule.resources","location":"resources/inkapplications.shade.resources/-shade-resources-module/resources.html","searchKeys":["resources","val resources: ResourceControls","inkapplications.shade.resources.ShadeResourcesModule.resources"]},{"name":"val type: ResourceType?","description":"inkapplications.shade.resources.structures.Resource.type","location":"resources/inkapplications.shade.resources.structures/-resource/type.html","searchKeys":["type","val type: ResourceType?","inkapplications.shade.resources.structures.Resource.type"]},{"name":"val v1Id: String?","description":"inkapplications.shade.resources.structures.Resource.v1Id","location":"resources/inkapplications.shade.resources.structures/-resource/v1-id.html","searchKeys":["v1Id","val v1Id: String?","inkapplications.shade.resources.structures.Resource.v1Id"]},{"name":"abstract suspend fun getLightLevel(id: ResourceId): LightLevel","description":"inkapplications.shade.lightlevel.LightLevelControls.getLightLevel","location":"lightlevel/inkapplications.shade.lightlevel/-light-level-controls/get-light-level.html","searchKeys":["getLightLevel","abstract suspend fun getLightLevel(id: ResourceId): LightLevel","inkapplications.shade.lightlevel.LightLevelControls.getLightLevel"]},{"name":"abstract suspend fun listLightLevels(): List","description":"inkapplications.shade.lightlevel.LightLevelControls.listLightLevels","location":"lightlevel/inkapplications.shade.lightlevel/-light-level-controls/list-light-levels.html","searchKeys":["listLightLevels","abstract suspend fun listLightLevels(): List","inkapplications.shade.lightlevel.LightLevelControls.listLightLevels"]},{"name":"abstract suspend fun updateLightLevel(id: ResourceId, parameters: LightLevelUpdateParameters): ResourceReference","description":"inkapplications.shade.lightlevel.LightLevelControls.updateLightLevel","location":"lightlevel/inkapplications.shade.lightlevel/-light-level-controls/update-light-level.html","searchKeys":["updateLightLevel","abstract suspend fun updateLightLevel(id: ResourceId, parameters: LightLevelUpdateParameters): ResourceReference","inkapplications.shade.lightlevel.LightLevelControls.updateLightLevel"]},{"name":"class ShadeLightLevelModule(internalsModule: InternalsModule)","description":"inkapplications.shade.lightlevel.ShadeLightLevelModule","location":"lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/index.html","searchKeys":["ShadeLightLevelModule","class ShadeLightLevelModule(internalsModule: InternalsModule)","inkapplications.shade.lightlevel.ShadeLightLevelModule"]},{"name":"constructor(changed: Instant, lightLevel: Illuminance)","description":"inkapplications.shade.lightlevel.structures.LightLevelReport.LightLevelReport","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/-light-level-report.html","searchKeys":["LightLevelReport","constructor(changed: Instant, lightLevel: Illuminance)","inkapplications.shade.lightlevel.structures.LightLevelReport.LightLevelReport"]},{"name":"constructor(enabled: Boolean? = null)","description":"inkapplications.shade.lightlevel.parameters.LightLevelUpdateParameters.LightLevelUpdateParameters","location":"lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/-light-level-update-parameters.html","searchKeys":["LightLevelUpdateParameters","constructor(enabled: Boolean? = null)","inkapplications.shade.lightlevel.parameters.LightLevelUpdateParameters.LightLevelUpdateParameters"]},{"name":"constructor(id: ResourceId, owner: ResourceReference, enabled: Boolean, light: LightLevelValue, type: ResourceType = ResourceType.LightLevel)","description":"inkapplications.shade.lightlevel.structures.LightLevel.LightLevel","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level/-light-level.html","searchKeys":["LightLevel","constructor(id: ResourceId, owner: ResourceReference, enabled: Boolean, light: LightLevelValue, type: ResourceType = ResourceType.LightLevel)","inkapplications.shade.lightlevel.structures.LightLevel.LightLevel"]},{"name":"constructor(internalsModule: InternalsModule)","description":"inkapplications.shade.lightlevel.ShadeLightLevelModule.ShadeLightLevelModule","location":"lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/-shade-light-level-module.html","searchKeys":["ShadeLightLevelModule","constructor(internalsModule: InternalsModule)","inkapplications.shade.lightlevel.ShadeLightLevelModule.ShadeLightLevelModule"]},{"name":"constructor(lightLevelReport: LightLevelReport? = null)","description":"inkapplications.shade.lightlevel.structures.LightLevelValue.LightLevelValue","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/-light-level-value.html","searchKeys":["LightLevelValue","constructor(lightLevelReport: LightLevelReport? = null)","inkapplications.shade.lightlevel.structures.LightLevelValue.LightLevelValue"]},{"name":"data class LightLevel(val id: ResourceId, val owner: ResourceReference, val enabled: Boolean, val light: LightLevelValue, val type: ResourceType = ResourceType.LightLevel)","description":"inkapplications.shade.lightlevel.structures.LightLevel","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level/index.html","searchKeys":["LightLevel","data class LightLevel(val id: ResourceId, val owner: ResourceReference, val enabled: Boolean, val light: LightLevelValue, val type: ResourceType = ResourceType.LightLevel)","inkapplications.shade.lightlevel.structures.LightLevel"]},{"name":"data class LightLevelReport(val changed: Instant, val lightLevel: Illuminance)","description":"inkapplications.shade.lightlevel.structures.LightLevelReport","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/index.html","searchKeys":["LightLevelReport","data class LightLevelReport(val changed: Instant, val lightLevel: Illuminance)","inkapplications.shade.lightlevel.structures.LightLevelReport"]},{"name":"data class LightLevelUpdateParameters(val enabled: Boolean? = null)","description":"inkapplications.shade.lightlevel.parameters.LightLevelUpdateParameters","location":"lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/index.html","searchKeys":["LightLevelUpdateParameters","data class LightLevelUpdateParameters(val enabled: Boolean? = null)","inkapplications.shade.lightlevel.parameters.LightLevelUpdateParameters"]},{"name":"data class LightLevelValue(val lightLevelReport: LightLevelReport? = null)","description":"inkapplications.shade.lightlevel.structures.LightLevelValue","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/index.html","searchKeys":["LightLevelValue","data class LightLevelValue(val lightLevelReport: LightLevelReport? = null)","inkapplications.shade.lightlevel.structures.LightLevelValue"]},{"name":"interface LightLevelControls","description":"inkapplications.shade.lightlevel.LightLevelControls","location":"lightlevel/inkapplications.shade.lightlevel/-light-level-controls/index.html","searchKeys":["LightLevelControls","interface LightLevelControls","inkapplications.shade.lightlevel.LightLevelControls"]},{"name":"val changed: Instant","description":"inkapplications.shade.lightlevel.structures.LightLevelReport.changed","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/changed.html","searchKeys":["changed","val changed: Instant","inkapplications.shade.lightlevel.structures.LightLevelReport.changed"]},{"name":"val enabled: Boolean","description":"inkapplications.shade.lightlevel.structures.LightLevel.enabled","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level/enabled.html","searchKeys":["enabled","val enabled: Boolean","inkapplications.shade.lightlevel.structures.LightLevel.enabled"]},{"name":"val enabled: Boolean?","description":"inkapplications.shade.lightlevel.parameters.LightLevelUpdateParameters.enabled","location":"lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/enabled.html","searchKeys":["enabled","val enabled: Boolean?","inkapplications.shade.lightlevel.parameters.LightLevelUpdateParameters.enabled"]},{"name":"val id: ResourceId","description":"inkapplications.shade.lightlevel.structures.LightLevel.id","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.lightlevel.structures.LightLevel.id"]},{"name":"val light: LightLevelValue","description":"inkapplications.shade.lightlevel.structures.LightLevel.light","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level/light.html","searchKeys":["light","val light: LightLevelValue","inkapplications.shade.lightlevel.structures.LightLevel.light"]},{"name":"val lightLevel: Illuminance","description":"inkapplications.shade.lightlevel.structures.LightLevelReport.lightLevel","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/light-level.html","searchKeys":["lightLevel","val lightLevel: Illuminance","inkapplications.shade.lightlevel.structures.LightLevelReport.lightLevel"]},{"name":"val lightLevelReport: LightLevelReport?","description":"inkapplications.shade.lightlevel.structures.LightLevelValue.lightLevelReport","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/light-level-report.html","searchKeys":["lightLevelReport","val lightLevelReport: LightLevelReport?","inkapplications.shade.lightlevel.structures.LightLevelValue.lightLevelReport"]},{"name":"val lightLevels: LightLevelControls","description":"inkapplications.shade.lightlevel.ShadeLightLevelModule.lightLevels","location":"lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/light-levels.html","searchKeys":["lightLevels","val lightLevels: LightLevelControls","inkapplications.shade.lightlevel.ShadeLightLevelModule.lightLevels"]},{"name":"val owner: ResourceReference","description":"inkapplications.shade.lightlevel.structures.LightLevel.owner","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level/owner.html","searchKeys":["owner","val owner: ResourceReference","inkapplications.shade.lightlevel.structures.LightLevel.owner"]},{"name":"val type: ResourceType","description":"inkapplications.shade.lightlevel.structures.LightLevel.type","location":"lightlevel/inkapplications.shade.lightlevel.structures/-light-level/type.html","searchKeys":["type","val type: ResourceType","inkapplications.shade.lightlevel.structures.LightLevel.type"]},{"name":"abstract suspend fun createZone(parameters: ZoneCreateParameters): ResourceReference","description":"inkapplications.shade.zones.ZoneControls.createZone","location":"zones/inkapplications.shade.zones/-zone-controls/create-zone.html","searchKeys":["createZone","abstract suspend fun createZone(parameters: ZoneCreateParameters): ResourceReference","inkapplications.shade.zones.ZoneControls.createZone"]},{"name":"abstract suspend fun deleteZone(id: ResourceId): ResourceReference","description":"inkapplications.shade.zones.ZoneControls.deleteZone","location":"zones/inkapplications.shade.zones/-zone-controls/delete-zone.html","searchKeys":["deleteZone","abstract suspend fun deleteZone(id: ResourceId): ResourceReference","inkapplications.shade.zones.ZoneControls.deleteZone"]},{"name":"abstract suspend fun getZone(id: ResourceId): Zone","description":"inkapplications.shade.zones.ZoneControls.getZone","location":"zones/inkapplications.shade.zones/-zone-controls/get-zone.html","searchKeys":["getZone","abstract suspend fun getZone(id: ResourceId): Zone","inkapplications.shade.zones.ZoneControls.getZone"]},{"name":"abstract suspend fun listZones(): List","description":"inkapplications.shade.zones.ZoneControls.listZones","location":"zones/inkapplications.shade.zones/-zone-controls/list-zones.html","searchKeys":["listZones","abstract suspend fun listZones(): List","inkapplications.shade.zones.ZoneControls.listZones"]},{"name":"abstract suspend fun updateZone(id: ResourceId, parameters: ZoneUpdateParameters): ResourceReference","description":"inkapplications.shade.zones.ZoneControls.updateZone","location":"zones/inkapplications.shade.zones/-zone-controls/update-zone.html","searchKeys":["updateZone","abstract suspend fun updateZone(id: ResourceId, parameters: ZoneUpdateParameters): ResourceReference","inkapplications.shade.zones.ZoneControls.updateZone"]},{"name":"class ShadeZonesModule(internalsModule: InternalsModule)","description":"inkapplications.shade.zones.ShadeZonesModule","location":"zones/inkapplications.shade.zones/-shade-zones-module/index.html","searchKeys":["ShadeZonesModule","class ShadeZonesModule(internalsModule: InternalsModule)","inkapplications.shade.zones.ShadeZonesModule"]},{"name":"constructor(id: ResourceId, services: List, metadata: SegmentMetadata, children: List)","description":"inkapplications.shade.zones.structures.Zone.Zone","location":"zones/inkapplications.shade.zones.structures/-zone/-zone.html","searchKeys":["Zone","constructor(id: ResourceId, services: List, metadata: SegmentMetadata, children: List)","inkapplications.shade.zones.structures.Zone.Zone"]},{"name":"constructor(internalsModule: InternalsModule)","description":"inkapplications.shade.zones.ShadeZonesModule.ShadeZonesModule","location":"zones/inkapplications.shade.zones/-shade-zones-module/-shade-zones-module.html","searchKeys":["ShadeZonesModule","constructor(internalsModule: InternalsModule)","inkapplications.shade.zones.ShadeZonesModule.ShadeZonesModule"]},{"name":"constructor(metadata: SegmentMetadata, children: List)","description":"inkapplications.shade.zones.parameters.ZoneCreateParameters.ZoneCreateParameters","location":"zones/inkapplications.shade.zones.parameters/-zone-create-parameters/-zone-create-parameters.html","searchKeys":["ZoneCreateParameters","constructor(metadata: SegmentMetadata, children: List)","inkapplications.shade.zones.parameters.ZoneCreateParameters.ZoneCreateParameters"]},{"name":"constructor(metadata: SegmentMetadataUpdate? = null, children: List? = null)","description":"inkapplications.shade.zones.parameters.ZoneUpdateParameters.ZoneUpdateParameters","location":"zones/inkapplications.shade.zones.parameters/-zone-update-parameters/-zone-update-parameters.html","searchKeys":["ZoneUpdateParameters","constructor(metadata: SegmentMetadataUpdate? = null, children: List? = null)","inkapplications.shade.zones.parameters.ZoneUpdateParameters.ZoneUpdateParameters"]},{"name":"data class Zone(val id: ResourceId, val services: List, val metadata: SegmentMetadata, val children: List)","description":"inkapplications.shade.zones.structures.Zone","location":"zones/inkapplications.shade.zones.structures/-zone/index.html","searchKeys":["Zone","data class Zone(val id: ResourceId, val services: List, val metadata: SegmentMetadata, val children: List)","inkapplications.shade.zones.structures.Zone"]},{"name":"data class ZoneCreateParameters(val metadata: SegmentMetadata, val children: List)","description":"inkapplications.shade.zones.parameters.ZoneCreateParameters","location":"zones/inkapplications.shade.zones.parameters/-zone-create-parameters/index.html","searchKeys":["ZoneCreateParameters","data class ZoneCreateParameters(val metadata: SegmentMetadata, val children: List)","inkapplications.shade.zones.parameters.ZoneCreateParameters"]},{"name":"data class ZoneUpdateParameters(val metadata: SegmentMetadataUpdate? = null, val children: List? = null)","description":"inkapplications.shade.zones.parameters.ZoneUpdateParameters","location":"zones/inkapplications.shade.zones.parameters/-zone-update-parameters/index.html","searchKeys":["ZoneUpdateParameters","data class ZoneUpdateParameters(val metadata: SegmentMetadataUpdate? = null, val children: List? = null)","inkapplications.shade.zones.parameters.ZoneUpdateParameters"]},{"name":"interface ZoneControls","description":"inkapplications.shade.zones.ZoneControls","location":"zones/inkapplications.shade.zones/-zone-controls/index.html","searchKeys":["ZoneControls","interface ZoneControls","inkapplications.shade.zones.ZoneControls"]},{"name":"val children: List","description":"inkapplications.shade.zones.parameters.ZoneCreateParameters.children","location":"zones/inkapplications.shade.zones.parameters/-zone-create-parameters/children.html","searchKeys":["children","val children: List","inkapplications.shade.zones.parameters.ZoneCreateParameters.children"]},{"name":"val children: List","description":"inkapplications.shade.zones.structures.Zone.children","location":"zones/inkapplications.shade.zones.structures/-zone/children.html","searchKeys":["children","val children: List","inkapplications.shade.zones.structures.Zone.children"]},{"name":"val children: List?","description":"inkapplications.shade.zones.parameters.ZoneUpdateParameters.children","location":"zones/inkapplications.shade.zones.parameters/-zone-update-parameters/children.html","searchKeys":["children","val children: List?","inkapplications.shade.zones.parameters.ZoneUpdateParameters.children"]},{"name":"val id: ResourceId","description":"inkapplications.shade.zones.structures.Zone.id","location":"zones/inkapplications.shade.zones.structures/-zone/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.zones.structures.Zone.id"]},{"name":"val metadata: SegmentMetadata","description":"inkapplications.shade.zones.parameters.ZoneCreateParameters.metadata","location":"zones/inkapplications.shade.zones.parameters/-zone-create-parameters/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadata","inkapplications.shade.zones.parameters.ZoneCreateParameters.metadata"]},{"name":"val metadata: SegmentMetadata","description":"inkapplications.shade.zones.structures.Zone.metadata","location":"zones/inkapplications.shade.zones.structures/-zone/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadata","inkapplications.shade.zones.structures.Zone.metadata"]},{"name":"val metadata: SegmentMetadataUpdate?","description":"inkapplications.shade.zones.parameters.ZoneUpdateParameters.metadata","location":"zones/inkapplications.shade.zones.parameters/-zone-update-parameters/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadataUpdate?","inkapplications.shade.zones.parameters.ZoneUpdateParameters.metadata"]},{"name":"val services: List","description":"inkapplications.shade.zones.structures.Zone.services","location":"zones/inkapplications.shade.zones.structures/-zone/services.html","searchKeys":["services","val services: List","inkapplications.shade.zones.structures.Zone.services"]},{"name":"val zones: ZoneControls","description":"inkapplications.shade.zones.ShadeZonesModule.zones","location":"zones/inkapplications.shade.zones/-shade-zones-module/zones.html","searchKeys":["zones","val zones: ZoneControls","inkapplications.shade.zones.ShadeZonesModule.zones"]},{"name":"abstract fun openSse(pathSegments: Array, dataDeserializer: DeserializationStrategy): Flow","description":"inkapplications.shade.internals.SseClient.openSse","location":"internals/inkapplications.shade.internals/-sse-client/open-sse.html","searchKeys":["openSse","abstract fun openSse(pathSegments: Array, dataDeserializer: DeserializationStrategy): Flow","inkapplications.shade.internals.SseClient.openSse"]},{"name":"abstract suspend fun sendRequest(method: String, pathSegments: Array, responseSerializer: KSerializer>, body: REQUEST? = null, requestSerializer: KSerializer? = null): RESPONSE","description":"inkapplications.shade.internals.HueHttpClient.sendRequest","location":"internals/inkapplications.shade.internals/-hue-http-client/send-request.html","searchKeys":["sendRequest","abstract suspend fun sendRequest(method: String, pathSegments: Array, responseSerializer: KSerializer>, body: REQUEST? = null, requestSerializer: KSerializer? = null): RESPONSE","inkapplications.shade.internals.HueHttpClient.sendRequest"]},{"name":"abstract suspend fun sendV1Request(method: String, pathSegments: Array, responseSerializer: KSerializer>>, body: REQUEST? = null, requestSerializer: KSerializer? = null): RESPONSE","description":"inkapplications.shade.internals.HueHttpClient.sendV1Request","location":"internals/inkapplications.shade.internals/-hue-http-client/send-v1-request.html","searchKeys":["sendV1Request","abstract suspend fun sendV1Request(method: String, pathSegments: Array, responseSerializer: KSerializer>>, body: REQUEST? = null, requestSerializer: KSerializer? = null): RESPONSE","inkapplications.shade.internals.HueHttpClient.sendV1Request"]},{"name":"actual constructor(configurationContainer: ERROR CLASS: Symbol not found for HueConfigurationContainer, json: ERROR CLASS: Symbol not found for Json, logger: ERROR CLASS: Symbol not found for KimchiLogger)","description":"inkapplications.shade.internals.PlatformModule.PlatformModule","location":"internals/inkapplications.shade.internals/-platform-module/-platform-module.html","searchKeys":["PlatformModule","actual constructor(configurationContainer: ERROR CLASS: Symbol not found for HueConfigurationContainer, json: ERROR CLASS: Symbol not found for Json, logger: ERROR CLASS: Symbol not found for KimchiLogger)","inkapplications.shade.internals.PlatformModule.PlatformModule"]},{"name":"actual fun createEngine(securityStrategy: ERROR CLASS: Symbol not found for SecurityStrategy): ERROR CLASS: Symbol not found for HttpClientEngineFactory<*>","description":"inkapplications.shade.internals.PlatformModule.createEngine","location":"internals/inkapplications.shade.internals/-platform-module/create-engine.html","searchKeys":["createEngine","actual fun createEngine(securityStrategy: ERROR CLASS: Symbol not found for SecurityStrategy): ERROR CLASS: Symbol not found for HttpClientEngineFactory<*>","inkapplications.shade.internals.PlatformModule.createEngine"]},{"name":"class CachedProperty(val keyProperty: () -> KEY, lazy: Boolean = false, val factory: (KEY) -> VALUE) : ReadOnlyProperty ","description":"inkapplications.shade.internals.CachedProperty","location":"internals/inkapplications.shade.internals/-cached-property/index.html","searchKeys":["CachedProperty","class CachedProperty(val keyProperty: () -> KEY, lazy: Boolean = false, val factory: (KEY) -> VALUE) : ReadOnlyProperty ","inkapplications.shade.internals.CachedProperty"]},{"name":"class InternalsModule(val configurationContainer: HueConfigurationContainer, logger: KimchiLogger = EmptyLogger)","description":"inkapplications.shade.internals.InternalsModule","location":"internals/inkapplications.shade.internals/-internals-module/index.html","searchKeys":["InternalsModule","class InternalsModule(val configurationContainer: HueConfigurationContainer, logger: KimchiLogger = EmptyLogger)","inkapplications.shade.internals.InternalsModule"]},{"name":"constructor(configurationContainer: HueConfigurationContainer, logger: KimchiLogger = EmptyLogger)","description":"inkapplications.shade.internals.InternalsModule.InternalsModule","location":"internals/inkapplications.shade.internals/-internals-module/-internals-module.html","searchKeys":["InternalsModule","constructor(configurationContainer: HueConfigurationContainer, logger: KimchiLogger = EmptyLogger)","inkapplications.shade.internals.InternalsModule.InternalsModule"]},{"name":"constructor(keyProperty: () -> KEY, lazy: Boolean = false, factory: (KEY) -> VALUE)","description":"inkapplications.shade.internals.CachedProperty.CachedProperty","location":"internals/inkapplications.shade.internals/-cached-property/-cached-property.html","searchKeys":["CachedProperty","constructor(keyProperty: () -> KEY, lazy: Boolean = false, factory: (KEY) -> VALUE)","inkapplications.shade.internals.CachedProperty.CachedProperty"]},{"name":"expect class PlatformModule","description":"inkapplications.shade.internals.PlatformModule","location":"internals/inkapplications.shade.internals/-platform-module/index.html","searchKeys":["PlatformModule","expect class PlatformModule","inkapplications.shade.internals.PlatformModule"]},{"name":"expect constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger = EmptyLogger)","description":"inkapplications.shade.internals.PlatformModule.PlatformModule","location":"internals/inkapplications.shade.internals/-platform-module/-platform-module.html","searchKeys":["PlatformModule","expect constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger = EmptyLogger)","inkapplications.shade.internals.PlatformModule.PlatformModule"]},{"name":"expect fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>","description":"inkapplications.shade.internals.PlatformModule.createEngine","location":"internals/inkapplications.shade.internals/-platform-module/create-engine.html","searchKeys":["createEngine","expect fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>","inkapplications.shade.internals.PlatformModule.createEngine"]},{"name":"fun applyPlatformConfiguration(builder: OkHttpClient.Builder, securityStrategy: SecurityStrategy): OkHttpClient.Builder","description":"inkapplications.shade.internals.PlatformModule.applyPlatformConfiguration","location":"internals/inkapplications.shade.internals/-platform-module/apply-platform-configuration.html","searchKeys":["applyPlatformConfiguration","fun applyPlatformConfiguration(builder: OkHttpClient.Builder, securityStrategy: SecurityStrategy): OkHttpClient.Builder","inkapplications.shade.internals.PlatformModule.applyPlatformConfiguration"]},{"name":"inline suspend fun HueHttpClient.postData(body: REQUEST, vararg pathSegments: String): RESPONSE","description":"inkapplications.shade.internals.postData","location":"internals/inkapplications.shade.internals/post-data.html","searchKeys":["postData","inline suspend fun HueHttpClient.postData(body: REQUEST, vararg pathSegments: String): RESPONSE","inkapplications.shade.internals.postData"]},{"name":"inline suspend fun HueHttpClient.putData(body: REQUEST, vararg pathSegments: String): RESPONSE","description":"inkapplications.shade.internals.putData","location":"internals/inkapplications.shade.internals/put-data.html","searchKeys":["putData","inline suspend fun HueHttpClient.putData(body: REQUEST, vararg pathSegments: String): RESPONSE","inkapplications.shade.internals.putData"]},{"name":"inline suspend fun HueHttpClient.deleteData(vararg pathSegments: String): T","description":"inkapplications.shade.internals.deleteData","location":"internals/inkapplications.shade.internals/delete-data.html","searchKeys":["deleteData","inline suspend fun HueHttpClient.deleteData(vararg pathSegments: String): T","inkapplications.shade.internals.deleteData"]},{"name":"inline suspend fun HueHttpClient.getData(vararg pathSegments: String): T","description":"inkapplications.shade.internals.getData","location":"internals/inkapplications.shade.internals/get-data.html","searchKeys":["getData","inline suspend fun HueHttpClient.getData(vararg pathSegments: String): T","inkapplications.shade.internals.getData"]},{"name":"interface HueHttpClient","description":"inkapplications.shade.internals.HueHttpClient","location":"internals/inkapplications.shade.internals/-hue-http-client/index.html","searchKeys":["HueHttpClient","interface HueHttpClient","inkapplications.shade.internals.HueHttpClient"]},{"name":"interface SseClient","description":"inkapplications.shade.internals.SseClient","location":"internals/inkapplications.shade.internals/-sse-client/index.html","searchKeys":["SseClient","interface SseClient","inkapplications.shade.internals.SseClient"]},{"name":"object DummyConfigurationContainer : HueConfigurationContainer","description":"inkapplications.shade.internals.DummyConfigurationContainer","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/index.html","searchKeys":["DummyConfigurationContainer","object DummyConfigurationContainer : HueConfigurationContainer","inkapplications.shade.internals.DummyConfigurationContainer"]},{"name":"object HueStubClient : HueHttpClient","description":"inkapplications.shade.internals.HueStubClient","location":"internals/inkapplications.shade.internals/-hue-stub-client/index.html","searchKeys":["HueStubClient","object HueStubClient : HueHttpClient","inkapplications.shade.internals.HueStubClient"]},{"name":"open operator override fun getValue(thisRef: Any?, property: KProperty<*>): VALUE","description":"inkapplications.shade.internals.CachedProperty.getValue","location":"internals/inkapplications.shade.internals/-cached-property/get-value.html","searchKeys":["getValue","open operator override fun getValue(thisRef: Any?, property: KProperty<*>): VALUE","inkapplications.shade.internals.CachedProperty.getValue"]},{"name":"open override val authToken: StateFlow","description":"inkapplications.shade.internals.DummyConfigurationContainer.authToken","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/auth-token.html","searchKeys":["authToken","open override val authToken: StateFlow","inkapplications.shade.internals.DummyConfigurationContainer.authToken"]},{"name":"open override val hostname: StateFlow","description":"inkapplications.shade.internals.DummyConfigurationContainer.hostname","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/hostname.html","searchKeys":["hostname","open override val hostname: StateFlow","inkapplications.shade.internals.DummyConfigurationContainer.hostname"]},{"name":"open override val securityStrategy: StateFlow","description":"inkapplications.shade.internals.DummyConfigurationContainer.securityStrategy","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/security-strategy.html","searchKeys":["securityStrategy","open override val securityStrategy: StateFlow","inkapplications.shade.internals.DummyConfigurationContainer.securityStrategy"]},{"name":"open suspend override fun sendRequest(method: String, pathSegments: Array, responseSerializer: KSerializer>, body: REQUEST?, requestSerializer: KSerializer?): RESPONSE","description":"inkapplications.shade.internals.HueStubClient.sendRequest","location":"internals/inkapplications.shade.internals/-hue-stub-client/send-request.html","searchKeys":["sendRequest","open suspend override fun sendRequest(method: String, pathSegments: Array, responseSerializer: KSerializer>, body: REQUEST?, requestSerializer: KSerializer?): RESPONSE","inkapplications.shade.internals.HueStubClient.sendRequest"]},{"name":"open suspend override fun sendV1Request(method: String, pathSegments: Array, responseSerializer: KSerializer>>, body: REQUEST?, requestSerializer: KSerializer?): RESPONSE","description":"inkapplications.shade.internals.HueStubClient.sendV1Request","location":"internals/inkapplications.shade.internals/-hue-stub-client/send-v1-request.html","searchKeys":["sendV1Request","open suspend override fun sendV1Request(method: String, pathSegments: Array, responseSerializer: KSerializer>>, body: REQUEST?, requestSerializer: KSerializer?): RESPONSE","inkapplications.shade.internals.HueStubClient.sendV1Request"]},{"name":"open suspend override fun setAuthToken(token: AuthToken?)","description":"inkapplications.shade.internals.DummyConfigurationContainer.setAuthToken","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/set-auth-token.html","searchKeys":["setAuthToken","open suspend override fun setAuthToken(token: AuthToken?)","inkapplications.shade.internals.DummyConfigurationContainer.setAuthToken"]},{"name":"open suspend override fun setHostname(hostname: String?)","description":"inkapplications.shade.internals.DummyConfigurationContainer.setHostname","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/set-hostname.html","searchKeys":["setHostname","open suspend override fun setHostname(hostname: String?)","inkapplications.shade.internals.DummyConfigurationContainer.setHostname"]},{"name":"open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","description":"inkapplications.shade.internals.DummyConfigurationContainer.setSecurityStrategy","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/set-security-strategy.html","searchKeys":["setSecurityStrategy","open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","inkapplications.shade.internals.DummyConfigurationContainer.setSecurityStrategy"]},{"name":"val configurationContainer: HueConfigurationContainer","description":"inkapplications.shade.internals.InternalsModule.configurationContainer","location":"internals/inkapplications.shade.internals/-internals-module/configuration-container.html","searchKeys":["configurationContainer","val configurationContainer: HueConfigurationContainer","inkapplications.shade.internals.InternalsModule.configurationContainer"]},{"name":"val factory: (KEY) -> VALUE","description":"inkapplications.shade.internals.CachedProperty.factory","location":"internals/inkapplications.shade.internals/-cached-property/factory.html","searchKeys":["factory","val factory: (KEY) -> VALUE","inkapplications.shade.internals.CachedProperty.factory"]},{"name":"val hueHttpClient: HueHttpClient","description":"inkapplications.shade.internals.InternalsModule.hueHttpClient","location":"internals/inkapplications.shade.internals/-internals-module/hue-http-client.html","searchKeys":["hueHttpClient","val hueHttpClient: HueHttpClient","inkapplications.shade.internals.InternalsModule.hueHttpClient"]},{"name":"val json: Json","description":"inkapplications.shade.internals.InternalsModule.json","location":"internals/inkapplications.shade.internals/-internals-module/json.html","searchKeys":["json","val json: Json","inkapplications.shade.internals.InternalsModule.json"]},{"name":"val keyProperty: () -> KEY","description":"inkapplications.shade.internals.CachedProperty.keyProperty","location":"internals/inkapplications.shade.internals/-cached-property/key-property.html","searchKeys":["keyProperty","val keyProperty: () -> KEY","inkapplications.shade.internals.CachedProperty.keyProperty"]},{"name":"val platformModule: PlatformModule","description":"inkapplications.shade.internals.InternalsModule.platformModule","location":"internals/inkapplications.shade.internals/-internals-module/platform-module.html","searchKeys":["platformModule","val platformModule: PlatformModule","inkapplications.shade.internals.InternalsModule.platformModule"]},{"name":"val sseClient: SseClient","description":"inkapplications.shade.internals.PlatformModule.sseClient","location":"internals/inkapplications.shade.internals/-platform-module/sse-client.html","searchKeys":["sseClient","val sseClient: SseClient","inkapplications.shade.internals.PlatformModule.sseClient"]},{"name":"abstract suspend fun getButton(id: ResourceId): Button","description":"inkapplications.shade.button.ButtonControls.getButton","location":"button/inkapplications.shade.button/-button-controls/get-button.html","searchKeys":["getButton","abstract suspend fun getButton(id: ResourceId): Button","inkapplications.shade.button.ButtonControls.getButton"]},{"name":"abstract suspend fun listButtons(): List
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-position/-position.html b/docs/reference/latest/structures/inkapplications.shade.structures/-position/-position.html new file mode 100644 index 00000000..99292385 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-position/-position.html @@ -0,0 +1,118 @@ + + + + + Position + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Position

+
+
constructor(x: Double, y: Double, z: Double)
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-position/index.html b/docs/reference/latest/structures/inkapplications.shade.structures/-position/index.html new file mode 100644 index 00000000..d6b7a83f --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-position/index.html @@ -0,0 +1,191 @@ + + + + + Position + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

Position

+
@Serializable
data class Position(val x: Double, val y: Double, val z: Double)

XYZ position coordinates.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(x: Double, y: Double, z: Double)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val x: Double

X coordinate of the position.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val y: Double

Y coordinate of the position.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val z: Double

Z coordinate of the position.

+
+
+
+
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-position/x.html b/docs/reference/latest/structures/inkapplications.shade.structures/-position/x.html new file mode 100644 index 00000000..cf534282 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-position/x.html @@ -0,0 +1,118 @@ + + + + + x + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

x

+
+
val x: Double

X coordinate of the position.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-position/y.html b/docs/reference/latest/structures/inkapplications.shade.structures/-position/y.html new file mode 100644 index 00000000..c83d9839 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-position/y.html @@ -0,0 +1,118 @@ + + + + + y + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

y

+
+
val y: Double

Y coordinate of the position.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-position/z.html b/docs/reference/latest/structures/inkapplications.shade.structures/-position/z.html new file mode 100644 index 00000000..fead318a --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-position/z.html @@ -0,0 +1,118 @@ + + + + + z + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+ +
+

z

+
+
val z: Double

Z coordinate of the position.

+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/index.html b/docs/reference/latest/structures/inkapplications.shade.structures/index.html index 7a6fce5d..b9e0c415 100644 --- a/docs/reference/latest/structures/inkapplications.shade.structures/index.html +++ b/docs/reference/latest/structures/inkapplications.shade.structures/index.html @@ -303,6 +303,21 @@

Types

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class Position(val x: Double, val y: Double, val z: Double)

XYZ position coordinates.

+
+
+
+
diff --git a/docs/reference/latest/structures/navigation.html b/docs/reference/latest/structures/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/structures/navigation.html +++ b/docs/reference/latest/structures/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/docs/reference/latest/zones/navigation.html b/docs/reference/latest/zones/navigation.html index d71c5de6..4b78116b 100644 --- a/docs/reference/latest/zones/navigation.html +++ b/docs/reference/latest/zones/navigation.html @@ -224,6 +224,166 @@
+
eventsSkip to content @@ -1212,147 +1372,152 @@ NetworkException
-
+
+
+ Position +
+
+ -
+ -
+ -
+ -
+ -
+
- -
+ -
+ -
+ -
+
-
+ -
+ -
+ - -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
diff --git a/entertainment/api/entertainment.api b/entertainment/api/entertainment.api new file mode 100644 index 00000000..a7c1634f --- /dev/null +++ b/entertainment/api/entertainment.api @@ -0,0 +1,686 @@ +public abstract interface class inkapplications/shade/entertainment/EntertainmentConfigurationControls { + public abstract fun createConfiguration (Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public abstract fun deleteConfiguration-klA6Vuc (Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public abstract fun getConfiguration-klA6Vuc (Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public abstract fun listConfigurations (Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public abstract fun updateConfiguration-bKh5c1I (Ljava/lang/String;Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; +} + +public abstract interface class inkapplications/shade/entertainment/EntertainmentControls { + public abstract fun getEntertainment-klA6Vuc (Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public abstract fun listEntertainment (Lkotlin/coroutines/Continuation;)Ljava/lang/Object; +} + +public final class inkapplications/shade/entertainment/ShadeEntertainmentModule { + public fun (Linkapplications/shade/internals/InternalsModule;)V + public final fun getConfigurations ()Linkapplications/shade/entertainment/EntertainmentConfigurationControls; + public final fun getEntertainment ()Linkapplications/shade/entertainment/EntertainmentControls; +} + +public final class inkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters { + public static final field Companion Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters$Companion; + public synthetic fun (Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters;Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public synthetic fun (Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters;Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters;Lkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1 ()Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata; + public final fun component2-kXrv_eM ()Ljava/lang/String; + public final fun component3 ()Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters; + public final fun component4 ()Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters; + public final fun copy-17hu6_I (Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters;Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters;)Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters; + public static synthetic fun copy-17hu6_I$default (Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters;Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters;Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters;ILjava/lang/Object;)Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters; + public fun equals (Ljava/lang/Object;)Z + public final fun getConfigurationType-kXrv_eM ()Ljava/lang/String; + public final fun getLocations ()Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters; + public final fun getMetadata ()Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata; + public final fun getStreamProxy ()Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters { + public static final field Companion Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters$Companion; + public synthetic fun (Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters;Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public synthetic fun (Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters;Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters;Lkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1 ()Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata; + public final fun component2-UFqhDZ4 ()Ljava/lang/String; + public final fun component3-PpS6XH0 ()Ljava/lang/String; + public final fun component4 ()Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters; + public final fun component5 ()Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters; + public final fun copy-nLwcIS0 (Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters;Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters;)Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters; + public static synthetic fun copy-nLwcIS0$default (Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters;Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters;Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters;ILjava/lang/Object;)Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters; + public fun equals (Ljava/lang/Object;)Z + public final fun getAction-PpS6XH0 ()Ljava/lang/String; + public final fun getConfigurationType-UFqhDZ4 ()Ljava/lang/String; + public final fun getLocations ()Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters; + public final fun getMetadata ()Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata; + public final fun getStreamProxy ()Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters { + public static final field Companion Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters$Companion; + public fun (Ljava/util/List;)V + public final fun component1 ()Ljava/util/List; + public final fun copy (Ljava/util/List;)Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters; + public static synthetic fun copy$default (Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters;Ljava/util/List;ILjava/lang/Object;)Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters; + public fun equals (Ljava/lang/Object;)Z + public final fun getServiceLocations ()Ljava/util/List; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters { + public static final field Companion Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters$Companion; + public fun (Ljava/util/List;)V + public final fun component1 ()Ljava/util/List; + public final fun copy (Ljava/util/List;)Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters; + public static synthetic fun copy$default (Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters;Ljava/util/List;ILjava/lang/Object;)Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters; + public fun equals (Ljava/lang/Object;)Z + public final fun getServiceLocations ()Ljava/util/List; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters { + public static final field Companion Linkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters$Companion; + public fun (Linkapplications/shade/structures/ResourceReference;Ljava/util/List;)V + public final fun component1 ()Linkapplications/shade/structures/ResourceReference; + public final fun component2 ()Ljava/util/List; + public final fun copy (Linkapplications/shade/structures/ResourceReference;Ljava/util/List;)Linkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters; + public static synthetic fun copy$default (Linkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters;Linkapplications/shade/structures/ResourceReference;Ljava/util/List;ILjava/lang/Object;)Linkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters; + public fun equals (Ljava/lang/Object;)Z + public final fun getPositions ()Ljava/util/List; + public final fun getService ()Linkapplications/shade/structures/ResourceReference; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters { + public static final field Companion Linkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters$Companion; + public fun (Linkapplications/shade/structures/ResourceReference;Ljava/util/List;Ljava/lang/Float;)V + public synthetic fun (Linkapplications/shade/structures/ResourceReference;Ljava/util/List;Ljava/lang/Float;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1 ()Linkapplications/shade/structures/ResourceReference; + public final fun component2 ()Ljava/util/List; + public final fun component3 ()Ljava/lang/Float; + public final fun copy (Linkapplications/shade/structures/ResourceReference;Ljava/util/List;Ljava/lang/Float;)Linkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters; + public static synthetic fun copy$default (Linkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters;Linkapplications/shade/structures/ResourceReference;Ljava/util/List;Ljava/lang/Float;ILjava/lang/Object;)Linkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters; + public fun equals (Ljava/lang/Object;)Z + public final fun getEqualizationFactor ()Ljava/lang/Float; + public final fun getPositions ()Ljava/util/List; + public final fun getService ()Linkapplications/shade/structures/ResourceReference; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/StreamProxyCreateParameters { + public static final field Companion Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters$Companion; + public synthetic fun (Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public synthetic fun (Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;Lkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1--4vbXQY ()Ljava/lang/String; + public final fun component2 ()Linkapplications/shade/structures/ResourceReference; + public final fun copy-uLJ9sGg (Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;)Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters; + public static synthetic fun copy-uLJ9sGg$default (Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters;Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;ILjava/lang/Object;)Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters; + public fun equals (Ljava/lang/Object;)Z + public final fun getMode--4vbXQY ()Ljava/lang/String; + public final fun getNode ()Linkapplications/shade/structures/ResourceReference; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/parameters/StreamProxyCreateParameters$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/parameters/StreamProxyCreateParameters;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/parameters/StreamProxyCreateParameters$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/Entertainment { + public static final field Companion Linkapplications/shade/entertainment/structures/Entertainment$Companion; + public synthetic fun (Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;ZLinkapplications/shade/structures/ResourceReference;ZZLjava/lang/Integer;Linkapplications/shade/entertainment/structures/Segments;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public synthetic fun (Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;ZLinkapplications/shade/structures/ResourceReference;ZZLjava/lang/Integer;Linkapplications/shade/entertainment/structures/Segments;Lkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1-XbiYvy0 ()Ljava/lang/String; + public final fun component2 ()Linkapplications/shade/structures/ResourceReference; + public final fun component3 ()Z + public final fun component4 ()Linkapplications/shade/structures/ResourceReference; + public final fun component5 ()Z + public final fun component6 ()Z + public final fun component7 ()Ljava/lang/Integer; + public final fun component8 ()Linkapplications/shade/entertainment/structures/Segments; + public final fun copy-A98v47k (Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;ZLinkapplications/shade/structures/ResourceReference;ZZLjava/lang/Integer;Linkapplications/shade/entertainment/structures/Segments;)Linkapplications/shade/entertainment/structures/Entertainment; + public static synthetic fun copy-A98v47k$default (Linkapplications/shade/entertainment/structures/Entertainment;Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;ZLinkapplications/shade/structures/ResourceReference;ZZLjava/lang/Integer;Linkapplications/shade/entertainment/structures/Segments;ILjava/lang/Object;)Linkapplications/shade/entertainment/structures/Entertainment; + public fun equals (Ljava/lang/Object;)Z + public final fun getEqualizer ()Z + public final fun getId-XbiYvy0 ()Ljava/lang/String; + public final fun getMaxStreams ()Ljava/lang/Integer; + public final fun getOwner ()Linkapplications/shade/structures/ResourceReference; + public final fun getProxy ()Z + public final fun getRenderer ()Z + public final fun getRendererReference ()Linkapplications/shade/structures/ResourceReference; + public final fun getSegments ()Linkapplications/shade/entertainment/structures/Segments; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/Entertainment$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/Entertainment$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/structures/Entertainment; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/structures/Entertainment;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/Entertainment$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentChannel { + public static final field Companion Linkapplications/shade/entertainment/structures/EntertainmentChannel$Companion; + public synthetic fun (ILinkapplications/shade/structures/Position;Ljava/util/List;Lkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1-twErxHc ()I + public final fun component2 ()Linkapplications/shade/structures/Position; + public final fun component3 ()Ljava/util/List; + public final fun copy-YUQ_Hnk (ILinkapplications/shade/structures/Position;Ljava/util/List;)Linkapplications/shade/entertainment/structures/EntertainmentChannel; + public static synthetic fun copy-YUQ_Hnk$default (Linkapplications/shade/entertainment/structures/EntertainmentChannel;ILinkapplications/shade/structures/Position;Ljava/util/List;ILjava/lang/Object;)Linkapplications/shade/entertainment/structures/EntertainmentChannel; + public fun equals (Ljava/lang/Object;)Z + public final fun getChannelId-twErxHc ()I + public final fun getMembers ()Ljava/util/List; + public final fun getPosition ()Linkapplications/shade/structures/Position; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/EntertainmentChannel$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/EntertainmentChannel$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/structures/EntertainmentChannel; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/structures/EntertainmentChannel;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentChannel$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentChannelId { + public static final field Companion Linkapplications/shade/entertainment/structures/EntertainmentChannelId$Companion; + public static final synthetic fun box-impl (I)Linkapplications/shade/entertainment/structures/EntertainmentChannelId; + public static fun constructor-impl (I)I + public fun equals (Ljava/lang/Object;)Z + public static fun equals-impl (ILjava/lang/Object;)Z + public static final fun equals-impl0 (II)Z + public final fun getValue ()I + public fun hashCode ()I + public static fun hashCode-impl (I)I + public fun toString ()Ljava/lang/String; + public static fun toString-impl (I)Ljava/lang/String; + public final synthetic fun unbox-impl ()I +} + +public final synthetic class inkapplications/shade/entertainment/structures/EntertainmentChannelId$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/EntertainmentChannelId$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun deserialize-RRhryiY (Lkotlinx/serialization/encoding/Decoder;)I + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public final fun serialize-d8FbzAc (Lkotlinx/serialization/encoding/Encoder;I)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentChannelId$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentConfiguration { + public static final field Companion Linkapplications/shade/entertainment/structures/EntertainmentConfiguration$Companion; + public synthetic fun (Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;Linkapplications/shade/entertainment/structures/StreamProxy;Ljava/util/List;Linkapplications/shade/entertainment/structures/EntertainmentLocations;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public synthetic fun (Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;Linkapplications/shade/entertainment/structures/StreamProxy;Ljava/util/List;Linkapplications/shade/entertainment/structures/EntertainmentLocations;Lkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1-XbiYvy0 ()Ljava/lang/String; + public final fun component2-1y3a6N0 ()Ljava/lang/String; + public final fun component3 ()Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata; + public final fun component4-kXrv_eM ()Ljava/lang/String; + public final fun component5-mS-bnQ4 ()Ljava/lang/String; + public final fun component6 ()Linkapplications/shade/structures/ResourceReference; + public final fun component7 ()Linkapplications/shade/entertainment/structures/StreamProxy; + public final fun component8 ()Ljava/util/List; + public final fun component9 ()Linkapplications/shade/entertainment/structures/EntertainmentLocations; + public final fun copy-KnIyEFU (Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;Linkapplications/shade/entertainment/structures/StreamProxy;Ljava/util/List;Linkapplications/shade/entertainment/structures/EntertainmentLocations;)Linkapplications/shade/entertainment/structures/EntertainmentConfiguration; + public static synthetic fun copy-KnIyEFU$default (Linkapplications/shade/entertainment/structures/EntertainmentConfiguration;Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;Linkapplications/shade/entertainment/structures/StreamProxy;Ljava/util/List;Linkapplications/shade/entertainment/structures/EntertainmentLocations;ILjava/lang/Object;)Linkapplications/shade/entertainment/structures/EntertainmentConfiguration; + public fun equals (Ljava/lang/Object;)Z + public final fun getActiveStreamer ()Linkapplications/shade/structures/ResourceReference; + public final fun getChannels ()Ljava/util/List; + public final fun getConfigurationType-kXrv_eM ()Ljava/lang/String; + public final fun getId-XbiYvy0 ()Ljava/lang/String; + public final fun getLocations ()Linkapplications/shade/entertainment/structures/EntertainmentLocations; + public final fun getMetadata ()Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata; + public final fun getStatus-mS-bnQ4 ()Ljava/lang/String; + public final fun getStreamProxy ()Linkapplications/shade/entertainment/structures/StreamProxy; + public final fun getType-1y3a6N0 ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/EntertainmentConfiguration$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/EntertainmentConfiguration$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/structures/EntertainmentConfiguration; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/structures/EntertainmentConfiguration;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentConfiguration$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentConfigurationAction { + public static final field Companion Linkapplications/shade/entertainment/structures/EntertainmentConfigurationAction$Companion; + public static final synthetic fun box-impl (Ljava/lang/String;)Linkapplications/shade/entertainment/structures/EntertainmentConfigurationAction; + public static fun constructor-impl (Ljava/lang/String;)Ljava/lang/String; + public fun equals (Ljava/lang/Object;)Z + public static fun equals-impl (Ljava/lang/String;Ljava/lang/Object;)Z + public static final fun equals-impl0 (Ljava/lang/String;Ljava/lang/String;)Z + public final fun getKey ()Ljava/lang/String; + public fun hashCode ()I + public static fun hashCode-impl (Ljava/lang/String;)I + public fun toString ()Ljava/lang/String; + public static fun toString-impl (Ljava/lang/String;)Ljava/lang/String; + public final synthetic fun unbox-impl ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/EntertainmentConfigurationAction$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/EntertainmentConfigurationAction$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun deserialize-hI1_GTE (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/String; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public final fun serialize-a3tC1jQ (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/String;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentConfigurationAction$Companion { + public final fun getStart-nhkgo4c ()Ljava/lang/String; + public final fun getStop-nhkgo4c ()Ljava/lang/String; + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata { + public static final field Companion Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata$Companion; + public fun (Ljava/lang/String;)V + public final fun component1 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;)Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata; + public static synthetic fun copy$default (Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;Ljava/lang/String;ILjava/lang/Object;)Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata; + public fun equals (Ljava/lang/Object;)Z + public final fun getName ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentConfigurationType { + public static final field Companion Linkapplications/shade/entertainment/structures/EntertainmentConfigurationType$Companion; + public static final synthetic fun box-impl (Ljava/lang/String;)Linkapplications/shade/entertainment/structures/EntertainmentConfigurationType; + public static fun constructor-impl (Ljava/lang/String;)Ljava/lang/String; + public fun equals (Ljava/lang/Object;)Z + public static fun equals-impl (Ljava/lang/String;Ljava/lang/Object;)Z + public static final fun equals-impl0 (Ljava/lang/String;Ljava/lang/String;)Z + public final fun getKey ()Ljava/lang/String; + public fun hashCode ()I + public static fun hashCode-impl (Ljava/lang/String;)I + public fun toString ()Ljava/lang/String; + public static fun toString-impl (Ljava/lang/String;)Ljava/lang/String; + public final synthetic fun unbox-impl ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/EntertainmentConfigurationType$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/EntertainmentConfigurationType$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun deserialize-8nU9UCc (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/String; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public final fun serialize-6tj8LoY (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/String;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentConfigurationType$Companion { + public final fun getMonitor-kXrv_eM ()Ljava/lang/String; + public final fun getMusic-kXrv_eM ()Ljava/lang/String; + public final fun getOther-kXrv_eM ()Ljava/lang/String; + public final fun getScreen-kXrv_eM ()Ljava/lang/String; + public final fun getThreeDSpace-kXrv_eM ()Ljava/lang/String; + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentLocations { + public static final field Companion Linkapplications/shade/entertainment/structures/EntertainmentLocations$Companion; + public fun (Ljava/util/List;)V + public final fun component1 ()Ljava/util/List; + public final fun copy (Ljava/util/List;)Linkapplications/shade/entertainment/structures/EntertainmentLocations; + public static synthetic fun copy$default (Linkapplications/shade/entertainment/structures/EntertainmentLocations;Ljava/util/List;ILjava/lang/Object;)Linkapplications/shade/entertainment/structures/EntertainmentLocations; + public fun equals (Ljava/lang/Object;)Z + public final fun getServiceLocations ()Ljava/util/List; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/EntertainmentLocations$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/EntertainmentLocations$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/structures/EntertainmentLocations; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/structures/EntertainmentLocations;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentLocations$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentStatus { + public static final field Companion Linkapplications/shade/entertainment/structures/EntertainmentStatus$Companion; + public static final synthetic fun box-impl (Ljava/lang/String;)Linkapplications/shade/entertainment/structures/EntertainmentStatus; + public static fun constructor-impl (Ljava/lang/String;)Ljava/lang/String; + public fun equals (Ljava/lang/Object;)Z + public static fun equals-impl (Ljava/lang/String;Ljava/lang/Object;)Z + public static final fun equals-impl0 (Ljava/lang/String;Ljava/lang/String;)Z + public final fun getKey ()Ljava/lang/String; + public fun hashCode ()I + public static fun hashCode-impl (Ljava/lang/String;)I + public fun toString ()Ljava/lang/String; + public static fun toString-impl (Ljava/lang/String;)Ljava/lang/String; + public final synthetic fun unbox-impl ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/EntertainmentStatus$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/EntertainmentStatus$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun deserialize-YzT9aGw (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/String; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public final fun serialize-MvHtn9U (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/String;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/EntertainmentStatus$Companion { + public final fun getActive-mS-bnQ4 ()Ljava/lang/String; + public final fun getInactive-mS-bnQ4 ()Ljava/lang/String; + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/SegmentReference { + public static final field Companion Linkapplications/shade/entertainment/structures/SegmentReference$Companion; + public fun (Linkapplications/shade/structures/ResourceReference;I)V + public final fun component1 ()Linkapplications/shade/structures/ResourceReference; + public final fun component2 ()I + public final fun copy (Linkapplications/shade/structures/ResourceReference;I)Linkapplications/shade/entertainment/structures/SegmentReference; + public static synthetic fun copy$default (Linkapplications/shade/entertainment/structures/SegmentReference;Linkapplications/shade/structures/ResourceReference;IILjava/lang/Object;)Linkapplications/shade/entertainment/structures/SegmentReference; + public fun equals (Ljava/lang/Object;)Z + public final fun getIndex ()I + public final fun getService ()Linkapplications/shade/structures/ResourceReference; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/SegmentReference$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/SegmentReference$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/structures/SegmentReference; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/structures/SegmentReference;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/SegmentReference$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/Segments { + public static final field Companion Linkapplications/shade/entertainment/structures/Segments$Companion; + public fun (ZILjava/util/List;)V + public final fun component1 ()Z + public final fun component2 ()I + public final fun component3 ()Ljava/util/List; + public final fun copy (ZILjava/util/List;)Linkapplications/shade/entertainment/structures/Segments; + public static synthetic fun copy$default (Linkapplications/shade/entertainment/structures/Segments;ZILjava/util/List;ILjava/lang/Object;)Linkapplications/shade/entertainment/structures/Segments; + public fun equals (Ljava/lang/Object;)Z + public final fun getConfigurable ()Z + public final fun getMaxSegments ()I + public final fun getSegmentRanges ()Ljava/util/List; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/Segments$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/Segments$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/structures/Segments; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/structures/Segments;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/Segments$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/ServiceLocation { + public static final field Companion Linkapplications/shade/entertainment/structures/ServiceLocation$Companion; + public fun (Linkapplications/shade/structures/ResourceReference;Ljava/util/List;D)V + public final fun component1 ()Linkapplications/shade/structures/ResourceReference; + public final fun component2 ()Ljava/util/List; + public final fun component3 ()D + public final fun copy (Linkapplications/shade/structures/ResourceReference;Ljava/util/List;D)Linkapplications/shade/entertainment/structures/ServiceLocation; + public static synthetic fun copy$default (Linkapplications/shade/entertainment/structures/ServiceLocation;Linkapplications/shade/structures/ResourceReference;Ljava/util/List;DILjava/lang/Object;)Linkapplications/shade/entertainment/structures/ServiceLocation; + public fun equals (Ljava/lang/Object;)Z + public final fun getEqualizationFactor ()D + public final fun getPositions ()Ljava/util/List; + public final fun getService ()Linkapplications/shade/structures/ResourceReference; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/ServiceLocation$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/ServiceLocation$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/structures/ServiceLocation; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/structures/ServiceLocation;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/ServiceLocation$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/StreamProxy { + public static final field Companion Linkapplications/shade/entertainment/structures/StreamProxy$Companion; + public synthetic fun (Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;Lkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1--4vbXQY ()Ljava/lang/String; + public final fun component2 ()Linkapplications/shade/structures/ResourceReference; + public final fun copy-uLJ9sGg (Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;)Linkapplications/shade/entertainment/structures/StreamProxy; + public static synthetic fun copy-uLJ9sGg$default (Linkapplications/shade/entertainment/structures/StreamProxy;Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;ILjava/lang/Object;)Linkapplications/shade/entertainment/structures/StreamProxy; + public fun equals (Ljava/lang/Object;)Z + public final fun getMode--4vbXQY ()Ljava/lang/String; + public final fun getNode ()Linkapplications/shade/structures/ResourceReference; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/StreamProxy$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/StreamProxy$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/entertainment/structures/StreamProxy; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/entertainment/structures/StreamProxy;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/StreamProxy$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/StreamProxyMode { + public static final field Companion Linkapplications/shade/entertainment/structures/StreamProxyMode$Companion; + public static final synthetic fun box-impl (Ljava/lang/String;)Linkapplications/shade/entertainment/structures/StreamProxyMode; + public static fun constructor-impl (Ljava/lang/String;)Ljava/lang/String; + public fun equals (Ljava/lang/Object;)Z + public static fun equals-impl (Ljava/lang/String;Ljava/lang/Object;)Z + public static final fun equals-impl0 (Ljava/lang/String;Ljava/lang/String;)Z + public final fun getKey ()Ljava/lang/String; + public fun hashCode ()I + public static fun hashCode-impl (Ljava/lang/String;)I + public fun toString ()Ljava/lang/String; + public static fun toString-impl (Ljava/lang/String;)Ljava/lang/String; + public final synthetic fun unbox-impl ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/entertainment/structures/StreamProxyMode$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/entertainment/structures/StreamProxyMode$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun deserialize-p6WEcZI (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/String; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public final fun serialize-na0l960 (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/String;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/entertainment/structures/StreamProxyMode$Companion { + public final fun getAuto--4vbXQY ()Ljava/lang/String; + public final fun getManual--4vbXQY ()Ljava/lang/String; + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + diff --git a/entertainment/build.gradle.kts b/entertainment/build.gradle.kts new file mode 100644 index 00000000..c3624bbb --- /dev/null +++ b/entertainment/build.gradle.kts @@ -0,0 +1,27 @@ +plugins { + id("library") + kotlin("plugin.serialization") + id("ink.publishing") +} + +kotlin { + sourceSets { + val commonMain by getting { + dependencies { + implementation(libs.serialization.json) + implementation(projects.internals) + implementation(projects.serialization) + api(projects.structures) + + api(libs.coroutines.core) + } + } + + val commonTest by getting { + dependencies { + implementation(libs.test.core) + implementation(libs.test.annotations) + } + } + } +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/EntertainmentConfigurationControls.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/EntertainmentConfigurationControls.kt new file mode 100644 index 00000000..165afcfe --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/EntertainmentConfigurationControls.kt @@ -0,0 +1,52 @@ +package inkapplications.shade.entertainment + +import inkapplications.shade.entertainment.parameters.EntertainmentConfigurationCreateParameters +import inkapplications.shade.entertainment.parameters.EntertainmentConfigurationUpdateParameters +import inkapplications.shade.entertainment.structures.EntertainmentConfiguration +import inkapplications.shade.structures.ResourceId +import inkapplications.shade.structures.ResourceReference + +/** + * Actions to get entertainment configuration resources in the hue system. + * + * Entertainment configurations manage the setup for Hue Entertainment functionality, + * including channel assignments, light positions, and streaming settings. + */ +interface EntertainmentConfigurationControls { + /** + * Get the state of a single entertainment configuration. + * + * @param id The resource ID of the entertainment configuration to fetch. + */ + suspend fun getConfiguration(id: ResourceId): EntertainmentConfiguration + + /** + * Get a list of entertainment configurations on the hue service. + */ + suspend fun listConfigurations(): List + + /** + * Create a new entertainment configuration on the hue bridge. + * + * @param parameters Data for the new entertainment configuration. + * @return A reference to the newly created resource. + */ + suspend fun createConfiguration(parameters: EntertainmentConfigurationCreateParameters): ResourceReference + + /** + * Update an existing entertainment configuration on the hue bridge. + * + * @param id The resource ID of the entertainment configuration to update. + * @param parameters Data to update on the entertainment configuration. + * @return A reference to the updated resource. + */ + suspend fun updateConfiguration(id: ResourceId, parameters: EntertainmentConfigurationUpdateParameters): ResourceReference + + /** + * Delete an existing entertainment configuration from the hue bridge. + * + * @param id The resource ID of the entertainment configuration to delete. + * @return A reference to the deleted resource. + */ + suspend fun deleteConfiguration(id: ResourceId): ResourceReference +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/EntertainmentControls.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/EntertainmentControls.kt new file mode 100644 index 00000000..3e9458cc --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/EntertainmentControls.kt @@ -0,0 +1,24 @@ +package inkapplications.shade.entertainment + +import inkapplications.shade.entertainment.structures.Entertainment +import inkapplications.shade.structures.ResourceId + +/** + * Actions to get entertainment resources in the hue system. + * + * Entertainment resources represent the entertainment streaming capabilities + * of lights and devices. + */ +interface EntertainmentControls { + /** + * Get the state of a single entertainment resource. + * + * @param id The resource ID of the entertainment resource to fetch data for. + */ + suspend fun getEntertainment(id: ResourceId): Entertainment + + /** + * Get a list of entertainment resources configured on the hue service. + */ + suspend fun listEntertainment(): List +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/ShadeEntertainment.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/ShadeEntertainment.kt new file mode 100644 index 00000000..ccf715ac --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/ShadeEntertainment.kt @@ -0,0 +1,21 @@ +package inkapplications.shade.entertainment + +import inkapplications.shade.entertainment.structures.Entertainment +import inkapplications.shade.internals.HueHttpClient +import inkapplications.shade.internals.getData +import inkapplications.shade.structures.ResourceId + +/** + * Implements entertainment controls via the hue client. + */ +internal class ShadeEntertainment( + private val hueHttpClient: HueHttpClient, +) : EntertainmentControls { + override suspend fun getEntertainment(id: ResourceId): Entertainment { + return hueHttpClient.getData>("resource", "entertainment", id.value).single() + } + + override suspend fun listEntertainment(): List { + return hueHttpClient.getData("resource", "entertainment") + } +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/ShadeEntertainmentConfigurations.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/ShadeEntertainmentConfigurations.kt new file mode 100644 index 00000000..44a3b5e9 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/ShadeEntertainmentConfigurations.kt @@ -0,0 +1,47 @@ +package inkapplications.shade.entertainment + +import inkapplications.shade.entertainment.parameters.EntertainmentConfigurationCreateParameters +import inkapplications.shade.entertainment.parameters.EntertainmentConfigurationUpdateParameters +import inkapplications.shade.entertainment.structures.EntertainmentConfiguration +import inkapplications.shade.internals.HueHttpClient +import inkapplications.shade.internals.deleteData +import inkapplications.shade.internals.getData +import inkapplications.shade.internals.postData +import inkapplications.shade.internals.putData +import inkapplications.shade.structures.ResourceId +import inkapplications.shade.structures.ResourceReference + +/** + * Implements entertainment configuration controls via the hue client. + */ +internal class ShadeEntertainmentConfigurations( + private val hueHttpClient: HueHttpClient, +) : EntertainmentConfigurationControls { + override suspend fun getConfiguration(id: ResourceId): EntertainmentConfiguration { + return hueHttpClient.getData>("resource", "entertainment_configuration", id.value).single() + } + + override suspend fun listConfigurations(): List { + return hueHttpClient.getData("resource", "entertainment_configuration") + } + + override suspend fun createConfiguration(parameters: EntertainmentConfigurationCreateParameters): ResourceReference { + val response: List = hueHttpClient.postData( + body = parameters, + pathSegments = arrayOf("resource", "entertainment_configuration"), + ) + return response.single() + } + + override suspend fun updateConfiguration(id: ResourceId, parameters: EntertainmentConfigurationUpdateParameters): ResourceReference { + val response: List = hueHttpClient.putData( + body = parameters, + pathSegments = arrayOf("resource", "entertainment_configuration", id.value), + ) + return response.single() + } + + override suspend fun deleteConfiguration(id: ResourceId): ResourceReference { + return hueHttpClient.deleteData>("resource", "entertainment_configuration", id.value).single() + } +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/ShadeEntertainmentModule.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/ShadeEntertainmentModule.kt new file mode 100644 index 00000000..adbfc11a --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/ShadeEntertainmentModule.kt @@ -0,0 +1,22 @@ +package inkapplications.shade.entertainment + +import inkapplications.shade.internals.InternalsModule + +/** + * Provides access to entertainment control services. + */ +class ShadeEntertainmentModule( + internalsModule: InternalsModule, +) { + /** + * Management for entertainment services. + * + * These are offered by devices with color lighting capabilities. + */ + val entertainment: EntertainmentControls = ShadeEntertainment(internalsModule.hueHttpClient) + + /** + * Controls for entertainment configurations (Hue Entertainment functionality setup). + */ + val configurations: EntertainmentConfigurationControls = ShadeEntertainmentConfigurations(internalsModule.hueHttpClient) +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters.kt new file mode 100644 index 00000000..04b32145 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentConfigurationCreateParameters.kt @@ -0,0 +1,35 @@ +package inkapplications.shade.entertainment.parameters + +import inkapplications.shade.entertainment.structures.EntertainmentConfigurationMetadata +import inkapplications.shade.entertainment.structures.EntertainmentConfigurationType +import inkapplications.shade.structures.ResourceType +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * Data used for creating a new entertainment configuration via the bridge. + */ +@Serializable +data class EntertainmentConfigurationCreateParameters( + /** + * Metadata containing the friendly name of the entertainment configuration. + */ + val metadata: EntertainmentConfigurationMetadata, + + /** + * Defines for which type of application this channel assignment was optimized. + */ + @SerialName("configuration_type") + val configurationType: EntertainmentConfigurationType, + + /** + * Stream proxy configuration for this entertainment group. + */ + @SerialName("stream_proxy") + val streamProxy: StreamProxyCreateParameters? = null, + + /** + * Entertainment service locations for lights in the zone. + */ + val locations: EntertainmentLocationsCreateParameters, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters.kt new file mode 100644 index 00000000..3a68f82f --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentConfigurationUpdateParameters.kt @@ -0,0 +1,47 @@ +package inkapplications.shade.entertainment.parameters + +import inkapplications.shade.entertainment.structures.EntertainmentConfigurationAction +import inkapplications.shade.entertainment.structures.EntertainmentConfigurationMetadata +import inkapplications.shade.entertainment.structures.EntertainmentConfigurationType +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * Data used for updating an existing entertainment configuration via the bridge. + * + * All properties are optional - only the specified fields will be updated. + */ +@Serializable +data class EntertainmentConfigurationUpdateParameters( + /** + * Metadata containing the friendly name of the entertainment configuration. + */ + val metadata: EntertainmentConfigurationMetadata? = null, + + /** + * Defines for which type of application this channel assignment was optimized. + */ + @SerialName("configuration_type") + val configurationType: EntertainmentConfigurationType? = null, + + /** + * Action to control streaming. + * + * If status is "inactive" -> write start to start streaming. + * If status is "active" -> write "stop" to end the current streaming. + * In order to start streaming when other application is already streaming, + * first write "stop" and then "start". + */ + val action: EntertainmentConfigurationAction? = null, + + /** + * Stream proxy configuration for this entertainment group. + */ + @SerialName("stream_proxy") + val streamProxy: StreamProxyCreateParameters? = null, + + /** + * Entertainment service locations for lights in the zone. + */ + val locations: EntertainmentLocationsUpdateParameters? = null, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters.kt new file mode 100644 index 00000000..8ea5faad --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentLocationsCreateParameters.kt @@ -0,0 +1,16 @@ +package inkapplications.shade.entertainment.parameters + +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * Entertainment service locations for creating an entertainment configuration. + */ +@Serializable +data class EntertainmentLocationsCreateParameters( + /** + * List of service locations for lights in the entertainment zone. + */ + @SerialName("service_locations") + val serviceLocations: List, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters.kt new file mode 100644 index 00000000..385667ca --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/EntertainmentLocationsUpdateParameters.kt @@ -0,0 +1,16 @@ +package inkapplications.shade.entertainment.parameters + +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * Entertainment service locations for updating an entertainment configuration. + */ +@Serializable +data class EntertainmentLocationsUpdateParameters( + /** + * List of service locations for lights in the entertainment zone. + */ + @SerialName("service_locations") + val serviceLocations: List, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters.kt new file mode 100644 index 00000000..f99afa81 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/ServiceLocationCreateParameters.kt @@ -0,0 +1,23 @@ +package inkapplications.shade.entertainment.parameters + +import inkapplications.shade.structures.Position +import inkapplications.shade.structures.ResourceReference +import kotlinx.serialization.Serializable + +/** + * Service location for creating an entertainment configuration. + */ +@Serializable +data class ServiceLocationCreateParameters( + /** + * Reference to the entertainment service. + */ + val service: ResourceReference, + + /** + * Describes the location(s) of the service. + * + * Can contain 1-2 positions. + */ + val positions: List, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters.kt new file mode 100644 index 00000000..d136e6eb --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/ServiceLocationUpdateParameters.kt @@ -0,0 +1,34 @@ +package inkapplications.shade.entertainment.parameters + +import inkapplications.shade.structures.Position +import inkapplications.shade.structures.ResourceReference +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * Service location for updating an entertainment configuration. + */ +@Serializable +data class ServiceLocationUpdateParameters( + /** + * Reference to the entertainment service. + */ + val service: ResourceReference, + + /** + * Describes the location(s) of the service. + * + * Can contain 1-2 positions. + */ + val positions: List, + + /** + * Relative equalization factor applied to the entertainment service, + * to compensate for differences in brightness in the entertainment configuration. + * + * Value cannot be 0, writing 0 changes it to lowest possible value. + * Default value is 1, maximum is 1. + */ + @SerialName("equalization_factor") + val equalizationFactor: Float? = null, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/StreamProxyCreateParameters.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/StreamProxyCreateParameters.kt new file mode 100644 index 00000000..e1b77367 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/parameters/StreamProxyCreateParameters.kt @@ -0,0 +1,27 @@ +package inkapplications.shade.entertainment.parameters + +import inkapplications.shade.entertainment.structures.StreamProxyMode +import inkapplications.shade.structures.ResourceReference +import kotlinx.serialization.Serializable + +/** + * Stream proxy configuration for creating an entertainment configuration. + */ +@Serializable +data class StreamProxyCreateParameters( + /** + * Proxy mode used for this group. + */ + val mode: StreamProxyMode, + + /** + * Reference to the device acting as proxy. + * + * The proxy node relays entertainment traffic and should be located in or + * close to all entertainment lamps in this group. + * Writing this property sets the proxy mode to "manual". + * Can be a BridgeDevice or ZigbeeDevice type. + * Not allowed to be combined with mode "auto". + */ + val node: ResourceReference? = null, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/Entertainment.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/Entertainment.kt new file mode 100644 index 00000000..1ac73a8b --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/Entertainment.kt @@ -0,0 +1,61 @@ +package inkapplications.shade.entertainment.structures + +import inkapplications.shade.structures.ResourceId +import inkapplications.shade.structures.ResourceReference +import inkapplications.shade.structures.ResourceType +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * State and capabilities of an entertainment resource. + * + * Entertainment resources represent the entertainment streaming capabilities + * of a light or device in the Hue system. + */ +@Serializable +data class Entertainment( + /** + * Unique identifier representing a specific entertainment resource instance. + */ + val id: ResourceId, + + /** + * Owner of the service. + * + * In case the owner service is deleted, the service also gets deleted. + */ + val owner: ResourceReference, + + /** + * Indicates if a lamp can be used for entertainment streaming as a renderer. + */ + val renderer: Boolean, + + /** + * Indicates which light service is linked to this entertainment service. + */ + @SerialName("renderer_reference") + val rendererReference: ResourceReference? = null, + + /** + * Indicates if a lamp can be used for entertainment streaming as a proxy node. + */ + val proxy: Boolean, + + /** + * Indicates if a lamp can handle the equalization factor to dimming + * maximum brightness in a stream. + */ + val equalizer: Boolean, + + /** + * Indicates the maximum number of parallel streaming sessions the bridge supports. + */ + @SerialName("max_streams") + val maxStreams: Int? = null, + + /** + * Holds all parameters concerning the segmentation capabilities of a device. + */ + val segments: Segments? = null, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentChannel.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentChannel.kt new file mode 100644 index 00000000..5b109241 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentChannel.kt @@ -0,0 +1,33 @@ +package inkapplications.shade.entertainment.structures + +import inkapplications.shade.structures.Position +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * A channel in an entertainment configuration. + * + * Each channel groups segments of one or different lights. + */ +@Serializable +data class EntertainmentChannel( + /** + * Channel identifier assigned by the bridge upon creation. + * + * This is the number to be used by the HueStream API when addressing the channel. + */ + @SerialName("channel_id") + val channelId: EntertainmentChannelId, + + /** + * XYZ position of this channel. + * + * It is the average position of its members. + */ + val position: Position, + + /** + * List of segment references that are members of this channel. + */ + val members: List, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentChannelId.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentChannelId.kt new file mode 100644 index 00000000..f23bd279 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentChannelId.kt @@ -0,0 +1,13 @@ +package inkapplications.shade.entertainment.structures + +import kotlinx.serialization.Serializable +import kotlin.jvm.JvmInline + +/** + * Identifier for an entertainment channel. + */ +@JvmInline +@Serializable +value class EntertainmentChannelId(val value: Int) { + override fun toString(): String = value.toString() +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfiguration.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfiguration.kt new file mode 100644 index 00000000..05763ad8 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfiguration.kt @@ -0,0 +1,69 @@ +package inkapplications.shade.entertainment.structures + +import inkapplications.shade.structures.ResourceId +import inkapplications.shade.structures.ResourceReference +import inkapplications.shade.structures.ResourceType +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * Configuration for Hue Entertainment functionality. + * + * Entertainment configurations manage the setup for entertainment streaming, + * including channel assignments and light positions. + */ +@Serializable +data class EntertainmentConfiguration( + /** + * Unique identifier representing a specific entertainment configuration instance. + */ + val id: ResourceId, + + /** + * Type of the resource (always entertainment_configuration). + */ + val type: ResourceType = ResourceType.EntertainmentConfiguration, + + /** + * Metadata containing the friendly name of the entertainment configuration. + */ + val metadata: EntertainmentConfigurationMetadata, + + /** + * Defines for which type of application this channel assignment was optimized. + */ + @SerialName("configuration_type") + val configurationType: EntertainmentConfigurationType, + + /** + * Read-only field reporting if the stream is active or not. + */ + val status: EntertainmentStatus, + + /** + * Reference to the application streaming to this configuration. + * + * Only available if [status] is [EntertainmentStatus.Active]. + * Expected value is a ResourceIdentifier of type auth_v1 (an application ID). + */ + @SerialName("active_streamer") + val activeStreamer: ResourceReference? = null, + + /** + * Stream proxy configuration for this entertainment group. + */ + @SerialName("stream_proxy") + val streamProxy: StreamProxy, + + /** + * Channels in the entertainment configuration. + * + * Each channel groups segments of one or different lights. + */ + val channels: List, + + /** + * Entertainment service locations for lights in the zone. + */ + val locations: EntertainmentLocations, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfigurationAction.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfigurationAction.kt new file mode 100644 index 00000000..3a75a0d3 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfigurationAction.kt @@ -0,0 +1,30 @@ +package inkapplications.shade.entertainment.structures + +import kotlinx.serialization.Serializable +import kotlin.jvm.JvmInline + +/** + * Action that can be taken on an entertainment configuration to control streaming. + * + * If status is "inactive" -> write start to start streaming. + * Writing start when it's already active does not change the ownership of the streaming. + * If status is "active" -> write "stop" to end the current streaming. + * In order to start streaming when other application is already streaming, first write "stop" and then "start". + */ +@JvmInline +@Serializable +value class EntertainmentConfigurationAction(val key: String) { + override fun toString(): String = key + + companion object { + /** + * Start the entertainment stream. + */ + val Start = EntertainmentConfigurationAction("start") + + /** + * Stop the entertainment stream. + */ + val Stop = EntertainmentConfigurationAction("stop") + } +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata.kt new file mode 100644 index 00000000..2dc983d4 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfigurationMetadata.kt @@ -0,0 +1,14 @@ +package inkapplications.shade.entertainment.structures + +import kotlinx.serialization.Serializable + +/** + * Metadata for an entertainment configuration. + */ +@Serializable +data class EntertainmentConfigurationMetadata( + /** + * Friendly name of the entertainment configuration. + */ + val name: String, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfigurationType.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfigurationType.kt new file mode 100644 index 00000000..c43b6746 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentConfigurationType.kt @@ -0,0 +1,40 @@ +package inkapplications.shade.entertainment.structures + +import kotlinx.serialization.Serializable +import kotlin.jvm.JvmInline + +/** + * Defines for which type of application an entertainment configuration channel assignment was optimized for. + */ +@JvmInline +@Serializable +value class EntertainmentConfigurationType(val key: String) { + override fun toString(): String = key + + companion object { + /** + * Channels are organized around content from a screen. + */ + val Screen = EntertainmentConfigurationType("screen") + + /** + * Channels are organized around content from one or several monitors. + */ + val Monitor = EntertainmentConfigurationType("monitor") + + /** + * Channels are organized for music synchronization. + */ + val Music = EntertainmentConfigurationType("music") + + /** + * Channels are organized to provide 3D spatial effects. + */ + val ThreeDSpace = EntertainmentConfigurationType("3dspace") + + /** + * General use case. + */ + val Other = EntertainmentConfigurationType("other") + } +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentLocations.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentLocations.kt new file mode 100644 index 00000000..267095a4 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentLocations.kt @@ -0,0 +1,16 @@ +package inkapplications.shade.entertainment.structures + +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * Locations of entertainment services within an entertainment configuration. + */ +@Serializable +data class EntertainmentLocations( + /** + * List of service locations for lights in the entertainment zone. + */ + @SerialName("service_locations") + val serviceLocations: List, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentStatus.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentStatus.kt new file mode 100644 index 00000000..cc2889f8 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/EntertainmentStatus.kt @@ -0,0 +1,25 @@ +package inkapplications.shade.entertainment.structures + +import kotlinx.serialization.Serializable +import kotlin.jvm.JvmInline + +/** + * Reports if an entertainment stream is active or not. + */ +@JvmInline +@Serializable +value class EntertainmentStatus(val key: String) { + override fun toString(): String = key + + companion object { + /** + * The entertainment stream is currently active. + */ + val Active = EntertainmentStatus("active") + + /** + * The entertainment stream is currently inactive. + */ + val Inactive = EntertainmentStatus("inactive") + } +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/SegmentRangeSerializer.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/SegmentRangeSerializer.kt new file mode 100644 index 00000000..835b5624 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/SegmentRangeSerializer.kt @@ -0,0 +1,37 @@ +package inkapplications.shade.entertainment.structures + +import kotlinx.serialization.KSerializer +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable +import kotlinx.serialization.descriptors.SerialDescriptor +import kotlinx.serialization.encoding.Decoder +import kotlinx.serialization.encoding.Encoder + +/** + * Serialize Hue's segment object to/from an int range. + */ +internal object SegmentRangeSerializer: KSerializer { + override val descriptor: SerialDescriptor = SegmentSurrogate.serializer().descriptor + + override fun serialize(encoder: Encoder, value: IntRange) { + val surrogate = SegmentSurrogate( + start = value.first, + length = value.count() + ) + SegmentSurrogate.serializer().serialize(encoder, surrogate) + } + + override fun deserialize(decoder: Decoder): IntRange { + val surrogate = SegmentSurrogate.serializer().deserialize(decoder) + return surrogate.toIntRange() + } + + @Serializable + @SerialName("Segment") + private data class SegmentSurrogate( + val start: Int, + val length: Int, + ) { + fun toIntRange(): IntRange = start until (start + length) + } +} diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/SegmentReference.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/SegmentReference.kt new file mode 100644 index 00000000..56fb542a --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/SegmentReference.kt @@ -0,0 +1,20 @@ +package inkapplications.shade.entertainment.structures + +import inkapplications.shade.structures.ResourceReference +import kotlinx.serialization.Serializable + +/** + * Reference to a segment that is a member of an entertainment channel. + */ +@Serializable +data class SegmentReference( + /** + * Reference to the entertainment service containing the segment. + */ + val service: ResourceReference, + + /** + * Index of the segment within the entertainment service. + */ + val index: Int, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/Segments.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/Segments.kt new file mode 100644 index 00000000..50514477 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/Segments.kt @@ -0,0 +1,32 @@ +package inkapplications.shade.entertainment.structures + +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * Holds all parameters concerning the segmentation capabilities of a device. + * + * Segmentation allows a device to be divided into multiple independently + * controllable sections for entertainment purposes. + */ +@Serializable +data class Segments( + /** + * Defines if the segmentation of the device is configurable or not. + */ + val configurable: Boolean, + + /** + * Maximum number of segments the device supports. + */ + @SerialName("max_segments") + val maxSegments: Int, + + /** + * Contains the segments configuration of the device for entertainment purposes. + * + * A device can be segmented in a single way. + */ + @SerialName("segments") + val segmentRanges: List<@Serializable(with = SegmentRangeSerializer::class) IntRange>, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/ServiceLocation.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/ServiceLocation.kt new file mode 100644 index 00000000..2ff9fd91 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/ServiceLocation.kt @@ -0,0 +1,33 @@ +package inkapplications.shade.entertainment.structures + +import inkapplications.shade.structures.Position +import inkapplications.shade.structures.ResourceReference +import kotlinx.serialization.SerialName +import kotlinx.serialization.Serializable + +/** + * Location information for an entertainment service within a configuration. + */ +@Serializable +data class ServiceLocation( + /** + * Reference to the entertainment service. + */ + val service: ResourceReference, + + /** + * Describes the location(s) of the service. + * + * Can contain 1-2 positions. + */ + val positions: List, + + /** + * Relative equalization factor applied to the entertainment service. + * + * This compensates for differences in brightness in the entertainment configuration. + * Value cannot be 0; writing 0 changes it to the lowest possible value. + */ + @SerialName("equalization_factor") + val equalizationFactor: Double, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/StreamProxy.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/StreamProxy.kt new file mode 100644 index 00000000..789eb418 --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/StreamProxy.kt @@ -0,0 +1,27 @@ +package inkapplications.shade.entertainment.structures + +import inkapplications.shade.structures.ResourceReference +import kotlinx.serialization.Serializable + +/** + * Stream proxy configuration for an entertainment configuration. + * + * The proxy node relays entertainment traffic and should be located in or + * close to all entertainment lamps in the group. + */ +@Serializable +data class StreamProxy( + /** + * Proxy mode used for this group. + */ + val mode: StreamProxyMode, + + /** + * Reference to the device acting as proxy. + * + * The proxy node set by the application (manual) or selected by the bridge (auto). + * Writing this property sets the proxy mode to "manual". + * Can be a BridgeDevice or ZigbeeDevice type. + */ + val node: ResourceReference, +) diff --git a/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/StreamProxyMode.kt b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/StreamProxyMode.kt new file mode 100644 index 00000000..751ea5cb --- /dev/null +++ b/entertainment/src/commonMain/kotlin/inkapplications/shade/entertainment/structures/StreamProxyMode.kt @@ -0,0 +1,25 @@ +package inkapplications.shade.entertainment.structures + +import kotlinx.serialization.Serializable +import kotlin.jvm.JvmInline + +/** + * Proxy mode used for an entertainment configuration group. + */ +@JvmInline +@Serializable +value class StreamProxyMode(val key: String) { + override fun toString(): String = key + + companion object { + /** + * The bridge will select a proxy node automatically. + */ + val Auto = StreamProxyMode("auto") + + /** + * The proxy node has been set manually. + */ + val Manual = StreamProxyMode("manual") + } +} diff --git a/settings.gradle.kts b/settings.gradle.kts index d13c069e..6771fb1b 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -7,6 +7,7 @@ include("cli") include("core") include("devices") include("discover") +include("entertainment") include("events") include("grouped-lights") include("homekit") diff --git a/structures/api/structures.api b/structures/api/structures.api index b05a64f9..7cc39ba3 100644 --- a/structures/api/structures.api +++ b/structures/api/structures.api @@ -134,6 +134,37 @@ public final class inkapplications/shade/structures/NetworkException : inkapplic public fun (Ljava/lang/String;Ljava/lang/Throwable;)V } +public final class inkapplications/shade/structures/Position { + public static final field Companion Linkapplications/shade/structures/Position$Companion; + public fun (DDD)V + public final fun component1 ()D + public final fun component2 ()D + public final fun component3 ()D + public final fun copy (DDD)Linkapplications/shade/structures/Position; + public static synthetic fun copy$default (Linkapplications/shade/structures/Position;DDDILjava/lang/Object;)Linkapplications/shade/structures/Position; + public fun equals (Ljava/lang/Object;)Z + public final fun getX ()D + public final fun getY ()D + public final fun getZ ()D + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final synthetic class inkapplications/shade/structures/Position$$serializer : kotlinx/serialization/internal/GeneratedSerializer { + public static final field INSTANCE Linkapplications/shade/structures/Position$$serializer; + public final fun childSerializers ()[Lkotlinx/serialization/KSerializer; + public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Linkapplications/shade/structures/Position; + public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object; + public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor; + public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Linkapplications/shade/structures/Position;)V + public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V + public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer; +} + +public final class inkapplications/shade/structures/Position$Companion { + public final fun serializer ()Lkotlinx/serialization/KSerializer; +} + public final class inkapplications/shade/structures/PowerInfo { public static final field Companion Linkapplications/shade/structures/PowerInfo$Companion; public fun (Z)V diff --git a/structures/src/commonMain/kotlin/inkapplications/shade/structures/Position.kt b/structures/src/commonMain/kotlin/inkapplications/shade/structures/Position.kt new file mode 100644 index 00000000..b47b7e81 --- /dev/null +++ b/structures/src/commonMain/kotlin/inkapplications/shade/structures/Position.kt @@ -0,0 +1,24 @@ +package inkapplications.shade.structures + +import kotlinx.serialization.Serializable + +/** + * XYZ position coordinates. + */ +@Serializable +data class Position( + /** + * X coordinate of the position. + */ + val x: Double, + + /** + * Y coordinate of the position. + */ + val y: Double, + + /** + * Z coordinate of the position. + */ + val z: Double, +)