Difference between revisions of "Welcome"
| Line 5: | Line 5: | ||
For more information about the Media Station X project, please visit: https://msx.benzac.de/info/. | For more information about the Media Station X project, please visit: https://msx.benzac.de/info/. | ||
| − | '''Note: The API sections that are marked with (XP) are designed for experts who have well experiences with the main API (i.e. the API sections that not are marked with (XP)). If you are new to Media Station X, please familiarize yourself with main API before using the experts API.''' | + | '''Note: The API sections that are marked with <sup>(XP)</sup> are designed for experts who have well experiences with the main API (i.e. the API sections that not are marked with <sup>(XP)</sup>). If you are new to Media Station X, please familiarize yourself with main API before using the experts API.''' |
== Start API == | == Start API == | ||
| Line 39: | Line 39: | ||
* [[M3U/PLS Files]] | * [[M3U/PLS Files]] | ||
| − | == Special API (XP) == | + | == Special API <sup>(XP)</sup> == |
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. | 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]] | * [[Internal Actions]] | ||
| Line 47: | Line 47: | ||
* [[Dictionary Structure]] | * [[Dictionary Structure]] | ||
| − | == Live API (XP) == | + | == Live API <sup>(XP)</sup> == |
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). | 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]] | * [[Live Object]] | ||
| Line 53: | Line 53: | ||
* [[Live Examples]] | * [[Live Examples]] | ||
| − | == Selection API (XP) == | + | == Selection API <sup>(XP)</sup> == |
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). | 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 Object]] | ||
* [[Selection Examples]] | * [[Selection Examples]] | ||
| − | == Plugin API (XP) == | + | == Plugin API <sup>(XP)</sup> == |
The plugin API can be used to create your own video/audio or interaction plugin. | The plugin API can be used to create your own video/audio or interaction plugin. | ||
* [[Video/Audio Plugin]] | * [[Video/Audio Plugin]] | ||
| Line 66: | Line 66: | ||
* [[Plugin API Reference]] | * [[Plugin API Reference]] | ||
| − | == Hidden Features (XP) == | + | == Hidden Features <sup>(XP)</sup> == |
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). | 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]] | * [[Start Action]] | ||
| Line 81: | Line 81: | ||
* [[Compress Property]] | * [[Compress Property]] | ||
| − | == Benchmark Tests (XP) == | + | == Benchmark Tests <sup>(XP)</sup> == |
Benchmark tests have been developed to check the performance of different TV devices. | Benchmark tests have been developed to check the performance of different TV devices. | ||
* [[Renderer]] | * [[Renderer]] | ||
* [[Drawing]] | * [[Drawing]] | ||
* [[Particles]] | * [[Particles]] | ||
Revision as of 11:37, 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 API sections that are marked with (XP) are designed for experts who have well experiences with the main API (i.e. the API sections that not are marked with (XP)). If you are new to Media Station X, please familiarize yourself with main API before using the experts API.
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.
Special API (XP)[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 (XP)[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 (XP)[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 (XP)[edit]
The plugin API can be used to create your own video/audio or interaction plugin.
Hidden Features (XP)[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).
- Start Action
- Settings Menu Item
- Execute Property
- Focus Separator
- Hide Images
- Number Inline Expressions
- Color Inline Expressions
- Key Property
- Large Offsets
- Page Action
- Dictionary Inline Expressions
- Compress Property
Benchmark Tests (XP)[edit]
Benchmark tests have been developed to check the performance of different TV devices.