entertainment/inkapplications.shade.entertainment.structures

Package-level declarations

Types

@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.

EntertainmentChannel

@Serializable

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

A channel in an entertainment configuration.

EntertainmentChannelId

@JvmInline

@Serializable

value class EntertainmentChannelId(val value: Int)

Identifier for an entertainment channel.

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.

EntertainmentConfigurationAction

@JvmInline

@Serializable

value class EntertainmentConfigurationAction(val key: String)

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

EntertainmentConfigurationMetadata

@Serializable

data class EntertainmentConfigurationMetadata(val name: String)

Metadata for an entertainment configuration.

EntertainmentConfigurationType

@JvmInline

@Serializable

value class EntertainmentConfigurationType(val key: String)

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

EntertainmentLocations

@Serializable

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

Locations of entertainment services within an entertainment configuration.

EntertainmentStatus

@JvmInline

@Serializable

value class EntertainmentStatus(val key: String)

Reports if an entertainment stream is active or not.

SegmentReference

@Serializable

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

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

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.

ServiceLocation

@Serializable

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

Location information for an entertainment service within a configuration.

StreamProxy

@Serializable

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

Stream proxy configuration for an entertainment configuration.

StreamProxyMode

@JvmInline

@Serializable

value class StreamProxyMode(val key: String)

Proxy mode used for an entertainment configuration group.