ContentLauncherTrait.ParameterEnum
enum ContentLauncherTrait.ParameterEnum : Enum, ClusterEnum
Content data elements that may be searched on.
Summary
Enum Values |
|
|---|---|
Actor |
An actor credited in video media content. |
Any |
|
Channel |
The identifying data for a television channel, for example, 'PBS'. |
Character |
A character represented in video media content. |
Director |
A director of the video media content. |
Episode |
|
Event |
An event is a reference to a type of event. |
Franchise |
A video entity which can represent a number of video entities, like movies or TV shows. |
Genre |
The genre of video media content such as action, drama or comedy. |
League |
The categorical information for a sporting league. |
Popularity |
Indicates whether the user is requesting popular content. |
Provider |
The media provider that the user wants this media to be played on. |
Season |
|
Sport |
The categorical information of a sport, for example, football. |
SportsTeam |
The categorical information of a professional sports team. |
Type |
The type of content requested. |
UnknownValue |
The enum value is out of range. |
Video |
The identifying data for a specific piece of video content. |
Public functions |
|
|---|---|
ContentLauncherTrait.ParameterEnum |
Returns the enum constant of this type with the specified name. |
Array<ContentLauncherTrait.ParameterEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Actor
val ContentLauncherTrait.ParameterEnum.Actor: ContentLauncherTrait.ParameterEnum
An actor credited in video media content.
Channel
val ContentLauncherTrait.ParameterEnum.Channel: ContentLauncherTrait.ParameterEnum
The identifying data for a television channel, for example, 'PBS'.
Character
val ContentLauncherTrait.ParameterEnum.Character: ContentLauncherTrait.ParameterEnum
A character represented in video media content.
Director
val ContentLauncherTrait.ParameterEnum.Director: ContentLauncherTrait.ParameterEnum
A director of the video media content.
Event
val ContentLauncherTrait.ParameterEnum.Event: ContentLauncherTrait.ParameterEnum
An event is a reference to a type of event. Examples include sports, music, or other types of events. For example, searching for 'Football games' would search for a 'game' event entity and a 'football' sport entity.
Franchise
val ContentLauncherTrait.ParameterEnum.Franchise: ContentLauncherTrait.ParameterEnum
A video entity which can represent a number of video entities, like movies or TV shows. For example, the fictional franchise 'Intergalactic Wars', which represents a collection of movie trilogies, as well as animated and live action TV shows. This entity can account for requests such as 'Find Intergalactic Wars movies', which would search for all 'Intergalactic Wars' programs of the Movie MediaType, rather than attempting to match to a single title.
Genre
val ContentLauncherTrait.ParameterEnum.Genre: ContentLauncherTrait.ParameterEnum
The genre of video media content such as action, drama or comedy.
League
val ContentLauncherTrait.ParameterEnum.League: ContentLauncherTrait.ParameterEnum
The categorical information for a sporting league.
Popularity
val ContentLauncherTrait.ParameterEnum.Popularity: ContentLauncherTrait.ParameterEnum
Indicates whether the user is requesting popular content.
Provider
val ContentLauncherTrait.ParameterEnum.Provider: ContentLauncherTrait.ParameterEnum
The media provider that the user wants this media to be played on.
Sport
val ContentLauncherTrait.ParameterEnum.Sport: ContentLauncherTrait.ParameterEnum
The categorical information of a sport, for example, football.
SportsTeam
val ContentLauncherTrait.ParameterEnum.SportsTeam: ContentLauncherTrait.ParameterEnum
The categorical information of a professional sports team.
Type
val ContentLauncherTrait.ParameterEnum.Type: ContentLauncherTrait.ParameterEnum
The type of content requested. Supported types are Movie, MovieSeries, TVSeries, TVSeason, TVEpisode, SportsEvent, and Video.
UnknownValue
val ContentLauncherTrait.ParameterEnum.UnknownValue: ContentLauncherTrait.ParameterEnum
The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.
Video
val ContentLauncherTrait.ParameterEnum.Video: ContentLauncherTrait.ParameterEnum
The identifying data for a specific piece of video content.
Public functions
valueOf
fun valueOf(value: String): ContentLauncherTrait.ParameterEnum
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<ContentLauncherTrait.ParameterEnum>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.