Difference between revisions of "Welcome"

Revision as of 12:07, 29 January 2021

Welcome to Media Station X - Wiki

These wiki pages contain all information about the various JSON structures with examples and screenshots as well as descriptions and source code examples of the different plugin possibilities. In other words, everything you want to know about the Media Station X API can be found here.

For more information about the Media Station X project, please visit: https://msx.benzac.de/info/.

Note: The Experts API are designed for experts who have well experiences with the Main API. If you are new to Media Station X, please familiarize yourself with Main API before using the Experts API.

Main API[edit]

Start API[edit]

The start object is used to setup the start parameter. The start parameter specifies which menu or content is loaded at startup.

Menu API[edit]

Menu objects are used to group different content objects. They are displayed as lists (vertical direction) on the left side of the screen.

Content API[edit]

Content objects are used to display content items on a grid. They can be displayed as pages (horizontal direction) or lists (vertical direction).

Common API[edit]

The common API is used in menu and content objects. It consists of responses, colors, icons, inline expressions, and actions.

Extended API[edit]

The extended API describes the integration of YouTube, Vimeo & Co. and the conversion of M3U/PLS files.

Experts API[edit]

Special API[edit]

The special API can be used for special use cases. It consists of internal actions, URL parameters, extended properties, attached data examples, and the dictionary structure.

Live API[edit]

The live API can be used to periodically update content items (e.g. with live data, playback progress, etc.). It also describes the live inline expressions that are also used in other properties (e.g. in the extension property).

Selection API[edit]

The selection API can be used to specify the behavior of a content item if it is selected (i.e. if it has the focus).

Plugin API[edit]

The plugin API can be used to create your own video/audio or interaction plugin.

Hidden Features[edit]

Hidden features are used in menu and content objects and can be used for special use cases. They are called "hidden" because they were not intended to be official features (to keep the menu and content API clear and compact).

Benchmark Tests[edit]

Benchmark tests have been developed to check the performance of different TV devices.

@@ Line 5: / Line 5: @@
 For more information about the Media Station X project, please visit: https://msx.benzac.de/info/.
-'''Note: The API sections that are marked with <sup><small>XP</small></sup> are designed for experts who have well experiences with the main API (i.e. the API sections that are not marked with <sup><small>XP</small></sup>). If you are new to Media Station X, please familiarize yourself with main API before using the experts API.'''
+'''Note: The Experts API are designed for experts who have well experiences with the Main API. If you are new to Media Station X, please familiarize yourself with Main API before using the Experts API.'''
-== Start API ==
+== Main API ==
+=== Start API ===
 The start object is used to setup the start parameter. The start parameter specifies which menu or content is loaded at startup.
 * [[Start Object]]
@@ Line 13: / Line 14: @@
 * [[Setup Start Parameter]]
-== Menu API ==
+=== Menu API ===
 Menu objects are used to group different content objects. They are displayed as lists (vertical direction) on the left side of the screen.
 * [[Menu Root Object]]
@@ Line 19: / Line 20: @@
 * [[Menu Examples]]
-== Content API ==
+=== Content API ===
 Content objects are used to display content items on a grid. They can be displayed as pages (horizontal direction) or lists (vertical direction).
 * [[Content Root Object]]
@@ Line 27: / Line 28: @@
 * [[Content Guide]]
-== Common API ==
+=== Common API ===
 The common API is used in menu and content objects. It consists of responses, colors, icons, inline expressions, and actions.
 * [[Responses]]
@@ Line 35: / Line 36: @@
 * [[Actions]]
-== Extended API ==
+=== Extended API ===
 The extended API describes the integration of YouTube, Vimeo & Co. and the conversion of M3U/PLS files.
 * [[YouTube, Vimeo & Co.]]
 * [[M3U/PLS Files]]
-== Special API <sup><small>XP</small></sup> ==
+== Experts API ==
+=== Special API ===
 The special API can be used for special use cases. It consists of internal actions, URL parameters, extended properties, attached data examples, and the dictionary structure.
 * [[Internal Actions]]
@@ Line 48: / Line 50: @@
 * [[Dictionary Structure]]
-== Live API <sup><small>XP</small></sup> ==
+=== Live API ===
 The live API can be used to periodically update content items (e.g. with live data, playback progress, etc.). It also describes the live inline expressions that are also used in other properties (e.g. in the <code>extension</code> property).
 * [[Live Object]]
@@ Line 54: / Line 56: @@
 * [[Live Examples]]
-== Selection API <sup><small>XP</small></sup> ==
+=== Selection API ===
 The selection API can be used to specify the behavior of a content item if it is selected (i.e. if it has the focus).
 * [[Selection Object]]
 * [[Selection Examples]]
-== Plugin API <sup><small>XP</small></sup> ==
+=== Plugin API ===
 The plugin API can be used to create your own video/audio or interaction plugin.
 * [[Video/Audio Plugin]]
@@ Line 67: / Line 69: @@
 * [[Plugin API Reference]]
-== Hidden Features <sup><small>XP</small></sup> ==
+=== Hidden Features ===
 Hidden features are used in menu and content objects and can be used for special use cases. They are called "hidden" because they were not intended to be official features (to keep the menu and content API clear and compact).
 * [[Start Action]]
@@ Line 82: / Line 84: @@
 * [[Compress Property]]
-== Benchmark Tests <sup><small>XP</small></sup> ==
+=== Benchmark Tests ===
 Benchmark tests have been developed to check the performance of different TV devices.
 * [[Renderer]]
 * [[Drawing]]
 * [[Particles]]