Developer Console
Sign In
Sign In
Developer Console

Step 2: Recipe Configuration Overview

 II: Configure your Feed

STEP 1:
Load Media Feed
→
STEP 2:
Recipe Config Overview
→
STEP 3:
Set Up the Categories Recipe
→
STEP 4:
Categories Recipe: Query Parameters
→
STEP 5:
Categories Recipe: Matchlist Parameters
→
STEP 6:
Set Up the Contents Recipe
→
STEP 7:
Contents Recipe: Query Parameters
→
STEP 8:
Contents Recipe: Matchlist Parameters
→
STEP 9:
Configure Navigator

After you load the media feed, you need to configure two recipes that Fire App Builder will use to pull the media categories and content from your feed. "Recipes" are JSON files that contain settings (in the form of keys and values) that Fire App Builder uses when building your app. The two recipes you must configure are as follows:

  1. Categories Recipe: Provides different containers to group your media. Due to the complexity of some of the parameters, the instructions are broken out into additional topics:
    1. Categories Recipe: query Parameter
    2. Categories Recipe: matchlist Parameter
  2. Contents Recipe: Maps the properties from your media feed, such as the titles, descriptions, video URLs, and images, to Fire App Builder's content model. Due to the complexity of some of the parameters, the instructions are broken out into additional topics:
    1. Contents Recipe: query Parameter
    2. Contents Recipe: matchlist Parameter

Understanding Categories

If you look at the Home screen with the default Lightcast feed, you'll see that the media is organized in different rows. In the screenshot below, you can see that media is grouped under different categories, including "Jamaican Attractions" and "The Country Jamaica."

Alternative Home screen
Categories providing groupings for media.

Since every media feed usually has a different structure (for example, your feed might use the term "channels" instead of "categories," "img" instead of "image," and so on, as well as different hierarchies and structures) you will need to write some query syntax to target the categories and content in your feed.

If your feed is JSON, you will use Jayway JsonPath syntax to write the queries. If your feed is XML, you will use XPath syntax here to write the queries.

After you query for the categories and content from your query, you then apply a selector to get the category or content text from the results. This selector, called matchList, doesn't use Jayway JsonPath or XPath expressions but rather is custom Fire App Builder syntax.

Customize the Recipe Files

By default, Fire App Builder's sample application files in app > assets > recipes say "LightCast." The essential files for a basic configuration are these three:

  • LightCastCategoriesRecipes.json
  • LightCastContentsRecipe.json
  • LightCastDataLoaderRecipe1.json

Customize these files names for your specific project by duplicating these files (Android Studio lets you copy and paste files in the navigation tree to duplicate them), and then giving the duplicates new names. If your project were named "acmemedia, you might customize these file names as follows:"

  • LightCastCategoriesRecipes.json –> AcmeMediaCategoriesRecipes.json
  • LightCastContentsRecipe.json –> AcmeMediaContentsRecipe.json
  • LightCastDataLoaderRecipe1.json –> AcmeMediaDataLoaderRecipe1.json

To copy a file in Android Studio, either just normal copy and paste commands (Cmd + C and Cmd + V), or right-click the file and select Refactor > Copy.

Note that Fire App Builder comes with some extra files used for demonstration purposes. You can ignore these extra files.

Sample Configurations

For example configurations of common feeds (such as feeds conforming to iTunes or Roku specifications), see the following:

Next Steps

See Set Up the Categories Recipe to start identifying categories in your feed. Fire App Builder will group your media based on these categories.

Last updated: Apr 06, 2017