Rails responses – instances

Overview

This page explains the fields and values for the pre-defined blueprint and key/value pair group instances and shows their expected/typical appearance.

Blueprint instances

Standard strip instances

Standard 2:3

Appearance	Key	Values
	`type`	`standard_strip`
	`layout_style`	`standard`
	`tile_pattern`	`["2x3"]`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Standard 2:3 & 4:3

Appearance	Key	Values
	`type`	`standard_strip`
	`layout_style`	`standard`
	`tile_pattern`	`["2x3","4x3"]`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Standard 16:9

Appearance	Key	Values
	`type`	`standard_strip`
	`layout_style`	`standard`
	`tile_pattern`	`["16x9"]`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Standard 4:3

Appearance	Key	Values
	`type`	`standard_strip`
	`layout_style`	`standard`
	`tile_pattern`	`["4x3"]`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Magazine strip instances

Hero Magazine 1 (2:3 Hero / 4:3 Dual Row)

Appearance	Key	Values
	`type`	`magazine_strip`
	`layout_style`	`dual_row_hero_grid`
	`grid_tile_pattern`	`["4x3"]`
	`grid_tile_pattern_invert`	`false`
	`hero_tile_aspect_ratio`	`"2x3"`
	`hero_tile_repeat`	`true`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Hero Magazine 2 (2:3 Hero / Alternating 4:3 & 16:9 Dual Row)

Appearance	Key	Values
	`type`	`magazine_strip`
	`layout_style`	`dual_row_hero_grid`
	`grid_tile_pattern`	`["4x3","16x9"]`
	`grid_tile_pattern_invert`	`true`
	`hero_tile_aspect_ratio`	`"2x3"`
	`hero_tile_repeat`	`true`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Hero Magazine 3 (4:3 & 16:9 Dual Row / 2:3 Hero)

Appearance	Key	Values
	`type`	`magazine_strip`
	`layout_style`	`dual_row_grid_hero`
	`grid_tile_pattern`	`["4x3","16x9"]`
	`grid_tile_pattern_invert`	`false`
	`hero_tile_aspect_ratio`	`"2x3"`
	`hero_tile_repeat`	`true`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Large Poster Magazine (2:3 single row)

Appearance	Key	Values
	`type`	`magazine_strip`
	`layout_style`	`single_row_grid`
	`grid_tile_pattern`	`["2x3"]`
	`grid_tile_pattern_invert`	`false`
	`hero_tile_aspect_ratio`	`"default"`
	`hero_tile_repeat`	`false`
	`show_more`	`false`
	`max_pages`	`0`
	`visible`	`true`

Promotional strip instances

Single Promotion 3:1 Dual Height Row

Appearance	Key	Values
	`type`	`promotional_strip`
	`layout_style`	`dual_height`
	`tile_pattern`	`["3x1"]`
	`visible`	`true`
	`carousel`	`false`

Single Promotion 4:1 Dual Height Row

Appearance	Key	Values
	`type`	`promotional_strip`
	`layout_style`	`dual_height`
	`tile_pattern`	`["4x1"]`
	`visible`	`true`
	`carousel`	`false`

Double Promotion 3:1 Dual Height Row

Appearance	Key	Values
	`type`	`promotional_strip`
	`layout_style`	`dual_height`
	`tile_pattern`	`["3x1","3x1"]`
	`visible`	`true`
	`carousel`	`false`

Double Promotion 4:1 Dual Height Row

Appearance	Key	Values
	`type`	`promotional_strip`
	`layout_style`	`dual_height`
	`tile_pattern`	`["4x1","4x1"]`
	`visible`	`true`
	`carousel`	`false`

Triple Promotion 3:1 Dual Height Row

Appearance	Key	Values
	`type`	`promotional_strip`
	`layout_style`	`double_height`
	`tile_pattern`	`["3x1","3x1","3x1"]`
	`visible`	`true`
	`carousel`	`false`

Triple Promotion 4:1 Dual Height Row

Appearance	Key	Values
	`type`	`promotional_strip`
	`layout_style`	`double_height`
	`tile_pattern`	`["4x1","4x1","4x1"]`
	`visible`	`true`
	`carousel`	`false`

Standard Carousel 16:9

Appearance	Key	Values
	`type`	`promotional_strip`
	`layout_style`	`single_height`
	`tile_pattern`	`["16x9"]`
	`visible`	`true`
	`carousel`	`true`

Showcase Carousel 3:1

Appearance	Key	Values
	`type`	`promotional_strip`
	`layout_style`	`single_height`
	`tile_pattern`	`["3x1"]`
	`visible`	`true`
	`carousel`	`true`

Ultra Showcase Carousel 4:1

Appearance	Key	Values
	`type`	`promotional_strip`
	`layout_style`	`single_height`
	`tile_pattern`	`["4x1"]`
	`visible`	`true`
	`carousel`	`true`

Custom component instances

No pre-defined custom component instances are defined.

Key/value pair group instances

Client-side processing

Now&Next

This KVP group instance is intended to be added to a rail to signify that it requires special handling for Now & Next EPG events.

Key	Values
`type`	`clientside`
`client_context`	`["now&next"]`

Channels

This KVP group instance is intended to be added to a rail to signify that it requires special handling for live channels.

Note: this is not the same as channels that are provided by the Android Channels API (below).

Key	Values
`type`	`clientside`
`client_context`	`["channels"]`

Android Channels API

This KVP group instance is intended to be added to a rail to signify that it requires special handling for live channels provided by the Android Channels API.

Key	Values
`type`	`clientside`
`stb_androidtv_package_id`