Difference between revisions of "Welcome"

From MSX - Wiki
Jump to navigation Jump to search
 
(25 intermediate revisions by the same user not shown)
Line 29: Line 29:
  
 
=== 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 37: Line 38:
  
 
=== Extended API ===
 
=== Extended API ===
The extended API describes the integration of YouTube, Vimeo & Co. and the conversion of M3U/PLS files.
+
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]]
 
* [[M3U/PLS Files]]
 +
* [[MRSS Feeds]]
  
 
== Experts API ==
 
== Experts API ==
 
=== Special 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.
+
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]]
 
* [[Internal Actions]]
 
* [[URL Parameters]]
 
* [[URL Parameters]]
Line 49: Line 51:
 
* [[Attached Data Examples]]
 
* [[Attached Data Examples]]
 
* [[Dictionary Structure]]
 
* [[Dictionary Structure]]
 +
* [[Tizen Player]]
 +
* [[NetCast Menu]]
 +
* [[Android Player]]
  
 
=== Live API ===
 
=== Live API ===
Line 67: Line 72:
 
* [[Image Plugin]]
 
* [[Image Plugin]]
 
* [[HTML5X Plugin]]
 
* [[HTML5X Plugin]]
 +
* [[Panorama Plugin]]
 +
* [[Background Plugin]]
 +
* [[Backdrop Plugin]]
 +
* [[Ad Plugin]]
 +
* [[Android Plugin]]
 +
* [[Play Plugin]]
 +
* [[IMA Plugin]]
 +
* [[Paging Plugin]]
 +
* [[Input Plugin]]
 
* [[Plugin API Reference]]
 
* [[Plugin API Reference]]
  
Line 83: Line 97:
 
* [[Dictionary Inline Expressions]]
 
* [[Dictionary Inline Expressions]]
 
* [[Compress Property]]
 
* [[Compress Property]]
 +
* [[Resolve Action]]
 +
* [[Option Shortcut]]
 +
* [[Replace Action]]
 +
* [[Image Options]]
 +
* [[Advanced Text & Image]]
 +
* [[Keep Ratio Keyword]]
 +
* [[Advanced Templated Items]]
  
 
=== Benchmark Tests ===
 
=== Benchmark Tests ===
Benchmark tests have been developed to check the performance of different TV devices.
+
Benchmark tests have been developed to check the performance and capabilities of a TV device.
 
* [[Renderer Plugin]]
 
* [[Renderer Plugin]]
 
* [[Drawing Plugin]]
 
* [[Drawing Plugin]]
Line 94: Line 115:
 
* Media Station X - Info: https://msx.benzac.de/info/
 
* Media Station X - Info: https://msx.benzac.de/info/
 
* Media Station X - Icons: https://msx.benzac.de/info/icons.html
 
* Media Station X - Icons: https://msx.benzac.de/info/icons.html
* Media Station X - Internal Actions: https://msx.benzac.de/info/xp/actions.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
 
* YouTube Channel: https://www.youtube.com/channel/UCblvVW1ZvYWBU4amsaT58vg
 
* Facebook Group: https://www.facebook.com/Media-Station-X-2311938729026920
 
* Facebook Group: https://www.facebook.com/Media-Station-X-2311938729026920
 
* GitHub Projects: https://github.com/benzac-de
 
* GitHub Projects: https://github.com/benzac-de
 +
* Support: https://www.buymeacoffee.com/benzac

Latest revision as of 17: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]