DeviceAPI Guide for
Samsung Smart TV
Version 2.20
Samsung Smart TV
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 2
1. DEVICEAPI INTRODUCTION ..................................................................................................................... 14
1.1. WHAT IS DEVICEAPI? ..............................................................................................................................................................14
1.2. ARCHITECTURE ..........................................................................................................................................................................15
1.3. VERSION POLICY .......................................................................................................................................................................15
2. USE METHOD OF DEVICEAPI ................................................................................................................... 16
2.1. DEVICEAPI OBJECT DEFINITION (HTML) ..........................................................................................................................16
2.2. VARIABLE DECLARATION OF DEVICEAPI TYPE (JAVASCRIPT) ......................................................................................16
2.3. DEVICEAPI OPERATION...........................................................................................................................................................16
3. DEVICEAPI LIST ........................................................................................................................................... 17
3.1. COMMON .....................................................................................................................................................................................17
3.2. APPCOMMON ..............................................................................................................................................................................17
3.3. AUDIO ..........................................................................................................................................................................................18
3.4. DEVICE ......................................................................................................................................................................................19
3.5. EXTERNALWIDGETINTERFACE ...................................................................................................................................19
3.6. DOWNLOAD ................................................................................................................................................................................20
3.7. FILESYSTEM ................................................................................................................................................................................20
3.8. FRONTPANEL ..............................................................................................................................................................................21
3.9. IME ..............................................................................................................................................................................................21
3.10. IMAGEVIWER .........................................................................................................................................................................22
3.11. NETWORK ..................................................................................................................................................................................23
3.12. NNAVI .............................................................................................................................................................................24
3.13. PLAYER .................................................................................................................................................................................24
3.14. SCREEN ...................................................................................................................................................................................26
3.15. TASKMANAGER .....................................................................................................................................................................27
3.16. TIME.........................................................................................................................................................................................27
3.17. TV ............................................................................................................................................................................................27
3.18. TVMW ...................................................................................................................................................................................29
3.19. VIDEO ....................................................................................................................................................................................30
3.20. WINDOW ..............................................................................................................................................................................30
4. DEVICEAPI FUNCTIONS DETAIL .............................................................................................................. 33
4.1. COMMON .................................................................................................................................................................................33
4.1.1. Function .............................................................................................................................................................................33
4.1.1.1. GetPluginInfo................................................................................................................................................................................. 33
4.1.2. Enumeration .....................................................................................................................................................................33
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 3
4.1.2.1. Number ............................................................................................................................................................................................ 33
4.1.2.2. PL_CMN__INFO ......................................................................................................................................................................... 34
4.1.2.3. String ................................................................................................................................................................................................ 34
4.2. APPCOMMON ..............................................................................................................................................................................35
4.2.1. Function .............................................................................................................................................................................35
4.2.1.1. CheckReservedKey ...................................................................................................................................................................... 35
4.2.1.2. IsKeyRegister................................................................................................................................................................................. 35
4.2.1.3. RegisterAllKey .............................................................................................................................................................................. 36
4.2.1.4. RegisterColorKey ......................................................................................................................................................................... 37
4.2.1.5. RegisterKey .................................................................................................................................................................................... 38
4.2.1.6. RegisterNaviKey ........................................................................................................................................................................... 39
4.2.1.7. RegisterNumKey........................................................................................................................................................................... 40
4.2.1.8. RegisterPlaybackKey ................................................................................................................................................................... 41
4.2.1.9. SendEvent_IME ............................................................................................................................................................................ 42
4.2.1.10. SendEvent_IME_Sync ................................................................................................................................................................ 43
4.2.1.11. SendKeyToTVViewer.................................................................................................................................................................. 44
4.2.1.12. SubscribeEvent .............................................................................................................................................................................. 44
4.2.1.13. UnregisterAllKey .......................................................................................................................................................................... 46
4.2.1.14. UnregisterColorKey ..................................................................................................................................................................... 47
4.2.1.15. UnregisterKey ................................................................................................................................................................................ 48
4.2.1.16. UnregisterNaviKey ....................................................................................................................................................................... 49
4.2.1.17. UnregisterNumKey ...................................................................................................................................................................... 50
4.2.1.18. UnregisterPlaybackKey ............................................................................................................................................................... 50
4.2.1.19. UnsubscribeEvent ......................................................................................................................................................................... 51
4.2.2. Enumeration .....................................................................................................................................................................53
4.2.2.1. PL_APPCOMMON_KEY ......................................................................................................................................................... 53
4.2.2.2. PL_APPCOMMON_MESSAGE ............................................................................................................................................. 60
4.2.3. EVENT ...............................................................................................................................................................................63
4.2.3.1. OnMessage ..................................................................................................................................................................................... 63
4.3. AUDIO ........................................................................................................................................................................................64
4.3.1. Function .............................................................................................................................................................................64
4.3.1.1. CheckExternalOutMode.............................................................................................................................................................. 64
4.3.1.2. GetExternalOutMode ................................................................................................................................................................... 65
4.3.1.3. GetOutputDevice .......................................................................................................................................................................... 66
4.3.1.4. GetSystemMute ............................................................................................................................................................................. 68
4.3.1.5. GetUserMute .................................................................................................................................................................................. 69
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 4
4.3.1.6. GetVolume ...................................................................................................................................................................................... 70
4.3.1.7. IsActiveSourceOnCEC ................................................................................................................................................................ 70
4.3.1.8. SetExternalOutMode.................................................................................................................................................................... 71
4.3.1.9. SetSystemMute .............................................................................................................................................................................. 72
4.3.1.10. SetTVSourceOnCEC ................................................................................................................................................................... 73
4.3.1.11. SetUserMute ................................................................................................................................................................................... 73
4.3.1.12. SetVolumeWithKey ...................................................................................................................................................................... 74
4.3.2. Enumeration .....................................................................................................................................................................75
4.3.2.1. PL_AUDIO_AUDIO_OUT_MODE ....................................................................................................................................... 75
4.3.2.2. PL_AUDIO_OUTPUT_DEVICE ............................................................................................................................................ 75
4.3.2.3. PL_AUDIO_VOLUME_KEY .................................................................................................................................................. 76
4.4. DEVICE ......................................................................................................................................................................................77
4.4.1. Function .............................................................................................................................................................................77
4.4.1.1. GetDisplayPanelType .................................................................................................................................................................. 77
4.4.1.2. GetModel ........................................................................................................................................................................................ 78
4.4.1.3. GetRealModel ................................................................................................................................................................................ 79
4.4.2. Enumeration .....................................................................................................................................................................79
4.4.2.1. PL_DEVICE_DPT ....................................................................................................................................................................... 79
4.5. DOWNLOAD ................................................................................................................................................................................80
4.5.1. Function .............................................................................................................................................................................80
4.5.1.1. CancelDownload ........................................................................................................................................................................... 80
4.5.1.2. CancelUpload................................................................................................................................................................................. 81
4.5.1.3. CheckDownloadSpeed ................................................................................................................................................................ 81
4.5.1.4. StartDownFile ................................................................................................................................................................................ 82
4.5.1.5. StartUpload ..................................................................................................................................................................................... 83
4.5.2. Enumeration .....................................................................................................................................................................85
4.5.2.1. PL_DN_ST ..................................................................................................................................................................................... 85
4.5.2.2. PL_DOWNLOAD_UPLOAD_SERVER_TYPE................................................................................................................. 86
4.5.3. EVENT ...............................................................................................................................................................................86
4.5.3.1. OnComplete ................................................................................................................................................................................... 86
4.5.3.2. OnUploadComplete ...................................................................................................................................................................... 88
4.5.3.3. OnUploadProgress ........................................................................................................................................................................ 90
4.6. EXTERNALWIDGETINTERFACE ...............................................................................................................................................91
4.6.1. Function .............................................................................................................................................................................91
4.6.1.1. AccountRead .................................................................................................................................................................................. 91
4.6.1.2. AccountRemove ............................................................................................................................................................................ 92
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 5
4.6.1.3. AccountWrite ................................................................................................................................................................................. 92
4.6.1.4. GetESN ............................................................................................................................................................................................ 93
4.6.1.5. IsBound ........................................................................................................................................................................................... 94
4.6.1.6. UnBindWidget ............................................................................................................................................................................... 95
4.7. FILESYSTEM ...............................................................................................................................................................................95
4.7.1. Function .............................................................................................................................................................................95
4.7.1.1. IsExistedPath .................................................................................................................................................................................. 95
4.8. FRONTPANEL ..............................................................................................................................................................................97
4.8.1. Function .............................................................................................................................................................................97
4.8.1.1. DisplayVFD_Show ...................................................................................................................................................................... 97
4.8.1.2. DisplayVFD_Time ....................................................................................................................................................................... 97
4.9. IME ..............................................................................................................................................................................................98
4.9.1. Function .............................................................................................................................................................................98
4.9.1.1. DeInitIME ....................................................................................................................................................................................... 98
4.9.1.2. DeInitMyWordIME ...................................................................................................................................................................... 99
4.9.1.3. GetActiveWordPosition .............................................................................................................................................................. 99
4.9.1.4. GetCharacterList ........................................................................................................................................................................ 100
4.9.1.5. GetCursorPosition ..................................................................................................................................................................... 100
4.9.1.6. GetIMEInputMode .................................................................................................................................................................... 101
4.9.1.7. GetLanguage ............................................................................................................................................................................... 101
4.9.1.8. GetRecommendedString .......................................................................................................................................................... 102
4.9.1.9. GetRecommendedStringCount ............................................................................................................................................... 102
4.9.1.10. GetShfCapState .......................................................................................................................................................................... 103
4.9.1.11. GetString ...................................................................................................................................................................................... 103
4.9.1.12. InitIME ......................................................................................................................................................................................... 104
4.9.1.13. InitMyWordIME ........................................................................................................................................................................ 104
4.9.1.14. InputKey ....................................................................................................................................................................................... 105
4.9.1.15. ResetUDBData ........................................................................................................................................................................... 105
4.9.1.16. SetCursorPositon........................................................................................................................................................................ 106
4.9.1.17. SetIMEInputMode ..................................................................................................................................................................... 106
4.9.1.18. SetLanguage ................................................................................................................................................................................ 107
4.9.1.19. SetString ....................................................................................................................................................................................... 108
4.10. IMAGEVIEWER .................................................................................................................................................................... 108
4.10.1. Function .......................................................................................................................................................................... 108
4.10.1.1. ClearScreen ................................................................................................................................................................................. 108
4.10.1.2. GetVideoHeight .......................................................................................................................................................................... 109
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 6
4.10.1.3. GetVideoWidth ........................................................................................................................................................................... 109
4.10.1.4. InitPlayer ...................................................................................................................................................................................... 110
4.10.1.5. Play ................................................................................................................................................................................................ 111
4.10.1.6. SetDisplayArea ........................................................................................................................................................................... 111
4.10.1.7. SetDisplayLock .......................................................................................................................................................................... 112
4.10.1.8. SetTransitionEffect .................................................................................................................................................................... 113
4.10.1.9. ShowImage .................................................................................................................................................................................. 114
4.10.1.10. Stop ............................................................................................................................................................................................... 115
4.10.3. Event ................................................................................................................................................................................ 115
4.10.3.1. OnBufferingComplete .............................................................................................................................................................. 115
4.10.3.2. OnBufferingStart ........................................................................................................................................................................ 116
4.10.3.3. OnConnectionFailed ................................................................................................................................................................. 116
4.10.3.4. OnNetworkDisconnected ......................................................................................................................................................... 117
4.10.3.5. OnRenderError ........................................................................................................................................................................... 118
4.10.3.6. OnRenderingComplete ............................................................................................................................................................. 118
4.10.3.7. OnStreamInfoReady .................................................................................................................................................................. 119
4.10.3.8. OnStreamNotFound .................................................................................................................................................................. 120
4.11. NNAVI ....................................................................................................................................................................................... 120
4.11.1. Function .......................................................................................................................................................................... 120
4.11.1.1. ActivateReady ............................................................................................................................................................................ 120
4.11.1.2. ActivateWithData ...................................................................................................................................................................... 121
4.11.1.3. ChangeWidgetManager ............................................................................................................................................................ 121
4.11.1.4. GetAppKey .................................................................................................................................................................................. 122
4.11.1.5. GetDUID ...................................................................................................................................................................................... 123
4.11.1.6. GetFirmware ............................................................................................................................................................................... 123
4.11.1.7. GetModelCode ........................................................................................................................................................................... 124
4.11.1.8. GetPath ......................................................................................................................................................................................... 124
4.11.1.9. GetRemoconType ...................................................................................................................................................................... 125
4.11.1.10. GetServerType ........................................................................................................................................................................... 126
4.11.1.11. GetSupportPIG .......................................................................................................................................................................... 126
4.11.1.12. GetSystemVersion ..................................................................................................................................................................... 127
4.11.1.13. GetToken ..................................................................................................................................................................................... 128
4.11.1.14. ResetWidgetData ....................................................................................................................................................................... 129
4.11.1.15. SendEventToDevice ................................................................................................................................................................. 129
4.11.1.16. SetBannerState ........................................................................................................................................................................... 130
4.11.2. Enumeration .................................................................................................................................................................. 130
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 7
4.11.2.1. PL_NNAVI_PATH .................................................................................................................................................................... 130
4.11.2.2. PL_NNAVI_SYSTEM_VERSION....................................................................................................................................... 131
4.11.2.3. PL_ST ........................................................................................................................................................................................... 131
4.12. NETWORK ............................................................................................................................................................................ 132
4.12.1. Function .......................................................................................................................................................................... 132
4.12.1.1. CheckDNS ................................................................................................................................................................................... 132
4.12.1.2. CheckGateway ............................................................................................................................................................................ 133
4.12.1.3. CheckHTTP ................................................................................................................................................................................. 134
4.12.1.4. CheckPhysicalConnection ....................................................................................................................................................... 135
4.12.1.5. CreatePlugin ................................................................................................................................................................................ 136
4.12.1.6. GetActiveType ............................................................................................................................................................................ 136
4.12.1.7. GetDNS ........................................................................................................................................................................................ 137
4.12.1.8. GetDNSMode ............................................................................................................................................................................. 138
4.12.1.9. GetGateway ................................................................................................................................................................................. 139
4.12.1.10. GetHostAddr .............................................................................................................................................................................. 140
4.12.1.11. GetHWaddr ................................................................................................................................................................................. 140
4.12.1.12. GetIP ............................................................................................................................................................................................. 141
4.12.1.13. GetIPMode .................................................................................................................................................................................. 142
4.12.1.14. GetMAC ...................................................................................................................................................................................... 143
4.12.1.15. GetNetMask ................................................................................................................................................................................ 143
4.12.1.16. GetNetworkInfo......................................................................................................................................................................... 144
4.12.1.17. GetNetworkType ....................................................................................................................................................................... 145
4.12.1.18. GetStatus ..................................................................................................................................................................................... 145
4.12.1.19. IsValidDNS ................................................................................................................................................................................. 146
4.12.1.20. IsValidGateway .......................................................................................................................................................................... 147
4.12.1.21. IsValidIP ...................................................................................................................................................................................... 148
4.12.1.22. IsValidMAC ................................................................................................................................................................................ 149
4.12.1.23. IsValidSubnetMask ................................................................................................................................................................... 150
4.12.1.24. SetDNSMode ............................................................................................................................................................................. 151
4.12.1.25. SetIPMode .................................................................................................................................................................................. 152
4.13. PLAYER ................................................................................................................................................................................. 153
4.13.1. Function .......................................................................................................................................................................... 153
4.13.1.1. ClearScreen ................................................................................................................................................................................. 153
4.13.1.2. GetAvailableBitrates ................................................................................................................................................................. 153
4.13.1.3. GetCurrentBitrates ..................................................................................................................................................................... 154
4.13.1.4. GetDuration ................................................................................................................................................................................. 155
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 8
4.13.1.5. GetPLiveDuration ...................................................................................................................................................................... 155
4.13.1.6. GetPlayerVersion ....................................................................................................................................................................... 156
4.13.1.7. GetVideoHeight .......................................................................................................................................................................... 156
4.13.1.8. GetVideoWidth ........................................................................................................................................................................... 157
4.13.1.9. InitPlayer ...................................................................................................................................................................................... 157
4.13.1.10. JumpBackward .......................................................................................................................................................................... 158
4.13.1.11. JumpForward ............................................................................................................................................................................. 159
4.13.1.12. Pause ............................................................................................................................................................................................. 160
4.13.1.13. Play ............................................................................................................................................................................................... 160
4.13.1.14. Resume ........................................................................................................................................................................................ 161
4.13.1.15. ResumePlay ................................................................................................................................................................................ 161
4.13.1.16. SetCropArea ............................................................................................................................................................................... 162
4.13.1.17. SetDisplayArea .......................................................................................................................................................................... 163
4.13.1.18. SetICT .......................................................................................................................................................................................... 164
4.13.1.19. SetInitialBuffer .......................................................................................................................................................................... 165
4.13.1.20. SetInitialTimeOut ...................................................................................................................................................................... 165
4.13.1.21. SetMacrovision .......................................................................................................................................................................... 166
4.13.1.22. SetPendingBuffer ...................................................................................................................................................................... 167
4.13.1.23. SetPlaybackSpeed ..................................................................................................................................................................... 168
4.13.1.24. SetPlayerProperty .................................................................................................................................................................. 168
4.13.1.25. SetTotalBufferSize .................................................................................................................................................................... 169
4.13.1.26. SetVBIData ................................................................................................................................................................................. 170
4.13.1.27. StartPlayback .............................................................................................................................................................................. 171
4.13.1.28. Stop ............................................................................................................................................................................................... 172
4.13.3. Event ................................................................................................................................................................................ 173
4.13.3.1. OnAdEnd ..................................................................................................................................................................................... 173
4.13.3.2. OnAdStart .................................................................................................................................................................................... 173
4.13.3.3. OnConnectionFailed ................................................................................................................................................................. 174
4.13.3.4. OnBufferingStartComplete ..................................................................................................................................................... 174
4.13.3.5. OnBufferingProgress ................................................................................................................................................................ 175
4.13.3.6. OnBufferingStart ........................................................................................................................................................................ 176
4.13.3.7. OnConnectionFailed ................................................................................................................................................................. 176
4.13.3.8. OnCurrentPlayTime .................................................................................................................................................................. 177
4.13.3.9. OnNetworkDisconnected ......................................................................................................................................................... 177
4.13.3.10. OnRenderError .......................................................................................................................................................................... 178
4.13.3.11. OnRenderingComplete ............................................................................................................................................................ 179
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 9
4.13.3.12. OnResolutionChanged ............................................................................................................................................................. 179
4.13.3.13. OnStreamInfoReady ................................................................................................................................................................. 180
4.13.3.14. OnStreamNotFound .................................................................................................................................................................. 181
4.14. SCREEN ................................................................................................................................................................................ 181
4.14.1. Function .......................................................................................................................................................................... 181
4.14.1.1. Check3DEffectMode ................................................................................................................................................................ 181
4.14.1.2. Flag3DTVConnect .................................................................................................................................................................... 183
4.14.1.3. Flag3DEffectSupport ................................................................................................................................................................ 184
4.14.1.4. Get3DEffectMode...................................................................................................................................................................... 185
4.14.1.5. GetOption..................................................................................................................................................................................... 186
4.14.1.6. Set3DEffectMode ...................................................................................................................................................................... 187
4.14.2. Enumeration .................................................................................................................................................................. 189
4.14.2.1. PL_SCREEN_3DEFFECT_MODE ..................................................................................................................................... 189
4.14.2.2. PL_SCREEN_OPTION ........................................................................................................................................................... 189
4.15. TV ......................................................................................................................................................................................... 190
4.15.1. Function .......................................................................................................................................................................... 190
4.15.1.1. CheckPIP ...................................................................................................................................................................................... 190
4.15.1.2. FlagStreamDST .......................................................................................................................................................................... 191
4.15.1.3. GetBDProductType ................................................................................................................................................................... 191
4.15.1.4. GetCountry .................................................................................................................................................................................. 192
4.15.1.5. GetDisplayPanelType ............................................................................................................................................................... 193
4.15.1.6. GetDST ......................................................................................................................................................................................... 193
4.15.1.7. GetLanguage ............................................................................................................................................................................... 194
4.15.1.8. GetLanguageSet ......................................................................................................................................................................... 195
4.15.1.9. GetPIP ........................................................................................................................................................................................... 195
4.15.1.10. GetPresentProgram_Duration ................................................................................................................................................ 196
4.15.1.11. GetPresentProgram_EndTime ............................................................................................................................................... 197
4.15.1.12. GetPresentProgram_StartTime .............................................................................................................................................. 197
4.15.1.13. GetPresentProgram_Title ........................................................................................................................................................ 198
4.15.1.14. GetProductCode ........................................................................................................................................................................ 199
4.15.1.15. GetProductType ......................................................................................................................................................................... 199
4.15.1.16. GetProgram_Duration .............................................................................................................................................................. 200
4.15.1.17. GetProgram_EndTime ............................................................................................................................................................. 201
4.15.1.18. GetProgram_StartTime ............................................................................................................................................................ 202
4.15.1.19. GetProgram_Title ...................................................................................................................................................................... 204
4.15.1.20. GetProgramList ......................................................................................................................................................................... 205
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 10
4.15.1.21. GetProgramList_Size ............................................................................................................................................................... 206
4.15.1.22. GetTargetLocation .................................................................................................................................................................... 207
4.15.1.23. GetTimeZone ............................................................................................................................................................................. 208
4.15.1.24. GetTimeZone_Offset ............................................................................................................................................................... 208
4.15.1.25. SetEvent ....................................................................................................................................................................................... 209
4.15.1.26. SetPIP ........................................................................................................................................................................................... 210
4.15.1.27. UnsetEvent .................................................................................................................................................................................. 211
4.15.2. Enumeration .................................................................................................................................................................. 213
4.15.2.1. PL_TV_BDPRODUCT_TYPE ............................................................................................................................................. 213
4.15.2.2. PL_TV_COUNTRY.................................................................................................................................................................. 213
4.15.2.3. PL_TV_DISPLAY_PANEL.................................................................................................................................................... 215
4.15.2.4. PL_TV_DST_TYPE ................................................................................................................................................................. 216
4.15.2.5. PL_TV_EVENT ......................................................................................................................................................................... 216
4.15.2.6. PL_TV_FACTORY_LANGUAGE ...................................................................................................................................... 219
4.15.2.7. PL_TV_LANGUAGE .............................................................................................................................................................. 220
4.15.2.8. PL_TV_PRODUCT_TYPE .................................................................................................................................................... 222
4.15.2.9. PL_TV_TARGET_LOCATION ............................................................................................................................................ 222
4.15.2.10. PL_TV_TIMEZONE ............................................................................................................................................................... 223
4.15.3. Event ................................................................................................................................................................................ 225
4.15.3.1. OnEvent ........................................................................................................................................................................................ 225
4.16. TVMW ................................................................................................................................................................................ 226
4.16.1. Function .......................................................................................................................................................................... 226
4.16.1.1. CheckReservedKey ................................................................................................................................................................... 226
4.16.1.2. Deactivate .................................................................................................................................................................................... 227
4.16.1.3. GetActiveApp ............................................................................................................................................................................. 228
4.16.1.4. GetBGApp ................................................................................................................................................................................... 229
4.16.1.5. GetCountry .................................................................................................................................................................................. 230
4.16.1.6. GetLanguage ............................................................................................................................................................................... 231
4.16.1.7. GetProfile ..................................................................................................................................................................................... 232
4.16.1.8. GetSource..................................................................................................................................................................................... 233
4.16.1.9. GetTVUseMode ......................................................................................................................................................................... 233
4.16.1.10. IsRegisteredKey ........................................................................................................................................................................ 234
4.16.1.11. RegisterKey ................................................................................................................................................................................ 235
4.16.1.12. RegisterKeyGroup .................................................................................................................................................................... 236
4.16.1.13. SendKeyToTVViewer .............................................................................................................................................................. 237
4.16.1.14. SetProfile ..................................................................................................................................................................................... 237
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 11
4.16.1.15. SetSource..................................................................................................................................................................................... 238
4.16.1.16. SetWatchDog .............................................................................................................................................................................. 239
4.16.1.17. UnregForBGApp ....................................................................................................................................................................... 240
4.16.1.18. UnregisterKey ............................................................................................................................................................................ 241
4.16.1.19. UnregisterKeyGroup ................................................................................................................................................................ 241
4.16.2. Enumeration .................................................................................................................................................................. 242
4.16.2.1. PL_TVMW_COUNTRY ......................................................................................................................................................... 242
4.16.2.2. PL_TVMW_DTVAPP .............................................................................................................................................................. 245
4.16.2.3. PL_TVMW_KEY ...................................................................................................................................................................... 246
4.16.2.4. PL_TVMW_KEY_GRP .......................................................................................................................................................... 254
4.16.2.5. PL_TVMW_LANGUAGE ..................................................................................................................................................... 255
4.16.2.6. PL_TVMW_PRFID .................................................................................................................................................................. 258
4.16.2.7. PL_TVMW_SOURCE ............................................................................................................................................................. 259
4.16.2.8. PL_TVMW_TVUT ................................................................................................................................................................... 262
4.16.2.9. PL_TVMW_WATCHDOG ..................................................................................................................................................... 263
4.17. TASKMANAGER .................................................................................................................................................................. 263
4.17.1. Function .......................................................................................................................................................................... 263
4.17.1.1. ActivateApplication .................................................................................................................................................................. 263
4.17.1.2. GetActiveApplication ............................................................................................................................................................... 264
4.17.1.3. GetBgApplication ...................................................................................................................................................................... 265
4.17.1.4. SetBgApplication ....................................................................................................................................................................... 266
4.17.2. Enumeration .................................................................................................................................................................. 266
4.17.2.1. PL_TASKMANAGER_DTVAPP ......................................................................................................................................... 266
4.18. TIME...................................................................................................................................................................................... 270
4.18.1. Function .......................................................................................................................................................................... 270
4.18.1.1. ConvertEpochToLocalTime .................................................................................................................................................... 270
4.18.1.2. GetEpochTime ............................................................................................................................................................................ 271
4.19. VIDEO ................................................................................................................................................................................... 272
4.19.1. Function .......................................................................................................................................................................... 272
4.19.1.1. ChangeWidgetMode ................................................................................................................................................................. 272
4.19.1.2. SetFrameRate .............................................................................................................................................................................. 273
4.19.1.3. SetOSDState ................................................................................................................................................................................ 274
4.19.2. Enumeratioin ................................................................................................................................................................. 275
4.19.2.1. PL_VIDEO_WIDGET_MODE ............................................................................................................................................. 275
4.20. WINDOW .............................................................................................................................................................................. 275
4.20.1. Function .......................................................................................................................................................................... 275
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 12
4.20.1.1. CheckScreenRect_PosSizeMode ........................................................................................................................................... 275
4.20.1.2. GetCurrentChannel_Major ...................................................................................................................................................... 277
4.20.1.3. GetCurrentChannel_Minor ...................................................................................................................................................... 277
4.20.1.4. GetCurrentChannel_Name ...................................................................................................................................................... 278
4.20.1.5. GetCurrentChannel_OriginNetID ......................................................................................................................................... 279
4.20.1.6. GetCurrentChannel_ProgramNumber .................................................................................................................................. 279
4.20.1.7. GetCurrentChannel_PTC ......................................................................................................................................................... 280
4.20.1.8. GetCurrentChannel_ServiceName ........................................................................................................................................ 280
4.20.1.9. GetCurrentChannel_Type ........................................................................................................................................................ 281
4.20.1.10. GetResolution ............................................................................................................................................................................ 281
4.20.1.11. GetScreenRect ........................................................................................................................................................................... 282
4.20.1.12. GetScreenRect_PosMode ....................................................................................................................................................... 283
4.20.1.13. GetScreenRect_SizeMode ...................................................................................................................................................... 283
4.20.1.14. GetSource .................................................................................................................................................................................... 284
4.20.1.15. GetState_Show .......................................................................................................................................................................... 285
4.20.1.16. SetSource..................................................................................................................................................................................... 286
4.20.2. Enumeration .................................................................................................................................................................. 286
4.20.2.1. PL_WINDOW_CHANNEL_TYPE ..................................................................................................................................... 286
4.20.2.2. PL_WINDOW_NAVIGATOR_MODE ............................................................................................................................... 287
4.20.2.3. PL_WINDOW_POSITION_MODE .................................................................................................................................... 288
4.20.2.4. PL_WINDOW_RECT_SIZE_MODE ................................................................................................................................. 289
4.20.2.5. PL_WINDOW_RESOLUTION ............................................................................................................................................ 290
4.20.2.6. PL_WINDOW_SEEK .............................................................................................................................................................. 292
4.20.2.7. PL_WINDOW_SHOW_STATE ............................................................................................................................................ 293
4.20.2.8. PL_WINDOW_SHOW_TYPE .............................................................................................................................................. 294
4.20.2.9. PL_WINDOW_SOURCE ....................................................................................................................................................... 294
5. CONCLUSION .............................................................................................................................................. 297
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 13
Preface
Document Object
The document describes the introcudtion, use method and detail APIs about DeviceAPI provided by Samsung
Smart TV products
Document Scope
The document describes only DeviceAPI provided by Samsung Smart TV products. The guideline documents like
development or UI is cared by other documents
Document Subject
The document is subject to the developers who have the basic understanding about digital TV and javascript
language
Version history
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 14
1. DeviceAPI Introduction
1.1. What is DeviceAPI?
o DeviceAPI is defined as follows : API which widget uses when Javascript function does not support
TV function (ex : Channel change )
- DeviceAPI can be called as Javascript
- DeviceAPI can be called as method call or callback, which means that it can have a
characteristic of bidirectional communication
- DeviceAPI is coupled with browser
- DeviceAPI has the limited expression and use such like data expression of structure or array
o Samsung DeviceAPI can be different for each product
- DeviceAPI is dependent on Samsung native modules, and products can have different modules
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 15
1.2. Architecture
o Widget can call DeviceAPI which supports the Samsung Device functions layered with various
Device modules such as Channel.
o DeviceAPI layer behaves like the language binding between C++/C and Javascript
o The Samsung Smart TV is composed of two main layers : Widget and Samsung Engine
– Widget is made by web script languages including HTML, XML, CSS, and Javascript
- Samsung Engine has many TV modules, and DeviceAPI is entering point to them by widget
- DeviceAPI is made as binary image, and can be not changed with arbitrary requirements
1.3. Version Policy
o Each API in DeviceAPI can have the version as additional function, and can be managed with each
version number
o Version description format : [DeviceAPIName]-[xxxx] ex) TVMW-0005
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 16
2. Use Method of DeviceAPI
2.1. DeviceAPI Object Definition (HTML)
o Declare the use of DeviceAPI using html object tag
o Declared as clsid attribute in object tag
o Other attributes are optional except clsid
<object id="pluginObjectAudio" border=0 classid="clsid:SAMSUNG-INFOLINK-AUDIO"
style="opacity:0.0;background-color:#000000;width:0px;height:0px;"></object>
2.2. Variable Declaration of DeviceAPI Type (Javascript)
o Defined as DeviceAPI variable using GetElementByID or embed
var AudioPlugin = document.getElementById("pluginObjectAudio");
or
var AudioPlugin = document.embeds[0];
2.3. DeviceAPI Operation
o Function call
AudioPlugin.GetVolume();
o Registration of function callback
function OnMuteCallback(mute) {
alert(mute);
}
AudioPlugin.OnMute = OnMuteCallback;
// when OnMute event happens on TV (TV becomes mute), OnMuteCallback function is called
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 17
3. DeviceAPI List
3.1. Common
Common
Common plugin is not a real plugin. This is a virtual plugin to describe common functions of all plugins
Latest Version none
CLSID none
Function GetPluginInfo
Event none
Enumeration
Number
PL_CMN_INFO
String
Top
3.2. AppCommon
AppCommon
TV Plugin deals with basic functions of TV ( ex : Key Registration, etc... )
Latest Version AppCommon -0010
CLSID clsid:SAMSUNG-INFOLINK-APPCOMMON
Function
CheckReservedKey
IsKeyRegister
RegisterAllKey
RegisterColorKey
RegisterKey
RegisterNaviKey
RegisterNumKey
RegisterPlaybackKey
SendEvent_IME
SendEvent_IME_Sync
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 18
SendKeyToTVViewer
SubscribeEvent
UnregisterAllKey
UnregisterColorKey
UnregisterKey
UnregisterNaviKey
UnregisterNumKey
UnregisterPlaybackKey
UnsubscribeEvent
Event OnMessage
Enumeration
PL_APPCOMMON_KEY
PL_APPCOMMON_MESSAGE
Top
3.3. Audio
Audio
Audio module supports to control audio relative functions(ex: Volume, Mute, etc) of DTV platform.
Latest Version AUDIO-0011
CLSID clsid:SAMSUNG-INFOLINK-AUDIO
Function
CheckExternalOutMode
GetExternalOutMode
GetOutputDevice
GetSystemMute
GetUserMute
GetVolume
IsActiveSourceOnCEC
SetExternalOutMode
SetSystemMute
SetTVSourceOnCEC
SetUserMute
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 19
SetVolumeWithKey
Event none
Enumeration
PL_AUDIO_AUDIO_OUT_MODE
PL_AUDIO_OUTPUT_DEVICE
PL_AUDIO_VOLUME_KEY
Top
3.4. DEVICE
Device
Device module supports to control H/W relative functions of DTV platform.(ex: panel)
Latest Version DEVICE-0002
CLSID clsid:SAMSUNG-INFOLINK-DEVICE
Function
GetDisplayPanelType (Replaced)
GetModel (Replaced)
GetRealModel (Replaced)
Event none
Enumeration PL_DEVICE_DPT (Replaced)
Top
3.5. EXTERNALWIDGETINTERFACE
ExternalWidgetInterface
xxx
Latest Version EXTERNALWIDGETINTERFACE-0004
CLSID clsid:SAMSUNG-INFOLINK-EXTERNALWIDGETINTERFACE
Function
AccountRead
AccountRemove
AccountWrite
GetESN
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 20
IsBound
UnBindWidget
Event none
Enumeration none
3.6. Download
Download
Download module supports to asynchrornus download file to DTV platform throughout HTTP, HTTPS protocol.
Latest Version DOWNLOAD-0008
CLSID clsid:SAMSUNG-INFOLINK-DOWNLOAD
Function
CancelDownload
CancelUpload
CheckDownloadSpeed
StartDownFile
StartUpload
Event
OnComplete
OnUploadComplete
OnUploadProgress
Enumeration
PL_DN_ST
PL_DOWNLOAD_UPLOAD_SERVER_TSERVER_TYPE
Top
3.7. Filesystem
FileSystem
Filesystem module support to control FileSystem in DTV Platform. ( ex : copy, move, unzip )
Latest Version FILESYSTEM-0005
CLSID clsid:SAMSUNG-INFOLINK-FILESYSTEM
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 21
Function IsExistedPath
Event none
Enumeration
Top
3.8. FrontPanel
FrontPanel
FrontPanel Plugin deals with Display of BD Player
Latest Version FrontPanel-0003
CLSID clsid:SAMSUNG-INFOLINK-FRONTPANEL
Function
DisplayVFD_Show
DisplayVFD_Time
Event none
Enumeration none
Top
Top
3.9. IME
IME
xxx
Latest Version IME-0002
CLSID clsid:SAMSUNG-INFOLINK-IME
Function
DeInitIME
DeInitMyWordIME
GetActiveWordPosition
GetCharacterList
GetCursorPosition
GetIMEInputMode
GetLanguage
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 22
GetRecommendedString
GetRecommendedStringCount
GetShfCapState
GetString
InitIME
InitMyWordIME
InputKey
ResetUDBData
SetCursorPositon
SetIMEInputMode
SetLanguage
SetString
Event none
Enumeration none
3.10. ImageViwer
ImageViewer
Plugin to display JPEG image
Latest Version IMAGEVIEWER-0001
CLSID clsid:SAMSUNG-INFOLINK-IMAGEVIEWER
Function
ClearScreen
GetVideoHeight
GetVideoWidth
InitPlayer
Play
SetDisplayArea
SetDisplayLock
SetTransitionEffect
ShowImage
Stop
Event
OnBufferingComplete
OnBufferingStart
OnConnectionFailed
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 23
OnNetworkDisconnected
OnRenderError
OnRenderingComplete
OnStreamInfoReady
OnStreamNotFound
Enumeration none
Top
3.11. Network
Network
Network module support to control and get network relative informations in DTV platform.
Latest Version NETWORK-0004
CLSID clsid:SAMSUNG-INFOLINK-NETWORK
Function
CheckCableConnection
CheckDNS
CheckGateway
CreatePlugin
GetActiveType
GetDNS
GetGateway
GetHostAddr
GetHWaddr
GetIpType
GetNetMask
GetStatus
HttpTest
IPConflictTest
Event none
Enumeration none
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 24
3.12. NNavi
NNavi
NNavi module supports to control Samsung Smart TV specific functions in DTV platform. (ex: DUID, ServerType,
etc.)
Latest Version NNAVI-0007
CLSID clsid:SAMSUNG-INFOLINK-NNAVI
Function
ActivateReady
ActivateWithData
ChangeWidgetManager
GetAppKey
GetDUID
GetFirmware
GetModelCode
GetPath
GetRemoconType
GetServerType
GetSupportPIG
GetSystemVersion
GetToken
ResetWidgetData
SendEventToDevice
SetBannerState
Event none
Enumeration
PL_NNAVI_PATH
PL_NNAVI_SYSTEM_VERSION
PL_ST
Top
Top
3.13. PLAYER
Player
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 25
Plugin for multimedia playback.
Latest Version PLAYER-0006
CLSID clsid:SAMSUNG-INFOLINK-PLAYER
Function
ClearScreen
GetAvailableBitrates
GetCurrentBitrates
GetDuration
GetPlayerVersion
GetVideoHeight
GetVideoWidth
InitPlayer
JumpBackward
JumpForward
Pause
Play
Resume
ResumePlay
SetCropArea
SetDisplayArea
SetICT
SetInitialBuffer
SetInitialTimeOut
SetMacrovision
SetPendingBuffer
SetPlaybackSpeed
SetTotalBufferSize
SetVBIData
StartPlayback
Stop
Event
OnAdEnd
OnAdStart
OnAuthenticationFailed
OnBufferingComplete
OnBufferingProgress
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 26
OnBufferingStart
OnConnectionFailed
OnCurrentPlayTime
OnNetworkDisconnected
OnRenderError
OnRenderingComplete
OnResolutionChanged
OnStreamInfoReady
OnStreamNotFound
Enumeration none
Top
Top
3.14. Screen
Screen
Screen Plugin deals with screen functions of TV ( ex : 3DEffect )
Latest Version SCREEN-0004
CLSID clsid:SAMSUNG-INFOLINK-SCREEN
Function
Check3DEffectMode
Flag3DEffectSupport
Get3DEffectMode
GetOption
Set3DEffectMode
Event none
Enumeration
PL_SCREEN_3DEFFECT_MODE
PL_SCREEN_OPTION
Top
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 27
3.15. TaskManager
TaskManager
TaskManager plugin deals with intertask action of TV ( ex : GetActiveApplication etc... )
Latest Version TASKMANAGER-0003
CLSID clsid:SAMSUNG-INFOLINK-TASKMANAGER
Function
ActivateApplication
GetActiveApplication
GetBgApplication
SetBgApplication
Event none
Enumeration PL_TASKMANAGER_DTVAPP
Top
3.16. Time
Time
Time plugin deals with time functions of TV ( ex : GetEpochTime, etc... )
Latest Version TIME-0001
CLSID clsid:SAMSUNG-INFOLINK-TIME
Function
ConvertEpochToLocalTime
GetEpochTime
Event none
Enumeration none
Top
3.17. TV
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 28
TV
TV Plugin deals with basic functions of TV ( ex : EPG, Callback event, etc... )
Latest Version TV-0011
CLSID clsid:SAMSUNG-INFOLINK-TV
Function
CheckPIP
FlagStreamDST
GetBDProductType
GetCountry
GetDisplayPanelType
GetDST
GetLanguage
GetLanguageSet
GetPIP
GetPresentProgram_Duration
GetPresentProgram_EndTime
GetPresentProgram_StartTime
GetPresentProgram_Title
GetProductCode
GetProductType
GetProgram_Duration
GetProgram_EndTime
GetProgram_StartTime
GetProgram_Title
GetProgramList
GetProgramList_Size
GetTargetLocation
GetTimeZone
GetTimeZone_Offset
SetEvent
SetPIP
UnsetEvent
Event OnEvent
Enumeration PL_TV_BDPRODUCT_TYPE
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 29
PL_TV_COUNTRY
PL_TV_DISPLAY_PANEL
PL_TV_DST_TYPE
PL_TV_EVENT
PL_TV_FACTORY_LANGUAGE
PL_TV_LANGUAGE
PL_TV_PRODUCT_TYPE
PL_TV_TARGET_LOCATION
PL_TV_TIMEZONE
Top
3.18. TVMW
TVMW
TVMW module supports to control various functionality about basic application, language, contry, input source(TV,
HDME, etc.), key registration, etc. in DTV platform.
Latest Version TVMW-0027
CLSID clsid:SAMSUNG-INFOLINK-TVMW
Function
CheckReservedKey (Replaced)
Deactivate (Replaced)
GetActiveApp (Replaced)
GetBGApp (Replaced)
GetCountry (Replaced)
GetLanguage (Replaced)
GetProfile
GetSource (Replaced)
GetTVUseMode (Replaced)
IsRegisteredKey (Replaced)
RegForBGApp (Replaced)
RegisterKey (Replaced)
RegisterKeyGroup (Replaced)
SendKeyToTVViewer (Replaced)
SetProfile
SetSource (Replaced)
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 30
SetWatchDog (Replaced)
UnregForBGApp (Replaced)
UnregisterKey (Replaced)
UnregisterKeyGroup (Replaced)
Event none
Enumeration
PL_TVMW_COUNTRY (Replaced)
PL_TVMW_DTVAPP (Replaced)
PL_TVMW_KEY (Replaced)
PL_TVMW_KEY_GRP (Replaced)
PL_TVMW_LANGUAGE (Replaced)
PL_TVMW_PRFID
PL_TVMW_SOURCE (Replaced)
PL_TVMW_TVUT (Replaced)
PL_TVMW_WATCHDOG (Replaced)
Top
3.19. VIDEO
Video
Video module supports to control Video relative functions in DTV platform. (ex: Screen state, etc.)
Latest Version VIDEO-0005
CLSID clsid:SAMSUNG-INFOLINK-VIDEO
Function
ChangeWidgetMode
SetFrameRate (Replaced)
SetOSDState
Event none
Enumeration PL_VIDEO_WIDGET_MODE
Top
3.20. WINDOW
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 31
Window
Window Plugin deals with basic functions of TV ( ex : Screen, Channel, etc... )
Latest Version WINDOW-0005
CLSID clsid:SAMSUNG-INFOLINK-WINDOW
Function
CheckScreenRect_PosSizeMode
GetCurrentChannel_Major
GetCurrentChannel_Minor
GetCurrentChannel_Name
GetCurrentChannel_OriginNetID
GetCurrentChannel_ProgramNumber
GetCurrentChannel_PTC
GetCurrentChannel_ServiceName
GetCurrentChannel_Type
GetResolution
GetScreenRect
GetScreenRect_PosMode
GetScreenRect_SizeMode
GetSource
GetState_Show
SetSource
Event none
Enumeration
PL_WINDOW_CHANNEL_TYPE
PL_WINDOW_NAVIGATOR_MODE
PL_WINDOW_POSITION_MODE
PL_WINDOW_RECT_SIZE_MODE
PL_WINDOW_RESOLUTION
PL_WINDOW_SEEK
PL_WINDOW_SHOW_STATE
PL_WINDOW_SHOW_TYPE
PL_WINDOW_SOURCE
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 32
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 33
p
4. DeviceAPI Functions Detail
4.1. COMMON
4.1.1. Function
4.1.1.1. GetPluginInfo
Function
GetPluginInfo
GetPluginInfo get DeviceAPI Info
Syntax GetPluginInfo( )
Parameter none
Return Value If success, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks none
Example versionMsg = pluginObject.GetPluginInfo(PL_CMN_INFO_VERSION);
Enumeration PL_CMN_INFO
Version none
Security Type none
Top
4.1.2. Enumeration
4.1.2.1. Number
Enumeration
Number
Interger Type( not real number)
Remarks none
Emulator
remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 34
Function
Value none
Top
4.1.2.2. PL_CMN__INFO
Enumeration
PL_CMN_INFO
DeviceAPI common information
Remarks none
Emulator
remarks none
Function GetPluginInfo
Value
0 - PL_CMN_INFO_VERSION
o Plugin version
Top
4.1.2.3. String
Enumeration
String
String Type
Remarks none
Emulator
remarks none
Function
Value none
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 35
4.2. AppCommon
4.2.1. Function
4.2.1.1. CheckReservedKey
Function
CheckReservedKey
CheckReservedKey function return whether TVViewer reserve this key or not.
Syntax CheckReservedKey( PL_APPCOMMON_KEY key )
Parameter
key
o PL_APPCOMMON_KEY
o
Return Value
If reserved, returns 1.
If not reserved, reutrn 0.
Otherwise, returns error code.
Remarks none
Emulator
remarks Only returns true
Example
if( 1 == AppCommonPlugin.CheckReservedKey(key) )
{
AppCommonPlugin.SendKeyToTVViewer(key);
}
Enumeration none
Version Support from APPCOMMON-0010
Security Type TVInfo
Top
4.2.1.2. IsKeyRegister
Function
IsKeyRegister
IsKeyRegister function returns whether a key is registered or not
Syntax IsKeyRegister( )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 36
Parameter none
Return
Value
If registered, return 1,
If not registered, return 0,
If function fails, returns negative value
Remarks none
Emulator
remarks Only returns true
Example
function OnLoadFunc()
{
AppCommonPlugin = document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
if( 0 ==
AppCommonPlugin.IsKeyRegister(PL_APPCOMMON_KEY_JOYSTICK_OK) )
{
AppCommonPlugin.RegisterNumberKey(PL_APPCOMMON_KEY_JOYST
ICK_OK);
}
}
Enumerati
on none
Version Support from APPCOMMON-0004
Security
Type TVInfo
Top
4.2.1.3. RegisterAllKey
Function
RegisterAllKey
RegisterAllKey function register all key
Syntax RegisterAllKey( )
Parameter none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 37
Return Value If success, returns positive value
otherwise, returns negative value
Remarks You can receive only registered keys
Emulator
remarks You can receive all keys without registering keys.
Example
function OnLoadFunc()
{
AppCommonPlugin =
document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.RegisterAllKey();
}
Enumeration none
Version Support from APPCOMMON-0004
Security Type TVInfo
Top
4.2.1.4. RegisterColorKey
Function
RegisterColorKey
RegisterColorKey function register color keys
Syntax RegisterColorKey( )
Parameter none
Return Value If success, returns positive value
otherwise, returns negative value
Remarks You can receive only registered keys.
Navigation keys are KEY_GREEN, KEY_YELLOW, KEY_CYAN,KEY_RED
Emulator
remarks You can receive all keys without registering keys.
Example
function OnLoadFunc()
{
AppCommonPlugin =
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 38
document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.RegisterNumberKey();
AppCommonPlugin.RegisterNaviKey();
AppCommonPlugin.RegisterColorKey();
AppCommonPlugin.RegisterPlaybackKey();
}
Enumeration none
Version Support from APPCOMMON-0004
Security Type TVInfo
Top
4.2.1.5. RegisterKey
Function
RegisterKey
RegisterKey function register key
Syntax RegisterKey( PL_APPCOMMON_KEY key )
Parameter
key
o PL_APPCOMMON_KEY
o key value
Return
Value
If success, returns positive value
otherwise, returns negative value
Remarks You can receive only registered keys.
Emulator
remarks You can receive all keys without registering keys.
Example
function OnLoadFunc()
{
AppCommonPlugin = document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.RegisterKey(PL_APPCOMMON_KEY_JOYSTICK_O
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 39
K);
AppCommonPlugin.RegisterKey(PL_APPCOMMON_KEY_JOYSTICK_U
P);
AppCommonPlugin.RegisterKey(PL_APPCOMMON_KEY_JOYSTICK_D
OWN);
AppCommonPlugin.RegisterKey(PL_APPCOMMON_KEY_JOYSTICK_L
EFT);
AppCommonPlugin.RegisterKey(PL_APPCOMMON_KEY_JOYSTICK_RI
GHT);
}
Enumeratio
n none
Version Support from APPCOMMON-0004
Security
Type TVInfo
Top
4.2.1.6. RegisterNaviKey
Function
RegisterNaviKey
RegisterNaviKey function register navigation keys
Syntax RegisterNaviKey( )
Parameter none
Return Value If success, returns positive value
otherwise, returns negative value
Remarks
You can receive only registered keys.
Navigation keys are KEY_JOYSTICK_OK, KEY_JOYSTICK_UP, KEY_JOYSTICK_DOWN,
KEY_JOYSTICK_LEFT, KEY_JOYSTICK_RIGHT, KEY_WHEEL_LEFT,
KEY_WHEEL_RIGHT
Emulator
remarks You can receive all keys without registering keys.
Example function OnLoadFunc()
{
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 40
AppCommonPlugin =
document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.RegisterNumberKey();
AppCommonPlugin.RegisterNaviKey();
AppCommonPlugin.RegisterColorKey();
AppCommonPlugin.RegisterPlaybackKey();
}
Enumeration none
Version Support from APPCOMMON-0004
Security Type TVInfo
Top
4.2.1.7. RegisterNumKey
Function
RegisterNumKey
RegisterNumKey function register number keys
Syntax RegisterNumKey( )
Parameter none
Return Value If success, returns positive value
otherwise, returns negative value
Remarks You can receive only registered keys.
Number keys are KEY_0 ~ KEY_9
Emulator
remarks You can receive all keys without registering keys.
Example
function OnLoadFunc()
{
AppCommonPlugin =
document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.RegisterNumberKey();
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 41
AppCommonPlugin.RegisterNaviKey();
AppCommonPlugin.RegisterColorKey();
AppCommonPlugin.RegisterPlaybackKey();
}
Enumeration none
Version Support from APPCOMMON-0004
Security Type TVInfo
Top
4.2.1.8. RegisterPlaybackKey
Function
RegisterPlaybackKey
RegisterPlaybackKey function register color keys
Syntax RegisterPlaybackKey( )
Parameter none
Return Value If success, returns positive value
otherwise, returns negative value
Remarks
You can receive only registered keys.
Navigation keys are KEY_REWIND, KEY_STOP, KEY_PLAY,
KEY_FF, KEY_REC, KEY_PAUSE
Emulator
remarks You can receive all keys without registering keys.
Example
function OnLoadFunc()
{
AppCommonPlugin =
document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.RegisterNumberKey();
AppCommonPlugin.RegisterNaviKey();
AppCommonPlugin.RegisterColorKey();
AppCommonPlugin.RegisterPlaybackKey();
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 42
Enumeration none
Version Support from APPCOMMON-0004
Security Type TVInfo
Top
4.2.1.9. SendEvent_IME
Function
SendEvent_IME
SendEvent_IME function start and stop sending key input to external device(ex : handset, mp3)
when key is inputed between start and stop, that key is sent to external device.
Syntax SendEvent_IME( Number nStart , Number inputType , Number charProsessingType ,
Number extraOption )
Parameter
nStart
o Number
o 1: start, 0: stop
inputType
o Number
o 1: Input, 2: TEXTAREA, 4: PASSWORD
charProsessingType
o Number
o 8 : CharByChar, 16 : FullString
extraOption
o Number
o 32 : JoysticKey, 64 : NumberKey, 128 : SpecialKey, 256 : NumberKey
Return Value If success, returns 1.
Otherwise, returns error code.
Remarks none
Emulator
remarks none
Example
if( 1 == AppCommonPlugin.CheckReservedKey(key) )
{
AppCommonPlugin.SendKeyToTVViewer(key);
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 43
Enumeration none
Version Support from APPCOMMON-0010
Security Type TVInfo
4.2.1.10. SendEvent_IME_Sync
Function
SendEvent_IME_Sync
SendEvent_IME_Sync function send string to external device(ex : handset, mp3) for sync
Syntax SendEvent_IME_Sync( String string )
Parameter
string
o String
o string to send to external device1: start(ex : handset, mp3)
Return Value If success, returns 1.
Otherwise, returns error code.
Remarks none
Emulator
remarks none
Example
OnKeyInputStartFromExternalDevice()
{
AppCommonPlugin.SendEvent_IME(1, 1, 8, 32);
}
OnKeyInputEndFromExternalDevice()
{
AppCommonPlugin.SendEvent_IME(0, 0, 0, 0); // When stop, only
first parameter is used.
}
OnSyncToExternalDevice()
{
AppCommonPlugin.SendEvent_IME_Sync(inputtext.value);
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 44
Enumeration none
Version Support from APPCOMMON-0010
Security Type TVInfo
Top
4.2.1.11. SendKeyToTVViewer
Function
SendKeyToTVViewer
SendKeyToTVViewer function send key to TVViewer.
Syntax SendKeyToTVViewer( PL_APPCOMMON_KEY key )
Parameter
key
o PL_APPCOMMON_KEY
o
Return Value If success, returns 1.
Otherwise, returns error code.
Remarks none
Emulator
remarks Only returns true.
Example
if( 1 == AppCommonPlugin.CheckReservedKey(key) )
{
AppCommonPlugin.SendKeyToTVViewer(key);
}
Enumeration none
Version Support from APPCOMMON-0010
Security Type TVInfo
Top
4.2.1.12. SubscribeEvent
Function
SubscribeEvent
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 45
SubscribeEvent function registers message to receive callback
Syntax SubscribeEvent( PL_APPCOMMON_MESSAGE message )
Parameter
message
o PL_APPCOMMON_MESSAGE
o Message to register
Return
Value
If success, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks none
Example
function OnLoadFunc()
{
document.getElementById(categoryID + '1').focus();
AppCommonPlugin = document.getElementById('PluginAppCommon');
AppCommonPlugin.SubscribeEvent(PL_APPCOMMON_MESSAGE_INPU
T_OCCUR);
AppCommonPlugin.OnMessage = OnMessage;
}
function OnUnloadFunc()
{
AppCommonPlugin.UnsubscribeEvent(PL_APPCOMMON_MESSAGE_INP
UT_OCCUR);
}
function OnMessage(id)
{
alert("OnMessage id=[" + id + "]");
switch( parseInt(id) )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 46
{
case PL_APPCOMMON_MESSAGE_IME_INPUT:
{
alert('PL_APPCOMMON_MESSAGE_IME_INPUT');
document.getElementById('OnMessage').value = "[" + id
+ "]";
break;
}
}
}
Enumerati
on
PL_APPCOMMON_MESSAGE
Version Support from APPCOMMON-0001
Security
Type TVInfo
Top
4.2.1.13. UnregisterAllKey
Function
UnregisterAllKey
UnregisterAllKey function unregister all key
Syntax UnregisterAllKey( )
Parameter none
Return Value If success, returns positive value
otherwise, returns negative value
Remarks You can receive only registered keys
Emulator
remarks None
Example
function OnUnloadFunc()
{
AppCommonPlugin =
document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 47
AppCommonPlugin.UnregisterAllKey();
}
Enumeration none
Version Support from APPCOMMON-0004
Security Type TVInfo
Top
4.2.1.14. UnregisterColorKey
Function
UnregisterColorKey
UnregisterColorKey function unregister color keys
Syntax UnregisterColorKey( )
Parameter none
Return Value If success, returns positive value
otherwise, returns negative value
Remarks You can receive only registered keys.
Navigation keys are KEY_GREEN, KEY_YELLOW, KEY_CYAN,KEY_RED
Emulator
remarks You can receive all keys without registering key.
Example
function OnLoadFunc()
{
AppCommonPlugin =
document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.UnregisterNumberKey();
AppCommonPlugin.UnregisterNaviKey();
AppCommonPlugin.UnregisterColorKey();
AppCommonPlugin.UnregisterPlaybackKey();
}
Enumeration none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 48
Version Support from APPCOMMON-0004
Security Type TVInfo
Top
4.2.1.15. UnregisterKey
Function
UnregisterKey
UnregisterKey function unregister key
Syntax UnregisterKey( PL_APPCOMMON_KEY key )
Parameter
key
o PL_APPCOMMON_KEY
o key value
Return
Value
If success, returns positive value
otherwise, returns negative value
Remarks You can receive only registered keys.
Emulator
remarks You can receive all keys without registering key.
Example
function OnLoadFunc()
{
AppCommonPlugin = document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.UnregisterKey(PL_APPCOMMON_KEY_JOYSTICK_
OK);
AppCommonPlugin.UnregisterKey(PL_APPCOMMON_KEY_JOYSTICK_
UP);
AppCommonPlugin.UnregisterKey(PL_APPCOMMON_KEY_JOYSTICK_
DOWN);
AppCommonPlugin.UnregisterKey(PL_APPCOMMON_KEY_JOYSTICK_
LEFT);
AppCommonPlugin.UnregisterKey(PL_APPCOMMON_KEY_JOYSTICK_
RIGHT);
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 49
Enumeratio
n none
Version Support from APPCOMMON-0004
Security
Type TVInfo
Top
4.2.1.16. UnregisterNaviKey
Function
UnregisterNaviKey
UnregisterNaviKey function unregister navigation keys
Syntax UnregisterNaviKey( )
Parameter none
Return Value If success, returns positive value
otherwise, returns negative value
Remarks
You can receive only registered keys.
Navigation keys are KEY_JOYSTICK_OK, KEY_JOYSTICK_UP, KEY_JOYSTICK_DOWN,
KEY_JOYSTICK_LEFT, KEY_JOYSTICK_RIGHT, KEY_WHEEL_LEFT,
KEY_WHEEL_RIGHT
Emulator
remarks You can receive all keys without registering key.
Example
function OnLoadFunc()
{
AppCommonPlugin =
document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.UnregisterNumberKey();
AppCommonPlugin.UnregisterNaviKey();
AppCommonPlugin.UnregisterColorKey();
AppCommonPlugin.UnregisterPlaybackKey();
}
Enumeration none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 50
Version Support from APPCOMMON-0004
Security Type TVInfo
Top
4.2.1.17. UnregisterNumKey
Function
UnregisterNumKey
UnregisterNumKey function unregister number keys
Syntax UnregisterNumKey( )
Parameter none
Return Value If success, returns positive value
otherwise, returns negative value
Remarks You can receive only registered keys.
Number keys are KEY_0 ~ KEY_9
Emulator
remarks You can receive all keys without registering key.
Example
function OnLoadFunc()
{
AppCommonPlugin =
document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.UnregisterNumberKey();
AppCommonPlugin.UnregisterNaviKey();
AppCommonPlugin.UnregisterColorKey();
AppCommonPlugin.UnregisterPlaybackKey();
}
Enumeration none
Version Support from APPCOMMON-0004
Security Type TVInfo
Top
4.2.1.18. UnregisterPlaybackKey
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 51
Function
UnregisterPlaybackKey
UnregisterPlaybackKey function unregister color keys
Syntax UnregisterPlaybackKey( )
Parameter none
Return Value If success, returns positive value
otherwise, returns negative value
Remarks
You can receive only registered keys.
Navigation keys are KEY_REWIND, KEY_STOP, KEY_PLAY,
KEY_FF, KEY_REC, KEY_PAUSE
Emulator
remarks You can receive all keys without registering key.
Example
function OnLoadFunc()
{
AppCommonPlugin =
document.getElementById('PluginAppCommon');
document.getElementById(categoryID + '1').focus();
AppCommonPlugin.UnregisterNumberKey();
AppCommonPlugin.UnregisterNaviKey();
AppCommonPlugin.UnregisterColorKey();
AppCommonPlugin.UnregisterPlaybackKey();
}
Enumeration none
Version Support from APPCOMMON-0004
Security Type TVInfo
Top
4.2.1.19. UnsubscribeEvent
Function
UnsubscribeEvent
UnsubscribeEvent function unregisters message to receive callback
Syntax UnsubscribeEvent( PL_APPCOMMON_MESSAGE message )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 52
Parameter
message
o PL_APPCOMMON_MESSAGE
o Message to unregister
Return
Value
If success, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks none
Example
function OnLoadFunc()
{
document.getElementById(categoryID + '1').focus();
AppCommonPlugin = document.getElementById('PluginAppCommon');
AppCommonPlugin.SubscribeEvent(PL_APPCOMMON_MESSAGE_INPU
T_OCCUR);
AppCommonPlugin.OnMessage = OnMessage;
}
function OnUnloadFunc()
{
AppCommonPlugin.UnsubscribeEvent(PL_APPCOMMON_MESSAGE_INP
UT_OCCUR);
}
function OnMessage(id)
{
alert("OnMessage id=[" + id + "]");
switch( parseInt(id) )
{
case PL_APPCOMMON_MESSAGE_IME_INPUT:
{
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 53
alert('PL_APPCOMMON_MESSAGE_IME_INPUT');
document.getElementById('OnMessage').value = "[" + id
+ "]";
break;
}
}
}
Enumerati
on
PL_APPCOMMON_MESSAGE
Version Support from APPCOMMON-0001
Security
Type TVInfo
Top
4.2.2. Enumeration
4.2.2.1. PL_APPCOMMON_KEY
Enumeration
PL_APPCOMMON_KEY
none
Remarks none
Emulator
remarks none
Function
Value
29443 - PL_APPCOMMON_KEY_JOYSTICK_OK
262 - PL_APPCOMMON_KEY_MENU
29460 - PL_APPCOMMON_KEY_JOYSTICK_UP
29461 - PL_APPCOMMON_KEY_JOYSTICK_DOWN
4 - PL_APPCOMMON_KEY_JOYSTICK_LEFT
5 - PL_APPCOMMON_KEY_JOYSTICK_RIGHT
6 - PL_APPCOMMON_KEY_3
7 - PL_APPCOMMON_KEY_VOLUP
8 - PL_APPCOMMON_KEY_4
9 - PL_APPCOMMON_KEY_5
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 54
10 - PL_APPCOMMON_KEY_6
11 - PL_APPCOMMON_KEY_VOLDOWN
12 - PL_APPCOMMON_KEY_7
13 - PL_APPCOMMON_KEY_8
14 - PL_APPCOMMON_KEY_9
27 - PL_APPCOMMON_KEY_MUTE
65 - PL_APPCOMMON_KEY_CHDOWN
17 - PL_APPCOMMON_KEY_0
68 - PL_APPCOMMON_KEY_CHUP
259 - PL_APPCOMMON_KEY_PRECH
20 - PL_APPCOMMON_KEY_GREEN
21 - PL_APPCOMMON_KEY_YELLOW
22 - PL_APPCOMMON_KEY_CYAN
1023 - PL_APPCOMMON_KEY_STEP
1024 - PL_APPCOMMON_KEY_DEL
1025 - PL_APPCOMMON_KEY_ADDDEL
222 - PL_APPCOMMON_KEY_SOURCE
77 - PL_APPCOMMON_KEY_TV
1028 - PL_APPCOMMON_KEY_AUTO
1029 - PL_APPCOMMON_KEY_MOIP
1030 - PL_APPCOMMON_KEY_PMENU
31 - PL_APPCOMMON_KEY_INFO
1032 - PL_APPCOMMON_KEY_PIP_ONOFF
1033 - PL_APPCOMMON_KEY_PIP_SWAP
1034 - PL_APPCOMMON_KEY_PIP_ROTATE
35 - PL_APPCOMMON_KEY_PLUS100
1036 - PL_APPCOMMON_KEY_PIP_INPUT
652 - PL_APPCOMMON_KEY_CAPTION
1038 - PL_APPCOMMON_KEY_PIP_STILL
1039 - PL_APPCOMMON_KEY_AD
1040 - PL_APPCOMMON_KEY_PMODE
1041 - PL_APPCOMMON_KEY_SOUND_MODE
1042 - PL_APPCOMMON_KEY_NR
1043 - PL_APPCOMMON_KEY_SMODE
650 - PL_APPCOMMON_KEY_TTX_MIX
45 - PL_APPCOMMON_KEY_EXIT
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 55
1046 - PL_APPCOMMON_KEY_ENTER
1047 - PL_APPCOMMON_KEY_PIP_SIZE
1048 - PL_APPCOMMON_KEY_MAGIC_CHANNEL
1049 - PL_APPCOMMON_KEY_PIP_SCAN
1050 - PL_APPCOMMON_KEY_PIP_CHUP
1051 - PL_APPCOMMON_KEY_PIP_CHDOWN
1052 - PL_APPCOMMON_KEY_DEVICE_CONNECT
1053 - PL_APPCOMMON_KEY_HELP
1054 - PL_APPCOMMON_KEY_ANTENA
1055 - PL_APPCOMMON_KEY_CONVERGENCE
73 - PL_APPCOMMON_KEY_11
1057 - PL_APPCOMMON_KEY_12
1058 - PL_APPCOMMON_KEY_AUTO_PROGRAM
1059 - PL_APPCOMMON_KEY_FACTORY
1060 - PL_APPCOMMON_KEY_3SPEED
1061 - PL_APPCOMMON_KEY_RSURF
653 - PL_APPCOMMON_KEY_ASPECT
1063 - PL_APPCOMMON_KEY_EMANUAL
1064 - PL_APPCOMMON_KEY_GAME
1065 - PL_APPCOMMON_KEY_QUICK_REPLAY
1066 - PL_APPCOMMON_KEY_STILL_PICTURE
1067 - PL_APPCOMMON_KEY_DTV
256 - PL_APPCOMMON_KEY_FAVCH
69 - PL_APPCOMMON_KEY_REWIND
70 - PL_APPCOMMON_KEY_STOP
71 - PL_APPCOMMON_KEY_PLAY
72 - PL_APPCOMMON_KEY_FF
192 - PL_APPCOMMON_KEY_REC
74 - PL_APPCOMMON_KEY_PAUSE
115 - PL_APPCOMMON_KEY_TOOLS
1076 - PL_APPCOMMON_KEY_INSTANT_REPLAY
1077 - PL_APPCOMMON_KEY_LINK
1078 - PL_APPCOMMON_KEY_FF_
651 - PL_APPCOMMON_KEY_GUIDE
1080 - PL_APPCOMMON_KEY_REWIND_
1081 - PL_APPCOMMON_KEY_ANGLE
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 56
1082 - PL_APPCOMMON_KEY_RESERVED1
1083 - PL_APPCOMMON_KEY_ZOOM1
1084 - PL_APPCOMMON_KEY_PROGRAM
1085 - PL_APPCOMMON_KEY_BOOKMARK
1086 - PL_APPCOMMON_KEY_DISC_MENU
1087 - PL_APPCOMMON_KEY_PRINT
88 - PL_APPCOMMON_KEY_RETURN
1089 - PL_APPCOMMON_KEY_SUB_TITLE
1090 - PL_APPCOMMON_KEY_CLEAR
1091 - PL_APPCOMMON_KEY_VCHIP
78 - PL_APPCOMMON_KEY_REPEAT
1093 - PL_APPCOMMON_KEY_DOOR
1094 - PL_APPCOMMON_KEY_OPEN
29468 - PL_APPCOMMON_KEY_WHEEL_LEFT
76 - PL_APPCOMMON_KEY_POWER
1097 - PL_APPCOMMON_KEY_SLEEP
98 - PL_APPCOMMON_KEY_2
1099 - PL_APPCOMMON_KEY_DMA
1100 - PL_APPCOMMON_KEY_TURBO
101 - PL_APPCOMMON_KEY_1
1102 - PL_APPCOMMON_KEY_FM_RADIO
1103 - PL_APPCOMMON_KEY_DVR_MENU
655 - PL_APPCOMMON_KEY_MTS
1105 - PL_APPCOMMON_KEY_PCMODE
1106 - PL_APPCOMMON_KEY_TTX_SUBFACE
84 - PL_APPCOMMON_KEY_CH_LIST
108 - PL_APPCOMMON_KEY_RED
1109 - PL_APPCOMMON_KEY_DNIe
654 - PL_APPCOMMON_KEY_SRS
1111 - PL_APPCOMMON_KEY_CONVERT_AUDIO_MAINSUB
1112 - PL_APPCOMMON_KEY_MDC
1113 - PL_APPCOMMON_KEY_SEFFECT
1114 - PL_APPCOMMON_KEY_DVR
1115 - PL_APPCOMMON_KEY_DTV_SIGNAL
1116 - PL_APPCOMMON_KEY_LIVE
1117 - PL_APPCOMMON_KEY_PERPECT_FOCUS
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 57
1118 - PL_APPCOMMON_KEY_HOME
1119 - PL_APPCOMMON_KEY_ESAVING
29469 - PL_APPCOMMON_KEY_WHEEL_RIGHT
261 - PL_APPCOMMON_KEY_CONTENTS
1122 - PL_APPCOMMON_KEY_VCR_MODE
1123 - PL_APPCOMMON_KEY_CATV_MODE
1124 - PL_APPCOMMON_KEY_DSS_MODE
1125 - PL_APPCOMMON_KEY_TV_MODE
1126 - PL_APPCOMMON_KEY_DVD_MODE
1127 - PL_APPCOMMON_KEY_STB_MODE
1128 - PL_APPCOMMON_KEY_CALLER_ID
1129 - PL_APPCOMMON_KEY_SCALE
1130 - PL_APPCOMMON_KEY_ZOOM_MOVE
1131 - PL_APPCOMMON_KEY_CLOCK_DISPLAY
1132 - PL_APPCOMMON_KEY_AV1
1133 - PL_APPCOMMON_KEY_SVIDEO1
1134 - PL_APPCOMMON_KEY_COMPONENT1
1135 - PL_APPCOMMON_KEY_SETUP_CLOCK_TIMER
1136 - PL_APPCOMMON_KEY_COMPONENT2
1137 - PL_APPCOMMON_KEY_MAGIC_BRIGHT
1138 - PL_APPCOMMON_KEY_DVI
1139 - PL_APPCOMMON_KEY_HDMI
115 - PL_APPCOMMON_KEY_W_LINK
1141 - PL_APPCOMMON_KEY_DTV_LINK
1142 - PL_APPCOMMON_KEY_RESERVED5
118 - PL_APPCOMMON_KEY_APP_LIST
1144 - PL_APPCOMMON_KEY_BACK_MHP
1145 - PL_APPCOMMON_KEY_ALT_MHP
1146 - PL_APPCOMMON_KEY_DNSe
147 - PL_APPCOMMON_KEY_RSS
653 - PL_APPCOMMON_KEY_ENTERTAINMENT
1149 - PL_APPCOMMON_KEY_ID_INPUT
1150 - PL_APPCOMMON_KEY_ID_SETUP
1151 - PL_APPCOMMON_KEY_ANYNET
1152 - PL_APPCOMMON_KEY_POWEROFF
1153 - PL_APPCOMMON_KEY_POWERON
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 58
1154 - PL_APPCOMMON_KEY_ANYVIEW
1155 - PL_APPCOMMON_KEY_MS
1156 - PL_APPCOMMON_KEY_MORE
614 - PL_APPCOMMON_KEY_PANNEL_POWER
105 - PL_APPCOMMON_KEY_PANNEL_CHUP
106 - PL_APPCOMMON_KEY_PANNEL_CHDOWN
203 - PL_APPCOMMON_KEY_PANNEL_VOLUP
204 - PL_APPCOMMON_KEY_PANNEL_VOLDOWN
309 - PL_APPCOMMON_KEY_PANNEL_ENTER
613 - PL_APPCOMMON_KEY_PANNEL_MENU
612 - PL_APPCOMMON_KEY_PANNEL_SOURCE
1165 - PL_APPCOMMON_KEY_AV2
1166 - PL_APPCOMMON_KEY_AV3
1167 - PL_APPCOMMON_KEY_SVIDEO2
1168 - PL_APPCOMMON_KEY_SVIDEO3
1169 - PL_APPCOMMON_KEY_ZOOM2
1170 - PL_APPCOMMON_KEY_PANORAMA
1171 - PL_APPCOMMON_KEY_4_3
1172 - PL_APPCOMMON_KEY_16_9
1173 - PL_APPCOMMON_KEY_DYNAMIC
1174 - PL_APPCOMMON_KEY_STANDARD
1175 - PL_APPCOMMON_KEY_MOVIE1
1176 - PL_APPCOMMON_KEY_CUSTOM
1177 - PL_APPCOMMON_KEY_AUTO_ARC_RESET
1178 - PL_APPCOMMON_KEY_AUTO_ARC_LNA_ON
1179 - PL_APPCOMMON_KEY_AUTO_ARC_LNA_OFF
1180 - PL_APPCOMMON_KEY_AUTO_ARC_ANYNET_MODE_OK
1181 - PL_APPCOMMON_KEY_AUTO_ARC_ANYNET_AUTO_START
1182 - PL_APPCOMMON_KEY_AUTO_FORMAT
1183 - PL_APPCOMMON_KEY_DNET
1184 - PL_APPCOMMON_KEY_HDMI1
1185 - PL_APPCOMMON_KEY_AUTO_ARC_CAPTION_ON
1186 - PL_APPCOMMON_KEY_AUTO_ARC_CAPTION_OFF
1187 - PL_APPCOMMON_KEY_AUTO_ARC_PIP_DOUBLE
1188 - PL_APPCOMMON_KEY_AUTO_ARC_PIP_LARGE
1189 - PL_APPCOMMON_KEY_AUTO_ARC_PIP_SMALL
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 59
1190 - PL_APPCOMMON_KEY_AUTO_ARC_PIP_WIDE
1191 - PL_APPCOMMON_KEY_AUTO_ARC_PIP_LEFT_TOP
1192 - PL_APPCOMMON_KEY_AUTO_ARC_PIP_RIGHT_TOP
1193 - PL_APPCOMMON_KEY_AUTO_ARC_PIP_LEFT_BOTTOM
1194 - PL_APPCOMMON_KEY_AUTO_ARC_PIP_RIGHT_BOTTOM
1195 - PL_APPCOMMON_KEY_AUTO_ARC_PIP_CH_CHANGE
1196 - PL_APPCOMMON_KEY_AUTO_ARC_AUTOCOLOR_SUCCESS
1197 - PL_APPCOMMON_KEY_AUTO_ARC_AUTOCOLOR_FAIL
1198 - PL_APPCOMMON_KEY_AUTO_ARC_C_FORCE_AGING
1199 - PL_APPCOMMON_KEY_AUTO_ARC_USBJACK_INSPECT
1200 - PL_APPCOMMON_KEY_AUTO_ARC_JACK_IDENT
1201 - PL_APPCOMMON_KEY_NINE_SEPERATE
1202 - PL_APPCOMMON_KEY_ZOOM_IN
1203 - PL_APPCOMMON_KEY_ZOOM_OUT
1204 - PL_APPCOMMON_KEY_MIC
1205 - PL_APPCOMMON_KEY_HDMI2
1206 - PL_APPCOMMON_KEY_HDMI3
1207 - PL_APPCOMMON_KEY_AUTO_ARC_CAPTION_KOR
1208 - PL_APPCOMMON_KEY_AUTO_ARC_CAPTION_ENG
1209 - PL_APPCOMMON_KEY_AUTO_ARC_PIP_SOURCE_CHANGE
1210 - PL_APPCOMMON_KEY_HDMI4
1211 - PL_APPCOMMON_KEY_AUTO_ARC_ANTENNA_AIR
1212 - PL_APPCOMMON_KEY_AUTO_ARC_ANTENNA_CABLE
1213 - PL_APPCOMMON_KEY_AUTO_ARC_ANTENNA_SATELLITE
1214 - PL_APPCOMMON_KEY_AUTO_ARC_CIP_TEST
1215 - PL_APPCOMMON_KEY_AUTO_ARC_CH_CHANGE
1216 - PL_APPCOMMON_KEY_AUTO_ARC_START_MBR_TEST
1217 - PL_APPCOMMON_KEY_TILT
1218 - PL_APPCOMMON_KEY_EZ_VIEW
1219 - PL_APPCOMMON_KEY_3D
1120 - PL_APPCOMMON_KEY_AUTO_ARC_PVR_RECORDING_TEST
1121 - PL_APPCOMMON_KEY_AUTO_ARC_PVR_PLAY_TEST
1122 - PL_APPCOMMON_KEY_AUTO_ARC_PVR_DELETE_ALL
1123 - PL_APPCOMMON_KEY_AUTO_ARC_HOTEL_INTERACTIVE
1124 - PL_APPCOMMON_KEY_D_LIST_UP
1125 - PL_APPCOMMON_KEY_D_LIST_DOWN
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 60
1126 - PL_APPCOMMON_KEY_D_ONDEMAND
1127 - PL_APPCOMMON_KEY_D_PANNEL_VIRTUAL_ENTER
1128 - PL_APPCOMMON_KEY_D_PANNEL_VIRTUAL_SOURCE
1129 - PL_APPCOMMON_KEY_D_REC_PAUSE
1130 - PL_APPCOMMON_KEY_D_CONTINUED_FF
1131 - PL_APPCOMMON_KEY_D_CONTINUED_RW
1132 - PL_APPCOMMON_KEY_D_CONTINUED_OFF
1133 - PL_APPCOMMON_KEY_D_CANCEL
1134 - PL_APPCOMMON_KEY_D_TITLE_MENU
1135 - PL_APPCOMMON_KEY_D_REPEAT_AB
1136 - PL_APPCOMMON_KEY_D_AUDIO
1137 - PL_APPCOMMON_KEY_D_REC_MODE
1138 - PL_APPCOMMON_KEY_D_USB
1239 - PL_APPCOMMON_KEY_D_HDD
1240 - PL_APPCOMMON_KEY_D_DISC
1241 - PL_APPCOMMON_KEY_D_TEST
1242 - PL_APPCOMMON_KEY_D_COPY
1243 - PL_APPCOMMON_KEY_D_FRONT_PLAY
1244 - PL_APPCOMMON_KEY_D_FRONT_STOP
1245 - PL_APPCOMMON_KEY_D_FRONT_FF
1246 - PL_APPCOMMON_KEY_D_FRONT_RW
1247 - PL_APPCOMMON_KEY_D_FRONT_REC
1248 - PL_APPCOMMON_KEY_D_VERSION_DISPLAY_KEU
1249 - PL_APPCOMMON_KEY_D_VIEW_MODE
1250 - PL_APPCOMMON_KEY_D_COLD_START
Top
4.2.2.2. PL_APPCOMMON_MESSAGE
Enumeration
PL_APPCOMMON_MESSAGE
none
Remarks none
Emulator
remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 61
Function
SubscribeEvent
UnsubscribeEvent
Value
0 - PL_APPCOMMON_MESSAGE_APP_DEACTIVE
o When App is deactivated
1 - PL_APPCOMMON_MESSAGE_APP_ACTIVE
o When App is activated
2 - PL_APPCOMMON_MESSAGE_APP_INITIALIZED
o Application initialize is done
3 - PL_APPCOMMON_MESSAGE_START_XLET_BY_APPLIST
o An xlet is started by Application list
4 - PL_APPCOMMON_MESSAGE_TIMEZONE_CHANGED
o Timezone is changed by Menu Application
5 - PL_APPCOMMON_MESSAGE_XLET_SHOW_STATE_CHANGE
o When xlet's show state was changed.
6 - PL_APPCOMMON_MESSAGE_JAM_INITIALIZED
7 - PL_APPCOMMON_MESSAGE_CHANGE_TV_MODE_START
8 - PL_APPCOMMON_MESSAGE_CHANGE_BURNPROOF_TIME
9 - PL_APPCOMMON_MESSAGE_CHANGE_DATASERVICE_AUTO_LAUNCH
10 - PL_APPCOMMON_MESSAGE_NOTIFY_BANNER_HIDE
11 - PL_APPCOMMON_MESSAGE_DATASERVICE_PREPARE
12 - PL_APPCOMMON_MESSAGE_DATASERVICE_RECEIVE
13 - PL_APPCOMMON_MESSAGE_DATASERVICE_ERROR
14 - PL_APPCOMMON_MESSAGE_DATASERVICE_HIDE
15 - PL_APPCOMMON_MESSAGE_POWER_ON_FROM_STANDBY
o About to power on from standby mode
16 - PL_APPCOMMON_MESSAGE_POWER_ON_BY_WAKEUP_UPGRADE
o About to power on from wakeup upgrade
17 - PL_APPCOMMON_MESSAGE_POWER_ON_BY_WAKEUP_STANDBY
o About to power on from wakeup standby
18 - PL_APPCOMMON_MESSAGE_NOTIFY_POWER_OFF
19 - PL_APPCOMMON_MESSAGE_RESET_TIME
o Occured when TVViewer received TCTv::EVENT_INITIALIZE_TIME.
20 - PL_APPCOMMON_MESSAGE_CHANGE_CHILDLOCK
o Occured when change Child Lock state
21 - PL_APPCOMMON_MESSAGE_CHANGE_RATING_BLOCK
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 62
o Occured when rating block state is changed
22 - PL_APPCOMMON_MESSAGE_CHANGE_AUDIO_LANGUAGE
o Occured when Audio Language is changed
23 - PL_APPCOMMON_MESSAGE_INPUT_OCCUR
o Occured when key is inputed. callback data format is [xxxxxxxx/yyyyyyyy
x..:MessageID y..:Key
24 - PL_APPCOMMON_MESSAGE_SWD_START
25 - PL_APPCOMMON_MESSAGE_SWD_END
26 - PL_APPCOMMON_MESSAGE_SWD_START_YES
27 - PL_APPCOMMON_MESSAGE_SWD_START_NO
28 - PL_APPCOMMON_MESSAGE_CC_DATA_SUBSCRIBE
29 - PL_APPCOMMON_MESSAGE_CC_DATA
30 - PL_APPCOMMON_MESSAGE_AUTO_MOTION_DEMO_ON
o Auto Motion Plus 120Hz Demo Start
31 - PL_APPCOMMON_MESSAGE_AUTO_MOTION_DEMO_OFF
o Auto Motion Plus 120Hz Demo Off
32 - PL_APPCOMMON_MESSAGE_MOVIE_PLUS_DEMO_ON
o Movie Plus Demo Start
33 - PL_APPCOMMON_MESSAGE_MOVIE_PLUS_DEMO_OFF
o Movie Plus Demo Off
34 - PL_APPCOMMON_MESSAGE_REAL_DEMO_ON
o Real Demo Start
35 - PL_APPCOMMON_MESSAGE_REAL_DEMO_OFF
o Real Demo Off
36 - PL_APPCOMMON_MESSAGE_LED_DEMO_ON
37 - PL_APPCOMMON_MESSAGE_LED_DEMO_OFF
38 - PL_APPCOMMON_MESSAGE_SMOOTHMOTION_DEMO_ON
39 - PL_APPCOMMON_MESSAGE_SMOOTHMOTION_DEMO_OFF
40 - PL_APPCOMMON_MESSAGE_WAKEUP_UPGRADE_START
41 - PL_APPCOMMON_MESSAGE_POWER_OFF_START
42 - PL_APPCOMMON_MESSAGE_REMIND_RECORD
43 - PL_APPCOMMON_MESSAGE_IME_INPUT_WAIT_START
44 - PL_APPCOMMON_MESSAGE_IME_INPUT_WAIT_END
45 - PL_APPCOMMON_MESSAGE_IME_INPUT
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 63
4.2.3. EVENT
4.2.3.1. OnMessage
Event
OnMessage
Use OnMessage when you receive message(PL_APPCOMMON) from AppCommon plugin
Paramet
er
data
o PL_APPCOMMON_MESSAGE
o xxxxxxxx[/yyyy] x.. : MessageID, yyyy : Optional data
Remarks none
Emulato
r
remarks
none
Example
function OnLoadFunc()
{
document.getElementById(categoryID + '1').focus();
AppCommonPlugin = document.getElementById('PluginAppCommon');
AppCommonPlugin.SubscribeEvent(PL_APPCOMMON_MESSAGE_INPUT
_OCCUR);
AppCommonPlugin.OnMessage = OnMessage;
}
function OnUnloadFunc()
{
AppCommonPlugin.UnsubscribeEvent(PL_APPCOMMON_MESSAGE_INPU
T_OCCUR);
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 64
function OnMessage(id)
{
alert("OnMessage id=[" + id + "]");
switch( parseInt(id) )
{
case PL_APPCOMMON_MESSAGE_IME_INPUT:
{
alert('PL_APPCOMMON_MESSAGE_IME_INPUT');
document.getElementById('OnMessage').value = "[" + id +
"]";
break;
}
}
}
Version APPCOMMON-0001
Top
Top
4.3. AUDIO
4.3.1. Function
4.3.1.1. CheckExternalOutMode
Function
CheckExternalOutMode
CheckExternalOutMode function check that external out mode can be changed to input value
Syntax CheckExternalOutMode( PL_AUDIO_AUDIO_OUT_MODE audioOutMode )
Parameter
audioOutMode
o PL_AUDIO_AUDIO_OUT_MODE
o PCM, DOLBY, DTS, ...
Return
Value
If success, returns 1.
Otherwise, returns a negative number.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 65
Remarks none
Emulator
remarks Only returns PLR_NOT_IMPLEMENT
Example
var audioOutMode = AudioPlugin.GetExternalOutMode();
alert("AudioPlugin.GetExternalOutMode() = " + audioOutMode);
if( audioOutMode == PL_AUDIO_AUDIO_OUT_MODE_PCM )
{
var checkAudioOutMode =
AudioPlugin.CheckExternalOutMode(PL_AUDIO_AUDIO_OUT_MODE_DOLBY)
;
alert("AudioPlugin.CheckExternalOutMode(1) = " + checkAudioOutMode);
if( 0 == checkAudioOutMode )
{
var result =
AudioPlugin.SetExternalOutMode(PL_AUDIO_AUDIO_OUT_MODE_DOLBY);
alert("AudioPlugin.SetExternalOutMode(1) = " + result);
}
}
alert("AudioPlugin.GetOutputDevice() = " + AudioPlugin.GetOutputDevice());
Enumeratio
n
PL_AUDIO_AUDIO_OUT_MODE
Version Support from AUDIO-0011
Security
Type Multimedia
Top
4.3.1.2. GetExternalOutMode
Function
GetExternalOutMode
GetExternalOutMode function returns external out mode (PCM, DOLBY, DTS, ... )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 66
Syntax GetExternalOutMode( )
Parameter none
Return
Value
If success, returns PL_AUDIO_AUDIO_OUT_MODE.
Otherwise, returns a negative number.
Remarks none
Emulator
remarks Only returns PLR_NOT_IMPLEMENT
Example
var audioOutMode = AudioPlugin.GetExternalOutMode();
alert("AudioPlugin.GetExternalOutMode() = " + audioOutMode);
if( audioOutMode == PL_AUDIO_AUDIO_OUT_MODE_PCM )
{
var checkAudioOutMode =
AudioPlugin.CheckExternalOutMode(PL_AUDIO_AUDIO_OUT_MODE_DOLBY)
;
alert("AudioPlugin.CheckExternalOutMode(1) = " + checkAudioOutMode);
if( 0 == checkAudioOutMode )
{
var result =
AudioPlugin.SetExternalOutMode(PL_AUDIO_AUDIO_OUT_MODE_DOLBY);
alert("AudioPlugin.SetExternalOutMode(1) = " + result);
}
}
alert("AudioPlugin.GetOutputDevice() = " + AudioPlugin.GetOutputDevice());
Enumeratio
n
PL_AUDIO_AUDIO_OUT_MODE
Version Support from AUDIO-0011
Security
Type Multimedia
Top
4.3.1.3. GetOutputDevice
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 67
Function
GetOutputDevice
Get audio device information which is now using for audio output
Syntax GetOutputDevice( )
Parameter none
Return Value If success, returns PL_AUDIO_OUTPUT_DEVICE
otherwise, returns error code
Remarks none
Emulator
remarks [FAKE] Return value is fixed as PL_AUDIO_OUTPUT_DEVICE_MAIN_SPEAKER
Example
var outputDevice;.
outputDevice = AudioPlugin.GetOutputDevice();
if( outputDevice == PL_AUDIO_OUTPUT_DEVICE_MAIN_SPEAKER )
{
...
}
else if( outputDevice == PL_AUDIO_OUTPUT_DEVICE_EARPHONE )
{
...
}
else if( outputDevice == PL_AUDIO_OUTPUT_DEVICE_SUBWOOFER )
{
...
}
else if( outputDevice == PL_AUDIO_OUTPUT_DEVICE_EXTERNAL )
{
...
}
else if( outputDevice == PL_AUDIO_OUTPUT_DEVICE_RECEIVER )
{
...
}
else
{
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 68
...
}
Enumeration PL_AUDIO_OUTPUT_DEVICE
Version Support from AUDIO-0001
Security Type Multimedia
Top
4.3.1.4. GetSystemMute
Function
GetSystemMute
Get information whether systemmute state is on or off. Systemmute means that mute state of DTV platform overall
Syntax GetSystemMute( )
Parameter none
Return Value
If SystemMute On, returns PLR_TRUE
if System Off, returns PLR_FALSE
if fail to get information, returns a negative number
Remarks If SystemMute is Off, DTV doesn't output any sound whatever UsermMute state is on or off.
Even though receiver is connected, you cannot bring sound from DTV to receiver.
Emulator remarks [FAKE] Get mute information of PC. (same to GetUserMute)
Example
var systemMute = AudioPlugin.GetSystemMute();
if( PLR_TRUE == systemMute )
{
... SystemMute On ...
}
else if( PLR_FALSE == systemMute )
{
... SystemMute Off ...
}
else
{
... Error ...
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 69
Enumeration none
Version Support from AUDIO-0005
Security Type Multimedia
Top
4.3.1.5. GetUserMute
Function
GetUserMute
Get information of UserMute state of DTV platform. UserMute means that mute state of speaker on DTV only.
Syntax GetUserMute( )
Parameter none
Return Value
If UserMute On, returns PLR_TRUE
if UserMute Off, returns PLR_FALSE
if fail to get information of UserMute. Return a negative number.
Remarks
UserMute means that mute state of speaker on DTV only. UserMute don't know whether external
audio output device is used now or not. For example, now receiver is connected and DTV user
use audio device as receiver, then GetUserMute cannot get any information of receiver's mute
state. In this case, you should use GetSystemMute for getting information of receiver's mute
state.
Emulator remarks [FAKE] Get mute information of PC. (same to GetSystemMute)
Example
var userMute = AudioPlugin.GetUserMute();
if( PLR_TRUE == userMute )
{
... UserMute On ...
}
else if( PLR_FALSE == userMute )
{
... UserMute Off ...
}
else
{
... Error ...
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 70
Enumeration none
Version Support from AUDIO-0005
Security Type Multimedia
Top
4.3.1.6. GetVolume
Function
GetVolume
Get volume level on DTV platform. The range of volume is 0 ~ 100
Syntax GetVolume( )
Parameter none
Return Value If success, returns a value between 0 and 100 as a volume level.
otherwise returns a negative number.
Remarks none
Emulator remarks [FAKE] Get volume information of PC, and calculate PC's volume range is 0~100.
Example
var volume;
volume = AudioPlugin.GetVolume();
alert(volume);
Enumeration none
Version Support from AUDIO-0001
Security Type Multimedia
Top
4.3.1.7. IsActiveSourceOnCEC
Function
IsActiveSourceOnCEC
Get information whether now HDMI-CEC device is active or not on DTV platform
Syntax IsActiveSourceOnCEC( )
Parameter none
Return Value If HDMI-CEC device is active, returns PLR_TRUE
If HDMI-CEC device is not active or connected, returns PLR_FALSE.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 71
If fail to get information, returns a negative number
Remarks none
Emulator
remarks [FAKE] Always returns PLR_FALSE
Example
if( PLR_TRUE == AudioPlugin.IsActiveSourceOnCEC() )
{
AudioPlugin.SetTVSourceOnCEC();
}
Enumeration none
Version Support from AUDIO-0004
Security Type Multimedia
Top
4.3.1.8. SetExternalOutMode
Function
SetExternalOutMode
SetExternalOutMode function sets external out mode (PCM, DOLBY, DTS, ... )
Syntax SetExternalOutMode( PL_AUDIO_AUDIO_OUT_MODE audioOutMode )
Parameter
audioOutMode
o PL_AUDIO_AUDIO_OUT_MODE
o PCM, DOLBY, DTS, ...
Return
Value
If success, returns 1.
Otherwise, returns a negative number.
Remarks none
Emulator
remarks Only returns PLR_NOT_IMPLEMENT.
Example
var audioOutMode = AudioPlugin.GetExternalOutMode();
alert("AudioPlugin.GetExternalOutMode() = " + audioOutMode);
if( audioOutMode == PL_AUDIO_AUDIO_OUT_MODE_PCM )
{
var checkAudioOutMode =
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 72
AudioPlugin.CheckExternalOutMode(PL_AUDIO_AUDIO_OUT_MODE_DOLBY)
;
alert("AudioPlugin.CheckExternalOutMode(1) = " + checkAudioOutMode);
if( 0 == checkAudioOutMode )
{
var result =
AudioPlugin.SetExternalOutMode(PL_AUDIO_AUDIO_OUT_MODE_DOLBY);
alert("AudioPlugin.SetExternalOutMode(1) = " + result);
}
}
alert("AudioPlugin.GetOutputDevice() = " + AudioPlugin.GetOutputDevice());
Enumeratio
n
PL_AUDIO_AUDIO_OUT_MODE
Version Support from AUDIO-0011
Security
Type Multimedia
Top
4.3.1.9. SetSystemMute
Function
SetSystemMute
Set state of SystemMute in DTV platform.
Syntax SetSystemMute( PLBOOL systemMute )
Parameter
systemMute
o PLBOOL
o PLR_TRUE : set state as SystemMute
PLR_FALSE :set state as non-SystemMute
Return Value If success, returns PLR_TRUE, otherwise returns a negative number.
Remarks If SystemMute is Off, DTV doesn't output any sound whatever UsermMute state is on or off.
Even though receiver is connected, you cannot bring sound from DTV to receiver.
Emulator [FAKE] Set PC's mute state
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 73
remarks
Example
AudioPlugin.SetSystemMute(PLR_TRUE);
AudioPlugin.SetSystemMute(PLR_FALSE);
Enumeration none
Version Support from AUDIO-0005
Security Type Multimedia
Top
4.3.1.10. SetTVSourceOnCEC
Function
SetTVSourceOnCEC
Change TV's source to TV signal itself from CEC source.
Syntax SetTVSourceOnCEC( )
Parameter none
Return Value If success, returns PLR_TRUE
otherwise returns a negative number.
Remarks none
Emulator
remarks [FAKE] do not any action, and always returns PLR_TRUE
Example
if( PLR_TRUE == AudioPlugin.IsActiveSourceOnCEC() )
{
AudioPlugin.SetTVSourceOnCEC();
}
Enumeration Only returns false.
Version Support from AUDIO-0004
Security Type Multimedia
Top
4.3.1.11. SetUserMute
Function
SetUserMute
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 74
Set state of UserMute in DTV platform.
Syntax SetUserMute( PLBOOL userMute )
Parameter
userMute
o PLBOOL
o PLR_TRUE : set as UserMute
PLR_FALSE : set as non-UserMute
Return Value If success, returns PLR_TRUE
otherwise, returns a negative number.
Remarks none
Emulator
remarks [FAKE] set mute state of PC
Example
AudioPlugin.SetUserMute(PLR_TRUE);
AudioPlugin.SetUserMute(PLR_FALSE);
Enumeration none
Version Support from AUDIO-0005
Security Type Multimedia
Top
4.3.1.12. SetVolumeWithKey
Function
SetVolumeWithKey
Increment(+1) or decrement(-1) volume level depending on key.
Syntax SetVolumeWithKey( PL_AUDIO_VOLUME_KEY key )
Parameter
key
o PL_AUDIO_VOLUME_KEY
o PL_AUDIO_VOLUME_KEY_UP : increment volume level
PL_AUDIO_VOLUME_KEY_DOWN : decrement volume level
Return Value If success, returns PLR_TRUE.
Otherwise, returns a negative number.
Remarks none
Emulator [FAKE] Do nothing, just print out function name on debug console in SDK.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 75
remarks
Example
AudioPlugin.SetVolumeWithKey(PL_AUDIO_VOLUME_KEY_UP);
AudioPlugin.SetVolumeWithKey(PL_AUDIO_VOLUME_KEY_DOWN);
Enumeration PL_AUDIO_VOLUME_KEY
Version Support from AUDIO-0002
Security Type Multimedia
Top
4.3.2. Enumeration
4.3.2.1. PL_AUDIO_AUDIO_OUT_MODE
Enumeration
PL_AUDIO_AUDIO_OUT_MODE
none
Remarks none
Emulator
remarks none
Function
GetExternalOutMode
CheckExternalOutMode
SetExternalOutMode
Value
0 - PL_AUDIO_AUDIO_OUT_MODE_PCM
1 - PL_AUDIO_AUDIO_OUT_MODE_DOLBY
2 - PL_AUDIO_AUDIO_OUT_MODE_DTS
Top
4.3.2.2. PL_AUDIO_OUTPUT_DEVICE
Enumeration
PL_AUDIO_OUTPUT_DEVICE
none
Remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 76
Emulator
remarks none
Function GetOutputDevice
Value
0 - PL_AUDIO_OUTPUT_DEVICE_MAIN_SPEAKER
o Main speaker
1 - PL_AUDIO_OUTPUT_DEVICE_EARPHONE
o Earphone
2 - PL_AUDIO_OUTPUT_DEVICE_SUBWOOFER
o Subwoofer
3 - PL_AUDIO_OUTPUT_DEVICE_EXTERNAL
o External speaker ex)Component audio, Composite audio
4 - PL_AUDIO_OUTPUT_DEVICE_RECEIVER
o receiver ex)HDMI, SPDIF
Top
4.3.2.3. PL_AUDIO_VOLUME_KEY
Enumeration
PL_AUDIO_VOLUME_KEY
none
Remarks none
Emulator
remarks none
Function SetVolumeWithKey
Value
0 - PL_AUDIO_VOLUME_KEY_UP
o Volume +1
1 - PL_AUDIO_VOLUME_KEY_DOWN
o Volume -1
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 77
4.4. DEVICE
4.4.1. Function
4.4.1.1. GetDisplayPanelType
Function
GetDisplayPanelType (Replaced)
Returns panel type of current DTV.
Syntax GetRealModel ( )
Parameter none
Return Value If success, returns PL_DEVICE_DPT(DisplayPanelType). (see example for detail)
otherwise, return error code.
Remarks This function is replaced same name function of TV plugin
Emulator
remarks [FAKE] always returns PL_DEVICE_DPT_LCD
Example
displayPanelType = DevicePlugin.GetRealModel();
switch( displayPanelType )
{
case PL_DEVICE_DPT_LCD:
...
break;
case PL_DEVICE_DPT_PDP:
...
break;
case PL_DEVICE_DPT_DLP:
...
break;
case PL_DEVICE_DPT_LED:
...
break;
case PL_DEVICE_DPT_LED_EDGE:
...
break;
case PL_DEVICE_DPT_LED_DIRECT:
...
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 78
break;
case PL_DEVICE_DPT_CRT:
...
break;
case PL_DEVICE_DPT_UNKNOWN:
...
break;
default:
displayPanelType = "ERROR";
}
Enumeration PL_DEVICE_DPT
Version Support from DEVICE-0001
Security Type TVInfo
Top
4.4.1.2. GetModel
Function
GetModel (Replaced)
Returns mode code which is modified for Samsung Smart TV
Syntax GetRealModel ( )
Parameter none
Return Value If success, returns modified model code.
Otherwise, returns error code.
Remarks
This function is replaced GetModelCode function of NNavi plugin
Modified model code is the same as real model code, except that panel size number is replaced
with XX (refer to GetRealModel())
ex) LNXXB650_KOR
Emulator remarks [Fake] Returns LNXXB650_KOR
Example DevicePlugin.GetModel();
Enumeration none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 79
Version Support from DEVICE-0001
Security Type TVInfo
Top
4.4.1.3. GetRealModel
Function
GetRealModel (Replaced)
Returns model code of DTV with region string.
Syntax GetRealModel( )
Parameter none
Return Value If success, return real model code
Otherwise, returns error code.
Remarks
This function is replaced GetProductCode function of TV plugin
Real model code = [model code]_[region code]
ex) LN40B650_KOR
Emulator remarks [Fake] Returns LNXXB650_KOR
Example DevicePlugin.GetRealModel();
Enumeration
Version Support from DEVICE-0002
Security Type TVInfo
Top
4.4.2. Enumeration
4.4.2.1. PL_DEVICE_DPT
Enumeration
PL_DEVICE_DPT (Replaced)
none
Remarks none
Emulator
remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 80
Function GetDisplayPanelType (Replaced)
Value
0 - PL_DEVICE_DPT_LCD
o LCD
1 - PL_DEVICE_DPT_PDP
o PDP
2 - PL_DEVICE_DPT_DLP:
o DLP
3 - PL_DEVICE_DPT_LED
o LED
4 - PL_DEVICE_DPT_LED_EDGE
o LED_EDGE
5 - PL_DEVICE_DPT_LED_DIRECT
o LED_DIRECT
6 - PL_DEVICE_DPT_CRT
o CRT
7 - PL_DEVICE_DPT_UNKNOWN
o UNKNOWN
Top
4.5. Download
4.5.1. Function
4.5.1.1. CancelDownload
Function
CancelDownload
Cancel download task. This function works asynchronously, so when cancel is completed, an event is sent to the widget.
(see OnComplete() for details of the event)
Syntax CancelDownload( )
Parameter none
Return Value none
Remarks Return value of this functions is not the result of cancelling download. To check whether
cancelling of download is completed or not, check the callback OnComplete().
Emulator Not supported
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 81
remarks
Example DownloadPlugin.CancelDownload();
Enumeration none
Version Support from DOWNLOAD-0001
Security Type System
Top
4.5.1.2. CancelUpload
Function
CancelUpload
Cancel Upload task. so when cancel is completed, an event is sent to the widget. (see OnUploadComplete() for details
of the event)
Syntax CancelUpload( )
Parameter none
Return Value none
Remarks none
Emulator remarks Not supported
Example DownloadPlugin.CancelUpload();
Enumeration none
Version Support from DOWNLOAD-0005
Security Type System
Top
4.5.1.3. CheckDownloadSpeed
Function
CheckDownloadSpeed
Check Download Speed. (see OnComplete() for details of the event)
Syntax CheckDownloadSpeed( String SrcURL , Number FileSize , Number DownGap )
Parameter
SrcURL
o String
o Source url to download (URL can start with http or https
FileSize
o Number
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 82
o Total file size to download. Used as basis for calculating download progress
ratio. (If http server sends the content size, then this parameter is ignored, and
received contents size is used instead.
DownGap
o Number
o The gap(%) for notification - meaning when SpeedCheck progress increases by
the gap amount, this module notifies the current Speedcheck progress to the
widget. For example, if the widget sets this parameter to 10, then the widget
will be notified with a progress event when SpeedCheck progress is 10%, 20%,
…, 90%, 100%.
Return Value not used
Remarks none
Emulator
remarks Not supported
Example
// for file download speed testing
DownloadPlugin.CheckDownloadSpeed('http://
testHttpServer//files/widget/WidgetDnTest.zip', 10000, 10 );
Enumeration none
Version Support from DOWNLOAD-0003
Security Type System
Top
4.5.1.4. StartDownFile
Function
StartDownFile
Request to start download throughout http or https. This function is asynchronous, download progress and state are
notified to widget as events. (see OnComplete() for details of events)
Syntax StartDownFile( String SrcURL , String DestURL , Number FileSize , Number DownGap )
Parameter
SrcURL
o String
o Source url to download (URL can start with http or https
DestURL
o String
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 83
o Destination on DTV to be downloaded. If this url is only “??”, then do not download
on DTV storage, but calculate download speed and notify it to widget.
FileSize
o Number
o Total file size to download. Used as basis for calculating download progress ratio. (If
http server sends the content size, then this parameter is ignored, and received
contents size is used instead.
DownGap
o Number
o The gap(%) for notification - meaning when download progress increases by the gap
amount, this module notifies the current download progress to the widget. For
example, if the widget sets this parameter to 10, then the widget will be notified with
a progress event when download progress is 10%, 20%, …, 90%, 100%.
Return
Value not used
Remarks none
Emulator
remarks Not supported
Example
// for file downloading
DownloadPlugin.StartDownFile('http://testHttpServer//files/widget/WidgetDnTest.zip
', '/dtv_root/TempDownLoad/WidgetDnTest.zip', 10000, 10 );
// for file download speed testing
DownloadPlugin.StartDownFile('http://
testHttpServer//files/widget/WidgetDnTest.zip', '??', 10000, 10 );
Enumeratio
n none
Version Support from DOWNLOAD-0001
Security
Type System
Top
4.5.1.5. StartUpload
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 84
Function
StartUpload
Request to start upload. Upload progress and state are notified to widget as events. (see
OnUploadComplete(),OnUploadProgress() for details of events)
Syntax StartUpload( String Server , Number Port , String Header , String Body , String FilePath ,
String UploadRatio , Number ServerType )
Parameter
Server
o String
o the server URL where file is upload at
Port
o Number
o It`s target server port for uploading
Header
o String
o Header String of Upload Message Format
Body
o String
o The body of the upload format.
FilePath
o String
o the file path which have uploaded file.
UploadRatio
o String
o This Ratio decide How often the progress of upload is showed.
ServerType
o Number
o deliver the different result which server returned to widgets by this server type.
Return Value the result success or fail
Remarks none
Emulator
remarks Not supported
Example
// for file Upload
function OnUploadComplete(msg)
{
alert('***OnUploadComplete***' + msg );
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 85
}
function OnUploadProgress(msg)
{
alert('***OnUploadProgress***' + msg );
}
function OnLoadFunc()
{
DownloadPlugin = document.getElementById('pluiginObject');
DownloadPlugin.OnUploadComplete=OnUploadComplete;
DownloadPlugin.OnUploadProgress=OnUploadProgress;
DownloadPlugin.StartUpload('10.88.76.42',1317,'111The Herder
Message by Thread SendEvent...\n','The body Message by
[[[FILE_BINARY]]]Thread
SendEvent...\n','$USB_DIR/sda1/UploadTest/UploadTest.txt',10,1);
document.getElementById(categoryID + '1').focus();
}
Enumeration none
Version Support from DOWNLOAD-0007
Security Type System
Top
4.5.2. Enumeration
4.5.2.1. PL_DN_ST
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 86
Enumeration
PL_DN_ST
none
Remarks none
Emulator
remarks none
Function
Value
0 - PL_DN_ST_PREPARED
1 - PL_DN_ST_DOWNLOADING
2 - PL_DN_ST_FINISH
3 - PL_DN_ST_IDLE
4 - PL_DN_ST_UNKNOWN
Top
4.5.2.2. PL_DOWNLOAD_UPLOAD_SERVER_TYPE
Enumeration
PL_DOWNLOAD_UPLOAD_SERVER_TSERVER_TYPE
none
Remarks none
Emulator
remarks Not supported
Function
Value
0 - PL_DOWNLOAD_UPLOAD_SERVER_TYPE_SIMPLE_RESULT
1 - PL_DOWNLOAD_UPLOAD_SERVER_TYPE_HTTP_PICASA
Top
4.5.3. EVENT
4.5.3.1. OnComplete
Event
OnComplete
Callback function of download result.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 87
Parameter is consist of 2 fields, and each fields is separated with „?‟.
If first field is “1000”, this event tells the widget that download is complete. If the second field is „1‟, download
completed with no error, otherwise with an error.
If first field is “1001”, this event tells the widget the percentage progress of the download. The second field gives the
current download percentage.
If first field is “1002”, this event tells the widget the download speed. The second field is the download speed
(bytes/sec).
See example for detail.
Parameter
DownloadStatus
o String
o 1000?1
Remarks none
Emulator
remarks Not supported
Example
// register
function OnLoadFunc()
{
DownloadPlugin = document.embeds[0];
DownloadPlugin.OnComplete = fnDnStatus; // register OnComplete
function callback as fnDnStatus
}
// actual function
function fnDnStatus(msg)
{
alert('fnCallback' + msg );
var tArrResult = msg.split("?");
for (var i=0 ; i<tArrResult.length ; i++) {
alert("tArrResult[" + i + "] = " + tArrResult[i]);
}
// DownResult : If res=1 success, otherwise ERROR (see end of this file)
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 88
if (tArrResult[0]==1000 )
{
document.getElementById('DownResult').value =
tArrResult[1];
}
// DownRatio : 0~100
else if (tArrResult[0]==1001 )
{
document.getElementById('DownloadedRatio').value = tArrResult[1];
}
// Down Speed : Bytes/Sec : It will be reach after Ratio
else if (tArrResult[0]==1002 )
{
document.getElementById('DownSpeed').value = tArrResult[1];
}
}
Version DOWNLOAD-0001
Top
4.5.3.2. OnUploadComplete
Event
OnUploadComplete
Callback function of Upload result.
Parameter is consist of 2 fields, and each fields is separated with „?‟.
If Upload is success the first field is set “201”, this event tells the widget that Upload is complete successfully. And The
2nd field is set to the body of ServerReturnMessage. this Two field is devided by "?"
If Upload is fail, just one filed is set to minus value.
If first field is “0”,it means that User Cancele Upload.
If first field is “-1”,It means that Socket creating is fail.
If first field is “-2”, It means that you fail to get host URL.
If first field is “-3”,It means that you fail to have connection to server
If first field is “-4”,It means that you fail to Send Uplad Message sucessfully.
If first field is “-5”,It means that You fail to Recieve return message from server in 30 sec.
If first filed is -6, It meams that You have Internal errors like the Failure of Reading File.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 89
See example for detail.
Parameter
DownloadStatus
o String
o 201?The Body Part of Return Message
Remarks none
Emulator
remarks Not supported
Example
function OnUploadComplete(msg)
{
alert('***OnUploadComplete***' + msg );
}
function OnUploadProgress(msg)
{
alert('***OnUploadProgress***' + msg );
}
function OnLoadFunc()
{
DownloadPlugin = document.getElementById('pluiginObject');
DownloadPlugin.OnUploadComplete=OnUploadComplete;
DownloadPlugin.OnUploadProgress=OnUploadProgress;
DownloadPlugin.StartUpload('10.88.76.42',1317,'111The Herder Message
by Thread SendEvent...\n','The body Message by [[[FILE_BINARY]]]Thread
SendEvent...\n','$USB_DIR/sda1/UploadTest/UploadTest.txt',10,1);
document.getElementById(categoryID + '1').focus();
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 90
Version DOWNLOAD-0007
Top
4.5.3.3. OnUploadProgress
Event
OnUploadProgress
Callback function of Upload result. This Event show the percentage of Upload Progress.
Parameter
UploadProgressRatio
o String
o
Remarks none
Emulator
remarks Not supported
Example
function OnUploadComplete(msg)
{
alert('***OnUploadComplete***' + msg );
}
function OnUploadProgress(msg)
{
alert('***OnUploadProgress***' + msg );
}
function OnLoadFunc()
{
DownloadPlugin = document.getElementById('pluiginObject');
DownloadPlugin.OnUploadComplete=OnUploadComplete;
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 91
DownloadPlugin.OnUploadProgress=OnUploadProgress;
DownloadPlugin.StartUpload('10.88.76.42',1317,'111The Herder Message
by Thread SendEvent...\n','The body Message by [[[FILE_BINARY]]]Thread
SendEvent...\n','$USB_DIR/sda1/UploadTest/UploadTest.txt',10,1);
document.getElementById(categoryID + '1').focus();
}
Version DOWNLOAD-0005
4.6. ExternalWidgetInterface
4.6.1. Function
4.6.1.1. AccountRead
Function
AccountRead
Read account data from SecureStorage
Syntax AccountRead( )
Parameter none
Return Value
if success returns string from SecureStorage,
NULL string in case of error,
PLR_FAIL if this function is not allowed for the widget
Remarks Restricted to use by WidgetManager ONLY
Emulator remarks none
Example
var data = plugin.AccountRead();
alert ("data = " + data);
Enumeration none
Version Support from EXTERNALWIDGETINTERFACE-0003
Security Type System
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 92
4.6.1.2. AccountRemove
Function
AccountRemove
Removes account data from SecureStorage
Syntax AccountRemove( )
Parameter none
Return Value
PLR_TRUE if data successfully removed,
PLR_FALSE in case of error,
PLR_FAIL if this function is not allowed for the widget
Remarks Restricted to use by WidgetManager ONLY
Emulator remarks none
Example alert("AccountRemove = " + plugin.AccountRemove());
Enumeration none
Version Support from EXTERNALWIDGETINTERFACE-0003
Security Type System
Top
4.6.1.3. AccountWrite
Function
AccountWrite
Writes account data to SecureStorage
Syntax AccountWrite( String dataString )
Parameter
dataString
o String
o Input data to be written
Return Value
PLR_TRUE if data successfully written,
PLR_FALSE in case of error,
PLR_FAIL if this function is not allowed for the widget
Remarks Restricted to use by WidgetManager ONLY
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 93
Emulator remarks none
Example
var data = "\
<encode type = UTF-8>\n\
<body>\n\
<company> \n\
<name> Netflix </name>\n\
<id> myID </id>\n\
<pw> 1234 </pw>\n\
</company>\n\
<company> \n\
<name> YouTube </name>\n\
<id> myID2 </id>\n\
<pw> 12345 </pw>\n\
</company>\n\
<company> \n\
<name> E-Bay </name>\n\
<id> myID3 </id>\n\
<pw> 123456 </pw>\n\
</company>\n\
</body>";
alert("AccountWrite = " + plugin.AccountWrite(data));
Enumeration none
Version Support from EXTERNALWIDGETINTERFACE-0003
Security Type System
Top
4.6.1.4. GetESN
Function
GetESN
GetESN string for needed service
Syntax GetESN( String widgetName )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 94
Parameter
widgetName
o String
o Name of the widget(ex. NFLX)
Return Value ESN string (success),
null string (error)
Remarks
Emulator
remarks none
Example document.getElementById('esn').value =
ExternalWidgetInterface.GetESN("NFLX");
Enumeration none
Version Support from EXTERNALWIDGETINTERFACE-0003
Security Type System
Top
4.6.1.5. IsBound
Function
IsBound
Checks the activation status of the widget
Syntax IsBound( String widgetName )
Parameter
widgetName
o String
o Name of the widget(ex. NFLX)
Return Value PLR_TRUE if widget is activated,
PLR_FALSE if it is not activated
Remarks
Emulator
remarks Only returns false.
Example alert ('IsBound(NFLX) = ' + ExternalWidgetInterface.IsBound("NFLX");
Enumeration none
Version Support from EXTERNALWIDGETINTERFACE-0003
Security Type System
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 95
Top
4.6.1.6. UnBindWidget
Function
UnBindWidget
Deactivate specific widget
Syntax UnBindWidget( String widgetName )
Parameter
widgetName
o String
o Name of the widget(ex. NFLX)
Return Value PLR_TRUE(deacitvated successfully),
PLR_FALSE otherwise
Remarks
Emulator
remarks Olny returs falses.
Example alert ('UnBindWidget(NFLX) = ' +
ExternalWidgetInterface.UnBindWidget("NFLX"));
Enumeration none
Version Support from EXTERNALWIDGETINTERFACE-0003
Security Type System
Top
4.7. FileSystem
4.7.1. Function
Top
4.7.1.1. IsExistedPath
Function
IsExistedPath
Returns whether designated path exists or not.
Syntax IsExistedPath( String path )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 96
Parameter
path
o String
o Path to check whether the path exists or not
Return Value
If exists, returns PLR_TRUE.
If does not exist, returns PLR_FALSE.
If check fails, returns error code.
Remarks none
Emulator
remarks none
Example
var CopyPath = '/dtv_root/test/srcCopy/GirlsGeneration.zip';
var result = FileSystemPlugin.IsExistedPath(CopyPath);
if( result == PLR_TRUE )
{
... EXISTED ...
}
else if (result == PLR_FALSE )
{
... NOT EXISTED ...
}
else
{
... ERROR ...
}
Enumeration none
Version Support from FILESYSTEM-0001
Security Type System
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 97
4.8. FrontPanel
4.8.1. Function
4.8.1.1. DisplayVFD_Show
Function
DisplayVFD_Show
SHOW the TEXT on VFD
Syntax DisplayVFD_Show( NUMBER cmd )
Parameter
cmd
o NUMBER
o Command
Return Value always return true.
Remarks
insert instead of Parameter NUMBER
FRONT_DISPLAY_PLAY 0100
FRONT_DISPLAY_STOP 0101
FRONT_DISPLAY_PAUSE 0102
FRONT_DISPLAY_ONLINE 0200
then, Show the PLAY, STOP, PAUSE or ONLINE text on VFD
Emulator
remarks none
Example FrontPanelPlugin.DisplayVFD_Show(FRONT_DISPLAY_PLAY);
Enumeration none
Version Support from FRONTPANEL-0001
Security Type Multimedia
Top
4.8.1.2. DisplayVFD_Time
Function
DisplayVFD_Time
Show the Play-Time
Syntax DisplayVFD_Time( NUMBER hour , NUMBER minutes , NUMBER seconds )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 98
Parameter
hour
o NUMBER
o hour
minutes
o NUMBER
o minutes
seconds
o NUMBER
o seconds
Return Value always return true.
Remarks none
Emulator
remarks none
Example FrontPanelPlugin.DIsplayVFD_Time(1,15,50);
Enumeration none
Version Support from FRONTPANEL-0001
Security Type Multimedia
Top
Top
4.9. IME
4.9.1. Function
4.9.1.1. DeInitIME
Function
DeInitIME
DeInit IME
Syntax DeInitIME( )
Parameter none
Return Value void
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 99
Remarks none
Emulator remarks Not supported by emulator
Example IMEPlugin.DeInitIME();
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.2. DeInitMyWordIME
Function
DeInitMyWordIME
DeInit My Word Page
Syntax DeInitMyWordIME( )
Parameter none
Return Value void
Remarks
Emulator remarks Not supported by emulator
Example
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.3. GetActiveWordPosition
Function
GetActiveWordPosition
Get beginning and end position of active word
Syntax GetActiveWordPosition( )
Parameter none
Return Value String(beginning~end)
Remarks
Emulator remarks Not supported by emulator
Example
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 100
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.4. GetCharacterList
Function
GetCharacterList
Get character list in ABC mode
Syntax GetCharacterList( Number keycode )
Parameter
keycode
o Number
o Keycode(ascii code, key 1->49, key 2->50,…)
Return Value Character list in ABC mode, Return -1 if failed.
Remarks
Emulator
remarks Not supported by emulator
Example
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.5. GetCursorPosition
Function
GetCursorPosition
Get the position of the cursor in the text buffer
Syntax GetCursorPosition( )
Parameter none
Return Value The offset from the beginning of the text buffer
Remarks
Emulator remarks Not supported by emulator
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 101
Example
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.6. GetIMEInputMode
Function
GetIMEInputMode
Get current input mode
Syntax GetIMEInputMode( )
Parameter none
Return Value Modetype (MODE_MENU=1, MODE_HELP=2, MODE_SYMBOL=3, MODE_123=4,
MODE_ABC=5, MODE_T9=6)
Remarks none
Emulator remarks Not supported by emulator
Example
var IMEInputMode = IMEPlugin.GetIMEInputMode();
alert('IMEInputMode = ' + IMEInputMode);
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.7. GetLanguage
Function
GetLanguage
Get current language
Syntax GetLanguage( )
Parameter none
Return Value LanguageCode, such as EN, FR, DE etc. See language code document for details. Return -1 if
failed.
Remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 102
Emulator remarks Not supported by emulator
Example
var lang = IMEPlugin.GetLanguage();
alert('lang = ' + lang);
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.8. GetRecommendedString
Function
GetRecommendedString
Get RecommendedString that will be displayed on screen
Syntax GetRecommendedString( )
Parameter none
Return Value String (Alphabet words list splitted by ~), Return -1 if failed.
Remarks
Emulator remarks Not supported by emulator
Example
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.9. GetRecommendedStringCount
Function
GetRecommendedStringCount
Get the amount of recommended string
Syntax GetRecommendedStringCount( )
Parameter none
Return Value The number of recommended string totally
Remarks
Emulator remarks Not supported by emulator
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 103
Example
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.10. GetShfCapState
Function
GetShfCapState
Get Shift Cap Lock State
Syntax GetShfCapState( )
Parameter none
Return Value Number (0 unshifted, 1 shift , 2 cap lock)
Remarks
Emulator remarks Not supported by emulator
Example IMEPlugin. GetShfCapState();
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.11. GetString
Function
GetString
Get strings that will be displayed on screen
Syntax GetString( )
Parameter none
Return Value String, Return -1 if failed.
Remarks
Emulator remarks Not supported by emulator
Example
Enumeration none
Version Support from IME-0002
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 104
Security Type Multimedia
Top
4.9.1.12. InitIME
Function
InitIME
Initialize IME System
Syntax InputKey ( Number maxBufLen )
Parameter
maxBufLen
o Number
o Max Buffer Length
Return Value 1 success 0 failed
Remarks none
Emulator remarks Not supported by emulator
Example IMEPlugin.InitIME(30);
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.13. InitMyWordIME
Function
InitMyWordIME
Init My Word Page
Syntax InputKey ( )
Parameter none
Return Value 1 success 0 failed
Remarks
Emulator remarks Not supported by emulator
Example
Enumeration none
Version Support from IME-0002
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 105
Security Type Multimedia
Top
4.9.1.14. InputKey
Function
InputKey
Handle pressed key and submit keycode to IME core
Syntax InputKey( Number keycode )
Parameter
keycode
o Number
o Keycode(ascii code, key 1->49, key 2->50,…)
Return Value void
Remarks none
Emulator
remarks Not supported by emulator
Example IMEPlugin.InputKey(49);
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.15. ResetUDBData
Function
ResetUDBData
Reset UDB to empty
Syntax ResetUDBData( )
Parameter none
Return Value Number
Remarks
Emulator remarks Not supported by emulator
Example
Enumeration none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 106
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.16. SetCursorPositon
Function
SetCursorPositon
Set Cursor Position in Text Buffer
Syntax SetCursorPositon( Number nCount )
Parameter
nCount
o Number
o Cursor Position which will be set to text buffer
Return Value void
Remarks
Emulator remarks Not supported by emulator
Example
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.17. SetIMEInputMode
Function
SetIMEInputMode
Set current input mode
Syntax SetIMEInputMode( Number ModeType )
Parameter
ModeType
o Number
o MODE_MENU=1, MODE_HELP=2, MODE_SYMBOL=3, MODE_123=4,
MODE_ABC=5, MODE_T9=6
Return Value void
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 107
Remarks
Default is MODE_T9, if you want to set your own default mode, you must call
IMEPlugin.SetIMEInputMode(i) in webpage OnLoadFunc()
If you want to input strings like “a2” or “ab2” in ABC mode (characters on the same button), you
must press right key (call InputKey(82) ) after inputting one character. Or set a timer by UI, after
timer is reached, call InputKey(82) automatically.
Emulator
remarks Not supported by emulator
Example IMEPlugin.SetIMEInputMode(6);
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.9.1.18. SetLanguage
Function
SetLanguage
Set current language
Syntax SetLanguage( String LanguageCode )
Parameter
LanguageCode
o String
o LanguageCode, such as EN, FR, DE etc. See language code document for
details.
Return Value 1 success 0 failed
Remarks
Emulator
remarks Not supported by emulator
Example IMEPlugin.SetLanguage("EN");
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 108
4.9.1.19. SetString
Function
SetString
Set strings that will be displayed on screen
Syntax SetString( String str )
Parameter
str
o String
o Strings which will be set to text buffer
Return Value 1 success 0 failed
Remarks none
Emulator remarks Not supported by emulator
Example
Enumeration none
Version Support from IME-0002
Security Type Multimedia
Top
4.10. ImageViewer
4.10.1. Function
4.10.1.1. ClearScreen
Function
ClearScreen
This ClearScreen() erases TV screen with black.
Syntax ClearScreen( )
Parameter none
Return Value
It returns ture if it succeeds, otherwise it returns false.
Remarks none
Emulator
remarks none
Example var retVal=ImageViewer.CleerScreen()
Enumeration none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 109
Version Support from IMAGEVIEWER-0001
Security Type none
Top
Top
4.10.1.2. GetVideoHeight
Function
GetVideoHeight
GetVideoHeight() function retrieves height of currently playing video.
Syntax GetVideoHeight( )
Parameter none
Return Value
GetVideoHeight returns the height size of currently playing video content.
Remarks
This GetVideoHeight() API has be called after OnStreamInfoReady callback function is called.
Emulator
remarks none
Example var width=ImageViewer.GetVideoHeight();
Enumeration none
Version Support from IMAGEVIEWER-0001
Security Type none
Top
4.10.1.3. GetVideoWidth
Function
GetVideoWidth
GetVideoWidth() function retrieves width of image
Syntax GetVideoWidth( )
Parameter none
Return Value
GetVideoWidth returns the width size of image.
Remarks
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 110
This GetVideoWidth() API has be called after OnStreamInfoReady callback function is called.
Emulator
remarks none
Example var width=ImageViewer.GetVideoWidth();
Enumeration none
Version Support from IMAGEVIEWER-0001
Security Type none
Top
4.10.1.4. InitPlayer
Function
InitPlayer
Initialize image viewer with the specified url.
Syntax InitPlayer( String url )
Parameter
url
o String
o
Specifies the URL of content to play
Return Value
It always returns ture.
Remarks
The InitPlayer() should not be used with Play() API.
If widget uses InitPlayer(), it has to use StartPlayback() to play a content.
Otherwidget it has to use Play() only.
When InitPlayer() is used, it has to come first becore other APIs are called.
Emulator
remarks none
Example
InitPlayer(url);
SetDisplayArea(x, y, width, height);
SetInitialBufferSize(400*1024);
//400KB
StartPlayback();
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 111
Enumeration none
Version Support from IMAGEVIEWER-0001
Security Type Multimedia
Top
4.10.1.5. Play
Function
Play
Starts playing a content specified by url.
Syntax Play( String url )
Parameter
url
o String
o Specifies the URL of content
Return Value
The return value is true if media player succeed to start play, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=ImageViewer.Play(url);
Enumeration none
Version Support from IMAGEVIEWER-0001
Security Type none
Top
4.10.1.6. SetDisplayArea
Function
SetDisplayArea
SetDisplayArea() sets the display area for video content in TV screen.
Syntax SetDisplayArea( Number x , Number y , Number width , Number height )
Parameter x
o Number
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 112
o
Specifies the initial x-coordinate of display area in TV screen coordinates.
This x value must be smaller than TV screen width, 960.
y
o Number
o
Specifies the initial y-coordinate of display area in TV screen coordinates.
This y value must be smaller than TV screen height, 540.
width
o Number
o
The width of display area.
This value must be smaller than width of TV screen.
height
o Number
o
The height of crop area from source Image.
This value must be smaller than height of source image.
Return Value
It returns ture if it succeeds, otherwise it returns false.
Remarks none
Emulator
remarks none
Example
var retVal=ImageViewer.SetDisplayArea(0, 0, 1920,
1080);
Enumeration none
Version Support from IMAGEVIEWER-0001
Security Type none
Top
4.10.1.7. SetDisplayLock
Function
SetDisplayLock
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 113
Lock or unlock the screen
Syntax SetDisplayLock( Boolean lock )
Parameter
lock
o Boolean
o set true to lock the screen or set faluse to unclok the screen
Return Value
The return value is true if media player succeed to start play, otherwise it returns false.
Remarks none
Emulator
remarks Not supported by enulator
Example var retVal=ImageViewer.SetDisplayLock(true);
Enumeration none
Version Support from IMAGEVIEWER-0001
Security Type none
Top
4.10.1.8. SetTransitionEffect
Function
SetTransitionEffect
Set transition effect for slide show
Syntax SetTransitionEffect( Number effect )
Parameter
effect
o Number
o Specifies the effect type
The effect types are as follow.
NONE : -2,
INIT : -1,
FADE1 : 0,
FADE2 : 1,
BLIND : 2,
SPIRAL : 3,
CHECKER : 4,
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 114
LINEAR : 5,
STAIRS : 6,
WIPE : 7,
RANDOM : 8
Return Value
The return value is true if media player succeed to start play, otherwise it returns false.
Remarks none
Emulator
remarks Not supported by enulator
Example var retVal=ImageViewer.SetTransitionEffect(effect);
Enumeration none
Version Support from IMAGEVIEWER-0001
Security Type none
Top
4.10.1.9. ShowImage
Function
ShowImage
Draw a picture on the screen
Syntax ShowImage( )
Parameter none
Return Value
It returns true if it succeeds, otherwise it returns false.
Remarks
ShowImage() has to be called with InitPlayer(), and it can't be called with Play().
Also ShowImage() can't be called before InitPlayer() is called.
Emulator
remarks none
Example
InitPlayer(url);
SetDisplayArea(x, y, width, height);
SetInitialBufferSize(400*1024);
//400KB
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 115
ShowImage();
Enumeration none
Version Support from IMAGEVIEWER-0001
Security Type Multimedia
Top
4.10.1.10. Stop
Function
Stop
Stops the currently playing content.
Syntax Stop( )
Parameter none
Return Value
The return value is ture if media player succeed to stop, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=ImageViewer.Stop();
Enumeration none
Version Support from IMAGEVIEWER-0001
Security Type none
Top
4.10.3. Event
4.10.3.1. OnBufferingComplete
Event
OnBufferingComplete
OnBufferingStart event is sent by media player when it gets out of buffering status.
Parameter none
Remarks none
Emulator none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 116
remarks
Example
ImageViewer.OnBufferingComplete=OnBufferingComplete;
function OnBufferingComplete()
{
//unload buffering image.
}
Version IMAGEVIEWER-0001
Top
4.10.3.2. OnBufferingStart
Event
OnBufferingStart
OnBufferingStart event is sent by media player when it goes on buffering status.
Parameter none
Remarks none
Emulator
remarks none
Example
ImageViewer.OnBufferingStart=OnBufferingStart;
function OnBufferingStart()
{
//Drawing buffering image.
}
Version IMAGEVIEWER-0001
Top
4.10.3.3. OnConnectionFailed
Event
OnConnectionFailed
OnConnectionFailed event is sent by media player when it fails to connect to streaming server.
Parameter
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 117
o
o
Remarks
OnConnectionFailed event is different from OnNetworkDisconnected.
This event is sent only when media player fails to connect to server at the begining or at the jump in
HTTP and HTTPS streaming.
Emulator
remarks none
Example
ImageViewer.OnConnectionFailed=OnConnectionFailed;
function OnConnectionFailed()
{
ImageViewer.Stop();
...
}
Version IMAGEVIEWER-0001
Top
4.10.3.4. OnNetworkDisconnected
Event
OnNetworkDisconnected
OnNetworkDisconnected is sent by media player when it knows that ethernet is disconnected or streaming server stops
to support content in the middle of streaming.
Parameter none
Remarks
Receiving OnNetworkDisconnected event means media player already succeed to connect to
streaming server.
Usually this event means network is disconnected during the streaming.
Emulator
remarks none
Example
ImageViewer.OnNetworkDisconnected=OnNetworkDisconnected;
function OnNetworkDisconnected()
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 118
{
ImageViewer.Stop();
....
}
Version IMAGEVIEWER-0001
Top
4.10.3.5. OnRenderError
Event
OnRenderError
OnRenderError event is sent by media player when it found that there are some problem in rendering because of the
reason specified by parameter.
Parameter
renderErrorType
o Number
o
Remarks
Parameter value of OnRenderError means as follow;
1 : Unsupported container
2 : Unsupported video codec
3 : Unsupported audio codec
4 : Unsupported video resolution
Emulator
remarks none
Example
Version IMAGEVIEWER-0001
Top
4.10.3.6. OnRenderingComplete
Event
OnRenderingComplete
OnRenderingComplete event is sent by media player when it reaches to the end of stream.
Parameter none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 119
Remarks none
Emulator
remarks none
Example
ImageViewer.OnRenderingComplete=OnRenderingComplete;
function OnRenderingComplete()
{
ImageViewer.Stop();
}
Version IMAGEVIEWER-0001
Top
4.10.3.7. OnStreamInfoReady
Event
OnStreamInfoReady
OnStreamInfoReady event is sent by media player when it is ready to send content information such as duration and
video resolution after parsing the stream.
Parameter none
Remarks
There are a few APIs which gives valid information only when they are called after
OnStreamInfoReady() event is sent.
APIs such as GetDuration(), GetVideoWidth(), and GetVideoHeight() are have to be used after
widget get OnStreamInfoReady event.
Emulator
remarks none
Example
ImageViewer.OnStreamInfoReady=OnStreamInfoReady;
function OnStreamInfoReady()
{
var totaltime=ImageViewer.GetDuration();
var width=ImageViewer.GetVideoWidth();
var height=ImageViewer.GetVideoHeight();
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 120
Version IMAGEVIEWER-0001
Top
4.10.3.8. OnStreamNotFound
Event
OnStreamNotFound
OnStreamNotFound event is sent by meida player when it fails to play because streaming server replys that the stream
specified by url parameter of Play() API is not exist.
Parameter none
Remarks
Emulator
remarks none
Example
ImageViewer.OnStreamNotFound=OnStreamNotFound;
function OnStreamNotFound()
{
ImageViewer.Stop();
....
}
Version IMAGEVIEWER-0001
Top
4.11. NNavi
4.11.1. Function
4.11.1.1. ActivateReady
Function
ActivateReady
Notify to widget manager that normal widget‟s initialization is ready. Then widget manager can activate normal widget.
Syntax ActivateReady( )
Parameter none
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 121
Remarks In general, a Widget calls this function in OnLoad().
Emulator remarks [FAKE] Do nothing, just print out function name on debug console in SDK.
Example NNaviPlugin.ActivateReady();
Enumeration none
Version Support from NNAVI-0001
Security Type System
Top
4.11.1.2. ActivateWithData
Function
ActivateWithData
ActivateWithData is thd fuction to implement the specified application.
Syntax ActivateWithData( Number nType , STRRING pszData )
Parameter
nType
o Number
o The Application type
pszData
o STRRING
o The String of Filepath, the waiting time for implementation
Return Value
Remarks none
Emulator
remarks none
Example NNaviPlugin.ActivateWithData(1,"/TV/data");
Enumeration none
Version Support from NNAVI-0003 부터
Security Type System
Top
4.11.1.3. ChangeWidgetManager
Function
ChangeWidgetManager
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 122
ChangeWidgetManager is called when The ContentsHome needs to update.
Syntax ChangeWidgetManager( )
Parameter none
Return Value Everytime The return Value is True.
Remarks Request update to Native.
Emulator
remarks none
Example
var type;
NNaviPlugin.ChangeWidgetManager();
Enumeration Only returns true.
Version Support from NNAVI-0002
Security Type System
Top
4.11.1.4. GetAppKey
Function
GetAppKey
Returns AppKey of DTV. DTV uses this key when communicating with Samsung Hubsite, and Samsung Hubsite can
recognize this device is a Samsung DTV by this key.
Syntax GetAppKey( )
Parameter none
Return Value If success, return AppKey in DTV
Otherwise, returns error code.
Remarks AppKey is already fixed before DTV is released, and the AppKey should be already registered in
Samsung Hubsite. (Unique value in same product line)
Emulator remarks Only returns false.
Example
var appKey;
appKey = NNaviPlugin.GetAppKey();
alert(appKey);
Enumeration none
Version Support from NNAVI-0001
Security Type System
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 123
Top
4.11.1.5. GetDUID
Function
GetDUID
Return DUID(Device Unique ID ) of each DTV.
Syntax GetDUID( STRING MAC )
Parameter
MAC
o STRING
o MAC : mac address of each DTV.
Widget can get MAC Address by Network module
Return Value If success, returns DUID of each DTV. ( ex : 7XCBNROQJQPYW )
otherwise, returns error code.
Remarks 13 length, and unique value on each individual DTV.
Emulator remarks none
Example
var DUID;
var MAC;
MAC = NetworkPlugin.GetHWAddr();
DUID = NNaviPlugin.GetDUID(MAC);
alert(DUID);
Enumeration none
Version Support from NNAVI-0001
Security Type System
Top
4.11.1.6. GetFirmware
Function
GetFirmware
Returns Firmware version which is used by Samsung Smart TV to check native source code version.
Syntax GetFirmware( )
Parameter none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 124
Return Value If success, returns Firmware version. ( ex: T-SPHAKRC-1000 )
Otherwise, error code.
Remarks Firmware version which is used by Samsung Smart TV to check native source code version.
Emulator remarks Only returns false.
Example
var firmware;
firmware = NNaviPlugin.GetFirmware();
alert(firmware);
Enumeration none
Version Support from NNAVI-0001
Security Type System
Top
4.11.1.7. GetModelCode
Function
GetModelCode
Returns model code which is modified for Samsung Smart TV
Syntax GetModelCode( )
Parameter none
Return Value If success, returns modified model code.
Otherwise, returns error code.
Remarks
This function is replaced GetModelCode function of NNavi plugin
Modified model code is the same as real model code, except that panel size number is replaced
with XX (refer to GetRealModel())
ex) LNXXB650_KOR
Emulator remarks [Fake] Returns LNXXB650_KOR
Example DevicePlugin.GetModel();
Enumeration none
Version Support from NNAVI-0002
Security Type System
Top
4.11.1.8. GetPath
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 125
Function
GetPath
Returns path which is root of Widget manager or normal widget.
Syntax GetPath( PL_NNAVI_PATH widgetType )
Parameter
widgetType
o PL_NNAVI_PATH
o Widget type to get root path ( WidgetManager or Widget )
Return Value If success, returns root path required ( ex : /dtv_root/widgets/manager ).
Otherwise, returns error code.
Remarks none
Emulator
remarks Only returns false.
Example
var widgetPath;
widgetPath = NNaviPlugin.GetPath(PL_NNAVI_PATH_WIDGET_MANAGER);
alert(widgetPath);
Enumeration PL_NNAVI_PATH
Version Support from NNAVI-0001
Security Type System
Top
4.11.1.9. GetRemoconType
Function
GetRemoconType
GetRemoconType is the function to get The Remocon Type from the Target location.
Syntax GetRemoconType( )
Parameter none
Return Value If success, Get The Remocon Type.
Otherwise, returns error code.
Remarks none
Emulator remarks none
Example var type;
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 126
type = NNaviPlugin.GetRemoconType();
alert(type);
Enumeration none
Version Support from NNAVI-0002
Security Type System
Top
4.11.1.10. GetServerType
Function
GetServerType
Retuns whether now Samsung Hubsite is for Development or Official release.
Syntax GetServerType( )
Parameter none
Return Value If success, returns one of PL_ST_SERVICE, PL_ST_DEVELOPMENT, PL_ST_DEVELOPING
Otherwise, return error code.
Remarks
PL_ST_SERVICE : Official release server
PL_ST_DEVELOPMENT : Development server for testing
PL_ST_DEVELOPING : Developing server including testing and only for developer.
Emulator remarks Only returns fasle.
Example
var serverType;
serverType = NNaviPlugin.GetServerType();
alert(serverType);
Enumeration PL_ST
Version Support from NNAVI-0001
Security Type System
Top
4.11.1.11. GetSupportPIG
Function
GetSupportPIG
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 127
GetSupportPIG is the function for the decisiont to Support PIG
Syntax GetSupportPIG( )
Parameter none
Return Value If success, returns 1(INFOLINK_MODEL_CODE) or return 0(BD)
Otherwise, returns error code.
Remarks none
Emulator remarks Only returns false.
Example
var Type;
type = NNaviPlugin.GetSupportPIG();
alert(type);
Enumeration none
Version Support from NNAVI-0001
Security Type System
Top
4.11.1.12. GetSystemVersion
Function
GetSystemVersion
Returns system version of DTV
Syntax GetSystemVersion( PL_NNAVI_SYSTEM_VERSION versionType )
Parameter
versionType
o PL_NNAVI_SYSTEM_VERSION
o PL_NNAVI_SYSTEM_VERSION_LEEUM : version of leeum platform
PL_NNAVI_SYSTEM_VERSION_COMP : version of advanced platform
Return Value If success, returns each version information
Otherwise, returns error code.
Remarks none
Emulator
remarks Only returns false
Example
NNaviPlugin.GetSystemVersion(PL_NNAVI_SYSTEM_VERSION_LEEUM);
NNaviPlugin.GetSystemVersion(PL_NNAVI_SYSTEM_VERSION_COMP);
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 128
Enumeration PL_NNAVI_SYSTEM_VERSION
Version Support from NNAVI-0001
Security Type System
Top
4.11.1.13. GetToken
Function
GetToken
Returns token information to communicate with Samsung Hubsite.
Syntax GetToken( STRING SessinID , STRING UserID , STRING SeedKey )
Parameter
SessinID
o STRING
o Need to get using HubSite openAPI
UserID
o STRING
o Need to get using HubSite openAPI.
SeedKey
o STRING
o Need to get using HubSite openAPI.
Return Value If success, returns Token. ( ex : 111+222+b18a6aeb5e845ecefee59d971d82d82b089b0434 )
Otherwise, returns error code.
Remarks none
Emulator
remarks Only returns false
Example
var token;
token = NNaviPlugin.GetToken(SessionID, UserID, SeedKey);
alert(token);
Enumeration none
Version Support from NNAVI-0001
Security Type System
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 129
4.11.1.14. ResetWidgetData
Function
ResetWidgetData
ResetWidgetData is the function to delete a specified APP Data
Syntax ResetWidgetData( )
Parameter none
Return Value If success, Delete a Selected APP Data
Otherwise, returns error code.
Remarks none
Emulator
remarks Only returns false.
Example NNaviPlugin.ResetWidgetData(11);
Enumeration none
Version Support from NNAVI-0002
Security Type System
Top
4.11.1.15. SendEventToDevice
Function
SendEventToDevice
SendEventToDevice is thd fuction to send the event to native.
Syntax SendEventToDevice( INTEGER nEventType , STRRING pszEventData )
Parameter
nEventType
o INTEGER
o The Event type
pszEventData
o STRRING
o The DATA of events
Return Value Everytime The return Value is True.
Remarks Request update to Native.
Emulator Only returns false
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 130
remarks
Example
var type;
NNaviPlugin.SendEventToDevice(1,"data");
Enumeration none
Version Support from NNAVI-0002
Security Type System
Top
4.11.1.16. SetBannerState
Function
SetBannerState
SetBannerState is the function which controls the overlapped OSD.
Syntax SetBannerState( INTEGER nSTATE )
Parameter
nSTATE
o INTEGER
o What kind of Widgets Manager
Return Value Everytime The return Value is True.
Remarks Request update to Native.
Emulator
remarks Only returns false
Example
var type;
NNaviPlugin.SetBannerState(1);
Enumeration none
Version Support from NNAVI-0002
Security Type System
Top
4.11.2. Enumeration
4.11.2.1. PL_NNAVI_PATH
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 131
Enumeration
PL_NNAVI_PATH
path of widget
Remarks none
Emulator
remarks none
Function GetPath
Value
0 - PL_NNAVI_PATH_WIDGET_MANAGER
o To get root path of WidgetManager
1 - PL_NNAVI_PATH_WIDGET_NORMAL
o To get root path of Normal Widget
Top
4.11.2.2. PL_NNAVI_SYSTEM_VERSION
Enumeration
PL_NNAVI_SYSTEM_VERSION
System version
Remarks none
Emulator
remarks none
Function GetSystemVersion
Value
0 - PL_NNAVI_SYSTEM_VERSION_LEEUM
o LEEUM Platform?version
1 - PL_NNAVI_SYSTEM_VERSION_COMP
o COMP version
Top
4.11.2.3. PL_ST
Enumeration
PL_ST
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 132
Server type
Remarks none
Emulator
remarks none
Function GetServerType
Value
0 - PL_ST_SERVICE
o Official Release server
1 - PL_ST_DEVELOPMENT
o Development server for testing
2 - PL_ST_DEVELOPING
o Developing server including testing and only for developer
Top
4.12. Network
4.12.1. Function
4.12.1.1. CheckDNS
Function
CheckDNS
pings the DNS
Syntax CheckDNS( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
1 if DNS is reachable
0 if DNS is not reachable
-1 if error
Remarks
Emulator Only returns false.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 133
remarks
Example
var checkDNS = networkPlugin.CheckDNS(cType);
if (checkDNS == 1) document.getElementById('CheckDNS').value = "OK";
if (checkDNS == 0) document.getElementById('CheckDNS').value = "Failure";
if (checkDNS == -1){ document.getElementById('CheckDNS').value = "Error";
return;}
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.2. CheckGateway
Function
CheckGateway
pings the Gateway
Syntax CheckGateway( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
1 if Gateway is reachable
0 if Gateway is not reachable
-1 if error
Remarks
Emulator
remarks Only returns false.
Example
var checkGW = networkPlugin.CheckGateway(cType);
if (checkGW == 1) document.getElementById('CheckGateway').value = "OK";
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 134
if (checkGW == 0) document.getElementById('CheckGateway').value =
"Failure";
if (checkGW == -1) {document.getElementById('CheckGateway').value =
"Error"; return;}
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.3. CheckHTTP
Function
CheckHTTP
checks Http connectivity
Syntax CheckHTTP( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
1 if HTTP is operating successfully
0 if HTTP is not available
-1 if error
Remarks
Emulator
remarks Only returns false.
Example
var checkHttp = networkPlugin.CheckHTTP(cType);
if (checkHttp== 1) document.getElementById('HttpTest').value = "OK";
if (checkHttp== 0) document.getElementById('HttpTest').value = "Failure";
if (checkHttp== -1) {document.getElementById('HttpTest').value = "Error";
return; }
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 135
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.4. CheckPhysicalConnection
Function
CheckPhysicalConnection
checks the connectivity of cable(for wired) or to accessPoint(wireless)
Syntax CheckPhysicalConnection( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
1 if connected
0 if not connected
-1 if error
Remarks
Emulator
remarks Only returns false
Example
var phyConnection = networkPlugin.CheckPhysicalConnection(cType);
if (phyConnection == 1) document.getElementById('PhysicalConnection').value
= "OK";
if (phyConnection == 0) document.getElementById('PhysicalConnection').value
= "Failure";
if (phyConnection == -1)
{document.getElementById('PhysicalConnection').value = "Error"; return;}
Enumeration none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 136
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.5. CreatePlugin
Function
CreatePlugin
Create Plugin instance. Must be called prior to all other functions.
OBSOLETE function
Syntax CreatePlugin( )
Parameter none
Return Value True if success. In case of error, or if plugin instance already exists returns False.
Remarks Supported but OBSOLETE
Emulator
remarks [FAKE] Do nothing, just print out function name on debug console in SDK.
Example
function OnLoadFunc()
{
networkPlugin =
document.embeds[0];
networkPlugin.CreatePlugin();
..........
}
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.6. GetActiveType
Function
GetActiveType
get the current active interface(Wired or Wireless)
Syntax GetActiveType( )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 137
Parameter none
Return Value
1 if acitve interface is WIRED
0 if active interface is WIRELESS
-1 if no active connection
Remarks
Emulator
remarks Only returns true.
Example
var cType = networkPlugin.GetActiveType();
if (cType == 1) document.getElementById('ActiveConnection').value = "wired";
if (cType == 0) document.getElementById('ActiveConnection').value =
"wireless";
if (cType == -1)
{
document.getElementById('ActiveConnection').value = "no active
connection";
return;
}
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.7. GetDNS
Function
GetDNS
get DNS address
Syntax GetDNS( Number interfaceType )
Parameter
interfaceType
o Number
o This function accepts call with One parameter Or WITHOUT parameter
type of interface (Wired/Wireless)
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 138
1 = wired,
0 = wireless
if called WITHOUT parameter it returns result for WIRED network
Return Value
DNS address string if success,
NULL string if error
Remarks
Emulator remarks Only returns false
Example
//for wired interface
var mac = networkPlugin.GetDNS(1);
//or with default parameter
var mac = networkPlugin.GetDNS();
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.8. GetDNSMode
Function
GetDNSMode
get DNS type (Auto/Manual)
Syntax GetDNSMode( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
0 if Auto
1 if Manual
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 139
-1 if error
Remarks
Emulator
remarks Only returns false
Example
var cType = networkPlugin.GetActiveType();
if (cType != -1)
var DnsType = networkPlugin.GetDNSMode(cType);
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.9. GetGateway
Function
GetGateway
get Gateway address
Syntax GetGateway( Number interfaceType )
Parameter
interfaceType
o Number
o This function accepts call with One parameter Or WITHOUT parameter
type of interface (Wired/Wireless)
1 = wired,
0 = wireless
if called WITHOUT parameter it returns result for WIRED network
Return Value
Gateway address string if success,
NULL string if error
Remarks
Emulator remarks Only returns false
Example
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 140
//for wired interface
var mac = networkPlugin.GetGateway(1);
//or with default parameter
var mac = networkPlugin.GetGateway();
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.10. GetHostAddr
Function
GetHostAddr
OBSOLETE function. Returns IP address for Wired interface.
Syntax GetHostAddr( )
Parameter none
Return Value
IP address string for WIRED interface if success,
NULL string if error
Remarks Supported but OBSOLETE. Use GetIP() instead.
Emulator remarks Only returns false
Example
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.11. GetHWaddr
Function
GetHWaddr
OBSOLETE function. Returns MAC address for Wired interface.
Syntax GetHWaddr( )
Parameter none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 141
Return Value
MAC address string for WIRED interface if success,
NULL string if error
Remarks Supported but OBSOLETE. Use GetMAC() instead.
Emulator remarks Only returns false.
Example
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.12. GetIP
Function
GetIP
get IP address
Syntax GetIP( Number interfaceType )
Parameter
interfaceType
o Number
o This function accepts call with One parameter Or WITHOUT parameter
type of interface (Wired/Wireless)
1 = wired,
0 = wireless
if called WITHOUT parameter it returns result for WIRED network
Return Value
IP address string if success,
NULL string if error
Remarks
Emulator remarks Only returns false.
Example
//for wired interface
var mac = networkPlugin.GetIP(1);
//or with default parameter
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 142
var mac = networkPlugin.GetIP();
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.13. GetIPMode
Function
GetIPMode
get IP address type (Auto/Manual)
Syntax GetIPMode( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
0 if Auto
1 if Manual
-1 if error
Remarks
Emulator
remarks Only returns false.
Example
var cType = networkPlugin.GetActiveType();
if (cType != -1)
var ipType = networkPlugin.GetIPMode(cType);
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 143
4.12.1.14. GetMAC
Function
GetMAC
get MAC address
Syntax GetMAC( Number interfaceType )
Parameter
interfaceType
o Number
o This function accepts call with One parameter Or WITHOUT parameter
type of interface (Wired/Wireless)
1 = wired,
0 = wireless
if called WITHOUT parameter it returns result for WIRED network
Return Value
MAC address string if success,
NULL string if error
Remarks
Emulator remarks Only returns false.
Example
//for wired interface
var mac = networkPlugin.GetMAC(1);
//or with default parameter
var mac = networkPlugin.GetMAC();
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.15. GetNetMask
Function
GetNetMask
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 144
get NetMask address
Syntax GetNetMask( Number interfaceType )
Parameter
interfaceType
o Number
o This function accepts call with One parameter Or WITHOUT parameter
type of interface (Wired/Wireless)
1 = wired,
0 = wireless
if called WITHOUT parameter it returns result for WIRED network
Return Value
NetMask address string if success,
NULL string if error
Remarks
Emulator remarks Only returns false
Example
//for wired interface
var mac = networkPlugin.GetNetMask(1);
//or with default parameter
var mac = networkPlugin.GetNetMask();
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.16. GetNetworkInfo
Function
GetNetworkInfo
OBSOLETE function
Syntax GetNetworkInfo( )
Parameter none
Return Value
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 145
always returns PLR_TRUE
Remarks Supported but OBSOLETE.
Emulator remarks Only returns false
Example
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.17. GetNetworkType
Function
GetNetworkType
OBSOLETE function
Syntax GetNetworkType( )
Parameter none
Return Value
PLR_NOT_IMPLEMENT
Remarks please do not use this function. Use GetActiveType() instead.
Emulator remarks Only returns false
Example
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.18. GetStatus
Function
GetStatus
OBSOLETE function. Get interface status: active or not active
Syntax GetStatus( Number interfaceType )
Parameter
interfaceType
o Number
o
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 146
type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
1 - interface is active
-1 interface is not acitve or error
Remarks Supported but OBSOLETE. Use GetActiveType() instead.
Emulator remarks Only returns fasle.
Example none
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.19. IsValidDNS
Function
IsValidDNS
validates DNS address
Syntax IsValidDNS( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
1 if DNS address is valid
0 if DNS is not valid
-1 if error
Remarks
Emulator
remarks Only returns true
Example
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 147
if (networkPlugin.IsValidMAC(cType) == 1 &&
networkPlugin.IsValidIP(cType) == 1 &&
networkPlugin.IsValidSubnetMask(cType) == 1 &&
networkPlugin.IsValidGateway(cType) == 1 &&
networkPlugin.IsValidDNS(cType) == 1)
document.getElementById('Validate').value = "OK";
else
{
document.getElementById('Validate').value = "Failure";
return;
}
Enumeration none
Version Support from NETWORK-0001
Security Type none
4.12.1.20. IsValidGateway
Top
Function
IsValidGateway
validates Gateway address
Syntax IsValidGateway( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
1 if Gateway address is valid
0 if Gateway is not valid
-1 if error
Remarks
Emulator
remarks Only returns true
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 148
Example
if (networkPlugin.IsValidMAC(cType) == 1 &&
networkPlugin.IsValidIP(cType) == 1 &&
networkPlugin.IsValidSubnetMask(cType) == 1 &&
networkPlugin.IsValidGateway(cType) == 1 &&
networkPlugin.IsValidDNS(cType) == 1)
document.getElementById('Validate').value = "OK";
else
{
document.getElementById('Validate').value = "Failure";
return;
}
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.21. IsValidIP
Function
IsValidIP
validates IP address
Syntax IsValidIP( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
1 if IP address is valid
0 if IP is not valid
-1 if error
Remarks
Emulator Only returns true
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 149
remarks
Example
if (networkPlugin.IsValidMAC(cType) == 1 &&
networkPlugin.IsValidIP(cType) == 1 &&
networkPlugin.IsValidSubnetMask(cType) == 1 &&
networkPlugin.IsValidGateway(cType) == 1 &&
networkPlugin.IsValidDNS(cType) == 1)
document.getElementById('Validate').value = "OK";
else
{
document.getElementById('Validate').value = "Failure";
return;
}
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.22. IsValidMAC
Function
IsValidMAC
validates MAC address
Syntax IsValidMAC( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
1 if MAC address is valid
0 if MAC is not valid
-1 if error
Remarks
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 150
Emulator
remarks Only returns true
Example
if (networkPlugin.IsValidMAC(cType) == 1 &&
networkPlugin.IsValidIP(cType) == 1 &&
networkPlugin.IsValidSubnetMask(cType) == 1 &&
networkPlugin.IsValidGateway(cType) == 1 &&
networkPlugin.IsValidDNS(cType) == 1)
document.getElementById('Validate').value = "OK";
else
{
document.getElementById('Validate').value = "Failure";
return;
}
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.23. IsValidSubnetMask
Function
IsValidSubnetMask
validates SubNet Mask address
Syntax IsValidSubnetMask( Number interfaceType )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
Return Value
1 if SubNet Mask address is valid
0 if SubNet Mask is not valid
-1 if error
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 151
Remarks
Emulator
remarks Only returns true
Example
if (networkPlugin.IsValidMAC(cType) == 1 &&
networkPlugin.IsValidIP(cType) == 1 &&
networkPlugin.IsValidSubnetMask(cType) == 1 &&
networkPlugin.IsValidGateway(cType) == 1 &&
networkPlugin.IsValidDNS(cType) == 1)
document.getElementById('Validate').value = "OK";
else
{
document.getElementById('Validate').value = "Failure";
return;
}
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.24. SetDNSMode
Function
SetDNSMode
set DNS type (Auto/Manual)
Syntax SetDNSMode( Number interfaceType , Number mode )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
mode
o Number
o set IP mode (Auto/Manual)
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 152
0 = Auto,
1 = Manual
Return Value
1 if succeess
-1 if error
Remarks
Emulator
remarks Only returns false
Example
var cType = networkPlugin.GetActiveType();
if (cType != -1)
var result = networkPlugin.SetDNSMode(cType,0);
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.12.1.25. SetIPMode
Function
SetIPMode
set IP address type (Auto/Manual)
Syntax SetIPMode( Number interfaceType , Number mode )
Parameter
interfaceType
o Number
o type of interface (Wired/Wireless)
1 = wired,
0 = wireless
mode
o Number
o set IP mode (Auto/Manual)
0 = Auto,
1 = Manual
Return Value
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 153
1 if succeess
-1 if error
Remarks
Emulator remarks Function body is empty. Only returns false
Example
var cType = networkPlugin.GetActiveType();
if (cType != -1)
var result = networkPlugin.SetIPMode(cType, 0);
Enumeration none
Version Support from NETWORK-0001
Security Type none
Top
4.13. Player
4.13.1. Function
4.13.1.1. ClearScreen
Function
ClearScreen
This ClearScreen() erases TV screen with black.
Syntax ClearScreen( )
Parameter none
Return Value
It returns ture if it succeeds, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=Player.CleerScreen()
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.2. GetAvailableBitrates
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 154
Function
GetAvailableBitrates
GetAvailableBitrates() function retrieves available bitrestes of currently playing content for adaptive streaming.
Syntax GetAvailableBitrates( )
Parameter none
Return Value
The GetAvailableBitrates() returns available bitrates information for currently playing content in
String format.
Each bitrates in byte are separated by separator '|'.
For example, if currently playing content can support 3 different bitrates for adaptive streaming,
100Kbps, 200kbps, 300kbps,
then GetAvailableBitrates() returns string '102400|204800|307200'.
Remarks
This GetAvailableBitrates() returns valid value only when it is called after calling Play().
Emulator
remarks none
Example var bitratesInfo=Player.GetAvailableBitrates();
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.3. GetCurrentBitrates
Function
GetCurrentBitrates
GetCurrentBitrates() retrieves the bitrates of currently playing content.
Syntax GetCurrentBitrates( )
Parameter none
Return Value
The GetCurrentBitrates() returns bitrates of currently playing content in byte number format.
Remarks
This GetCurrentBitrates() returns valid value only when it is called after calling Play().
Emulator remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 155
Example var bps=Player.GetCurrentBitrates();
Enumeration
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.4. GetDuration
Function
GetDuration
GetDuration() retrieves the duration of currently playing content.
Syntax GetDuration( )
Parameter none
Return Value
GetDuration() returns the total playing time if it succeed, otherwise return -1.
Remarks
This GetDuration() API has be called after OnStreamInfoReady callback function is called.
Emulator remarks none
Example var totalTime=Player.GetDuration();
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.5. GetPLiveDuration
Function
GetLiveDuration
GetLiveDuration() retrieves duration of current live contents media server can support.
Syntax GetLiveDuration( )
Parameter none
Return Value
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 156
GetLiveDuration() returns string which include start and end time of current live content that
media server can support for current time.
Remarks
This API is available only for some contents which use Widevine live streaming solution.
Emulator remarks none
Example var retVal=GetLiveDuration();
Enumeration none
Version Support from PLAYER-0004
Security Type Multimedia
Top
4.13.1.6. GetPlayerVersion
Function
GetPlayerVersion
GetPlayerVersion retrieves the version of media player.
Syntax GetPlayerVersion( )
Parameter none
Return Value
GetPlayerVersion() returns the version of media player in the form of 'UNIPLYAER-000000'.
Remarks none
Emulator remarks none.
Example var version=GetPlayerVersion()
Enumeration none
Version Support from PLAYER-0001
Security Type none
Top
4.13.1.7. GetVideoHeight
Function
GetVideoHeight
GetVideoHeight() function retrieves height of currently playing video.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 157
Syntax GetVideoHeight( )
Parameter none
Return Value
GetVideoHeight returns the height size of currently playing video content.
Remarks
This GetVideoHeight() API has be called after OnStreamInfoReady callback function is called.
Emulator remarks none
Example var width=Player.GetVideoHeight();
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.8. GetVideoWidth
Function
GetVideoWidth
GetVideoWidth() function retrieves width of currently playing video.
Syntax GetVideoWidth( )
Parameter none
Return Value
GetVideoWidth returns the width size of currently playing video content.
Remarks
This GetVideoWidth() API has be called after OnStreamInfoReady callback function is called.
Emulator remarks none
Example var width=Player.GetVideoWidth();
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.9. InitPlayer
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 158
Function
InitPlayer
Initialize media player with the specified url.
Syntax InitPlayer( String url )
Parameter
url
o String
o
Specifies the URL of content to play
Return Value
It always returns ture.
Remarks
The InitPlayer() should not be used with Play() API.
If widget uses InitPlayer(), it has to use StartPlayback() to play a content.
Otherwidget it has to use Play() only.
When InitPlayer() is used, it has to come first becore other APIs are called.
Emulator
remarks none
Example
Player.InitPlayer(url);
SetDisplayArea(x, y, width, height);
SetInitialBufferSize(400*1024);
//400KB
StartPlayback();
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.10. JumpBackward
Function
JumpBackward
Syntax JumpBackward( Number offset )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 159
Parameter
offset
o Number
o Relative time offset from current time in second
Return Value
The return value is ture if media player succeed to jump, otherwise it returns false.
Remarks Same as TV.
Emulator remarks Implemented like TV‟s API
Example var retVal=Player.JumpBackward(30);
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.11. JumpForward
Function
JumpForward
Syntax JumpForward( Number offset )
Parameter
offset
o Number
o Relative time offset from current time in second
Return Value
The return value is ture if media player succeed to jump, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=Player.JumpForward(30);
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 160
4.13.1.12. Pause
Function
Pause
Pauses the currently playing content.
Syntax Pause( )
Parameter none
Return Value
The return value is ture if media player succeed to pause, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=Player.Pause();
Enumeration
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.13. Play
Function
Play
Starts playing a content specified by url.
Syntax Play( String url )
Parameter
url
o String
o Specifies the URL of content
Return Value
The return value is true if media player succeed to start play, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=Player.Play(url);
Enumeration none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 161
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.14. Resume
Function
Resume
Resume currently paused content.
Syntax Resume( )
Parameter none
Return Value
The return value is ture if media player succeed to resume, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=Player.Resume();
Enumeration
Version Support from PLAYER-0001
Security Type none
Top
4.13.1.15. ResumePlay
Function
ResumePlay
Starts playing a content specified by url.
Syntax ResumePlay( String url , Number sec )
Parameter
url
o String
o Specifies the URL of content
sec
o Number
o Specifies the position of content in sec
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 162
Return Value
The return value is true if media player succeed to start play, otherwise it returns false.
Remarks
The ResumePlay() is used when a widget want to play from bookmark point.
Emulator remarks none
Example var retVal=Player.ResumePlay(url, 3600);
Enumeration
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.16. SetCropArea
Function
SetCropArea
SetCropArea() sets the cropped aread of orginal image which widget wants to display.
Syntax SetCropArea( Number x , Number y , Number width , Number height )
Parameter
x
o Number
o
Specify the initial horizontal position of the cropped image.
The initial x-coordinate of the upper-left corner of the cropped image relative
to the upper-left corner of the orginal image.
y
o Number
o
Specifies the initial vertical position of the cropped image.
The initial y-coordinate of the upper-left corner of the cropped image relative
to the upper-left corner of the orginal image.
width
o Number
o
Specifies the width of cropped area.
This value must be smaller than width of original image.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 163
height
o Number
o
Specifies the height of crop area.
This value must be smaller than height of original image.
Return Value
It returns ture if it succeeds, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=Player.SetCropArea(0, 100, 1920, 880);
Enumeration
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.17. SetDisplayArea
Function
SetDisplayArea
SetDisplayArea() sets the display area for video content in TV screen.
Syntax SetDisplayArea( Number x , Number y , Number width , Number height )
Parameter
x
o Number
o
Specifies the initial x-coordinate of display area in TV screen coordinates.
This x value must be smaller than TV screen width, 960.
y
o Number
o
Specifies the initial y-coordinate of display area in TV screen coordinates.
This y value must be smaller than TV screen height, 540.
width
o Number
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 164
o
The width of display area.
This value must be smaller than width of TV screen.
height
o Number
o
The height of crop area from source Image.
This value must be smaller than height of source image.
Return Value
It returns ture if it succeeds, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=Player.SetDisplayArea(0, 0, 1920, 1080);
Enumeration
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.18. SetICT
Top
Function
SetICT
SetICT() specifies ICT output level.
Syntax SetICT( bool bICTOn )
Parameter
bICTOn
o bool
o
Specifies the ICT output level.
true : ICT On
false : ICT off
Return Value
SetICT() returns true if it succeeds, otherwise it returns false.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 165
Remarks
This API has to be called when OnStreamInfoReady callback is called.
If widget doesn't call this function, system will off the ICT.
Emulator remarks none
Example var retVal=SetICT(false);
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
Top
Top
4.13.1.19. SetInitialBuffer
Function
SetInitialBuffer
SetInitialBuffer sets the first buffering size in percent of buffer size before starting playback.
Syntax SetInitialBuffer( Number byte)
Parameter
byte
o Number
o Specifies the initial buffering size in byte
This API is optional and media player has default value.
Return Value SetInitialBuffer() returns true if it succeeds, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=SetInitialBuffer(1024*1024); //1MB
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.20. SetInitialTimeOut
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 166
Function
SetInitialTimeOut
SetInitialTimeOut sets the maximum time out value for initial buffering before starting playback.
Syntax SetInitialTimeOut( Number second )
Parameter
second
o Number
o
Specifies the time out value for initial buffering before starting playback.
This API is optional and media player has default value.
Return Value
SetInitialBuffer() returns true if it succeeds, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=SetInitialTimeOut(30);
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.21. SetMacrovision
Top
Function
SetMacrovision
SetMacrovision() specifies macrovision level.
Syntax SetMacrovision( Number macrovisionType )
Parameter
macrovisionType
o Number
o
Specifies the macrovision level.
0 : APS_ALL_OFF
1 : APS_AGC_ON_ONLY
2 : APS_AGC_ON_CS_2L
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 167
3 : APS_AGC_ON_CS_4L
Return Value
SetMacrovision() returns true if it succeeds, otherwise it returns false.
Remarks
This API has to be called when OnStreamInfoReady callback is called.
If widget doesn't call this function, system will not set macrovision level, so the level will be 0.
If widget wants to protect contents or want to use differenct level of protection, widget has to call
this API.
Emulator
remarks none
Example var retVal=SetMacrovision(3);
Enumeration none
Version Support from PLAYER-0003
Security Type Multimedia
Top
Top
4.13.1.22. SetPendingBuffer
Function
SetPendingBuffer
SetPendingBuffer() specifies the size of buffer in percent of total buffer size that media player goes out from buffering
status.
Syntax SetPendingBuffer( Number byte)
Parameter
byte
o Number
o Specifies the buffer size in byte which media player goes out from
buffering.
This API is optional and media player has default value.
Return Value
SetInitialBuffer() returns true if it succeeds, otherwise it returns false.
Remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 168
Emulator remarks none
Example var retVal=SetPendingBuffer(512*1024); //512KB
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.23. SetPlaybackSpeed
Function
SetPlaybackSpeed
SetPlaybackSpeed() sets playback speed of contents.
Syntax SetPlaybackSpeed( Number speed )
Parameter
speed
o Number
o
Specifies the playback speed in multiple of 2.
This can be negative integer for backward playback.
Return Value
The return value is ture if media player succeed to play in the speed specified by paramter,
otherwise it's false.
Remarks
SetPlaybackSpeed() has be called after Play() function is called.
Emulator remarks none
Example var retVal=SetPlaybackSpeed(2);
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
4.13.1.24. SetPlayerProperty
Function
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 169
SetPlayerProperty
SetPlayerProperty sets property such as Cookie to media player
Syntax SetPlayerProperty( Number Type , String StrParam , Number NumParam )
Parameter
Type
o Number
o Specifies the type of property widget want to set.
1 : Cookie
StrParam
o String
o Specifies the string parameter of property defined in 1st, Type,
parameter.
ex) Cookie value for cookie property.
NumParam
o Number
o Specifies the number parameter of property defined in 1st, Type,
parameter.
ex) Cookie value length for cookie property.
Return Value SetPlayerProperty() returns true if it succeeds, otherwise it returns false.
Remarks This API has to be called between InitPlayer() and StartPlayback().
Thus, Play() must not be used to use SetPlayerProperty().
Emulator
remarks none
Example
InitPlayer(URL);
SetTotalBufferSize(size); //Optional
SetPlayerProperty(1, "CookieValue", CookievalueLength); //Set
cookie
StartPlayback(sec);
Enumeration none
Version Support from PLAYER-0006
Security Type Multimedia
Top
4.13.1.25. SetTotalBufferSize
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 170
Function
SetTotalBufferSize
SetTotalBufferSize sets stremaing buffer size of media player.
Syntax SetTotalBufferSize( Number size )
Parameter
size
o Number
o
Specifies the total buffer size for streaming in bytes.
This API is optional and media player has default value.
Return Value
SetTotalBufferSize() returns true if it succeeds, otherwise it returns false.
Remarks none
Emulator
remarks none
Example var retVal=SetTotalBufferSize(5*1024*1024); //5MB
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.26. SetVBIData
Top
Function
SetVBIData
SetVBIData() specifies VBIData output level.
Syntax SetVBIData( Number macrovisionType , Number cgmsType )
Parameter
macrovisionType
o Number
o
Specifies the macrovisionType level.
0 : APS_ALL_OFF
1 : APS_AGC_ON_ONLY
2 : APS_AGC_ON_CS_2L
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 171
3 : APS_AGC_ON_CS_4L
cgmsType
o Number
o
Specifies the cgmsType level.
0 : CGMS_COPY_FREE
1 : CGMS_COPY_NO_MORE
2 : CGMS_COPY_ONCE
3 : CGMS_COPY_NEVER
Return Value
SetVBIData() returns true if it succeeds, otherwise it returns false.
Remarks
This API has to be called when OnStreamInfoReady callback is called.
If widget doesn't call this function, system will not set VBIData output level, so the lowest level
will be applied.
If widget wants to protect contents or want to use differenct level of protection, widget has to call
this API.
The default is APS_ALL_OFF with CGMS_COPY_FREE.
Emulator remarks none
Example var retVal=SetVBIData(3, 3);
Enumeration none
Version Support from PLAYER-0003
Security Type Multimedia
Top
Top
4.13.1.27. StartPlayback
Function
StartPlayback
Start playback of contents
Syntax StartPlayback( )
Parameter none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 172
Return Value
It returns true if it succeeds, otherwise it returns false.
Remarks
StartPlayback() has to be called with InitPlayer(), and it can't be called with Play().
Also StartPlaybac() can't be called before InitPlayer() is called.
Emulator
remarks none.
Example
Player.InitPlayer(url);
SetDisplayArea(x, y, width, height);
SetInitialBufferSize(400*1024);
//400KB
StartPlayback();
Enumeration none
Version Support from PLAYER-0001
Security Type Multimedia
Top
4.13.1.28. Stop
Function
Stop
Stops the currently playing content.
Syntax Stop( )
Parameter none
Return Value
The return value is ture if media player succeed to stop, otherwise it returns false.
Remarks none
Emulator remarks none
Example var retVal=Player.Stop();
Enumeration none
Version Support from PLAYER-0001
Security Type none
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 173
4.13.3. Event
4.13.3.1. OnAdEnd
Top
Event
OnAdEnd
Event to notify that playback for advertisement is finished. This event is available only for some specific contents which
use HAS streaming solution.
Parameter none
Remarks none
Emulator
remarks none
Example
Player.OnAdEnd=OnAdEnd;
function OnAdEnd()
{
...
}
Version PLAYER-0005
Top
4.13.3.2. OnAdStart
Event
OnAdStart
Event to notify that playback for advertisement is started. This event is available only for some specific contents which
use HAS streaming solution.
Parameter none
Remarks none
Emulator
remarks none
Example
Player.OnAdStart=OnAdStart;
function OnAdStart()
{
...
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 174
}
Version PLAYER-0005
Top
4.13.3.3. OnConnectionFailed
Event
OnAuthenticationFailed
OnConnectionFailed event is sent by media player when it fails to play because authentication process has been failed.
Parameter
o
o
Remarks none
Emulator
remarks none
Example
Player.OnAuthenticationFailed=OnAuthenticationFailed;
function OnAuthenticationFailed()
{
Player.Stop();
...
}
Version PLAYER-0001
Top
4.13.3.4. OnBufferingStartComplete
Event
OnBufferingComplete
OnBufferingStart event is sent by media player when it gets out of buffering status.
Parameter none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 175
Remarks none
Emulator
remarks none
Example
Player.OnBufferingComplete=OnBufferingComplete;
function OnBufferingComplete()
{
//unload buffering image.
}
Version PLAYER-0001
Top
4.13.3.5. OnBufferingProgress
Event
OnBufferingProgress
OnBufferingProgress event is sent by media play to notify how much data it has to receive more to get out from
buffering status.
Parameter
percent
o Number
o
Remarks
The minimum value of parameter is 0 and the maximum is 100.
Emulator
remarks none
Example
Player.OnBufferingProgress=OnBufferingProgress;
function OnBufferingProgress()
{
//Draing buffering progress bar.
}
Version PLAYER-0001
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 176
4.13.3.6. OnBufferingStart
Event
OnBufferingStart
OnBufferingStart event is sent by media player when it goes on buffering status.
Parameter none
Remarks none
Emulator
remarks none
Example
Player.OnBufferingStart=OnBufferingStart;
function OnBufferingStart()
{
//Drawing buffering image.
}
Version PLAYER-0001
Top
4.13.3.7. OnConnectionFailed
Event
OnConnectionFailed
OnConnectionFailed event is sent by media player when it fails to connect to streaming server.
Parameter
o
o
Remarks
OnConnectionFailed event is different from OnNetworkDisconnected.
This event is sent only when media player fails to connect to server at the begining or at the jump in
HTTP and HTTPS streaming.
Emulator
remarks none
Example
Player.OnConnectionFailed=OnConnectionFailed;
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 177
function OnConnectionFailed()
{
Player.Stop();
...
}
Version PLAYER-0001
Top
4.13.3.8. OnCurrentPlayTime
Event
OnCurrentPlayTime
OnCurrentPlayTime is sent by media player to notify current playback time.
Parameter
milli-sec
o Number
o
Remarks none
Emulator
remarks none
Example
Player.OnCurrentPlayTime=OnCurrentPlayTime;
function OnCurrentPlayTime()
{
...
}
Version PLAYER-0001
Top
4.13.3.9. OnNetworkDisconnected
Event
OnNetworkDisconnected
OnNetworkDisconnected is sent by media player when it knows that ethernet is disconnected or streaming server stops
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 178
to support content in the middle of streaming.
Parameter none
Remarks
Receiving OnNetworkDisconnected event means media player already succeed to connect to
streaming server.
Usually this event means network is disconnected during the streaming.
Emulator
remarks none
Example
Player.OnNetworkDisconnected=OnNetworkDisconnected;
function OnNetworkDisconnected()
{
Player.Stop();
....
}
Version PLAYER-0001
Top
4.13.3.10. OnRenderError
Event
OnRenderError
OnRenderError event is sent by media player when it found that there are some problem in rendering because of the
reason specified by parameter.
Parameter
renderErrorType
o Number
o
Remarks
Parameter value of OnRenderError means as follow;
1 : Unsupported container
2 : Unsupported video codec
3 : Unsupported audio codec
4 : Unsupported video resolution
Emulator none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 179
remarks
Example
Version PLAYER-0001
Top
4.13.3.11. OnRenderingComplete
Event
OnRenderingComplete
OnRenderingComplete event is sent by media player when it reaches to the end of stream.
Parameter none
Remarks none
Emulator
remarks none
Example
Player.OnRenderingComplete=OnRenderingComplete;
function OnRenderingComplete()
{
Player.Stop();
}
Version PLAYER-0001
Top
4.13.3.12. OnResolutionChanged
Event
OnResolutionChanged
Event to notify that the Video resolution has been changed during playback. This event is available only for some
specific contents which use HAS streaming solution.
Parameter none
Remarks none
Emulator
remarks none
Example
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 180
Player.OnResolutionChanged=OnResolutionChanged;
function OnResolutionChanged()
{
...
}
Version PLAYER-0002
Top
Top
4.13.3.13. OnStreamInfoReady
Event
OnStreamInfoReady
OnStreamInfoReady event is sent by media player when it is ready to send content information such as duration and
video resolution after parsing the stream.
Parameter none
Remarks
There are a few APIs which gives valid information only when they are called after
OnStreamInfoReady() event is sent.
APIs such as GetDuration(), GetVideoWidth(), and GetVideoHeight() are have to be used after
widget get OnStreamInfoReady event.
Emulator
remarks none
Example
Player.OnStreamInfoReady=OnStreamInfoReady;
function OnStreamInfoReady()
{
var totaltime=Player.GetDuration();
var width=Player.GetVideoWidth();
var height=Player.GetVideoHeight();
}
Version PLAYER-0001
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 181
4.13.3.14. OnStreamNotFound
Event
OnStreamNotFound
OnStreamNotFound event is sent by meida player when it fails to play because streaming server replys that the stream
specified by url parameter of Play() API is not exist.
Parameter none
Remarks
Emulator
remarks none
Example
Player.OnStreamNotFound=OnStreamNotFound;
function OnStreamNotFound()
{
Player.Stop();
....
}
Version PLAYER-0001
Top
4.14. Screen
4.14.1. Function
4.14.1.1. Check3DEffectMode
Function
Check3DEffectMode
Check3DEffectMode function returns whether 3DEffect mode can be chagend to input mode or not
Syntax Check3DEffectMode( PL_SCREEN_3DEFFECT_MODE mode )
Parameter
mode
o PL_SCREEN_3DEFFECT_MODE
o 3DEffect mode
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 182
Return
Value
If success, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks Only returns false.
Example
if( 1 == ScreenPlugin.Flag3DEffectSupport() )
{
if( PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SIDE ==
ScreenPlugin.Get3DEffectMode() )
{
if( 1 ==
ScreenPlugin.Check3DEffectMode(PL_SCREEN_3DEFFECT_MODE_OFF);
{
ScreenPlugin.Set3DEffectMode(PL_SCREEN_3DEFFECT_MODE_OFF);
}
}
else
{
if( 1 ==
ScreenPlugin.Check3DEffectMode(PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SI
DE);
{
ScreenPlugin.Set3DEffectMode(PL_SCREEN_3DEFFECT_MODE_SIDE_
BY_SIDE);
}
}
}
Enumerati
on
PL_SCREEN_3DEFFECT_MODE
Version Support from SCREEN-0002
Security
Type Multimedia
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 183
4.14.1.2. Flag3DTVConnect
Function
Flag3DTVConnect
Flag3DTVConnect function returns whether connect TV supports 3DEffect or not. call
this function only on BD
Syntax Flag3DTVConnect( )
Parameter none
Return
Value
If connected TV supports 3DEffect, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks none
Example
if( 1 == ScreenPlugin.Flag3DTVConnect() )
{
if( PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SIDE ==
ScreenPlugin.Get3DEffectMode() )
{
if( 1 ==
ScreenPlugin.Check3DEffectMode(PL_SCREEN_3DEFFECT_MODE_OFF);
{
ScreenPlugin.Set3DEffectMode(PL_SCREEN_3DEFFECT_MODE_OFF);
}
}
else
{
if( 1 ==
ScreenPlugin.Check3DEffectMode(PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SIDE
);
{
ScreenPlugin.Set3DEffectMode(PL_SCREEN_3DEFFECT_MODE_SIDE_BY
_SIDE);
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 184
}
}
}
Enumeratio
n none
Version Support from SCREEN-0005
Security
Type none
Top
4.14.1.3. Flag3DEffectSupport
Function
Flag3DEffectSupport
Flag3DEffectSupport function returns whether device supports 3DEffect or not
Syntax Flag3DEffectSupport( )
Parameter none
Return
Value
If device supports 3DEffect, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks Only returns false.
Example
if( 1 == ScreenPlugin.Flag3DEffectSupport() )
{
if( PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SIDE ==
ScreenPlugin.Get3DEffectMode() )
{
if( 1 ==
ScreenPlugin.Check3DEffectMode(PL_SCREEN_3DEFFECT_MODE_OFF);
{
ScreenPlugin.Set3DEffectMode(PL_SCREEN_3DEFFECT_MODE_OFF);
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 185
}
else
{
if( 1 ==
ScreenPlugin.Check3DEffectMode(PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SI
DE);
{
ScreenPlugin.Set3DEffectMode(PL_SCREEN_3DEFFECT_MODE_SIDE_
BY_SIDE);
}
}
}
Enumerati
on none
Version Support from SCREEN-0002
Security
Type Multimedia
Top
4.14.1.4. Get3DEffectMode
Function
Get3DEffectMode
Get3DEffectMode function returns a current 3DEffectMode ( PL_SCREEN_3DEFFECT_MODE )
Syntax Get3DEffectMode( )
Parameter none
Return
Value
If success, returns a current 3DEffectMode ( PL_SCREEN_3DEFFECT_MODE )
otherwise, returns negative value
Remarks none
Emulator
remarks Only returns PL_SCREEN_3DEFFECT_MODE_OFF
Example if( 1 == ScreenPlugin.Flag3DEffectSupport() )
{
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 186
if( PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SIDE ==
ScreenPlugin.Get3DEffectMode() )
{
if( 1 ==
ScreenPlugin.Check3DEffectMode(PL_SCREEN_3DEFFECT_MODE_OFF);
{
ScreenPlugin.Set3DEffectMode(PL_SCREEN_3DEFFECT_MODE_OFF);
}
}
else
{
if( 1 ==
ScreenPlugin.Check3DEffectMode(PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SI
DE);
{
ScreenPlugin.Set3DEffectMode(PL_SCREEN_3DEFFECT_MODE_SIDE_
BY_SIDE);
}
}
}
Enumerati
on
PL_SCREEN_3DEFFECT_MODE
Version Support from SCREEN-0002
Security
Type Multimedia
Top
4.14.1.5. GetOption
Function
GetOption
GetOption function returns a value for each option(PL_SCREEN_OPTION)
Syntax GetOption( PL_SCREEN_OPTION option )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 187
Parameter
option
o PL_SCREEN_OPTION
o option
Return Value
If success, a value for each option(PL_SCREEN_OPTION)
otherwise, returns negative value
For detail return value, see PL_SCREEN_OPTION section.
Remarks none
Emulator
remarks Only return true.
Example
if( 1 == ScreenPlugin.GetOption(PL_SCREEN_OPTION_SHOP_MODE) )
{
ScreenPlugin.GetOption(PL_SCREEN_OPTION_SHOP_MODE, 0)
}
else
{
...
}
Enumeration PL_SCREEN_OPTION
Version Support from SCREEN-0002
Security Type TVInfo
Top
4.14.1.6. Set3DEffectMode
Function
Set3DEffectMode
Set3DEffectMode function sets 3DEffect
Syntax Set3DEffectMode( PL_SCREEN_3DEFFECT_MODE mode )
Parameter
mode
o PL_SCREEN_3DEFFECT_MODE
o 3DEffect mode
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 188
Return
Value
If success, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks Only returns false
Example
if( 1 == ScreenPlugin.Flag3DEffectSupport() )
{
if( PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SIDE ==
ScreenPlugin.Get3DEffectMode() )
{
if( 1 ==
ScreenPlugin.Check3DEffectMode(PL_SCREEN_3DEFFECT_MODE_OFF);
{
ScreenPlugin.Set3DEffectMode(PL_SCREEN_3DEFFECT_MODE_OFF);
}
}
else
{
if( 1 ==
ScreenPlugin.Check3DEffectMode(PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SI
DE);
{
ScreenPlugin.Set3DEffectMode(PL_SCREEN_3DEFFECT_MODE_SIDE_
BY_SIDE);
}
}
}
Enumerati
on
PL_SCREEN_3DEFFECT_MODE
Version Support from SCREEN-0002
Security
Type Multimedia
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 189
Top
Top
4.14.2. Enumeration
4.14.2.1. PL_SCREEN_3DEFFECT_MODE
Enumeration
PL_SCREEN_3DEFFECT_MODE
3D effect mode
Remarks none
Emulator
remarks none
Function
Set3DEffectMode
Get3DEffectMode
Check3DEffectMode
Value
0 - PL_SCREEN_3DEFFECT_MODE_OFF
1 - PL_SCREEN_3DEFFECT_MODE_TOP_BOTTOM
2 - PL_SCREEN_3DEFFECT_MODE_SIDE_BY_SIDE
3 - PL_SCREEN_3DEFFECT_MODE_LINE_BY_LINE
4 - PL_SCREEN_3DEFFECT_MODE_VERTICAL_STRIPE
5 - PL_SCREEN_3DEFFECT_MODE_FRAME_SEQUENCE
6 - PL_SCREEN_3DEFFECT_MODE_CHECKER_BD
7 - PL_SCREEN_3DEFFECT_MODE_FROM_2D_TO_3D
Top
4.14.2.2. PL_SCREEN_OPTION
Enumeration
PL_SCREEN_OPTION
screen option
Remarks none
Emulator
remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 190
Function
GetOption
SetOption
Value
3 - PL_SCREEN_OPTION_SHOP_MODE
o value : Shop mode(1), Home mode(0)
36 - PL_SCREEN_OPTION_FIXED_FRAME_RATE
o value : fixed(1), non-fixed(0)
41 - PL_SCREEN_OPTION_BRIGHTNESS_SENSOR
o value : on(1), off(0)
Top
4.15. TV
4.15.1. Function
4.15.1.1. CheckPIP
Function
CheckPIP
CheckPIP function return whether you can change PIP state or not
Syntax CheckPIP( Number IsOn )
Parameter
IsOn
o Number
o On : 1, Off : 0
Return Value
If you can change PIP state to IsOn value, returns 1,
If you can't cahnge, returns 0,
If function fails, returns negative value
Remarks none
Emulator remarks Only returns false
Example
if( 1 == TVPlugin.GetPIP() )
{
if( 0 < TVPlugin.CheckPIP(0) )
{
TVPlugin.SetPIP(0);
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 191
}
Enumeration none
Version Support from TV-0003
Security Type TVInfo
Top
4.15.1.2. FlagStreamDST
Function
FlagStreamDST
FlagStreamDST function returns DST(Daylight Saving Time) on/off information from a current stream
Syntax FlagStreamDST( )
Parameter none
Return Value If success, returns positive value.
otherwise, returns negative value
Remarks none
Emulator remarks Only returns false
Example TVPlugin.FlagStreamDST();
Enumeration none
Version Support from TV-0001
Security Type TVInfo
Top
4.15.1.3. GetBDProductType
Function
GetBDProductType
GetBDProductType function returns a BD product type ( Single or HTS or ... )
Syntax GetBDProductType( )
Parameter none
Return Value If success, returns a target location. (PL_TV_BDPRODUCT_TYPE)
otherwise, returns negative value
Remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 192
Emulator remarks [Fake] returns PL_TV_BDPRODUCT_TYPE_SINGLE
Example
if( PL_TV_BDPRODUCT_TYPE_SINGLE ==
TVPlugin.GetBDProductType() )
{
...
}
7Enumeration PL_TV_BDPRODUCT_TYPE
Version Support from TV-0007
Security Type TVInfo
Top
4.15.1.4. GetCountry
Function
GetCountry
GetCountry function returns a current country information
Syntax GetCountry( )
Parameter none
Return Value If success, returns a current country information. (PL_TV_COUNTRY)
otherwise, returns negative value
Remarks This function replace same name function of TVMW plugin
Emulator
remarks none
Example
alert("SetCountry = " + TVPlugin.SetCountry(PL_TV_COUNTRY_USA));
alert("SetLanguage = " +
TVPlugin.SetLanguage(PL_TV_LANGUAGE_FRA_US));
alert("Country = " + TVPlugin.GetCountry());
alert("Language = " + TVPlugin.GetLanguage());
Enumeration PL_TV_COUNTRY
Version Support from TV-0001
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 193
Security Type TVInfo
Top
4.15.1.5. GetDisplayPanelType
Function
GetDisplayPanelType
GetDisplayPanelType function returns a display panel type ( LCD or LED ... )
Syntax GetDisplayPanelType( )
Parameter none
Return Value If success, returns a display panel type. (PL_TV_DISPLAY_PANEL)
otherwise, returns negative value
Remarks This function replace same name function of Device plugin
Emulator
remarks none
Example
if( TVPlugin.GetDisplayPanelType() == PL_TV_DISPLAY_PANEL_PDP);
{
...
}
Enumeration PL_TV_DISPLAY_PANEL
Version Support from TV-0004
Security Type TVInfo
Top
4.15.1.6. GetDST
Function
GetDST
GetDST function returns a current DST(Daylight Saving Time) type
Syntax GetDST( )
Parameter none
Return Value If success, returns a current DST Type. (PL_TV_DST_TYPE)
otherwise, returns negative value
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 194
Remarks none
Emulator remarks Oly returns false
Example TVPlugin.GetDST();
Enumeration PL_TV_DST_TYPE
Version Support from TV-0001
Security Type TVInfo
Top
4.15.1.7. GetLanguage
Function
GetLanguage
GetLanguage function returns a language information
Syntax GetLanguage( )
Parameter none
Return Value If success, returns a language information. (PL_TV_LANGUAGE)
otherwise, returns negative value
Remarks This function replace same name function of TVMW plugin
Emulator
remarks none
Example
alert("SetCountry = " + TVPlugin.SetCountry(PL_TV_COUNTRY_USA));
alert("SetLanguage = " +
TVPlugin.SetLanguage(PL_TV_LANGUAGE_FRA_US));
alert("Country = " + TVPlugin.GetCountry());
alert("Language = " + TVPlugin.GetLanguage());
Enumeration PL_TV_LANGUAGE
Version Support from TV-0001
Security Type TVInfo
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 195
4.15.1.8. GetLanguageSet
Function
GetLanguageSet
GetLanguageSet function returns a language set
Syntax GetLanguageSet( )
Parameter none
Return Value If success, returns a language set. (PL_TV_FACTORY_LANGUAGE)
otherwise, returns negative value
Remarks none
Emulator
remarks none
Example alert("TVPlugin.GetLanguageSet() = " + TVPlugin.GetLanguageSet());
Enumeration PL_TV_FACTORY_LANGUAGE
Version Support from TV-0009
Security Type TVInfo
Top
4.15.1.9. GetPIP
Function
GetPIP
GetPIP function return current PIP state(On or Off)
Syntax GetPIP( )
Parameter none
Return Value
If PIP is on, returns 1,
If PIP is off, returns 0,
If function fails, returns negative value
Remarks none
Emulator remarks Only returns false
Example
if( 1 == TVPlugin.GetPIP() )
{
if( 0 < TVPlugin.CheckPIP(0) )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 196
{
TVPlugin.SetPIP(0);
}
}
Enumeration none
Version Support from TV-0003
Security Type TVInfo
Top
4.15.1.10. GetPresentProgram_Duration
Function
GetPresentProgram_Duration
GetPresentProgram_Duration function returns duration(sec) of current program
Syntax GetPresentProgram_Duration( )
Parameter none
Return Value If success, returns duration(sec) of current program
otherwise, returns negative value
Remarks none
Emulator
remarks Returns duration of current program in a virtual channel.
Example
var title = TVPlugin.GetPresentProgram_Title();
var startTime =
TimePlugin.ConvertEpochToLocalTime(TVPlugin.GetPresentProgram_StartTime());
var endTime =
TimePlugin.ConvertEpochToLocalTime(TVPlugin.GetPresentProgram_EndTime());
var duration = TVPlugin.GetPresentProgram_Duration();
Enumeration none
Version Support from TV-0001
Security
Type Channel
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 197
4.15.1.11. GetPresentProgram_EndTime
Function
GetPresentProgram_EndTime
GetPresentProgram_EndTime function returns end time(UTC) of current program
Syntax GetPresentProgram_EndTime( )
Parameter none
Return Value If success, returns end time(UTC) of current program
otherwise, returns negative value
Remarks none
Emulator
remarks Returns end time of current programe in a virtual channel
Example
var title = TVPlugin.GetPresentProgram_Title();
var startTime =
TimePlugin.ConvertEpochToLocalTime(TVPlugin.GetPresentProgram_StartTime());
var endTime =
TimePlugin.ConvertEpochToLocalTime(TVPlugin.GetPresentProgram_EndTime());
var duration = TVPlugin.GetPresentProgram_Duration();
Enumeration none
Version Support from TV-0001
Security
Type Channel
Top
4.15.1.12. GetPresentProgram_StartTime
Function
GetPresentProgram_StartTime
GetPresentProgram_StartTime function returns start time(UTC) of current program
Syntax GetPresentProgram_StartTime( )
Parameter none
Return Value If success, returns start time(UTC) of current program
otherwise, returns negative value
Remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 198
Emulator
remarks Returns start time of current program in a virtual channel.
Example
var title = TVPlugin.GetPresentProgram_Title();
var startTime =
TimePlugin.ConvertEpochToLocalTime(TVPlugin.GetPresentProgram_StartTime());
var endTime =
TimePlugin.ConvertEpochToLocalTime(TVPlugin.GetPresentProgram_EndTime());
var duration = TVPlugin.GetPresentProgram_Duration();
Enumeration none
Version Support from TV-0001
Security
Type Channel
Top
4.15.1.13. GetPresentProgram_Title
Function
GetPresentProgram_Title
GetPresentProgram_Title function returns title of current program
Syntax GetPresentProgram_Title( )
Parameter none
Return Value If success, returns title of current program
otherwise, returns negative value
Remarks none
Emulator
remarks Returns a title of current program in a virtual channel.
Example
var title = TVPlugin.GetPresentProgram_Title();
var startTime =
TimePlugin.ConvertEpochToLocalTime(TVPlugin.GetPresentProgram_StartTime());
var endTime =
TimePlugin.ConvertEpochToLocalTime(TVPlugin.GetPresentProgram_EndTime());
var duration = TVPlugin.GetPresentProgram_Duration();
Enumeration none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 199
Version Support from TV-0001
Security
Type Channel
Top
4.15.1.14. GetProductCode
Function
GetProductCode
GetProductCode function returns a product code ( ex: UNNOC7000 )
Syntax GetProductType ( NUMBER region )
Parameter
region
o NUMBER
o 1:add "_[region]", 0:No region
Return Value If success, returns a target location. (UNNOC7000 or UNNOC7000_USA)
otherwise, returns negative value
Remarks none
Emulator
remarks [Fake] Returns LN40B650_KOR
Example
if( "UNNOC7000_USA" == TVPlugin.GetProductCode(1) )
{
...
}
Enumeration none
Version Support from TV-0007
Security Type Channel
Top
4.15.1.15. GetProductType
Function
GetProductType
GetProductType function returns a product type (TV or BD or Mornitor ...)
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 200
Syntax GetProductType( )
Parameter none
Return Value If success, returns a product type. (PL_TV_PRODUCT_TYPE)
otherwise, returns negative value
Remarks none
Emulator
remarks [Fake]Returns PL_TV_PRODUCT_TYPE_TV
Example
if( PL_TV_PRODUCT_TYPE_BD == TVPlugin.GetProductType() )
{
...
}
Enumeration PL_TV_PRODUCT_TYPE
Version Support from TV-0004
Security Type Channel
Top
4.15.1.16. GetProgram_Duration
Function
GetProgram_Duration
GetProgram_Duration function returns duration(sec) of program at input index
Syntax GetProgram_Duration( Number index )
Parameter
index
o Number
o index on program list made by GetProgramList function
Return Value If success, returns duration(sec) of program at input index
otherwise, returns negative value
Remarks none
Emulator
remarks Returns duration of program at input index in a virtual channel
Example var epochTime = TimePlugin.GetEpochTime();
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 201
TVPlugin.GetProgramList(epochTime, 3600);
var programListSize = TVPlugin.GetProgramList_Size();
if( programListSize > 5 )
{
programListSize = 5;
}
for(var i=0 ; i<programListSize ; ++i)
{
document.getElementById('Title' + i).value =
TVPlugin.GetProgram_Title(i);
document.getElementById('Start' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_StartTime(i) );
document.getElementById('End' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_EndTime(i) );
document.getElementById('Duration' + i).value =
TVPlugin.GetProgram_Duration(i);
}
Enumeration none
Version Support from TV-0001
Security Type Channel
Top
4.15.1.17. GetProgram_EndTime
Function
GetProgram_EndTime
GetProgram_EndTime function returns end time(UTC) of program at input index
Syntax GetProgram_EndTime( Number index )
Parameter
index
o Number
o index on program list made by GetProgramList function
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 202
Return Value If success, returns end time(UTC) of program at input index
otherwise, returns negative value
Remarks none
Emulator
remarks Returns end time of program at input index in a virtual channel.
Example
var epochTime = TimePlugin.GetEpochTime();
TVPlugin.GetProgramList(epochTime, 3600);
var programListSize = TVPlugin.GetProgramList_Size();
if( programListSize > 5 )
{
programListSize = 5;
}
for(var i=0 ; i<programListSize ; ++i)
{
document.getElementById('Title' + i).value =
TVPlugin.GetProgram_Title(i);
document.getElementById('Start' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_StartTime(i) );
document.getElementById('End' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_EndTime(i) );
document.getElementById('Duration' + i).value =
TVPlugin.GetProgram_Duration(i);
}
Enumeration none
Version Support from TV-0001
Security Type Channel
Top
4.15.1.18. GetProgram_StartTime
Function
GetProgram_StartTime
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 203
GetProgram_StartTime function returns start time(UTC) of program at input index
Syntax GetProgram_StartTime( Number index )
Parameter
index
o Number
o index on program list made by GetProgramList function
Return Value If success, returns start time(UTC) of program at input index
otherwise, returns negative value
Remarks none
Emulator
remarks Returns start time of program at input index in a virtual channel.
Example
var epochTime = TimePlugin.GetEpochTime();
TVPlugin.GetProgramList(epochTime, 3600);
var programListSize = TVPlugin.GetProgramList_Size();
if( programListSize > 5 )
{
programListSize = 5;
}
for(var i=0 ; i<programListSize ; ++i)
{
document.getElementById('Title' + i).value =
TVPlugin.GetProgram_Title(i);
document.getElementById('Start' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_StartTime(i) );
document.getElementById('End' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_EndTime(i) );
document.getElementById('Duration' + i).value =
TVPlugin.GetProgram_Duration(i);
}
Enumeration none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 204
Version Support from TV-0001
Security Type Channel
Top
4.15.1.19. GetProgram_Title
Function
GetProgram_Title
GetProgram_Title function returns title of program at input index
Syntax GetProgram_Title( Number index )
Parameter
index
o Number
o index on program list made by GetProgramList function
Return Value If success, returns title of program at input index
otherwise, returns negative value
Remarks none
Emulator
remarks Returns title of program at intput index in a virtual channel
Example
var epochTime = TimePlugin.GetEpochTime();
TVPlugin.GetProgramList(epochTime, 3600);
var programListSize = TVPlugin.GetProgramList_Size();
if( programListSize > 5 )
{
programListSize = 5;
}
for(var i=0 ; i<programListSize ; ++i)
{
document.getElementById('Title' + i).value =
TVPlugin.GetProgram_Title(i);
document.getElementById('Start' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_StartTime(i) );
document.getElementById('End' + i).value =
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 205
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_EndTime(i) );
document.getElementById('Duration' + i).value =
TVPlugin.GetProgram_Duration(i);
}
Enumeration none
Version Support from TV-0001
Security Type Channel
Top
4.15.1.20. GetProgramList
Function
GetProgramList
GetProgramList function make program list of input time
Syntax GetProgramList( Number startTime , Number duration )
Parameter
startTime
o Number
o Start time to search(UTC)
duration
o Number
o Duration from startTime(sec)
Return Value If success, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks Make program list of intput time with a virtual channel.
Example
var epochTime = TimePlugin.GetEpochTime();
TVPlugin.GetProgramList(epochTime, 3600);
var programListSize = TVPlugin.GetProgramList_Size();
if( programListSize > 5 )
{
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 206
programListSize = 5;
}
for(var i=0 ; i<programListSize ; ++i)
{
document.getElementById('Title' + i).value =
TVPlugin.GetProgram_Title(i);
document.getElementById('Start' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_StartTime(i) );
document.getElementById('End' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_EndTime(i) );
document.getElementById('Duration' + i).value =
TVPlugin.GetProgram_Duration(i);
}
Enumeration none
Version Support from TV-0001
Security Type Channel
Top
4.15.1.21. GetProgramList_Size
Function
GetProgramList_Size
GetProgramList_Size function returns size of program list
Syntax GetProgramList_Size( )
Parameter none
Return Value If success, returns return size of program list
otherwise, returns negative value
Remarks none
Emulator
remarks Returns size of program list made with a virtual channel.
Example var epochTime = TimePlugin.GetEpochTime();
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 207
TVPlugin.GetProgramList(epochTime, 3600);
var programListSize = TVPlugin.GetProgramList_Size();
if( programListSize > 5 )
{
programListSize = 5;
}
for(var i=0 ; i<programListSize ; ++i)
{
document.getElementById('Title' + i).value =
TVPlugin.GetProgram_Title(i);
document.getElementById('Start' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_StartTime(i) );
document.getElementById('End' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_EndTime(i) );
document.getElementById('Duration' + i).value =
TVPlugin.GetProgram_Duration(i);
}
Enumeration none
Version Support from TV-0001
Security Type Channel
Top
4.15.1.22. GetTargetLocation
Function
GetTargetLocation
GetTargetLocation function returns a target location (KOR or USA ...)
Syntax GetTargetLocation( )
Parameter none
Return Value If success, returns a target location. (PL_TV_TARGET_LOCATION)
otherwise, returns negative value
Remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 208
Emulator
remarks [Fake]Returns PL_TV_TARGET_LOCATION_UNKNOWN
Example
if( PL_TV_TARGET_LOCATION_USA == TVPlugin.GetTargetLocation() )
{
...
}
Enumeration PL_TV_TARGET_LOCATION
Version Support from TV-0005
Security Type TVInfo
Top
4.15.1.23. GetTimeZone
Function
GetTimeZone
GetTimeZone function returns a timezone(PL_TV_TIMEZONE)
Syntax GetTimeZone( )
Parameter none
Return Value If success, returns a timezone(PL_TV_TIMEZONE)
otherwise, returns negative value
Remarks none
Emulator remarks Only returns false
Example TVPlugin.GetTimeZone();
Enumeration PL_TV_TIMEZONE
Version Support from TV-0001
Security Type TVInfo
Top
4.15.1.24. GetTimeZone_Offset
Function
GetTimeZone_Offset
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 209
GetTimeZone_Offset function returns a offset of timezone(PL_TV_TIMEZONE)
Syntax GetTimeZone_Offset( )
Parameter none
Return Value If success, returns a offset of timezone(PL_TV_TIMEZONE)
otherwise, returns negative value
Remarks none
Emulator remarks Only returns false
Example TVPlugin.GetTimeZone_Offset();
Enumeration none
Version Support from TV-0001
Security Type TVInfo
Top
4.15.1.25. SetEvent
Function
SetEvent
SetEvent function registers event to receive callback
Syntax SetEvent( PL_TV_EVENT event )
Parameter
event
o PL_TV_EVENT
o Event to register
Return Value If success, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks Supports only PL_TV_EVENT_CHANNEL_CHANGE and PL_TV_EVENT_TUNE_SUCCESS.
Example
function OnLoadFunc()
{
TVPlugin.SetEvent(PL_TV_EVENT_CHANNEL_CHANGED);
TVPlugin.SetEvent(PL_TV_EVENT_NO_SIGNAL);
TVPlugin.SetEvent(PL_TV_EVENT_TUNE_SUCCESS);
TVPlugin.SetEvent(PL_TV_EVENT_PROGRAM_CHANGED);
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 210
TVPlugin.OnEvent = OnEvent;
}
function OnUnloadFunc()
{
TVPlugin.UnsetEvent(PL_TV_EVENT_CHANNEL_CHANGED);
TVPlugin.UnsetEvent(PL_TV_EVENT_NO_SIGNAL);
TVPlugin.UnsetEvent(PL_TV_EVENT_TUNE_SUCCESS);
TVPlugin.UnsetEvent(PL_TV_EVENT_PROGRAM_CHANGED);
}
function OnEvent(id)
{
switch( parseInt(id) )
{
case PL_TV_EVENT_TUNE_SUCCESS:
{
UpdateChannelData();
break;
}
case PL_TV_EVENT_PROGRAM_CHANGED:
{
UpdateProgramData();
break;
}
}
}
Enumeration PL_TV_EVENT
Version Support from TV-0001
Security Type TVInfo
Top
Top
4.15.1.26. SetPIP
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 211
Function
SetPIP
SetPIP function turn on or off PIP State
Syntax SetPIP( Number IsOn )
Parameter
IsOn
o Number
o On : 1, Off : 0
Return Value If success, returns positive value.
otherwise, returns negative value
Remarks none
Emulator remarks Returns only false
Example
if( 1 == TVPlugin.GetPIP() )
{
if( 0 < TVPlugin.CheckPIP(0) )
{
TVPlugin.SetPIP(0);
}
}
Enumeration none
Version Support from TV-0003
Security Type TVInfo
Top
Top
4.15.1.27. UnsetEvent
Function
UnsetEvent
UnsetEvent function cancels event registration
Syntax UnsetEvent( PL_TV_EVENT event )
Parameter event
o PL_TV_EVENT
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 212
o Event to cancel registration
Return Value If success, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks Supports only PL_TV_EVENT_CHANNEL_CHANGE and PL_TV_EVENT_TUNE_SUCCESS.
Example
function OnLoadFunc()
{
TVPlugin.SetEvent(PL_TV_EVENT_CHANNEL_CHANGED);
TVPlugin.SetEvent(PL_TV_EVENT_NO_SIGNAL);
TVPlugin.SetEvent(PL_TV_EVENT_TUNE_SUCCESS);
TVPlugin.SetEvent(PL_TV_EVENT_PROGRAM_CHANGED);
TVPlugin.OnEvent = OnEvent;
}
function OnUnloadFunc()
{
TVPlugin.UnsetEvent(PL_TV_EVENT_CHANNEL_CHANGED);
TVPlugin.UnsetEvent(PL_TV_EVENT_NO_SIGNAL);
TVPlugin.UnsetEvent(PL_TV_EVENT_TUNE_SUCCESS);
TVPlugin.UnsetEvent(PL_TV_EVENT_PROGRAM_CHANGED);
}
function OnEvent(id)
{
switch( parseInt(id) )
{
case PL_TV_EVENT_TUNE_SUCCESS:
{
UpdateChannelData();
break;
}
case PL_TV_EVENT_PROGRAM_CHANGED:
{
UpdateProgramData();
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 213
break;
}
}
}
Enumeration PL_TV_EVENT
Version Support from TV-0001
Security Type TVInfo
Top
4.15.2. Enumeration
4.15.2.1. PL_TV_BDPRODUCT_TYPE
Enumeration
PL_TV_BDPRODUCT_TYPE
Bluray Disc Product type
Remarks none
Emulator
remarks none
Function GetBDProductType
Value
0 - PL_TV_BDPRODUCT_TYPE_UNKNOWN
1 - PL_TV_BDPRODUCT_TYPE_SINGLE
2 - PL_TV_BDPRODUCT_TYPE_HTS
3 - PL_TV_BDPRODUCT_TYPE_HDD
Top
4.15.2.2. PL_TV_COUNTRY
Enumeration
PL_TV_COUNTRY
Country
Remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 214
Emulator
remarks none
Function
SetCountry
GetCountry
Value
0 - PL_TV_COUNTRY_USA
1 - PL_TV_COUNTRY_KOR
2 - PL_TV_COUNTRY_SPA
3 - PL_TV_COUNTRY_FRA
4 - PL_TV_COUNTRY_JPN
5 - PL_TV_COUNTRY_EU
6 - PL_TV_COUNTRY_UK
7 - PL_TV_COUNTRY_GERMANY
8 - PL_TV_COUNTRY_ITALY
9 - PL_TV_COUNTRY_SWEDEN
10 - PL_TV_COUNTRY_BULGARIA
11 - PL_TV_COUNTRY_CROATIA
12 - PL_TV_COUNTRY_CZECH
13 - PL_TV_COUNTRY_NETHERLANDS
14 - PL_TV_COUNTRY_GREECE
15 - PL_TV_COUNTRY_HUNGARY
16 - PL_TV_COUNTRY_POLAND
17 - PL_TV_COUNTRY_PORTUGAL
18 - PL_TV_COUNTRY_ROMANIA
19 - PL_TV_COUNTRY_RUSSIA
20 - PL_TV_COUNTRY_SWITZERLAND
21 - PL_TV_COUNTRY_TURKEY
22 - PL_TV_COUNTRY_AUSTRALIA
23 - PL_TV_COUNTRY_AUSTRIA
24 - PL_TV_COUNTRY_BELGIUM
25 - PL_TV_COUNTRY_DENMARK
26 - PL_TV_COUNTRY_FINLAND
27 - PL_TV_COUNTRY_NORWAY
28 - PL_TV_COUNTRY_CHINA
29 - PL_TV_COUNTRY_IRELAND
30 - PL_TV_COUNTRY_SERBIA
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 215
31 - PL_TV_COUNTRY_SAN_MARINO
32 - PL_TV_COUNTRY_MONACO
33 - PL_TV_COUNTRY_BRAZIL
34 - PL_TV_COUNTRY_HONGKONG
35 - PL_TV_COUNTRY_TAIWAN
36 - PL_TV_COUNTRY_NEWZEALAND
37 - PL_TV_COUNTRY_SLOVAKIA
38 - PL_TV_COUNTRY_SINGAPORE
39 - PL_TV_COUNTRY_GENERALCABLE
40 - PL_TV_COUNTRY_NORTH_AFRICA
41 - PL_TV_COUNTRY_BELGIUM_FRENCH
42 - PL_TV_COUNTRY_BELGIUM_DUTCH
43 - PL_TV_COUNTRY_SOUTH_AFRICA
44 - PL_TV_COUNTRY_OTHER
45 - PL_TV_COUNTRY_ASIAWEUROPE_ANALOG
46 - PL_TV_COUNTRY_HONGKONG_UK_ANALOG
47 - PL_TV_COUNTRY_NZL_INDONESIA_ANALOG
48 - PL_TV_COUNTRY_SOUTH_AFRICA_ANALOG
49 - PL_TV_COUNTRY_AMERICA_ANALOG
50 - PL_TV_COUNTRY_CHINA_ANALOG
51 - PL_TV_COUNTRY_EASTEUROPE_ANALOG
Top
4.15.2.3. PL_TV_DISPLAY_PANEL
Enumeration
PL_TV_DISPLAY_PANEL
Display panel
Remarks none
Emulator
remarks none
Function GetDisplayPanelType
Value 0 - PL_TV_DISPLAY_PANEL_LCD
1 - PL_TV_DISPLAY_PANEL_PDP
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 216
2 - PL_TV_DISPLAY_PANEL_DLP
3 - PL_TV_DISPLAY_PANEL_LED
4 - PL_TV_DISPLAY_PANEL_LED_EDGE
5 - PL_TV_DISPLAY_PANEL_LED_DIRECT
6 - PL_TV_DISPLAY_PANEL_CRT
Top
4.15.2.4. PL_TV_DST_TYPE
Enumeration
PL_TV_DST_TYPE
DST(Daylight Saving Time) type
Remarks none
Emulator
remarks none
Function
SetDST
GetDST
Value
0 - PL_TV_DST_TYPE_OFF
1 - PL_TV_DST_TYPE_ON
2 - PL_TV_DST_TYPE_AUTO
Top
4.15.2.5. PL_TV_EVENT
Enumeration
PL_TV_EVENT
Event
Remarks none
Emulator
remarks none
Function
SetEvent
UnsetEvent
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 217
Value
101 - PL_TV_EVENT_NO_SIGNAL
o When no signal
102 - PL_TV_EVENT_TUNE_CHANNEL
o When start channel tuning
103 - PL_TV_EVENT_TUNE_SUCCESS
o When channel tune success
104 - PL_TV_EVENT_BACKGROUND_SIGNAL_OK
o Not supported
105 - PL_TV_EVENT_SEARCH_CHANNEL
o When start seraching channel ( for each channel number )
106 - PL_TV_EVENT_CHANNEL_FOUND
o When channel is found
107 - PL_TV_EVENT_CHANNEL_FOUND_LIST
o Not supported
108 - PL_TV_EVENT_SEARCH_CHANNEL_DONE
o When finish searching channel
109 - PL_TV_EVENT_SEARCH_CHANNEL_MAP_FULL
o When channel search is be terminated since channel map is full when channel
search.
110 - PL_TV_EVENT_NOT_SUPPORTED
o When channel signal is not supported signal
111 - PL_TV_EVENT_MTS_CHANGED
o When MTS is changed
112 - PL_TV_EVENT_CHANNEL_MAP_CHANGED
o When channel map is changed because stream information is changed
113 - PL_TV_EVENT_CHANNEL_CHANGED
o When channel is changed
114 - PL_TV_EVENT_SOURCE_CHANGED
o When source is changed
115 - PL_TV_EVENT_CHANGE_TV_MODE
o When TV mode is changed
116 - PL_TV_EVENT_SETCHANNEL_TUNED
o When setchannel command is finished
117 - PL_TV_EVENT_RESOLUTION_CHANGED
o When resolution is changed
118 - PL_TV_EVENT_RESOLUTION_DETECTED
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 218
o Not supported
121 - PL_TV_EVENT_EXTSOURCE_SCART
o SCART Plug, Unplug event
122 - PL_TV_EVENT_UPDATE_DYNAMICSI
o Not supported
123 - PL_TV_EVENT_SEARCH_GET_NETWORK_DONE
o Not supported
124 - PL_TV_EVENT_HD_NOT_SUPPORT
o Not supported
125 - PL_TV_EVENT_SHOW_START
o This triggers mute-off when tuner tunes to DTV.
126 - PL_TV_EVENT_SOURCE_CONNECTED
o When a source is connected in source changing procedure.
201 - PL_TV_EVENT_EPG_COMPLETED
o When all EPG information is received
202 - PL_TV_EVENT_EPG_CHANGED
o When EIT is changed
203 - PL_TV_EVENT_CAPTION_DESCRIPTOR
o When caption descriptor is received
204 - PL_TV_EVENT_PROGRAM_CHANGED
o When current program is changed
205 - PL_TV_EVENT_STREAM_CLOCK_CHANGED
o When system clock is changed
206 - PL_TV_EVENT_SW_UPGRADE
o When USB S/W update is started
207 - PL_TV_EVENT_PMT_ARRIVED
o Not supported
208 - PL_TV_EVENT_DSIDII_ARRIVED
o Not supported
209 - PL_TV_EVENT_DDB_ARRIVED
o Not supported
210 - PL_TV_EVENT_TSD_ARRIVED
o Not supported
211 - PL_TV_EVENT_CHANGE_POWER_STATE
o Not supported
212 - PL_TV_EVENT_RECV_CURRENT_EVENT
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 219
o Not supported
213 - PL_TV_EVENT_STT_CHANGED
o Not supported
214 - PL_TV_EVENT_CAPTION_MODE_CHANGED
o When caption mode is changed
215 - PL_TV_EVENT_PROGRAM_CHANGED_MULTIPLEX
o [Not supported] Program changed event with service information in current
mux(DVB)
216 - PL_TV_EVENT_DVBSI_STARTED
o Not supported
217 - PL_TV_EVENT_PRESENT_EIT_CHANGED
o Not supported
Top
4.15.2.6. PL_TV_FACTORY_LANGUAGE
Enumeration
PL_TV_FACTORY_LANGUAGE
Factory language
Remarks none
Emulator
remarks none
Function GetLanguageSet
Value
0 - PL_TV_FACTORY_LANGUAGE_UNKNOWN
1 - PL_TV_FACTORY_LANGUAGE_EAST_ASIA
2 - PL_TV_FACTORY_LANGUAGE_IRAN
3 - PL_TV_FACTORY_LANGUAGE_ISRAEL
4 - PL_TV_FACTORY_LANGUAGE_MIDDLE_ASIA
5 - PL_TV_FACTORY_LANGUAGE_SOUTH_AMERICA
6 - PL_TV_FACTORY_LANGUAGE_TAIWAN
7 - PL_TV_FACTORY_LANGUAGE_AFRICA
8 - PL_TV_FACTORY_LANGUAGE_NORTH_AFRICA
9 - PL_TV_FACTORY_LANGUAGE_WEST_ASIA
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 220
Top
4.15.2.7. PL_TV_LANGUAGE
Enumeration
PL_TV_LANGUAGE
Language
Remarks none
Emulator
remarks none
Function
SetLanguage
GetLanguage
Value
0 - PL_TV_LANGUAGE_KOR
1 - PL_TV_LANGUAGE_ENG_US
2 - PL_TV_LANGUAGE_SPA_US
3 - PL_TV_LANGUAGE_FRA_US
4 - PL_TV_LANGUAGE_POR_US
5 - PL_TV_LANGUAGE_BUL
6 - PL_TV_LANGUAGE_CRO
7 - PL_TV_LANGUAGE_CZE
8 - PL_TV_LANGUAGE_DAN
9 - PL_TV_LANGUAGE_DUT
10 - PL_TV_LANGUAGE_FIN
11 - PL_TV_LANGUAGE_FRA
12 - PL_TV_LANGUAGE_DEU
13 - PL_TV_LANGUAGE_GRE
14 - PL_TV_LANGUAGE_HUN
15 - PL_TV_LANGUAGE_ITA
16 - PL_TV_LANGUAGE_NOR
17 - PL_TV_LANGUAGE_ENG
18 - PL_TV_LANGUAGE_POL
19 - PL_TV_LANGUAGE_POR
20 - PL_TV_LANGUAGE_ROM
21 - PL_TV_LANGUAGE_RUS
22 - PL_TV_LANGUAGE_SER
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 221
23 - PL_TV_LANGUAGE_SLK
24 - PL_TV_LANGUAGE_SPA
25 - PL_TV_LANGUAGE_SWE
26 - PL_TV_LANGUAGE_TUR
27 - PL_TV_LANGUAGE_CHI
28 - PL_TV_LANGUAGE_HKG
29 - PL_TV_LANGUAGE_TPE
30 - PL_TV_LANGUAGE_JPN
31 - PL_TV_LANGUAGE_MAO
32 - PL_TV_LANGUAGE_CMN
33 - PL_TV_LANGUAGE_YUE
34 - PL_TV_LANGUAGE_HIN
35 - PL_TV_LANGUAGE_EST
36 - PL_TV_LANGUAGE_LAT
37 - PL_TV_LANGUAGE_LTU
38 - PL_TV_LANGUAGE_ARA
o Arab
39 - PL_TV_LANGUAGE_PER
o Farsi
40 - PL_TV_LANGUAGE_QAA
41 - PL_TV_LANGUAGE_AD
42 - PL_TV_LANGUAGE_CAT
43 - PL_TV_LANGUAGE_VAL
44 - PL_TV_LANGUAGE_THA
o Thai
45 - PL_TV_LANGUAGE_HEB
o Hebrew
46 - PL_TV_LANGUAGE_IND
o Indonesia
47 - PL_TV_LANGUAGE_VIE
o Vietnamese
48 - PL_TV_LANGUAGE_URD
o Urdu
49 - PL_TV_LANGUAGE_AFR
o Afrikaans
50 - PL_TV_LANGUAGE_ZUL
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 222
o Zulu
51 - PL_TV_LANGUAGE_XHO
o Xhosa
52 - PL_TV_LANGUAGE_YOR
o Yoruba
53 - PL_TV_LANGUAGE_IGB
o Igbo
54 - PL_TV_LANGUAGE_HAU
o Hausa
55 - PL_TV_LANGUAGE_SWA
o Swahili
56 - PL_TV_LANGUAGE_AMH
o Amharic
57 - PL_TV_LANGUAGE_OTHER
Top
4.15.2.8. PL_TV_PRODUCT_TYPE
Enumeration
PL_TV_PRODUCT_TYPE
Product type
Remarks none
Emulator
remarks none
Function GetProductType
Value
0 - PL_TV_PRODUCT_TYPE_TV
1 - PL_TV_PRODUCT_TYPE_MONITOR
2 - PL_TV_PRODUCT_TYPE_BD
Top
4.15.2.9. PL_TV_TARGET_LOCATION
Enumeration
PL_TV_TARGET_LOCATION
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 223
Target location
Remarks none
Emulator
remarks none
Function GetTargetLocation
Value
0 - PL_TV_TARGET_LOCATION_UNKNOWN
1 - PL_TV_TARGET_LOCATION_KOR
2 - PL_TV_TARGET_LOCATION_USA
3 - PL_TV_TARGET_LOCATION_BRA
4 - PL_TV_TARGET_LOCATION_PANEURO
5 - PL_TV_TARGET_LOCATION_CHI
6 - PL_TV_TARGET_LOCATION_HKG
7 - PL_TV_TARGET_LOCATION_ARB
8 - PL_TV_TARGET_LOCATION_PANNORDIG
9 - PL_TV_TARGET_LOCATION_SOUTHEASTASIA
10 - PL_TV_TARGET_LOCATION_ASIA_ATV
11 - PL_TV_TARGET_LOCATION_ASIA_DTV
12 - PL_TV_TARGET_LOCATION_TW
13 - PL_TV_TARGET_LOCATION_NORTHAFRICA
14 - PL_TV_TARGET_LOCATION_EA_DTV
15 - PL_TV_TARGET_LOCATION_CIS
16 - PL_TV_TARGET_LOCATION_PHI
17 - PL_TV_TARGET_LOCATION_S_AFR_DTV
Top
4.15.2.10. PL_TV_TIMEZONE
Enumeration
PL_TV_TIMEZONE
Time zone
Remarks none
Emulator
remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 224
Function
SetTimeZone
GetTimeZone
Value
0 - PL_TV_TIMEZONE_NEWFOUNDLAND
o ATSC USA NEWFOUNDLAND
1 - PL_TV_TIMEZONE_ATLANTIC
o ATSC USA ATLANTIC
2 - PL_TV_TIMEZONE_EASTERN
o ATSC USA EASTERN
3 - PL_TV_TIMEZONE_CENTRAL
o ATSC USA CENTRAL
4 - PL_TV_TIMEZONE_MOUNTAIN
o ATSC USA MOUNTAIN
5 - PL_TV_TIMEZONE_PACIFIC
o ATSC USA PACIFIC
6 - PL_TV_TIMEZONE_ALASKA
o ATSC USA ALASKA
7 - PL_TV_TIMEZONE_HAWAII
o ATSC USA HAWAII
100 - PL_TV_TIMEZONE_SEOUL
o ATSC KOR
200 - PL_TV_TIMEZONE_REGION_0
o DVB Time Zone Offset (Region 0) - Australia : Use in a contury that don't have
multi time zone
201 - PL_TV_TIMEZONE_REGION_1
o DVB Time Zone Offset (Region 1) - Australia : reserved , Spain
202 - PL_TV_TIMEZONE_REGION_2
o DVB Time Zone Offset (Region 2) - Australia : New Southwales/ACT , Spain
203 - PL_TV_TIMEZONE_REGION_3
o DVB Time Zone Offset (Region 3) - Australia : Victoria
204 - PL_TV_TIMEZONE_REGION_4
o DVB Time Zone Offset (Region 4) - Australia : Queensland
205 - PL_TV_TIMEZONE_REGION_5
o DVB Time Zone Offset (Region 5) - Australia : South Australia
206 - PL_TV_TIMEZONE_REGION_6
o DVB Time Zone Offset (Region 6) - Australia : Western Australia
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 225
207 - PL_TV_TIMEZONE_REGION_7
o DVB Time Zone Offset (Region 7) - Australia : Tasmania
208 - PL_TV_TIMEZONE_REGION_8
o DVB Time Zone Offset (Region 8) - Australia : Northern Territory
Top
4.15.3. Event
4.15.3.1. OnEvent
Event
OnEvent
Use OnEvent when you receive basic event(PL_TV_EVENT) from TV plugin
Parameter
eventID
o PL_TV_EVENT
o eventID
Remarks none
Emulator
remarks
Example
function OnLoadFunc()
{
TVPlugin.SetEvent(PL_TV_EVENT_CHANNEL_CHANGED);
TVPlugin.SetEvent(PL_TV_EVENT_NO_SIGNAL);
TVPlugin.SetEvent(PL_TV_EVENT_TUNE_SUCCESS);
TVPlugin.SetEvent(PL_TV_EVENT_PROGRAM_CHANGED);
TVPlugin.OnEvent = OnEvent;
}
function OnUnloadFunc()
{
TVPlugin.UnsetEvent(PL_TV_EVENT_CHANNEL_CHANGED);
TVPlugin.UnsetEvent(PL_TV_EVENT_NO_SIGNAL);
TVPlugin.UnsetEvent(PL_TV_EVENT_TUNE_SUCCESS);
TVPlugin.UnsetEvent(PL_TV_EVENT_PROGRAM_CHANGED);
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 226
}
function OnEvent(id)
{
switch( parseInt(id) )
{
case PL_TV_EVENT_TUNE_SUCCESS:
{
UpdateChannelData();
break;
}
case PL_TV_EVENT_PROGRAM_CHANGED:
{
UpdateProgramData();
break;
}
}
}
Version TV-0001
Top
4.16. TVMW
4.16.1. Function
4.16.1.1. CheckReservedKey
Function
CheckReservedKey (Replaced)
CheckReservedKey function return whether TVViewer reserve this key or not.
Syntax CheckReservedKey( PL_TVMW_KEY key )
Parameter key
o PL_TVMW_KEY
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 227
o
Return Value
If reserved, returns 1.
If not reserved, reutrn 0.
Otherwise, returns error code.
Remarks none
Emulator
remarks none
Example
if( 1 == TVMWPlugin.CheckReservedKey(key) )
{
TVMWPlugin.SendKeyToTVViewer(key);
}
Enumeration none
Version Support from TVMW-0024
Security Type TVInfo
Top
4.16.1.2. Deactivate
Function
Deactivate (Replaced)
Deactivate Samsung Smart TV application and activate designated app. (ex: Menu, etc.)
Syntax Deactivate( PL_TVMW_DTVAPP app )
Parameter
app
o PL_TVMW_DTVAPP
o Application ID to activate after deactivating Samsung Smart TV application
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks This function is replaced with ActivateApplication function in TaskManager plugin
Emulator
remarks none
Example TVMWPlugin.Deactivate(PL_TVMW_DTVAPP_NONE);
Enumeration PL_TVMW_DTVAPP
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 228
Version Support from TVMW-0001
Security Type TVInfo
Top
4.16.1.3. GetActiveApp
Function
GetActiveApp (Replaced)
Returns currently active application ID.
Syntax GetActiveApp( )
Parameter none
Return Value If success, returns active application ID (PL_TVMW_DTVAPP).
Otherwise, returns error code.
Remarks This function is replaced with GetActiveApplication function in TaskManager plugin
Emulator
remarks [FAKE] returns PL_TVMW_DTV_APP_INFOLINK [fixed]
Example
var activeApp;
var msg;
activeApp = TVMWPlugin.GetActiveApp();
alert(activeApp);
alert('activeApp = ' + activeApp);
if( activeApp == PL_TVMW_DTVAPP_INFOLINK )
{
msg = 'INFOLINK';
}
else
{
msg = 'Not INFOLINK';
}
document.getElementById('ActiveApp').value = msg;
Enumeration PL_TVMW_DTVAPP
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 229
Version Support from TVMW-0001
Security Type TVInfo
Top
4.16.1.4. GetBGApp
Function
GetBGApp (Replaced)
Returns background application of DTV. When the TV no-signal banner, menu, etc. is deactivated, the background
application will be activated automatically.
Syntax GetBGApp( )
Parameter none
Return Value
If success, returns the application ID that is registered as background application
(PL_TVMW_DTVAPP).
Otherwise, returns error code.
Remarks
This function is replaced with GetBgApplication function in TaskManager plugin
When the TV no-signal banner, menu, etc. is deactivated, the background application will be
activated automatically.
ex)
1) Samsung Smart TV is not set as background. Channel change -> When channel is about to
change, Samsung Smart TV is deactivated, and channel is changed.
2) Samsung Smart TV is set as background. Channel change -> When channel is about to change,
Samsung Smart TV is deactivated, and channel is changed. After hiding channel banner, Samsung
Smart TV is activated automatically.
Emulator
remarks none
Example
var BGApp;
var msg;
BGApp = TVMWPlugin.GetBGApp();
alert('BGApp = ' + BGApp);
if( BGApp == PL_TVMW_DTVAPP_INFOLINK )
{
msg = 'INFOLINK';
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 230
}
else
{
msg = 'Not INFOLINK';
}
document.getElementById('BGApp').value = msg;
Enumeration PL_TVMW_DTVAPP
Version Support from TVMW-0001
Security Type TVInfo
Top
4.16.1.5. GetCountry
Function
GetCountry (Replaced)
Return country code of DTV.
Syntax GetCountry( )
Parameter none
Return Value If success, returns contry code(PL_TVMW_COUNTRY).
Otherwise, returns error code.
Remarks
This function is replaced with GetCountry function in TV plugin
Country code can be changed using DTV menu by user.
Emulator remarks none
Example
var country = TVMWPlugin.GetCountry();
alert('country = ' + country);
if( country == PL_TVMW_COUNTRY_KOR )
{
alert('country == KOREA!!!!!');
}
else
{
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 231
alert('country == Not KOREA!!!!!');
}TVMWPlugin.GetCountry();
Enumeration PL_TVMW_COUNTRY
Version Support from TVMW-0001
Security Type TVInfo
Top
4.16.1.6. GetLanguage
Function
GetLanguage (Replaced)
Return language code of DTV.
Syntax GetLanguage( )
Parameter none
Return Value If success, returns language code of DTV (PL_TVMW_LANGUAGE).
Otherwise, returns error code.
Remarks
This function is replaced with GetLanguage function in TV plugin
Country code can be changed using DTV menu by user.
Emulator
remarks none
Example
var language = TVMWPlugin.GetLanguage();
alert('language = ' + language);
if( language == PL_TVMW_LANGUAGE_KOR )
{
alert('language == KOREAN!!!!!');
}
else
{
alert('language == Not KOREAN!!!!!');
}
TVMWPlugin.GetLanguage();
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 232
Enumeration PL_TVMW_LANGUAGE
Version Support from TVMW-0001
Security Type TVInfo
Top
4.16.1.7. GetProfile
Function
GetProfile
Returns information stored in flash for predefined profile field of DTV platform.
Syntax GetProfile( PL_TVMW_PRFID profileID )
Parameter
profileID
o PL_TVMW_PRFID
o Profile id to get profile information
Return Value If success, returns value of profile ID
Otherwise, returns error code.
Remarks Profile on DTV is similar to registry on Windows OS. DTV developer can use a profile field in
flash to keep small information permanently, and share it with other applications.
Emulator
remarks Empty body.
Example
TVMWPlugin.SetProfile(PL_TVMW_PRFID_TICKER_ID, '1234567890123');
document.getElementById('Profile0').value =
TVMWPlugin.GetProfile(PL_TVMW_PRFID_TICKER_ID);
document.getElementById('Profile1').value =
TVMWPlugin.GetProfile(PL_TVMW_PRFID_CHILDLOCK_PIN);
document.getElementById('Profile2').value =
TVMWPlugin.GetProfile(PL_TVMW_PRFID_HUB_TVID);
Enumeration PL_TVMW_PRFID
Version Support from TVMW-0001
Security Type System
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 233
4.16.1.8. GetSource
Function
GetSource (Replaced)
Return current source of DTV. (see remarks for source detail)
Syntax GetSource( )
Parameter none
Return Value If success, returns source of DTV (PL_TVMW_SOURCE).
Otherwise, returns error code.
Remarks
This function is replaced with GetSource function in TV plugin
Source means main stream that is displayed on the TV. It can be one of TV, HDMI,
COMPONENT, etc.
To play back multimedia video contents, this source should be set as MEDIA. And to see the TV
signal, this source should be set as TV.
(for detail source type, see PL_TVMW_SOURCE)
Emulator remarks none
Example TVMWPlugin.GetSource();
Enumeration PL_TVMW_SOURCE
Version Support from TVMW-0001
Security Type Multimedia
Top
4.16.1.9. GetTVUseMode
Function
GetTVUseMode (Replaced)
Returns whether this TV is set for home or for retail shop.
Syntax GetTVUseMode( )
Parameter none
Return Value If success, returns one of PL_TVMW_TVUT
Otherwise, returns error code.
Remarks This function is replaced with GetOption(PL_SCREEN_OPTION_SHOP_MODE) function in
Screen plugin
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 234
Emulator
remarks none
Example
var TVUseMode;
var msg;
TVUseMode = TVMWPlugin.GetTVUseMode();
alert(TVUseMode);
switch( TVUseMode )
{
case PL_TVMW_TVUT_HOME:
msg = "Home";
break;
case PL_TVMW_TVUT_SHOP:
msg = "Shop";
break;
case PL_TVMW_TVUT_UNKNOWN:
msg = "Unknown";
break;
default:
msg = "Error";
}
document.getElementById('TVUseMode').value = msg;
Enumeration PL_TVMW_TVUT
Version Support from TVMW-0001
Security Type TVInfo
Top
4.16.1.10. IsRegisteredKey
Function
IsRegisteredKey (Replaced)
Returns whether the key is already registered for the Widget. Widgets should register a key to use it. (see RegisterKey())
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 235
Syntax IsRegisteredKey( )
Parameter none
Return Value
If registered, returns PLR_TRUE.
If not registered, returns PLR_FALSE.
If fail to get information, return error code.
Remarks
This function is replaced with IsRegisteredKey function in AppCommon plugin
Widget should register a key to use the key. (see RegisterKey())
Emulator
remarks Same as TV.
Example TVMWPlugin.IsRegisteredKey(PL_TVMW_KEY_3);
Enumeration PL_TVMW_KEY
Version Support from TVMW-0001
Security Type TVInfo
Top
Top
4.16.1.11. RegisterKey
Function
RegisterKey (Replaced)
Register key to be used by widgets.
Syntax RegisterKey( PL_TVMW_KEY key )
Parameter
key
o PL_TVMW_KEY
o Key to use
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks
This function is replaced with RegisterKey function in AppCommon plugin
If the widget has registered the CHANNEL_UP key, and CHANNEL_UP is pressed on the remote
controller, then the widget can respond to CHANNEL_UP(the widget can map CHANNEL_UP to
a page up operation). But if the widget has not registered CHANNEL_UP, and CHANNEL_UP is
pressed on the remote controller, then the widget cannot respond to it, and the DTV platform will
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 236
perform a channel up operation (because of this, Samsung Smart TV including the widget is
automatically deactivated)
[CAUTION] Key registering affects not just each individual widget, but all widgets on Samsung
Smart TV, including Samsung Smart TV application itself.
Emulator
remarks Same as TV.
Example TVMWPlugin.RegisterKey(PL_TVMW_KEY_3);
Enumeration PL_TVMW_KEY
Version Support from TVMW-0001
Security Type TVInfo
Top
4.16.1.12. RegisterKeyGroup
Function
RegisterKeyGroup (Replaced)
Register a group of keys to be used by widgets. This is the same as using Registerkey() several times, once for each key.
Syntax RegisterKeyGroup( PL_TVMW_KEY_GRP keyGroup )
Parameter
keyGroup
o PL_TVMW_KEY_GRP
o Predefined key group
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks
This function is replaced with Register[GroupName]Key function in AppCommon plugin
See remarks of RegisterKey() for key details.
Emulator
remarks Same as TV.
Example TVMWPlugin.RegisterKeyGroup(PL_TVMW_KEY_GRP_NUMBER);
Enumeration PL_TVMW_KEY_GRP
Version Support from TVMW-0001
Security Type TVInfo
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 237
4.16.1.13. SendKeyToTVViewer
Function
SendKeyToTVViewer (Replaced)
SendKeyToTVViewer function send key to TVViewer.
Syntax SendKeyToTVViewer( PL_TVMW_KEY key )
Parameter
key
o PL_TVMW_KEY
o
Return Value If success, returns 1.
Otherwise, returns error code.
Remarks none
Emulator
remarks none
Example
if( 1 == TVMWPlugin.CheckReservedKey(key) )
{
TVMWPlugin.SendKeyToTVViewer(key);
}
Enumeration none
Version Support from TVMW-0024
Security Type TVInfo
Top
4.16.1.14. SetProfile
Function
SetProfile
Sets the value of a predefined profile field of DTV platform.
Syntax SetProfile( PL_TVMW_PRFID profileID , STRING value )
Parameter
profileID
o PL_TVMW_PRFID
o Designated field to be set
value
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 238
o STRING
o Value to be set
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks Profile on DTV is similar to registry on Windows OS. DTV developer can use a profile field in
flash to keep small information permanently, and share it with other applications.
Emulator
remarks Empty body.
Example
TVMWPlugin.SetProfile(PL_TVMW_PRFID_TICKER_ID, '1234567890123');
document.getElementById('Profile0').value =
TVMWPlugin.GetProfile(PL_TVMW_PRFID_TICKER_ID);
document.getElementById('Profile1').value =
TVMWPlugin.GetProfile(PL_TVMW_PRFID_CHILDLOCK_PIN);
document.getElementById('Profile2').value =
TVMWPlugin.GetProfile(PL_TVMW_PRFID_HUB_TVID);
Enumeration PL_TVMW_PRFID
Version Support from TVMW-0001
Security Type System
Top
4.16.1.15. SetSource
Function
SetSource (Replaced)
Set new source for TV. (see remarks for source detail)
Syntax SetSource( PL_TVMW_SOURCE source )
Parameter
source
o PL_TVMW_SOURCE
o Source to be set
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks This function is replaced with SetSource function in TV plugin
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 239
Source means main stream that is displayed on the TV. It can be one of TV, HDMI,
COMPONENT, etc.
To play back multimedia video contents, this source should be set as MEDIA. And to see the TV
signal, this source should be set as TV. (When a widget sets the source as MEDIA, the DTV video
layer displays a black screen)
(for detail source type, see PL_TVMW_SOURCE)
Emulator
remarks
[FAKE] When a widget sets the source as MEDIA, the DTV video layer displays a black screen. If
any other source is set, no action is taken, the value is kept in memory only.
Example TVMWPlugin.SetSource(PL_TVMW_SOURCE_TV);
Enumeration PL_TVMW_SOURCE
Version Support from TVMW-0001
Security Type Multimedia
Top
4.16.1.16. SetWatchDog
Function
SetWatchDog (Replaced)
Register or unregister a widget to watchdog queue (see remarks for watchdog detail)
Syntax SetWatchDog( PL_TVMW_WATCHDOG watchDog )
Parameter
watchDog
o PL_TVMW_WATCHDOG
o watchDog On/Off
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks
This function is replaced with SetWatchDog function in TV plugin
When Watchdog is enabled, if a thread is busy for too much time (more than about 30 seconds),
then the DTV platform checks this state and reboots the DTV automatically to avoid blocking
forever. All threads including widgets are already set as Watchdog on. But sometimes, a widget
needs to be busy for more than about 30 seconds to process its own functionality, in this case that
widget has to set Watchdog off during this processing. After finishing this long processing, the
widget has to set the watchdog state back to ON.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 240
[WARNING] A widget that does not follow this rule cannot released officially.
Emulator
remarks [FAKE] Do nothing, just print out function name on debug console in SDK.
Example TVMWPlugin.SetWatchDog(PL_TVMW_WATCHDOG_OFF);
Enumeration PL_TVMW_WATCHDOG
Version Support from TVMW-0001
Security Type TVInfo
Top
4.16.1.17. UnregForBGApp
Function
UnregForBGApp (Replaced)
Unregister a designated application from background application list.
Syntax UnregForBGApp( PL_TVMW_DTVAPP app )
Parameter
app
o PL_TVMW_DTVAPP
o o Application ID to be unregistered as background application. If this parameter
is emply, then PL_TVMW_DTV_APP_INFOLINK (Samsung Smart TV
Application ID) is used as a default.
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks
This function is replaced with SetBgApplication function in TaskManager plugin
See remarks of GetBGApp for background application details.
Emulator
remarks none
Example TVMWPlugin.UnregForBGApp();
Enumeration PL_TVMW_DTVAPP
Version Support from TVMW-0001
Security Type System
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 241
4.16.1.18. UnregisterKey
Function
UnregisterKey (Replaced)
Unregister the key so it is not used by widgets.
Syntax UnregisterKey( PL_TVMW_KEY key )
Parameter
key
o PL_TVMW_KEY
o Key to be unregistered
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks
This function is replaced with UnregisterKey function in AppCommon plugin
See remarks in RegisterKey for Key Registration details.
Emulator
remarks Same as TV.
Example TVMWPlugin.UnregisterKey(PL_TVMW_KEY_3);
Enumeration PL_TVMW_KEY
Version Support from TVMW-0001
Security Type TVInfo
Top
4.16.1.19. UnregisterKeyGroup
Function
UnregisterKeyGroup (Replaced)
Unregister a group of keys so they are not used by widgets.
Syntax UnregisterKeyGroup( PL_TVMW_KEY_GRP keyGroup )
Parameter
keyGroup
o PL_TVMW_KEY_GRP
o Key group to be unregistered
Return Value If success, returns PLR_TRUE.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 242
Otherwise, returns error code.
Remarks
This function is replaced with Unregister[GroupName]Key function in AppCommon plugin
See remarks in RegisterKey for Key Registration details.
Emulator
remarks Same as TV.
Example TVMWPlugin.UnregisterKeyGroup(PL_TVMW_KEY_GRP_NUMBER);
Enumeration PL_TVMW_KEY_GRP
Version Support from TVMW-0001
Security Type TVInfo
Top
4.16.2. Enumeration
4.16.2.1. PL_TVMW_COUNTRY
Enumeration
PL_TVMW_COUNTRY (Replaced)
Country
Remarks This enum is replaced with PL_TV_COUNTRY enum in TV plugin
Emulator
remarks none
Function GetCountry (Replaced)
Value
0 - PL_TVMW_COUNTRY_USA
o USA
1 - PL_TVMW_COUNTRY_KOR
o Korea
2 - PL_TVMW_COUNTRY_SPA
o Spain
3 - PL_TVMW_COUNTRY_FRA
o France
4 - PL_TVMW_COUNTRY_JPN
o Japan
5 - PL_TVMW_COUNTRY_EU
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 243
o Europe
6 - PL_TVMW_COUNTRY_UK
o United kingdom
7 - PL_TVMW_COUNTRY_GERMANY
o Germany
8 - PL_TVMW_COUNTRY_ITALY
o Italy
9 - PL_TVMW_COUNTRY_SWEDEN
o Sweden
10 - PL_TVMW_COUNTRY_BULGARIA
o Bulgaria
11 - PL_TVMW_COUNTRY_CROATIA
o Croatia
12 - PL_TVMW_COUNTRY_CZECH
o Czech
13 - PL_TVMW_COUNTRY_NETHERLANDS
o Netherlands
14 - PL_TVMW_COUNTRY_GREECE
o Greece
15 - PL_TVMW_COUNTRY_HUNGARY
o Hungary
16 - PL_TVMW_COUNTRY_POLAND
o Poland
17 - PL_TVMW_COUNTRY_PORTUGAL
o Portugal
18 - PL_TVMW_COUNTRY_ROMANIA
o Romania
19 - PL_TVMW_COUNTRY_RUSSIA
o Russia
20 - PL_TVMW_COUNTRY_SWITZERLAND
o Switzerland
21 - PL_TVMW_COUNTRY_TURKEY
o Turkey
22 - PL_TVMW_COUNTRY_AUSTRALIA
o Australia
23 - PL_TVMW_COUNTRY_AUSTRIA
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 244
o Austria
24 - PL_TVMW_COUNTRY_BELGIUM
o Belgium
25 - PL_TVMW_COUNTRY_DENMARK
o Denmark
26 - PL_TVMW_COUNTRY_FINLAND
o Finland
27 - PL_TVMW_COUNTRY_NORWAY
o Norway
28 - PL_TVMW_COUNTRY_CHINA
o China
29 - PL_TVMW_COUNTRY_IRELAND
o Ireland
30 - PL_TVMW_COUNTRY_SERBIA
o Serbia
31 - PL_TVMW_COUNTRY_SAN_MARINO
o San Marino
32 - PL_TVMW_COUNTRY_MONACO
o Monaco
33 - PL_TVMW_COUNTRY_BRAZIL
o Brazil
34 - PL_TVMW_COUNTRY_HONGKONG
o Hongkong
35 - PL_TVMW_COUNTRY_TAIWAN
o Taiwan
36 - PL_TVMW_COUNTRY_NEWZEALAND
o Newzealand
37 - PL_TVMW_COUNTRY_SLOVAKIA
o Slovakia
38 - PL_TVMW_COUNTRY_SINGAPORE
o Singapore
39 - PL_TVMW_COUNTRY_GENERALCABLE
o Generalcable
40 - PL_TVMW_COUNTRY_OTHER
o Others
41 - PL_TVMW_COUNTRY_ASIAWEUROPE_ANALOG
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 245
o Asia west europe (analog)
42 - PL_TVMW_COUNTRY_HONGKONG_UK_ANALOG
o Hongkong UK (analog)
43 - PL_TVMW_COUNTRY_NZL_INDONESIA_ANALOG
o Newzealand Indonesia (alalog)
44 - PL_TVMW_COUNTRY_SOUTH_AFRICA_ANALOG
o South africa (analog)
45 - PL_TVMW_COUNTRY_AMERICA_ANALOG
o America (analog)
46 - PL_TVMW_COUNTRY_CHINA_ANALOG
o China (analog)
47 - PL_TVMW_COUNTRY_EASTEUROPE_ANALOG
o East europe (analog)
Top
4.16.2.2. PL_TVMW_DTVAPP
Enumeration
PL_TVMW_DTVAPP (Replaced)
DTV Application
Remarks This enum is replaced with PL_TASKMANAGER_DTVAPP enum in TaskManager plugin
Emulator
remarks none
Function
Deactivate (Replaced)
GetActiveApp (Replaced)
GetBGApp (Replaced)
RegForBGApp (Replaced)
UnregForBGApp (Replaced)
Value
0 - PL_TVMW_DTVAPP_NONE
o default app
1 - PL_TVMW_DTVAPP_TVVIEWER
o TVViewer
2 - PL_TVMW_DTV_APP_INFOLINK
o Infolink
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 246
3 - PL_TVMW_DTVAPP_MENU
o Menu
Top
4.16.2.3. PL_TVMW_KEY
Enumeration
PL_TVMW_KEY (Replaced)
Key
Remarks This enum is replaced with [Un]RegisterKey functions in AppCommon plugin
Emulator
remarks none
Function
IsRegisteredKey (Replaced)
RegisterKey (Replaced)
UnregisterKey (Replaced)
Value
0 - PL_TVMW_KEY_1
o Number 1
1 - PL_TVMW_KEY_2
o Number 2
2 - PL_TVMW_KEY_3
o Number 3
3 - PL_TVMW_KEY_4
o Number 4
4 - PL_TVMW_KEY_5
o Number 5
5 - PL_TVMW_KEY_6
o Number 6
6 - PL_TVMW_KEY_7
o Number 7
7 - PL_TVMW_KEY_8
o Number 8
8 - PL_TVMW_KEY_9
o Number 9
9 - PL_TVMW_KEY_0
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 247
o Number 0
10 - PL_TVMW_KEY_HYPHEN
o Hyphen(-)
11 - PL_TVMW_KEY_11
o Number 11
101 - PL_TVMW_KEY_CH_UP
o Channel up
102 - PL_TVMW_KEY_CH_DOWN
o Channel down
103 - PL_TVMW_KEY_CH_PREV
o Previous channel
104 - PL_TVMW_KEY_CH_FAV
o Favorite channel
105 - PL_TVMW_KEY_CH_LIST
o Channel list
106 - PL_TVMW_KEY_CH_PANNEL_UP
o Pannel channel up
107 - PL_TVMW_KEY_CH_PANNEL_DOWN
o Pannel channel down
201 - PL_TVMW_KEY_VOL_UP
o Volume up
202 - PL_TVMW_KEY_VOL_DOWN
o Volume down
203 - PL_TVMW_KEY_MUTE
o Mute
204 - PL_TVMW_KEY_VOL_PANNEL_UP
o Pannel volume up
205 - PL_TVMW_KEY_VOL_PANNEL_DOWN
o Pannel volume down
301 - PL_TVMW_KEY_ENTER
o Enter
302 - PL_TVMW_KEY_RETURN
o Return
303 - PL_TVMW_KEY_EXIT
o Exit
304 - PL_TVMW_KEY_ARROW_UP
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 248
o Arrow up
305 - PL_TVMW_KEY_ARROW_DOWN
o Arrow down
306 - PL_TVMW_KEY_ARROW_LEFT
o Arrow left
307 - PL_TVMW_KEY_ARROW_RIGHT
o Arrow right
308 - PL_TVMW_KEY_WHEEL_LEFT
o Wheel left
309 - PL_TVMW_KEY_WHEEL_RIGHT
o Wheel right
310 - PL_TVMW_KEY_PANNEL_ENTER
o Pannel enter
401 - PL_TVMW_KEY_RED
o Color key red
402 - PL_TVMW_KEY_GREEN
o Color key green
403 - PL_TVMW_KEY_YELLOW
o Color key yellow
404 - PL_TVMW_KEY_CYAN
o Color key cyan
501 - PL_TVMW_KEY_REWARD
o Color key reward
502 - PL_TVMW_KEY_PAUSE
o Playback key pause
503 - PL_TVMW_KEY_FOWARD
o Playback key foward
504 - PL_TVMW_KEY_PLAY
o Playback key play
505 - PL_TVMW_KEY_STOP
o Playback key stop
506 - PL_TVMW_KEY_REC
o Playback key rec
601 - PL_TVMW_KEY_INFO
o Info
602 - PL_TVMW_KEY_TOOLS
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 249
o Tools
603 - PL_TVMW_KEY_INFOLINK
o Infolink (Info.L)
604 - PL_TVMW_KEY_EMODE
o Entertainment mode
605 - PL_TVMW_KEY_DATA
o Data
606 - PL_TVMW_KEY_DMA
o DMA
607 - PL_TVMW_KEY_CONTENTS
o Contents
608 - PL_TVMW_KEY_MENU
o Menu
609 - PL_TVMW_KEY_WISELINK
o Wiselink (W.Link)
610 - PL_TVMW_KEY_SOURCE
o Source
611 - PL_TVMW_KEY_POWER
o Power
612 - PL_TVMW_KEY_TV
o TV
613 - PL_TVMW_KEY_PANNEL_SOURCE
o Pannel source
614 - PL_TVMW_KEY_PANNEL_MENU
o Pannel menu
615 - PL_TVMW_KEY_PANNEL_POWER
o Pannel power
650 - PL_TVMW_KEY_TTX_MIX
o TTX MIX
651 - PL_TVMW_KEY_GUIDE
o Key guide
652 - PL_TVMW_KEY_SUBTITLE
o Subtitle
653 - PL_TVMW_KEY_ASPECT
o Aspect
654 - PL_TVMW_KEY_DOLBY_SRR
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 250
o Dolby surround
655 - PL_TVMW_KEY_MTS
o MTS
656 - PL_TVMW_KEY_REPEAT
o Repeat
1023 - PL_TVMW_KEY_STEP
o STEP
1032 - PL_TVMW_KEY_PIP_ONOFF
o PIP_ONOFF
1039 - PL_TVMW_KEY_AD
o AD
1040 - PL_TVMW_KEY_PMODE
o PMODE
1043 - PL_TVMW_KEY_SMODE
o SMODE
1050 - PL_TVMW_KEY_PIP_CHUP
o PIP_CHUP
1051 - PL_TVMW_KEY_PIP_CHDOWN
o PIP_CHDOWN
1078 - PL_TVMW_KEY_FF_
o _FF_
1080 - PL_TVMW_KEY_REWIND_
o REWIND
1086 - PL_TVMW_KEY_DISC_MENU
o DISC_MENU
1089 - PL_TVMW_KEY_SUB_TITLE
o SUB_TITLE
1097 - PL_TVMW_KEY_SLEEP
o SLEEP
1105 - PL_TVMW_KEY_PCMODE
o PCMODE
1132 - PL_TVMW_KEY_AV1
o AV1
1133 - PL_TVMW_KEY_SVIDEO1
o SVIDEO1
1134 - PL_TVMW_KEY_COMPONENT1
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 251
o COMPONENT1
1136 - PL_TVMW_KEY_COMPONENT2
o COMPONENT2
1139 - PL_TVMW_KEY_HDMI
o HDMI
1165 - PL_TVMW_KEY_AV2
o AV2
1166 - PL_TVMW_KEY_AV3
o AV3
1167 - PL_TVMW_KEY_SVIDEO2
o SVIDEO2
1168 - PL_TVMW_KEY_SVIDEO3
o SVIDEO3
1169 - PL_TVMW_KEY_ZOOM2
o ZOOM2
1170 - PL_TVMW_KEY_PANORAMA
o PANORAMA
1171 - PL_TVMW_KEY_4_3
o 4_3
1172 - PL_TVMW_KEY_16_9
o 16_9
1173 - PL_TVMW_KEY_DYNAMIC
o DYNAMIC
1174 - PL_TVMW_KEY_STANDARD
o STANDARD
1175 - PL_TVMW_KEY_MOVIE1
o MOVIE1
1176 - PL_TVMW_KEY_CUSTOM
o CUSTOM
1184 - PL_TVMW_KEY_HDMI1
o HDMI1
1205 - PL_TVMW_KEY_HDMI2
o HDMI2
1206 - PL_TVMW_KEY_HDMI3
o HDMI3
1210 - PL_TVMW_KEY_HDMI4
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 252
o HDMI4
1165 - PL_TVMW_KEY_AV2
o AV2
1166 - PL_TVMW_KEY_AV3
o AV3
1167 - PL_TVMW_KEY_SVIDEO2
o SVIDEO2
1168 - PL_TVMW_KEY_SVIDEO3
o SVIDEO3
1169 - PL_TVMW_KEY_ZOOM2
o ZOOM2
1170 - PL_TVMW_KEY_PANORAMA
o PANORAMA
1171 - PL_TVMW_KEY_4_3
o 4_3
1172 - PL_TVMW_KEY_16_9
o 16_9
1173 - PL_TVMW_KEY_DYNAMIC
o DYNAMIC
1174 - PL_TVMW_KEY_STANDARD
o STANDARD
1175 - PL_TVMW_KEY_MOVIE1
o MOVIE1
1176 - PL_TVMW_KEY_CUSTOM
o CUSTOM
1119 - PL_TVMW_KEY_ESAVING
o ESAVING
1128 - PL_TVMW_KEY_CALLER_ID
o CALLER_ID
1217 - PL_TVMW_KEY_TILT
o TILT
1218 - PL_TVMW_KEY_EZ_VIEW
o EZ_VIEW
1219 - PL_TVMW_KEY_3D
o 3D
1220 - PL_TVMW_KEY_AUTO_ARC_PVR_RECORDING_TEST
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 253
o AUTO_ARC_PVR_RECORDING_TEST
1221 - PL_TVMW_KEY_AUTO_ARC_PVR_PLAY_TEST
o AUTO_ARC_PVR_PLAY_TEST
1222 - PL_TVMW_KEY_AUTO_ARC_PVR_DELETE_ALL
o AUTO_ARC_PVR_DELETE_ALL
1223 - PL_TVMW_KEY_AUTO_ARC_HOTEL_INTERACTIVE
o AUTO_ARC_HOTEL_INTERACTIVE
1224 - PL_TVMW_KEY_D_LIST_UP
o D_LIST_UP
1225 - PL_TVMW_KEY_D_LIST_DOWN
o D_LIST_DOWN
1226 - PL_TVMW_KEY_D_ONDEMAND
o D_ONDEMAND
1227 - PL_TVMW_KEY_D_PANNEL_VIRTUAL_ENTER
o D_PANNEL_VIRTUAL_ENTER
1228 - PL_TVMW_KEY_D_PANNEL_VIRTUAL_SOURCE
o D_PANNEL_VIRTUAL_SOURCE
1229 - PL_TVMW_KEY_D_REC_PAUSE
o D_REC_PAUSE
1230 - PL_TVMW_KEY_D_CONTINUED_FF
o D_CONTINUED_FF
1231 - PL_TVMW_KEY_D_CONTINUED_RW
o D_CONTINUED_RW
1232 - PL_TVMW_KEY_D_CONTINUED_OFF
o D_CONTINUED_OFF
1233 - PL_TVMW_KEY_D_CANCEL
o D_CANCEL
1234 - PL_TVMW_KEY_D_TITLE_MENU
o D_TITLE_MENU
1235 - PL_TVMW_KEY_D_REPEAT_AB
o D_REPEAT_AB
1236 - PL_TVMW_KEY_D_AUDIO
o _D_AUDIO
1237 - PL_TVMW_KEY_D_REC_MODE
o D_REC_MODE
1238 - PL_TVMW_KEY_D_USB
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 254
o D_USB
1239 - PL_TVMW_KEY_D_HDD
o D_HDD
1240 - PL_TVMW_KEY_D_DISC
o D_DISC
1241 - PL_TVMW_KEY_D_TEST
o D_TEST
1242 - PL_TVMW_KEY_D_COPY
o D_COPY
1243 - PL_TVMW_KEY_D_FRONT_PLAY
o D_FRONT_PLAY
1244 - PL_TVMW_KEY_D_FRONT_STOP
o D_FRONT_STOP
1245 - PL_TVMW_KEY_D_FRONT_FF
o D_FRONT_FF
1246 - PL_TVMW_KEY_D_FRONT_RW
o D_FRONT_RW
1247 - PL_TVMW_KEY_D_FRONT_REC
o D_FRONT_REC
1248 - PL_TVMW_KEY_D_VERSION_DISPLAY_KEU
o D_VERSION_DISPLAY_KEU
1249 - PL_TVMW_KEY_D_VIEW_MODE
o D_VIEW_MODE
1250 - PL_TVMW_KEY_D_COLD_START
o D_COLD_START
Top
4.16.2.4. PL_TVMW_KEY_GRP
Enumeration
PL_TVMW_KEY_GRP (Replaced)
Key group
Remarks This enum is replaced with [Un]Register[GroupName]Key functions in AppCommon plugin
Emulator
remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 255
Function
RegisterKeyGroup (Replaced)
UnregisterKeyGroup (Replaced)
Value
0 - PL_TVMW_KEY_GRP_ALL
o All keys
1 - PL_TVMW_KEY_GRP_NUMBER
o All number keys
2 - PL_TVMW_KEY_GRP_CHANNEL
o All channel keys
3 - PL_TVMW_KEY_GRP_VOLUME
o All volume keys
4 - PL_TVMW_KEY_GRP_NAVI
o All nnavi keys
5 - PL_TVMW_KEY_GRP_COLOR
o All color keys
6 - PL_TVMW_KEY_GRP_PLAYBACK
o All playback keys
Top
4.16.2.5. PL_TVMW_LANGUAGE
Enumeration
PL_TVMW_LANGUAGE (Replaced)
Language
Remarks This enum is replaced with PL_TV_LANGUAGE enum in TV plugin
Emulator
remarks none
Function GetLanguage (Replaced)
Value
0 - PL_TVMW_LANGUAGE_KOR
o KOR
1 - PL_TVMW_LANGUAGE_ENG_US
o ENG_US
2 - PL_TVMW_LANGUAGE_SPA_US
o SPA_US
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 256
3 - PL_TVMW_LANGUAGE_FRA_US
o FRA_US
4 - PL_TVMW_LANGUAGE_POR_US
o POR_US
5 - PL_TVMW_LANGUAGE_BUL
o BUL
6 - PL_TVMW_LANGUAGE_CRO
o CRO
7 - PL_TVMW_LANGUAGE_CZE
o CZE
8 - PL_TVMW_LANGUAGE_DAN
o DAN
9 - PL_TVMW_LANGUAGE_DUT
o DUT
10 - PL_TVMW_LANGUAGE_FIN
o FIN
11 - PL_TVMW_LANGUAGE_FRA
o FRA
12 - PL_TVMW_LANGUAGE_DEU
o DEU
13 - PL_TVMW_LANGUAGE_GRE
o GRE
14 - PL_TVMW_LANGUAGE_HUN
o HUN
15 - PL_TVMW_LANGUAGE_ITA
o ITA
16 - PL_TVMW_LANGUAGE_NOR
o NOR
17 - PL_TVMW_LANGUAGE_ENG
o ENG
18 - PL_TVMW_LANGUAGE_POL
o POL
19 - PL_TVMW_LANGUAGE_POR
o POR
20 - PL_TVMW_LANGUAGE_ROM
o ROM
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 257
21 - PL_TVMW_LANGUAGE_RUS
o RUS
22 - PL_TVMW_LANGUAGE_SER
o SER
23 - PL_TVMW_LANGUAGE_SLK
o SLK
24 - PL_TVMW_LANGUAGE_SPA
o SPA
25 - PL_TVMW_LANGUAGE_SWE
o SWE
26 - PL_TVMW_LANGUAGE_TUR
o TUR
27 - PL_TVMW_LANGUAGE_CHI
o CHI
28 - PL_TVMW_LANGUAGE_HKG
o HKG
29 - PL_TVMW_LANGUAGE_TPE
o TPE
30 - PL_TVMW_LANGUAGE_JPN
o JPN
31 - PL_TVMW_LANGUAGE_MAO
o MAO
32 - PL_TVMW_LANGUAGE_CMN
o CMN
33 - PL_TVMW_LANGUAGE_YUE
o YEU
34 - PL_TVMW_LANGUAGE_HIN
o HIN
35 - PL_TVMW_LANGUAGE_EST
o EST
36 - PL_TVMW_LANGUAGE_LAT
o LAT
37 - PL_TVMW_LANGUAGE_LTU
o LTU
38 - PL_TVMW_LANGUAGE_ARA
o ARA
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 258
39 - PL_TVMW_LANGUAGE_PER
o PER
40 - PL_TVMW_LANGUAGE_QAA
o QAA
41 - PL_TVMW_LANGUAGE_AD
o AD
42 - PL_TVMW_LANGUAGE_CAT
o CAT
43 - PL_TVMW_LANGUAGE_VAL
o VAL
44 - PL_TVMW_LANGUAGE_HEB
o HEB
45 - PL_TVMW_LANGUAGE_OTHER
o OTHER
46 - PL_TVMW_LANGUAGE_THA
o THA
Top
4.16.2.6. PL_TVMW_PRFID
Enumeration
PL_TVMW_PRFID
Profile ID
Remarks none
Emulator
remarks none
Function
GetProfile
SetProfile
Value
0 - PL_TVMW_PRFID_TICKER_ID
o Ticker ID
1 - PL_TVMW_PRFID_CHILDLOCK_PIN
o Childlock PIN number
2 - PL_TVMW_PRFID_HUB_TVID
o Hub TV ID
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 259
3 - PL_TVMW_PRFID_TICKER_AUTOBOOT
o Ticker autoboot
4 - PL_TVMW_PRFID_TICKER_DURATION
o Ticker duration
5 - PL_TVMW_PRFID_WIDGET_DPTIME
o Widget display time
6 - PL_TVMW_PRFID_CONTRACT
o Contract
7 - PL_TVMW_PRFID_TICKER_SAFE
o Ticker safe
8 - PL_TVMW_PRFID_RESET
o Reset
9 - PL_TVMW_PRFID_PASSWD_RESET
o Password reset
10 - PL_TVMW_PRFID_GEOIP_STATUS
o GeoIP status
11 - PL_TVMW_PRFID_COUNTRY_CODE
o Country code
12 - PL_TVMW_PRFID_WLAN_DEFAULT_NETWORK
o wired(0) or wiress(-1)
13 - PL_TVMW_PRFID_AUTO_PROTECTION_TIME
o Auto protection time
14 - PL_TVMW_PRFID_CHANNEL_BOUND_EXECUTE
o Channel bound execute
Top
4.16.2.7. PL_TVMW_SOURCE
Enumeration
PL_TVMW_SOURCE (Replaced)
none
Remarks This enum is replaced with PL_WINDOW_SOURCE enum in TV plugin
Emulator
remarks none
Function GetSource (Replaced)
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 260
SetSource (Replaced)
Value
0 - PL_TVMW_SOURCE_TV
o TV
1 - PL_TVMW_SOURCE_ATV
o ATV
2 - PL_TVMW_SOURCE_DTV
o DTV
3 - PL_TVMW_SOURCE_CATV
o CATV
4 - PL_TVMW_SOURCE_CDTV
o CDTV
5 - PL_TVMW_SOURCE_PATV
o PATV
6 - PL_TVMW_SOURCE_PDTV
o PDTV
7 - PL_TVMW_SOURCE_SDTV
o SDTV
8 - PL_TVMW_SOURCE_BSDTV
o BSDTV
9 - PL_TVMW_SOURCE_CS1DTV
o CS1DTV
10 - PL_TVMW_SOURCE_CS2DTV
o CS2DTV
11 - PL_TVMW_SOURCE_ATV1
o ATV1
12 - PL_TVMW_SOURCE_ATV2
o ATV2
13 - PL_TVMW_SOURCE_DTV1
o DTV1
14 - PL_TVMW_SOURCE_DTV2
o DTV2
15 - PL_TVMW_SOURCE_AV1
o AV1
16 - PL_TVMW_SOURCE_AV2
o AV2
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 261
17 - PL_TVMW_SOURCE_AV3
o AV3
18 - PL_TVMW_SOURCE_AV4
o AV4
19 - PL_TVMW_SOURCE_SVIDEO1
o SVIDEO1
20 - PL_TVMW_SOURCE_SVIDEO2
o SVIDEO2
21 - PL_TVMW_SOURCE_SVIDEO3
o SVIDEO3
22 - PL_TVMW_SOURCE_SVIDEO4
o SVIDEO4
23 - PL_TVMW_SOURCE_COMP1
o COMP1
24 - PL_TVMW_SOURCE_COMP2
o COMP2
25 - PL_TVMW_SOURCE_COMP3
o COMP3
26 - PL_TVMW_SOURCE_COMP4
o COMP4
27 - PL_TVMW_SOURCE_PC1
o PC1
28 - PL_TVMW_SOURCE_PC2
o PC2
29 - PL_TVMW_SOURCE_PC3
o PC3
30 - PL_TVMW_SOURCE_PC4
o PC4
31 - PL_TVMW_SOURCE_HDMI1
o HDMI1
32 - PL_TVMW_SOURCE_HDMI2
o HDMI2
33 - PL_TVMW_SOURCE_HDMI3
o HDMI3
34 - PL_TVMW_SOURCE_HDMI4
o HDMI4
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 262
35 - PL_TVMW_SOURCE_SCART1
o SCART1
36 - PL_TVMW_SOURCE_SCART2
o SCART2
37 - PL_TVMW_SOURCE_SCART3
o SCART3
38 - PL_TVMW_SOURCE_SCART4
o SCART4
39 - PL_TVMW_SOURCE_DVI1
o DVI1
40 - PL_TVMW_SOURCE_DVI2
o DVI2
41 - PL_TVMW_SOURCE_DVI3
o DVI3
42 - PL_TVMW_SOURCE_DVI4
o DVI4
43 - PL_TVMW_SOURCE_MEDIA
o MEDIA
44 - PL_TVMW_SOURCE_HOMING
o DCR HOMING
45 - PL_TVMW_SOURCE_NONE
o No source
Top
4.16.2.8. PL_TVMW_TVUT
Enumeration
PL_TVMW_TVUT (Replaced)
TV use type
Remarks This enum is replaced with GetOption(PL_SCREEN_OPTION_SHOP_MODE) function in Screen
plugin
Emulator
remarks none
Function GetTVUseMode (Replaced)
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 263
Value
0 - PL_TVMW_TVUT_HOME
o Home
1 - PL_TVMW_TVUT_SHOP
o Shop
Top
4.16.2.9. PL_TVMW_WATCHDOG
Enumeration
PL_TVMW_WATCHDOG (Replaced)
Watchdog
Remarks This enum is replaced with SetWatchDog function in TV plugin
Emulator
remarks none
Function SetWatchDog (Replaced)
Value
0 - PL_TVMW_WATCHDOG_ON
o Watchdog On
1 - PL_TVMW_WATCHDOG_OFF
o Watchdog Off
Top
4.17. TaskManager
4.17.1. Function
4.17.1.1. ActivateApplication
Function
ActivateApplication
ActivateApplication function activate new application ( ex : PL_TASKMANAGER_DTVAPP_INFOLINK2 or etc... )
Syntax ActivateApplication( PL_TASKMANAGER_DTVAPP Application )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 264
Parameter
Application
o PL_TASKMANAGER_DTVAPP
o Application to be actiavted
Return
Value
If success, returns positive value.
otherwise, returns negative value
Remarks none
Emulator
remarks Only returns true
Example TaskManagerPlugin.ActivateApplication(PL_TASKMANAGER_DTVAPP_INFOLI
NK2);
Enumeratio
n
PL_TASKMANAGER_DTVAPP
Version Support from TASKMANAGER-0001
Security
Type System
Top
4.17.1.2. GetActiveApplication
Function
GetActiveApplication
GetActiveApplication function returns a current activated application ( ex : GetActiveApplication etc... )
Syntax GetActiveApplication( )
Parameter none
Return Value If success, a current activated application (PL_TASKMANAGER_DTVAPP),
otherwise, returns negative value
Remarks none
Emulator
remarks Only returns true
Example
if( PL_TASKMANAGER_DTVAPP_INFOLINK2 ==
TaskManagerPlugin.GetActiveApplication())
{
.....
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 265
else
{
...
}
Enumeration PL_TASKMANAGER_DTVAPP
Version Support from TASKMANAGER-0001
Security Type TVInfo
Top
4.17.1.3. GetBgApplication
Function
GetBgApplication
GetBgApplication function returns a background application ( ex : PL_TASKMANAGER_DTVAPP_INFOLINK2 or
etc... )
Syntax GetBgApplication( )
Parameter none
Return Value If success, a background application (PL_TASKMANAGER_DTVAPP),
otherwise, returns negative value
Remarks none
Emulator
remarks Only returns false
Example
if( PL_TASKMANAGER_DTVAPP_INFOLINK2 ==
TaskManagerPlugin.GetBgApplication())
{
.....
}
else
{
...
}
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 266
Enumeration PL_TASKMANAGER_DTVAPP
Version Support from TASKMANAGER-0001
Security Type TVInfo
Top
4.17.1.4. SetBgApplication
Function
SetBgApplication
SetBgApplication function sets a background application ( ex : PL_TASKMANAGER_DTVAPP_INFOLINK2 or
etc... )
Syntax SetBgApplication( PL_TASKMANAGER_DTVAPP Application )
Parameter
Application
o PL_TASKMANAGER_DTVAPP
o Application to be registered as background application
Return
Value
If success, returns positive value.
otherwise, returns negative value
Remarks none
Emulator
remarks Only returns false
Example TaskManagerPlugin.SetBgApplication(PL_TASKMANAGER_DTVAPP_INFOLIN
K2);
Enumeratio
n
PL_TASKMANAGER_DTVAPP
Version Support from TASKMANAGER-0001
Security
Type System
Top
4.17.2. Enumeration
4.17.2.1. PL_TASKMANAGER_DTVAPP
Enumeration
PL_TASKMANAGER_DTVAPP
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 267
Application ( ex : Infolink, Wiselink, ... )
Remarks none
Emulator
remarks none
Function
GetActiveApplication
GetBgApplication
SetBgApplication
ActivateApplication
Value
0 - PL_TASKMANAGER_DTV_APP_NONE
1 - PL_TASKMANAGER_DTV_APP_TASKMANAGER
2 - PL_TASKMANAGER_DTV_APP_TVVIEWER
3 - PL_TASKMANAGER_DTV_APP_MENU
4 - PL_TASKMANAGER_DTV_APP_EPG
5 - PL_TASKMANAGER_DTV_APP_CM
6 - PL_TASKMANAGER_DTV_APP_CC
7 - PL_TASKMANAGER_DTV_APP_FAC
8 - PL_TASKMANAGER_DTV_APP_CHANNELSEARCH
9 - PL_TASKMANAGER_DTV_APP_ADDDEL
10 - PL_TASKMANAGER_DTV_APP_REMINDER
11 - PL_TASKMANAGER_DTV_APP_SOURCE
12 - PL_TASKMANAGER_DTV_APP_TVTOOLS
13 - PL_TASKMANAGER_DTV_APP_INTERTEST
14 - PL_TASKMANAGER_DTV_APP_INTERNALTEST
15 - PL_TASKMANAGER_DTV_APP_HOTEL
16 - PL_TASKMANAGER_DTV_APP_MINIFAVCH
17 - PL_TASKMANAGER_DTV_APP_EAS
18 - PL_TASKMANAGER_DTV_APP_DV
19 - PL_TASKMANAGER_DTV_APP_HTML
20 - PL_TASKMANAGER_DTV_APP_APPLIST
21 - PL_TASKMANAGER_DTV_APP_JAVAMW
22 - PL_TASKMANAGER_DTV_APP_COMDOWNLOAD
23 - PL_TASKMANAGER_DTV_APP_TTX
24 - PL_TASKMANAGER_DTV_APP_SBT
25 - PL_TASKMANAGER_DTV_APP_CI
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 268
26 - PL_TASKMANAGER_DTV_APP_MHEG
27 - PL_TASKMANAGER_DTV_APP_RETURN_CHANNEL
28 - PL_TASKMANAGER_DTV_APP_CU
29 - PL_TASKMANAGER_DTV_APP_FAVCHLIST
30 - PL_TASKMANAGER_DTV_APP_LOGOMANAGER
31 - PL_TASKMANAGER_DTV_APP_GEMSTAR
32 - PL_TASKMANAGER_DTV_APP_FMRADIO
33 - PL_TASKMANAGER_DTV_APP_HOME_MENU
34 - PL_TASKMANAGER_DTV_APP_MOVIE_WISELINK
35 - PL_TASKMANAGER_DTV_APP_MMBROSWER
36 - PL_TASKMANAGER_DTV_APP_MMPLAYER
37 - PL_TASKMANAGER_DTV_APP_MOVIE_PLAYER
38 - PL_TASKMANAGER_DTV_APP_MINT
39 - PL_TASKMANAGER_DTV_APP_WPRO
40 - PL_TASKMANAGER_DTV_APP_DLNA
41 - PL_TASKMANAGER_DTV_APP_DLNACENTER
42 - PL_TASKMANAGER_DTV_APP_DMR
43 - PL_TASKMANAGER_DTV_APP_PMR
44 - PL_TASKMANAGER_DTV_APP_RUIS
45 - PL_TASKMANAGER_DTV_APP_RUIC
46 - PL_TASKMANAGER_DTV_APP_USBLIST
47 - PL_TASKMANAGER_DTV_APP_STORY
48 - PL_TASKMANAGER_DTV_APP_PVR
49 - PL_TASKMANAGER_DTV_APP_PVR_EDIT
50 - PL_TASKMANAGER_DTV_APP_PVR_BROWSER
51 - PL_TASKMANAGER_DTV_APP_CEC
52 - PL_TASKMANAGER_DTV_APP_CEC_DEVICE
53 - PL_TASKMANAGER_DTV_APP_BLUETOOTH
54 - PL_TASKMANAGER_DTV_APP_SWUPGRADE
55 - PL_TASKMANAGER_DTV_APP_OTA
56 - PL_TASKMANAGER_DTV_APP_SWUPGRADE_AIR
57 - PL_TASKMANAGER_DTV_APP_OAD
58 - PL_TASKMANAGER_DTV_APP_OAD_SAT
59 - PL_TASKMANAGER_DTV_APP_OTN
60 - PL_TASKMANAGER_DTV_APP_SWUCOMMON
61 - PL_TASKMANAGER_DTV_APP_USB_HOTEL_LOGOCLONE
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 269
62 - PL_TASKMANAGER_DTV_APP_CHMAP_TRANSFER
63 - PL_TASKMANAGER_DTV_APP_RSS
64 - PL_TASKMANAGER_DTV_APP_INFOLINK2
65 - PL_TASKMANAGER_DTV_APP_MEDIALINK
66 - PL_TASKMANAGER_DTV_APP_CONTENTSHOME
67 - PL_TASKMANAGER_DTV_APP_GPLAYER
68 - PL_TASKMANAGER_DTV_APP_FLASHPLAYER
69 - PL_TASKMANAGER_DTV_APP_TLIBBROWSER
70 - PL_TASKMANAGER_DTV_APP_PRODUCTGUIDE
71 - PL_TASKMANAGER_DTV_APP_USERMANUAL
72 - PL_TASKMANAGER_DTV_APP_GALLERYPLAYER
73 - PL_TASKMANAGER_DTV_APP_CLMOVIEPLAYER
74 - PL_TASKMANAGER_DTV_APP_CLPOP
75 - PL_TASKMANAGER_DTV_APP_WLAN
76 - PL_TASKMANAGER_DTV_APP_YAHOO
77 - PL_TASKMANAGER_DTV_APP_SHOPDEMO
78 - PL_TASKMANAGER_DTV_APP_MAINTVUPNPSERVER
79 - PL_TASKMANAGER_DTV_APP_DUALTV_READY
80 - PL_TASKMANAGER_DTV_APP_MOIP
81 - PL_TASKMANAGER_DTV_APP_DNET
82 - PL_TASKMANAGER_DTV_APP_POP
83 - PL_TASKMANAGER_DTV_APP_FRONTRUNNER
84 - PL_TASKMANAGER_DTV_APP_HOTEL_IPTV
85 - PL_TASKMANAGER_DTV_APP_IPTV_BROWSER
86 - PL_TASKMANAGER_DTV_APP_PHAROS_AGENT
87 - PL_TASKMANAGER_DTV_APP_FRONT_DISPLAY
88 - PL_TASKMANAGER_DTV_APP_BDP_TOOLS
89 - PL_TASKMANAGER_DTV_APP_BDHTS
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 270
4.18. Time
4.18.1. Function
4.18.1.1. ConvertEpochToLocalTime
Function
ConvertEpochToLocalTime
ConvertEpochToLocalTime function returns convert epoch time(UTC) to local time and return it as string
type(yyyy/mm/dd/hh/mm/ss)
Syntax ConvertEpochToLocalTime( Number epochTime )
Parameter
epochTime
o Number
o epoch time(UTC)
Return Value If success, local time(yyyy/mm/dd/hh/mm/ss),
otherwise, returns negative value
Remarks none
Emulator
remarks none
Example
var epochTime = TimePlugin.GetEpochTime();
TVPlugin.GetProgramList(epochTime, 3600);
var programListSize = TVPlugin.GetProgramList_Size();
if( programListSize > 5 )
{
programListSize = 5;
}
for(var i=0 ; i<programListSize ; ++i)
{
document.getElementById('Title' + i).value =
TVPlugin.GetProgram_Title(i);
document.getElementById('Start' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_StartTime(i) );
document.getElementById('End' + i).value =
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 271
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_EndTime(i) );
document.getElementById('Duration' + i).value =
TVPlugin.GetProgram_Duration(i);
}
Enumeration none
Version Support from TIME-0001
Security Type TVInfo
Top
4.18.1.2. GetEpochTime
Function
GetEpochTime
GetEpochTime function returns a current epoch time(UTC)
Syntax GetEpochTime( )
Parameter none
Return Value If success, returns a current epoch time(UTC)
otherwise, returns negative value
Remarks none
Emulator
remarks none
Example
var epochTime = TimePlugin.GetEpochTime();
TVPlugin.GetProgramList(epochTime, 3600);
var programListSize = TVPlugin.GetProgramList_Size();
if( programListSize > 5 )
{
programListSize = 5;
}
for(var i=0 ; i<programListSize ; ++i)
{
document.getElementById('Title' + i).value =
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 272
TVPlugin.GetProgram_Title(i);
document.getElementById('Start' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_StartTime(i) );
document.getElementById('End' + i).value =
TimePlugin.ConvertEpochToLocalTime( TVPlugin.GetProgram_EndTime(i) );
document.getElementById('Duration' + i).value =
TVPlugin.GetProgram_Duration(i);
}
Enumeration none
Version Support from TIME-0001
Security Type TVInfo
Top
4.19. Video
4.19.1. Function
4.19.1.1. ChangeWidgetMode
Function
ChangeWidgetMode
This function process underneath widget side when an widget changes from Full mode to Partial Mode or from Partial
mode to Full mode. So widget should call this function when Full/Partial mode to be changed.
Syntax ChangeWidgetMode( PL_VIDEO_WIDGET_MODE widgetMode )
Parameter
widgetMode
o PL_VIDEO_WIDGET_MODE
o Full or Partial
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks Full mode : Widget covers full Screen(960x540)
Partial Mode : Widget doesn‟t cover full screen, only part of DTV screen.
Emulator
remarks [FAKE] Do nothing, just print out function name on debug console in SDK.
Example VideoPlugin.ChangeWidgetMode(PL_VIDEO_WIDGET_MODE_FULL);
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 273
// switch to Full screen widget
VideoPlugin.ChangeWidgetMode(PL_VIDEO_WIDGET_MODE_PART);
// switch to Partial screen widget
Enumeration PL_VIDEO_WIDGET_MODE
Version Support from VIDEO-0001
Security Type System
Top
4.19.1.2. SetFrameRate
Function
SetFrameRate (Replaced)
Change whether the frame rate of the screen should be changed or not
If any problem occurs when frame rate is changed, then a widget can fix the frame rate to avoid the problem.
Syntax SetFrameRate( Number IsFixedFrameRate )
Parameter
IsFixedFrameRate
o Number
o 1 : fixed 0: not fixed
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks
This function is replaced with SetOption(PL_SCREEN_OPTION_FIXED_FRAME_RATE)
function in Screen plugin
When some video contents is played, screen frame rate is changed automatically, and the screen
has some noise. In this case, widgets can fix frame rate using this function.
Emulator
remarks [FAKE] Do nothing, just print out function name on debug console in SDK.
Example VideoPlugin.SetFrameRate(PLR_TRUE);
Enumeration none
Version Support from VIDEO-0004
Security Type System
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 274
4.19.1.3. SetOSDState
Function
SetOSDState
Set screen enhancement function (MJC) on / off.
Syntax SetOSDState( Number handle , Number x , Number y , Number w , Number h ,
Number OSDState )
Parameter
handle
o Number
o Handle value. The same value should be used for SetOSDState( PLR_TRUE )
and SetOSDState( PLR_FALSE )
x
o Number
o X(hor) coordinate of starting position
y
o Number
o Y(ver) coordinate of starting position
w
o Number
o Width of region
h
o Number
o Height of region
OSDState
o Number
o 1 : MJC off, 0: MJC On
Return Value If success, returns PLR_TRUE.
Otherwise, returns error code.
Remarks
When some widgets are displayed on some panels, when hiding the widget, sometimes a
rectangle remains from the widget. In this case, the widget should use this function to avoid the
problem with the remaining rectangle.
Emulator
remarks [FAKE] Do nothing, just print out function name on debug console in SDK.
Example ... MJC Off ...
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 275
VideoPlugin.SetOSDState(1,100, 100, 100, 100, PLR_TRUE);
... MJC On ...
VideoPlugin.SetOSDState(1,100, 100, 100, 100, PLR_FALSE);
Enumeration none
Version Support from VIDEO-0003
Security Type System
Top
4.19.2. Enumeratioin
4.19.2.1. PL_VIDEO_WIDGET_MODE
Enumeration
PL_VIDEO_WIDGET_MODE
Widget type based on a size ( full or part )
Remarks none
Emulator
remarks none
Function ChangeWidgetMode
Value
0 - PL_VIDEO_WIDGET_MODE_FULL
o Full screen widget mode
1 - PL_VIDEO_WIDGET_MODE_PART
o Partial screen widget mode(ex: Partial widget manager, UCC widget mode for
playing video contents)
Top
4.20. Window
4.20.1. Function
4.20.1.1. CheckScreenRect_PosSizeMode
Function
CheckScreenRect_PosSizeMode
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 276
CheckScreenRect_PosSizeMode function checks whether you can change TV screen state to PosMode and SizeMode of
parameters
Syntax CheckScreenRect_PosSizeMode( PL_WINDOW_POSITION_MODE PosMode ,
PL_WINDOW_RECT_SIZE_MODE SizeMode )
Parameter
PosMode
o PL_WINDOW_POSITION_MODE
o enumeration of screen left, top coordinates
SizeMode
o PL_WINDOW_RECT_SIZE_MODE
o enumeration of screen width, height
Return
Value
If success, returns positive value
otherwise, returns negative value
Remarks none
Emulator
remarks Returns true about all input parameter values.
Example
var result;
// PL_WINDOW_POSITION_MODE value is defined in refrence file PluginTV.js
result =
WindowPlugin.CheckScreenRect_PosSizeMode(PL_WINDOW_POSITION_MODE_
DEFAULT, PL_WINDOW_RECT_SIZE_MODE_DEFALUT);
if( result > 0 )
{
WindowPlugin.SetScreenRect_PosSizeMode(PL_WINDOW_POSITION_M
ODE_DEFAULT, PL_WINDOW_RECT_SIZE_MODE_DEFALUT);
}
else
{
// Error
}
Enumerati
on PL_WINDOW_POSITION_MODE
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 277
PL_WINDOW_RECT_SIZE_MODE
Version Support from WINDOW-0001
Security
Type TVInfo
Top
4.20.1.2. GetCurrentChannel_Major
Function
GetCurrentChannel_Major
GetCurrentChannel_Major function returns a major number ( ex: "11" from "11-1" ) of a current channel number
Syntax GetCurrentChannel_Major( )
Parameter none
Return Value If success, returns a major number of a current channel number
otherwise, returns negative value
Remarks none
Emulator
remarks
There are only four channel(1-1, 2-1, 3-1, 4-0) in the emulator.
Returns a major number of a current virtual channel supported by the emulator.
Example
var major = WindowPlugin.GetCurrentChannel_Major();
var minor = WindowPlugin.GetCurrentChannel_Minor();
var channelNumber = major + "-" + minor;
Enumeration none
Version Support from WINDOW-0001
Security Type Channel
Top
4.20.1.3. GetCurrentChannel_Minor
Function
GetCurrentChannel_Minor
GetCurrentChannel_Minor function returns a minor number ( ex: "1" from "11-1" ) of a current channel number
Syntax GetCurrentChannel_Minor( )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 278
Parameter none
Return Value If success, returns a minor number of a current channel number
otherwise, returns negative value
Remarks none
Emulator
remarks
There are only four channel(1-1, 2-1, 3-1, 4-0) in the emulator.
Returns a major number of a virtual channel supported by the emulator.
Example
var major = WindowPlugin.GetCurrentChannel_Major();
var minor = WindowPlugin.GetCurrentChannel_Minor();
var channelNumber = major + "-" + minor;
Enumeration none
Version Support from WINDOW-0001
Security Type Channel
Top
4.20.1.4. GetCurrentChannel_Name
Function
GetCurrentChannel_Name
GetCurrentChannel_Name function returns a name of a current channel( ex : "BBC" )
Syntax GetCurrentChannel_Name( )
Parameter none
Return Value If success, returns a name of a current channel
otherwise, returns negative value
Remarks Channel name is supported in only digital channel. There is no channel name in analog channel
Emulator
remarks Returns a virtual current channel name.
Example var name = WindowPlugin.GetCurrentChannel_Name();
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 279
Enumeration none
Version Support from WINDOW-0001
Security Type Channel
Top
4.20.1.5. GetCurrentChannel_OriginNetID
Function
GetCurrentChannel_OriginNetID
GetCurrentChannel_OriginNetID function returns a OriginNetID of a current channel
Syntax GetCurrentChannel_OriginNetID( )
Parameter none
Return Value If success, returns a OriginNetID of a current channel
otherwise, returns negative value
Remarks none
Emulator
remarks Body is empty, returns false
Example var originNetID = WindowPlugin.GetCurrentChannel_OriginNetID();
Enumeration none
Version Support from WINDOW-0001
Security Type Channel
Top
4.20.1.6. GetCurrentChannel_ProgramNumber
Function
GetCurrentChannel_ProgramNumber
GetCurrentChannel_ProgramNumber function returns a program number of a current channel
Syntax GetCurrentChannel_ProgramNumber( )
Parameter none
Return Value If success, returns a program number of a current channel
otherwise, returns negative value
Remarks none
Emulator Returns a current program number in a virtual channel.
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 280
remarks
Example var programNumber = WindowPlugin.GetCurrentChannel_ProgramNumber();
Enumeration none
Version Support from WINDOW-0001
Security Type Channel
Top
4.20.1.7. GetCurrentChannel_PTC
Function
GetCurrentChannel_PTC
GetCurrentChannel_PTC function returns a PTC of a current channel
Syntax GetCurrentChannel_PTC( )
Parameter none
Return Value If success, returns a PTC of a current channel
otherwise, returns negative value
Remarks none
Emulator
remarks Returns a virtual PTC of a current channel.
Example var PTC = WindowPlugin.GetCurrentChannel_PTC();
Enumeration none
Version Support from WINDOW-0001
Security Type Channel
Top
4.20.1.8. GetCurrentChannel_ServiceName
Function
GetCurrentChannel_ServiceName
GetCurrentChannel_ServiceName function returns a ServiceName of a current channel
Syntax GetCurrentChannel_ServiceName( )
Parameter none
Return Value If success, returns a ServiceName of a current channel
otherwise, returns negative value
Remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 281
Emulator
remarks Boldy is empty, returns only false
Example var serviceName = WindowPlugin.GetCurrentChannel_ServiceName();
Enumeration none
Version Support from WINDOW-0001
Security Type Channel
Top
4.20.1.9. GetCurrentChannel_Type
Function
GetCurrentChannel_Type
GetCurrentChannel_Type function returns a type( AnalogTV, DigitalTV, CableAnalogTV, CableDigitalTV, ... ) of a
current channel
Syntax GetCurrentChannel_Type( )
Parameter none
Return Value If success, returns a type of a current channel (PL_WINDOW_CHANNEL_TYPE)
otherwise, returns negative value
Remarks none
Emulator
remarks
Supports three digital channel(1-1,2-1,3-1) and one analog channel(4-0)
Returns a channel type of a current virtual channel supported by the emulator.
Example var type = WindowPlugin.GetCurrentChannel_Type();
Enumeration PL_WINDOW_CHANNEL_TYPE
Version Support from WINDOW-0001
Security Type Channel
Top
4.20.1.10. GetResolution
Function
GetResolution
GetResolution function returns a resolution of video layer( ex : 720P, 1080I, NoSignal, NotSupported, ... )
Syntax GetResolution( )
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 282
Parameter none
Return Value If success, returns a resolution of video layer( ex : 720P, 1080I, NoSignal, NotSupported, ... )
otherwise, returns negative value
Remarks none
Emulator
remarks Boldy is empty, returns only false
Example
if( PL_WINDOW_SHOW_STATE_START != WindowPlugin.GetState_Show() )
{
WindowPlugin.Show(PL_WINDOW_SHOW_TYPE_START);
}
Enumeration PL_WINDOW_RESOLUTION
Version Support from WINDOW-0001
Security Type TVInfo
Top
4.20.1.11. GetScreenRect
Function
GetScreenRect
GetScreenRect function returns a screen size(left, top, width, height) of a video layer
Syntax GetScreenRect( )
Parameter none
Return Value If success, returns a string that each value is connected with "/" ( ex : 0010/0010/0320/0240 ) in
otherwise, returns negative value
Remarks none
Emulator remarks Returns rectangle area values of the screen in the emulator.
Example var type = WindowPlugin.GetScreenRect();
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 283
Enumeration none
Version Support from WINDOW-0001
Security Type TVInfo
Top
4.20.1.12. GetScreenRect_PosMode
Function
GetScreenRect_PosMode
GetScreenRect_PosMode function returns a enumeration of screen left, top coordinates of video layer
Syntax GetScreenRect_PosMode( )
Parameter none
Return
Value
If success, returns a enumeration of screen left, top coordinates
otherwise, returns negative value
Remarks none
Emulator
remarks Returns a position mode of the screen in the emulator.
Example
if( (PL_WINDOW_POSITION_MODE_DEFAULT !=
WindowPlugin.GetScreenRect_PosMode() ) ||
(PL_WINDOW_RECT_SIZE_MODE_DEFALUT !=
WindowPlugin.GetScreenRect_SizeMode() )
{
WindowPlugin.SetScreenRect_PosSizeMode(PL_WINDOW_POSITION_M
ODE_DEFAULT, PL_WINDOW_RECT_SIZE_MODE_DEFALUT);
}
Enumerati
on
PL_WINDOW_POSITION_MODE
Version Support from WINDOW-0001
Security
Type TVInfo
Top
4.20.1.13. GetScreenRect_SizeMode
Function
GetScreenRect_SizeMode
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 284
GetScreenRect_SizeMode function returns a enumeration of screen size(width, height) of the video layer
Syntax GetScreenRect_SizeMode( )
Parameter none
Return
Value
If success, returns a enumeration of screen size(width, height) of the video layer
otherwise, returns negative value
Remarks none
Emulator
remarks Returns a size mode of the screen in the emulator.
Example
if( (PL_WINDOW_POSITION_MODE_DEFAULT !=
WindowPlugin.GetScreenRect_PosMode() ) ||
(PL_WINDOW_RECT_SIZE_MODE_DEFALUT !=
WindowPlugin.GetScreenRect_SizeMode() )
{
WindowPlugin.SetScreenRect_PosSizeMode(PL_WINDOW_POSITION_M
ODE_DEFAULT, PL_WINDOW_RECT_SIZE_MODE_DEFALUT);
}
Enumerati
on
PL_WINDOW_RECT_SIZE_MODE
Version Support from WINDOW-0001
Security
Type TVInfo
Top
4.20.1.14. GetSource
Function
GetSource
GetSource function returns a current source. (TV or PC or DVI ...)
Syntax GetSource( )
Parameter none
Return Value If success, returns a current source (PL_WINDOW_SOURCE)
otherwise, returns negative value
Remarks none
Emulator
remarks Boldy is empty, returns only false
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 285
Example
if( PL_WINDOW_SOURCE_MEDIA != WindowPlugin.GetSource() )
{
WindowPlugin.SetSource(PL_WINDOW_SOURCE_MEDIA);
}
Enumeration PL_WINDOW_SOURCE
Version Support from WINDOW-0003
Security Type TVInfo
Top
4.20.1.15. GetState_Show
Function
GetState_Show
GetState_Show function returns a state of video layer( ex : Play, NoSignal, ... )
Syntax GetState_Show( )
Parameter none
Return Value If success, returns a state of video layer( ex : Play, NoSignal, ... )
otherwise, returns negative value
Remarks none
Emulator
remarks Returns a virtual set viedeo state.
Example
if( PL_WINDOW_SHOW_STATE_START != WindowPlugin.GetState_Show() )
{
WindowPlugin.Show(PL_WINDOW_SHOW_TYPE_START);
}
Enumeration PL_WINDOW_SHOW_STATE
Version Support from WINDOW-0001
Security Type TVInfo
Top
Top
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 286
4.20.1.16. SetSource
Function
SetSource
SetSource function chage current source. (TV or PC or DVI ...)
Syntax SetSource( PL_WINDOW_SOURCE source )
Parameter
source
o PL_WINDOW_SOURCE
o Source
Return Value If success, returns a positive value
otherwise, returns negative value
Remarks none
Emulator
remarks Boldy is empty, returns only false
Example
if( PL_WINDOW_SOURCE_MEDIA != WindowPlugin.GetSource() )
{
WindowPlugin.SetSource(PL_WINDOW_SOURCE_MEDIA);
}
Enumeration PL_WINDOW_SOURCE
Version Support from WINDOW-0003
Security Type TVInfo
Top
4.20.2. Enumeration
4.20.2.1. PL_WINDOW_CHANNEL_TYPE
Enumeration
PL_WINDOW_CHANNEL_TYPE
none
Remarks none
Emulator
remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 287
Function GetCurrentChannel_Type
Value
0 - PL_WINDOW_CHANNEL_TYPE_UNKNOWN
o Unknown channel
1 - PL_WINDOW_CHANNEL_TYPE_TV
o TV
2 - PL_WINDOW_CHANNEL_TYPE_ATV
o Analog TV
3 - PL_WINDOW_CHANNEL_TYPE_DTV
o Digital TV
4 - PL_WINDOW_CHANNEL_TYPE_CATV
o Cable analog TV
5 - PL_WINDOW_CHANNEL_TYPE_CDTV
o Cable digital TV
6 - PL_WINDOW_CHANNEL_TYPE_PATV
o POD analog TV
7 - PL_WINDOW_CHANNEL_TYPE_PDTV
o POD digital TV
8 - PL_WINDOW_CHANNEL_TYPE_SDTV
o SDTV
9 - PL_WINDOW_CHANNEL_TYPE_FREESAT
o Freesat
10 - PL_WINDOW_CHANNEL_TYPE_MEDIA
o Media
Top
4.20.2.2. PL_WINDOW_NAVIGATOR_MODE
Enumeration
PL_WINDOW_NAVIGATOR_MODE
none
Remarks none
Emulator
remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 288
Function SetChannel_Seek
Value
0 - PL_WINDOW_NAVIGATOR_MODE_ALL
o All channel
1 - PL_WINDOW_NAVIGATOR_MODE_DIGITAL
o Digital channel
2 - PL_WINDOW_NAVIGATOR_MODE_ANALOG
o Analog channel
3 - PL_WINDOW_NAVIGATOR_MODE_FAVORITE
o Favirite channel
4 - PL_WINDOW_NAVIGATOR_MODE_CURR_TYPE
o Unsed
5 - PL_WINDOW_NAVIGATOR_MODE_EXCEPT_ADDDEL
o Unsed
6 - PL_WINDOW_NAVIGATOR_MODE_ANALOG_ALL
o Unsed
Top
4.20.2.3. PL_WINDOW_POSITION_MODE
Enumeration
PL_WINDOW_POSITION_MODE
none
Remarks none
Emulator
remarks none
Function
CheckScreenRect_PosSizeMode
GetScreenRect_PosMode
SetScreenRect_PosSizeMode
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 289
Value
0 - PL_WINDOW_POSITION_MODE_TOPLEFT
o Set screen position of video layer to Top Left.
1 - PL_WINDOW_POSITION_MODE_TOPRIGHT
o Set screen position of video layer to Top Right.
2 - PL_WINDOW_POSITION_MODE_TOPCENTER
o Set screen position of video layer to Top Center
3 - PL_WINDOW_POSITION_MODE_BOTTOMRIGHT
o Set screen position of video layer to Bottom Right.
4 - PL_WINDOW_POSITION_MODE_BOTTOMLEFT
o Set screen position of video layer to Bottom Left.
5 - PL_WINDOW_POSITION_MODE_MIDDLELEFT
o Set Window positon to Middle Left.
6 - PL_WINDOW_POSITION_MODE_MIDDLECENTER
o Set screen position of video layer to Middle Center.
7 - PL_WINDOW_POSITION_MODE_CUSTOM
o Set screen position of video layer to custom(position by SetScreenRect) position.
8 - PL_WINDOW_POSITION_MODE_DEFAULT
o Set screen position of video layer to defualt(Full screen) position.
Top
4.20.2.4. PL_WINDOW_RECT_SIZE_MODE
Enumeration
PL_WINDOW_RECT_SIZE_MODE
none
Remarks none
Emulator
remarks none
Function CheckScreenRect_PosSizeMode
GetScreenRect_SizeMode
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 290
SetScreenRect_PosSizeMode
Value
0 - PL_WINDOW_RECT_SIZE_PIP_SMALL
o Set PIP size small
1 - PL_WINDOW_RECT_SIZE_PIP_LARGE
o Set PIP size large
2 - PL_WINDOW_RECT_SIZE_PIP_DOUBLE_SMALL
o Set PIP size double small
3 - PL_WINDOW_RECT_SIZE_PIP_DOUBLE_LARGE
o Set PIP size double large
4 - PL_WINDOW_RECT_SIZE_PIG
o Set PIP size PIG
5 - PL_WINDOW_RECT_SIZE_DEFALUT
o Set PIP size default(Full screen)
6 - PL_WINDOW_RECT_SIZE_CUSTOM
o Set PIP size custom(size by SetScreenRect)
7 - PL_WINDOW_RECT_SIZE_WIDEPC
o Set PIP size wide PC
8 - PL_WINDOW_RECT_SIZE_PC_4_3
o Set PIP size PC 4:3
Top
4.20.2.5. PL_WINDOW_RESOLUTION
Enumeration
PL_WINDOW_RESOLUTION
PL_WINDOW_RESOLUTION is enumeration value of the video layer resolution
Remarks If a state of video layer is changed, resolution can be changed ( ex : If RF signal is disconnected,
resolution is changed to NoSignal )
Emulator
remarks
Function GetResolution
Value 0 - PL_WINDOW_RESOLUTION_NOTSUPPORT
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 291
o NOTSUPPORT
1 - PL_WINDOW_RESOLUTION_NOSIGNAL
o NOSIGNAL
2 - PL_WINDOW_RESOLUTION_NT
o NT resolution for NTSC3_58 color system
3 - PL_WINDOW_RESOLUTION_NT_N
o NT_N resolution for NTSC4_43 color system
4 - PL_WINDOW_RESOLUTION_PC
o PC
5 - PL_WINDOW_RESOLUTION_1080I
o 1080I
6 - PL_WINDOW_RESOLUTION_1080P
o 1080P
7 - PL_WINDOW_RESOLUTION_720P
o 720P
8 - PL_WINDOW_RESOLUTION_480P
o 480P
8 - PL_WINDOW_RESOLUTION_480I
o 480I
10 - PL_WINDOW_RESOLUTION_640X480P
o 640 x 480P
11 - PL_WINDOW_RESOLUTION_1440x480I
o 1440X480I
12 - PL_WINDOW_RESOLUTION_576P
o 576P
13 - PL_WINDOW_RESOLUTION_576I
o 576I
14 - PL_WINDOW_RESOLUTION_PAL
o PAL resolution for PAL color system
15 - PL_WINDOW_RESOLUTION_PAL_M
o PAL_M resolution for PAL_M color system
16 - PL_WINDOW_RESOLUTION_PAL_N
o PAL_N resolution for PAL_N color system
17 - PL_WINDOW_RESOLUTION_SECAM
o PAL_N resolution for PAL_N color system
18 - PL_WINDOW_RESOLUTION_YC_SECAM
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 292
o YC_SECAM
18 - PL_WINDOW_RESOLUTION_NOVIDEO
o NOVIDEO
20 - PL_WINDOW_RESOLUTION_UNKNOWN
o Unknown Resolution
21 - PL_WINDOW_RESOLUTION_UNSTABLE
o Unstable Resolution. to control AV Mute without showing banner
22 - PL_WINDOW_RESOLUTION_288I
o 352x288 resolution for MHEG. to control AV Mute without showing banner
Top
4.20.2.6. PL_WINDOW_SEEK
Enumeration
PL_WINDOW_SEEK
none
Remarks none
Emulator
remarks none
Function SetChannel_Seek
Value
0 - PL_WINDOW_SEEK_UNKNOWN
o UNKNOWN
1 - PL_WINDOW_SEEK_FAVORITE
o Favirite infomation
2 - PL_WINDOW_SEEK_CURRENT
o Current information
3 - PL_WINDOW_SEEK_UP
o Next information that can be set
4 - PL_WINDOW_SEEK_DOWN
o Previous information that can be set
5 - PL_WINDOW_SEEK_FIRST
o First information
6 - PL_WINDOW_SEEK_LAST
o Last information
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 293
7 - PL_WINDOW_SEEK_NEXT
o Next information of input information
8 - PL_WINDOW_SEEK_PREV
o Previous information of input information
9 - PL_WINDOW_SEEK_BACK
o Information before changing to current information
10 - PL_WINDOW_SEEK_EXE
o Set input information
11 - PL_WINDOW_SEEK_DIRECT
o Set input information without checking whether it can be chagend
12 - PL_WINDOW_SEEK_TEMPORAL
o After execution, change only current information
Top
4.20.2.7. PL_WINDOW_SHOW_STATE
Enumeration
PL_WINDOW_SHOW_STATE
none
Remarks none
Emulator
remarks none
Function GetState_Show
Value
0 - PL_WINDOW_SHOW_STATE_OFF
o Video layer show state is off
1 - PL_WINDOW_SHOW_STATE_NO_SIGNAL
o Video layer show state is no signal
2 - PL_WINDOW_SHOW_STATE_VCHIP
o Video layer show state is vchip
3 - PL_WINDOW_SHOW_STATE_START
o Video layer show state is start
4 - PL_WINDOW_SHOW_STATE_STOP
o Video layer show state is stop
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 294
Top
4.20.2.8. PL_WINDOW_SHOW_TYPE
Enumeration
PL_WINDOW_SHOW_TYPE
none
Remarks none
Emulator
remarks none
Function Show
Value
0 - PL_WINDOW_SHOW_TYPE_OFF
o Set video off
1 - PL_WINDOW_SHOW_TYPE_ON
o Set video on
2 - PL_WINDOW_SHOW_TYPE_STOP
o Set video stop
3 - PL_WINDOW_SHOW_TYPE_START
o Set video start
4 - PL_WINDOW_SHOW_TYPE_NO_SIGNAL
o Set video nosignal ( If blue screen option is set, set video blue screen )
5 - PL_WINDOW_SHOW_TYPE_VCHIP_ON
o Set video blue screen on (When vchip, child lock on)
6 - PL_WINDOW_SHOW_TYPE_VCHIP_OFF
o Set video blue screen off
4.20.2.9. PL_WINDOW_SOURCE
Enumeration
PL_WINDOW_SOURCE
none
Remarks none
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 295
Emulator
remarks none
Function
GetSource
SetSource
Value
0 - PL_WINDOW_SOURCE_TV
o TV
1 - PL_WINDOW_SOURCE_ATV
o ATV
2 - PL_WINDOW_SOURCE_DTV
o DTV
3 - PL_WINDOW_SOURCE_CATV
o CATV
4 - PL_WINDOW_SOURCE_CDTV
o CDTV
5 - PL_WINDOW_SOURCE_PATV
o PATV
6 - PL_WINDOW_SOURCE_PDTV
o PDTV
7 - PL_WINDOW_SOURCE_SDTV
o SDTV
11 - PL_WINDOW_SOURCE_ATV1
o ATV1
12 - PL_WINDOW_SOURCE_ATV2
o ATV2
13 - PL_WINDOW_SOURCE_DTV1
o DTV1
14 - PL_WINDOW_SOURCE_DTV2
o DTV2
15 - PL_WINDOW_SOURCE_AV1
o AV1
16 - PL_WINDOW_SOURCE_AV2
o AV2
17 - PL_WINDOW_SOURCE_AV3
o AV3
18 - PL_WINDOW_SOURCE_AV4
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 296
o AV4
19 - PL_WINDOW_SOURCE_SVIDEO1
o SVIDEO1
20 - PL_WINDOW_SOURCE_SVIDEO2
o SVIDEO2
21 - PL_WINDOW_SOURCE_SVIDEO3
o SVIDEO3
22 - PL_WINDOW_SOURCE_SVIDEO4
o SVIDEO4
23 - PL_WINDOW_SOURCE_COMP1
o COMP1
24 - PL_WINDOW_SOURCE_COMP2
o COMP2
25 - PL_WINDOW_SOURCE_COMP3
o COMP3
26 - PL_WINDOW_SOURCE_COMP4
o COMP4
27 - PL_WINDOW_SOURCE_PC1
o PC1
28 - PL_WINDOW_SOURCE_PC2
o PC2
29 - PL_WINDOW_SOURCE_PC3
o PC3
30 - PL_WINDOW_SOURCE_PC4
o PC4
31 - PL_WINDOW_SOURCE_HDMI1
o HDMI1
32 - PL_WINDOW_SOURCE_HDMI2
o HDMI2
33 - PL_WINDOW_SOURCE_HDMI3
o HDMI3
34 - PL_WINDOW_SOURCE_HDMI4
o HDMI4
35 - PL_WINDOW_SOURCE_SCART1
o SCART1
36 - PL_WINDOW_SOURCE_SCART2
DeviceAPI Guide for Samsung Smart TV
@Samsung Electronics Copyright All Rights Reserved 297
o SCART2
37 - PL_WINDOW_SOURCE_SCART3
o SCART3
38 - PL_WINDOW_SOURCE_SCART4
o SCART4
39 - PL_WINDOW_SOURCE_DVI1
o DVI1
40 - PL_WINDOW_SOURCE_DVI2
o DVI2
41 - PL_WINDOW_SOURCE_DVI3
o DVI3
42 - PL_WINDOW_SOURCE_DVI4
o DVI4
43 - PL_WINDOW_SOURCE_MEDIA
o MEDIA
44 - PL_WINDOW_SOURCE_HOMING
o DCR HOMING
45 - PL_WINDOW_SOURCE_NONE
o No source
Top
5. Conclusion
This document described the DeviceAPI introduction, method of use, and API list. We hope that this document helps
widget or TV developers understand easy and exact Samsung Smart TV programming, which includes Samsung
developers and 3rd
Party Content Providers. As a result, the Samsung Smart TV team wishes that many high quality
widgets and software come into products, with the highest brand power.