Metadata Overview#
The PED SDK offers a Metadata service that enables users to retrieve a media library categorized by media type and detailed metadata. This service provides access to a variety of media content, including movies, TV shows, audio, eBooks, and games available on the aircraft and on the ground.
Media content is tailored based on flight routes, dates, and seat classes. Each media item is assigned specific parameters, ensuring it is visible only to passengers matching those criteria. For route-based media, the content is categorized by flight routes, while data-based media leverages different media sets for specific time periods, a process known as media preloading.
The Metadata service provides two main functionalities, each catering to different scenarios of passenger engagement with media content:
-
Ground Metadata(Pre-Flight & Post-Flight)
-
Description: This service allows passengers to browse media content available on the ground server when connected to it. It displays the complete media library that is accessible on the ground.
-
Ground Media is typically based on the selected flight information, such as route or travel date. The available media content will change according to the current travel date. If the media is route-based, the media list will vary depending on the selected route.
-
Use Case: Passengers waiting at the airport can preview the list of available media options before boarding, helping them decide what to watch or listen to during the flight.
-
Metadata(In-Flight)
-
Description: This service enables passengers to browse media content available in the aircraft during flight (air mode). It fetches metadata for all onboard media.
-
Use Case: Passengers can explore the onboard media library, categorized by type, and play their selected content on their seatback screens.
The diagram above illustrates the basic structure of metadata, which may differ based on the specific configuration set by each airline.
1. Browsing Categories#
1.1. Get a List of All Categories#
The Metadata service provides an API to retrieve a list of all available categories, such as Movies, TV Shows, Music, Games, and more. These categories help developers structure the media library for easy navigation and user interaction.
Example Use Case:
A passenger uses the in-flight entertainment system to explore available content. The Movies category displays a broad selection, helping the passenger quickly choose the type of media they want to view.
1.2. Get Subcategories for a Specific Root Category#
This API retrieves subcategories for a specific root category, such as Movies. Subcategories like New Releases, Hollywood, or Classics are organized hierarchically, making it easier to manage and display media content dynamically. To define a particular root category for the media database, please contact Panasonic Focal for further assistance and configuration details.
Example Use Case:
Passengers browsing the Movies section can see organized subcategories, such as New Releases for the latest films or Action for high-energy content, enabling them to find what they want without scrolling through unrelated items.
2. Retrieving Media Lists#
2.1. Get Media List by Category#
The API provides a list of media items organized under specific categories or subcategories. Each media item includes basic details, such as a unique identifier (media URI) that can be used to retrieve detailed metadata.
Example Use Case:
A passenger browsing the "Romantic Movies" subcategory can see a list of available titles. Each title includes an image, summary, or other basic details that guide the passenger’s selection.
3. Viewing Media Details#
3.1. Get Detailed Media Information#
The API fetches detailed information for a specific media item using its unique identifier (media URI). The metadata includes a synopsis, duration, cast, genre, available subtitles, soundtrack options, and more.
Example Use Case:
Before selecting a movie, a passenger can view its description, cast, and runtime to ensure it matches their preferences. For TV shows, they can check the episode list, and for music albums, they can review the tracklist before playing a song.
4. Searching for Media#
4.1. Search Metadata Using Text#
This API enables developers to implement a search feature that looks across multiple metadata fields, such as title, genre, year, cast, or director. Additional filters, such as content type (e.g., movies, music) or seat class (e.g., Economy, Premium), can be applied to refine search results.
Example Use Case:
A passenger searches for "Inception" in the entertainment system. The API ensures the search result shows the movie regardless of whether the passenger searched by title or director (Christopher Nolan). If the passenger is in Economy Class, the results are tailored to the content available for their seat class.
4.2. Search Metadata Using Fields#
Developers can configure the API to allow field-based search operations, such as filtering by director, genre, or release year. The API supports combining multiple fields for more refined search results.
Example Use Case:
A passenger is interested in action movies directed by "Christopher Nolan" and released in "2010." The API can return specific results matching both criteria, helping the passenger quickly locate relevant options.
5. Caching Mechanism in Metadata Requests#
For all Metadata requests, the SDK uses cached responses instead of making a new request when the same data is queried again. This caching mechanism helps in:
-
Faster Load Times – Since the data is fetched from the cache instead of the network, passengers experience quicker navigation when browsing media.
-
Reduced Network Usage – Avoids redundant API calls, which helps maintain smooth performance, especially in limited connectivity environments.
-
Seamless User Experience – Enhances browsing by ensuring that previously loaded media lists, categories, and metadata remain instantly accessible, minimizing delays.
Passenger can quickly resume browsing their media library without waiting for repeated data loads, making the experience more efficient and enjoyable.
Content Identification and Management#
In order to manage media content effectively, whether for playback, bookmarking, it is essential to understand how each piece of content is uniquely identified in the system.
Media URI as Unique Identifier#
Each media item (e.g., a movie or TV episode) is assigned a unique identifier known as the Media URI. This Media URI remains stable across content update cycles, allowing developers to reliably track and reference content. Use the Media URI in all scenarios where content needs to be identified or stored (e.g., adding to a watchlist, saving playback history, etc.).
Quick Reference:#
-
Unique ID used:
Media URI -
Should developers use this ID: Yes, always use
Media URIto identify and track content. -
Does the ID change between cycles: No — it remains the same as long as the content is not removed.
-
When does it change: Only if the content is removed and later re-added; in that case, a new Media URI will be generated.
-
Recommendation:
-
Always persist content using the Media URI.
-
If a Media URI is no longer found, assume the content was removed or replaced and update your records accordingly.
By following this approach, developers can ensure consistent and stable content handling across app sessions and content updates.
By implementing Metadata service, developers can build a robust and user-friendly in-flight entertainment system, ensuring passengers can browse, search, and explore media content effortlessly, enhancing their overall experience.
Version 1.0
