Difference between revisions of "Welcome"

From MSX - Wiki
Jump to navigation Jump to search
 
(69 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
'''Welcome to Media Station X - Wiki'''
+
<big>'''Welcome to Media Station X - Wiki'''</big>
  
−
These wiki pages were created as an alternative to the Media Station X info and experts pages to provide a better and more structured view of the entire API.
+
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.
  
−
== Start API ==
+
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 the main API before using the experts one.'''
 +
 
 +
== 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.
 
The start object is used to setup the start parameter. The start parameter specifies which menu or content is loaded at startup.
 
* [[Start Object]]
 
* [[Start Object]]
Line 9: Line 14:
 
* [[Setup Start Parameter]]
 
* [[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 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]]
 
* [[Menu Root Object]]
Line 15: Line 20:
 
* [[Menu Examples]]
 
* [[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 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]]
 
* [[Content Root Object]]
Line 21: Line 26:
 
* [[Content Item Object]]
 
* [[Content Item Object]]
 
* [[Content Examples]]
 
* [[Content Examples]]
 +
* [[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.
+
The common API is used in menu and content objects. It consists of requests, responses, colors, icons, inline expressions, and actions.
 +
* [[Requests]]
 
* [[Responses]]
 
* [[Responses]]
 
* [[Colors]]
 
* [[Colors]]
Line 30: Line 37:
 
* [[Actions]]
 
* [[Actions]]
  
−
== Special API ==
+
=== Extended API ===
−
The special API describes the integration of YouTube, Vimeo & Co. and the conversion of M3U/PLS files. Additionally, it describes the extended properties, the dictionary structure, and more.
+
The extended API describes the integration of YouTube, Vimeo & Co., the conversion of M3U/PLS files, and the loading of MRSS feeds.
 
* [[YouTube, Vimeo & Co.]]
 
* [[YouTube, Vimeo & Co.]]
 +
* [[M3U/PLS Files]]
 +
* [[MRSS Feeds]]
 +
 +
== 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, the dictionary structure, the Tizen player, the NetCast menu, and the Android player.
 +
* [[Internal Actions]]
 +
* [[URL Parameters]]
 +
* [[Extended Properties]]
 +
* [[Attached Data Examples]]
 +
* [[Dictionary Structure]]
 +
* [[Tizen Player]]
 +
* [[NetCast Menu]]
 +
* [[Android Player]]
 +
 +
=== 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]]
 +
* [[Live Inline Expressions]]
 +
* [[Live Examples]]
 +
 +
=== 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 ===
 +
The plugin API can be used to create your own video/audio or interaction plugin.
 +
* [[Video/Audio Plugin]]
 +
* [[Interaction Plugin]]
 +
* [[Image Plugin]]
 +
* [[HTML5X Plugin]]
 +
* [[Panorama Plugin]]
 +
* [[Background Plugin]]
 +
* [[Backdrop Plugin]]
 +
* [[Ad Plugin]]
 +
* [[Android Plugin]]
 +
* [[Play Plugin]]
 +
* [[IMA Plugin]]
 +
* [[Paging Plugin]]
 +
* [[Input Plugin]]
 +
* [[Plugin API Reference]]
 +
 +
=== 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]]
 +
* [[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]]
 +
* [[Resolve Action]]
 +
* [[Option Shortcut]]
 +
* [[Replace Action]]
 +
* [[Image Options]]
 +
* [[Advanced Text & Image]]
 +
* [[Keep Ratio Keyword]]
 +
* [[Advanced Templated Items]]
 +
 +
=== Benchmark Tests ===
 +
Benchmark tests have been developed to check the performance and capabilities of a TV device.
 +
* [[Renderer Plugin]]
 +
* [[Drawing Plugin]]
 +
* [[Particles Plugin]]
  
 
== Related Links ==
 
== Related Links ==
−
* [https://msx.benzac.de/info/ Media Station X - Info]
+
* Media Station X - App: https://msx.benzac.de/
−
* [https://msx.benzac.de/info/xp/ Media Station X - Experts]
+
* Media Station X - Info: https://msx.benzac.de/info/
 +
* Media Station X - Icons: https://msx.benzac.de/info/icons.html
 +
* Media Station X - Actions: https://msx.benzac.de/info/xp/actions.html
 +
* Media Station X - M3U: https://msx.benzac.de/info/m3u.html
 +
* Media Station X - MRSS: https://msx.benzac.de/info/mrss.html
 +
* YouTube Channel: https://www.youtube.com/channel/UCblvVW1ZvYWBU4amsaT58vg
 +
* Facebook Group: https://www.facebook.com/Media-Station-X-2311938729026920
 +
* GitHub Projects: https://github.com/benzac-de
 +
* Support: https://www.buymeacoffee.com/benzac

Latest revision as of 16:11, 26 March 2024

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 the main API before using the experts one.

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 requests, responses, colors, icons, inline expressions, and actions.

Extended API[edit]

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

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, the dictionary structure, the Tizen player, the NetCast menu, and the Android player.

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 and capabilities of a TV device.

Related Links[edit]

Retrieved from "https://msx.benzac.de/wiki/index.php?title=Welcome&oldid=3426"