Difference between revisions of "Tizen Player"
| Line 1: | Line 1: | ||
| − | The Tizen player is  | + | The Tizen player is used in Media Station X version '''0.1.128''' or higher for all Samsung TVs (2016+ models). In previous versions the HTML5 player is used. It works similar to the HTML5 player, but can also be used like a plugin by using the extended properties of a content item. Please see [[Extended Properties]] for more information. Additionally, you can interact with it using the <code>player:commit</code> actions. Please see [[Internal Actions]] for more information. Some extended properties are dynamic and can be changed via an action at runtime. Please see [[#Runtime Usage]] for more information. | 
| Some extended properties are mapped to a corresponding Tizen (i.e. <code>AVPlay</code>) function. For more information, please visit: https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/avplay-api.html | Some extended properties are mapped to a corresponding Tizen (i.e. <code>AVPlay</code>) function. For more information, please visit: https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/avplay-api.html | ||
Revision as of 13:58, 11 February 2021
The Tizen player is used in Media Station X version 0.1.128 or higher for all Samsung TVs (2016+ models). In previous versions the HTML5 player is used. It works similar to the HTML5 player, but can also be used like a plugin by using the extended properties of a content item. Please see Extended Properties for more information. Additionally, you can interact with it using the player:commit actions. Please see Internal Actions for more information. Some extended properties are dynamic and can be changed via an action at runtime. Please see #Runtime Usage for more information.
Some extended properties are mapped to a corresponding Tizen (i.e. AVPlay) function. For more information, please visit: https://developer.samsung.com/smarttv/develop/api-references/samsung-product-api-references/avplay-api.html
Note: All properties are reset if a new video/audio is played. Please also note that you can still use the HTML5 video element with a plugin (see Video/Audio Plugin#Examples)
Syntax[edit]
| Property | Value | Example | Tizen Function | Dynamic | Since Version | Description | 
|---|---|---|---|---|---|---|
| tizen:buffer:size | {SECONDS} | "tizen:buffer:size": "10" | setBufferingParam("PLAYER_BUFFER_FOR_PLAY", "PLAYER_BUFFER_SIZE_IN_SECOND", {SECONDS});setBufferingParam("PLAYER_BUFFER_FOR_RESUME", "PLAYER_BUFFER_SIZE_IN_SECOND", {SECONDS}); | No | 0.1.128 | Sets up the initial and resume buffer size in seconds. The default buffer size is "10". Please seeAVPlayAPI for possible values. | 
| tizen:buffer:size:init | {SECONDS} | "tizen:buffer:size:init": "10" | setBufferingParam("PLAYER_BUFFER_FOR_PLAY", "PLAYER_BUFFER_SIZE_IN_SECOND", {SECONDS}); | No | 0.1.128 | Sets up the initial buffer size in seconds. The default buffer size is "10". Please seeAVPlayAPI for possible values. | 
| tizen:buffer:size:resume | {SECONDS} | "tizen:buffer:size:resume": "10" | setBufferingParam("PLAYER_BUFFER_FOR_RESUME", "PLAYER_BUFFER_SIZE_IN_SECOND", {SECONDS}); | No | 0.1.128 | Sets up the resume buffer size in seconds. The default buffer size is "10". Please seeAVPlayAPI for possible values. | 
| tizen:buffer:timeout | {SECONDS} | "tizen:buffer:timeout": "20" | setTimeoutForBuffering({SECONDS}); | Yes | 0.1.128 | Sets up the buffer timeout in seconds. The default buffer timeout is "20". Please seeAVPlayAPI for possible values. | 
| tizen:display:area | {REL_X},{REL_Y},{REL_W},{REL_H} | "tizen:display:area": "0,0,1,1""tizen:display:area": "0.125,0,0.75,1""tizen:display:area": "0,0.119,1,0.762" | setDisplayRect({ABS_X}, {ABS_Y}, {ABS_W}, {ABS_H}); | Yes | 0.1.128 | Sets up the display area with relative coordinates. The default area is "0,0,1,1", which fills the entire screen. Please seeAVPlayAPI for possible values.Note: If this property is set, the property  | 
| tizen:display:mode | {DISPLAY_MODE} | "tizen:display:mode": "PLAYER_DISPLAY_MODE_LETTER_BOX""tizen:display:mode": "PLAYER_DISPLAY_MODE_FULL_SCREEN""tizen:display:mode": "PLAYER_DISPLAY_MODE_AUTO_ASPECT_RATIO" | setDisplayMethod({DISPLAY_MODE}); | Yes | 0.1.128 | Sets up the display mode. The default mode is "PLAYER_DISPLAY_MODE_LETTER_BOX", which fills the entire screen (by keeping the video aspect ratio). Please seeAVPlayAPI for possible values.Note: If this property is set, the property  | 
| tizen:load | {ACTION} | "tizen:load": "info:Tizen player loaded." | n/a | No | 0.1.128 | Sets up an action that is executed if the player is loaded (i.e. the internal state is "IDLE"). Please seeAVPlayAPI for more information. | 
| tizen:ready | {ACTION} | "tizen:ready": "info:Tizen player ready." | n/a | Yes | 0.1.128 | Sets up an action that is executed if the player is ready (i.e. the internal state is "READY"). Please seeAVPlayAPI for more information. | 
| tizen:start | {ACTION} | "tizen:start": "info:Tizen player started." | n/a | Yes | 0.1.128 | Sets up an action that is executed if the player is started (i.e. the internal state is "PLAYING"or"PAUSED"). Please seeAVPlayAPI for more information. | 
| tizen:stream:{STREAM_TYPE} | {STREAM_VALUE} | "tizen:stream:PREBUFFER_MODE": "5000""tizen:stream:ADAPTIVE_INFO": "FIXED_MAX_RESOLUTION=7680X4320""tizen:stream:ADAPTIVE_INFO": "BITRATES=5000~10000|STARTBITRATE=HIGHEST|SKIPBITRATE=LOWEST" | setStreamingProperty({STREAM_TYPE}, {STREAM_VALUE}); | No | 0.1.128 | Sets up a stream specific property. Please see AVPlayAPI for possible values. | 
| tizen:track:audio | {TRACK_INDEX} | "tizen:track:audio": "1" | setSelectTrack("AUDIO", {TRACK_INDEX}); | Yes | 0.1.128 | Selects an audio track by indicating the index. Please see AVPlayAPI for more information. | 
| tizen:track:text | {TRACK_INDEX} | "tizen:track:text": "1" | setSelectTrack("TEXT", {TRACK_INDEX}); | Yes | 0.1.128 | Selects a text track by indicating the index. Please see AVPlayAPI for more information. | 
Runtime Usage[edit]
It is possible to change some extended properties via an action at runtime and to request data from the Tizen player.
| Syntax & Example | Data | Tizen Function | Since Version | Description | 
|---|---|---|---|---|
| 
 | n/a | n/a | 0.1.128 | Sets up an extended property during runtime. Note: Only the dynamic properties can be set at runtime. Please see #Syntax for more information. | 
| player:commit | {
   "key": "{PROPERTY}",
   "value": "{VALUE}",
   "action": "{ACTION}",
   "data": null
}
 | n/a | 0.1.128 | Sets up an extended property during runtime and optionally executes an action on completion. Note: Only the dynamic properties can be set at runtime. Please see #Syntax for more information. | 
| 
 | n/a | 
 | 0.1.128 | Requests info data from the player and commits the response to the interaction plugin. Please see AVPlayAPI for more information. | 
| 
 | n/a | getStreamingProperty({STREAM_TYPE}); | 0.1.128 | Requests a stream specific property from the player and commits the response to the interaction plugin. Please see AVPlayAPI for more information. | 
| 
 | n/a | getStreamingProperty({STREAM_TYPE}); | 0.1.128 | Requests multiple stream specific properties from the player and commits the response to the interaction plugin. Please see AVPlayAPI for more information. |