TheDavidBox SDK API
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 1
Table of Contents1 Getting Started.......................................................................................................................................................10
1.1 Request Sample..............................................................................................................................................101.2 Response Sample...........................................................................................................................................10
1.2.1 Success Response...................................................................................................................................101.2.2 Failed Response.....................................................................................................................................10
2 Module...................................................................................................................................................................112.1 setting.............................................................................................................................................................12
2.1.1 list_language :public..............................................................................................................................132.1.2 set_language :public...............................................................................................................................152.1.3 get_language :public..............................................................................................................................162.1.4 list_subtitle_language :public.................................................................................................................172.1.5 set_subtitle_language :public.................................................................................................................192.1.6 get_subtitle_language :public.................................................................................................................202.1.7 list_repeat_mode :public........................................................................................................................212.1.8 set_repeat_mode :public.........................................................................................................................222.1.9 get_repeat_mode :public........................................................................................................................232.1.10 list_slide_show_effect :public..............................................................................................................242.1.11 set_slide_show_effect :public..............................................................................................................252.1.12 get_slide_show_effect :public..............................................................................................................262.1.13 list_photo_interval :public...................................................................................................................272.1.14 set_photo_interval :public....................................................................................................................282.1.15 get_photo_interval :public....................................................................................................................292.1.16 list_screen_saver_time :public.............................................................................................................302.1.17 set_screen_saver_time :public..............................................................................................................312.1.18 get_screen_saver_time :public.............................................................................................................322.1.19 set_setup_page_lock :public................................................................................................................332.1.20 get_setup_page_lock :public................................................................................................................342.1.21 list_video_output :public......................................................................................................................352.1.22 set_video_output :public......................................................................................................................362.1.23 get_video_output :public......................................................................................................................372.1.24 list_ framerate_sync :public.................................................................................................................382.1.25 set_framerate_sync :public...................................................................................................................392.1.26 get_framerate_sync :public..................................................................................................................402.1.27 list_ video_zoom :public......................................................................................................................412.1.28 set_video_zoom :public........................................................................................................................422.1.29 get_video_zoom :public.......................................................................................................................432.1.30 list_tv_type :public...............................................................................................................................442.1.31 set_tv_type :public...............................................................................................................................452.1.32 get_tv_type :public...............................................................................................................................462.1.33 list_color_space :public........................................................................................................................472.1.34 set_color_space :public........................................................................................................................482.1.35 get_color_space :public........................................................................................................................492.1.36 set_hdmi_audio :public........................................................................................................................502.1.37 get_hdmi_audio :public........................................................................................................................51
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 2
2.1.38 list_surround_mode :public..................................................................................................................522.1.39 set_surround_mode :public..................................................................................................................522.1.40 get_surround_mode :public..................................................................................................................522.1.41 list_dts_audio_mode :public................................................................................................................532.1.42 set_dts_audio_mode :public.................................................................................................................542.1.43 get_dts_audio_mode :public................................................................................................................552.1.44 list_ac3_audio_mode :public................................................................................................................562.1.45 set_ac3_audio_mode :public................................................................................................................572.1.46 get_ac3_audio_mode :public................................................................................................................582.1.47 list_aac_audio_mode :public................................................................................................................592.1.48 set_aac_audio_mode :public................................................................................................................602.1.49 get_aac_audio_mode :public................................................................................................................612.1.50 list_wma_pro_audio_mode :public......................................................................................................622.1.51 set_wma_pro_audio_mode :public......................................................................................................632.1.52 get_wma_pro_audio_mode :public......................................................................................................642.1.53 list_pcm_audio_mode :public..............................................................................................................652.1.54 set_pcm_audio_mode...........................................................................................................................662.1.55 get_pcm_audio_mode..........................................................................................................................672.1.56 list_network_mode :public...................................................................................................................682.1.57 set_network_mode :public...................................................................................................................692.1.58 get_network_mode :public...................................................................................................................702.1.59 list_time_zone :public..........................................................................................................................712.1.60 set_time_zone :public...........................................................................................................................732.1.61 get_time_zone :public..........................................................................................................................742.1.62 set_time_server :public........................................................................................................................752.1.63 get_time_server :public........................................................................................................................762.1.64 set_daylight_saving :public..................................................................................................................772.1.65 get_daylight_saving :public.................................................................................................................782.1.66 set_ip_setting :public...........................................................................................................................792.1.67 get_ip_setting :public...........................................................................................................................802.1.68 list_network_shared_folder :public......................................................................................................812.1.69 add_network_shared_folder :public.....................................................................................................822.1.70 delete_network_shared_folder :public.................................................................................................832.1.71 list_dvd_parental_control_level :public...............................................................................................842.1.72 set_dvd_parental_control_level :public...............................................................................................852.1.73 get_dvd_parental_control_level :public...............................................................................................862.1.74 set_dvd_cdda_autoplay :public............................................................................................................872.1.75 get_dvd_cdda_autoplay :public............................................................................................................882.1.76 list_dvd_audio_language :public..........................................................................................................892.1.77 set_dvd_audio_language :public..........................................................................................................912.1.78 get_dvd_audio_language :public..........................................................................................................922.1.79 list_dvd_subtitle_language :public.......................................................................................................932.1.80 set_dvd_subtitle_language :public.......................................................................................................952.1.81 get_dvd_subtitle_language :public.......................................................................................................962.1.82 set_dvd_parental_control_password :public........................................................................................972.1.83 set_proxy_setting :public.....................................................................................................................982.1.84 get_proxy_setting :public.....................................................................................................................992.1.85 list_wireless_ssid :public...................................................................................................................100
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 3
2.1.86 list_wireless_connection :public........................................................................................................1012.1.87 list_wireless_security :public.............................................................................................................1022.1.88 get_wireless_ssid :public....................................................................................................................1032.1.89 get_wireless_connection :public........................................................................................................1042.1.90 get_wireless_security :public.............................................................................................................1052.1.91 set_wireless_ssid :public....................................................................................................................1062.1.92 set_wireless_connection :public.........................................................................................................1072.1.93 set_wireless_security :public..............................................................................................................1082.1.94 set_wireless_setting :public................................................................................................................1092.1.95 list_file_lock :public...........................................................................................................................1102.1.96 set_ file_lock :public..........................................................................................................................1112.1.97 get_file_lock :public...........................................................................................................................1122.1.98 list_setup_option :public....................................................................................................................1132.1.99 list_bd_navigation_option :public......................................................................................................1152.1.100 set_bd_navigation :public.................................................................................................................1162.1.101 get_bd_navigation :public................................................................................................................1172.1.102 list_drc_option :public......................................................................................................................1182.1.103 set_drc :public..................................................................................................................................1192.1.104 get_drc :public..................................................................................................................................1202.1.105 list_connection_speed_option :public..............................................................................................1212.1.106 set_connection_speed :public...........................................................................................................1222.1.107 get_connection_speed :public..........................................................................................................1232.1.108 list_dns_address_setup :public.........................................................................................................1242.1.109 set_dns_address_setup :public.........................................................................................................1252.1.110 get_dns_address_setup :public.........................................................................................................1262.1.111 set_dns_address :public....................................................................................................................1272.1.112 get_dns_address :public...................................................................................................................1282.1.113 get_preferences :public.....................................................................................................................1292.1.114 get_audio :public..............................................................................................................................1342.1.115 get_video :public..............................................................................................................................1362.1.116 get_dvd :public.................................................................................................................................1382.1.117 get_security :public..........................................................................................................................1412.1.118 get_maintenance :public...................................................................................................................1432.1.119 get_nmt_application :public.............................................................................................................1442.1.120 get_configure_ip :public..................................................................................................................1452.1.121 get_wireless_config :public..............................................................................................................1472.1.122 get_advanced_network :public.........................................................................................................1492.1.123 set_scanner_language :public...........................................................................................................1502.1.124 get_scanner_language :public..........................................................................................................1512.1.125 set_menu_mode :public....................................................................................................................1522.1.126 get_menu_mode :public...................................................................................................................1532.1.127 set_recent_activity :public................................................................................................................1542.1.128 get_recent_activity :public...............................................................................................................1552.1.129 set_browse_mode :public.................................................................................................................1562.1.130 get_browse_mode :public................................................................................................................1572.1.131 set_wallpaper_download_option :public..........................................................................................1582.1.132 get_wallpaper_download_option :public.........................................................................................159
2.2 playback.......................................................................................................................................................160
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 4
2.2.1 list_vod_supported_format :public......................................................................................................1612.2.2 next_dvd :public...................................................................................................................................1632.2.3 previous_dvd :public............................................................................................................................1632.2.4 menu_dvd :public.................................................................................................................................1632.2.5 title_dvd :public...................................................................................................................................1632.2.6 start_vod :public...................................................................................................................................1642.2.7 get_current_vod_info :public...............................................................................................................1652.2.8 list_playback_speed_vod :public.........................................................................................................1662.2.9 get_playback_speed_vod :public........................................................................................................1672.2.10 set_playback_speed_vod :public.......................................................................................................1682.2.11 step_vod :public.................................................................................................................................1692.2.12 repeat_vod :public..............................................................................................................................1702.2.13 list_subtitle_vod :public.....................................................................................................................1712.2.14 set_subtitle_vod :public.....................................................................................................................1732.2.15 list_audio_vod :public........................................................................................................................1752.2.16 set_audio_vod :public........................................................................................................................1762.2.17 set_time_seek_vod :public.................................................................................................................1772.2.18 set_zoom_vod :public........................................................................................................................1782.2.19 pause_vod :public...............................................................................................................................1792.2.20 resume_vod :public............................................................................................................................1802.2.21 stop_vod :public.................................................................................................................................1812.2.22 insert_vod_queue :public...................................................................................................................1822.2.23 next_vod_in_queue :public................................................................................................................1832.2.24 delete_vod_entry_queue :public........................................................................................................1842.2.25 list_vod_queue_info :public...............................................................................................................1852.2.26 list_aod_supported_format :public.....................................................................................................1862.2.27 start_aod :public.................................................................................................................................1872.2.28 get_current_aod_info :public.............................................................................................................1882.2.29 pause_aod :public...............................................................................................................................1892.2.30 resume_aod :public............................................................................................................................1902.2.31 repeat_aod :public..............................................................................................................................1912.2.32 stop_aod :public.................................................................................................................................1922.2.33 insert_aod_queue :public....................................................................................................................1932.2.34 next_aod_in_queue :public................................................................................................................1942.2.35 delete_aod_entry_queue :public.........................................................................................................1952.2.36 list_aod_queue_info :public...............................................................................................................1962.2.37 list_pod_supported_format :public....................................................................................................1972.2.38 marquee_aod :public..........................................................................................................................1982.2.39 start_pod :public.................................................................................................................................1992.2.40 get_current_pod_info :public.............................................................................................................2012.2.41 pause_pod :public...............................................................................................................................2022.2.42 resume_pod :public............................................................................................................................2032.2.43 set_zoom_pod :public........................................................................................................................2042.2.44 stop_pod :public.................................................................................................................................2052.2.45 insert_pod_queue :public...................................................................................................................2062.2.46 next_pod_in_queue :public................................................................................................................2072.2.47 delete_pod_entry_queue :public........................................................................................................2082.2.48 list_pod_queue_info :public...............................................................................................................209
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 5
2.2.49 prev_playlist_aod_in_queue :public ...............................................................................................2102.2.50 next_playlist_aod_in_queue :public...................................................................................................2102.2.51 start_database_aod :public.................................................................................................................2112.2.52 insert_database_aod_queue :public....................................................................................................2132.2.53 delete_playlist_aod_queue :public.....................................................................................................2152.2.54 list_playlist_aod_queue_info :public.................................................................................................2162.2.55 get_playlist_current_aod_info :public................................................................................................2172.2.56 prev_aod_in_queue :public................................................................................................................2182.2.57 start_database_vod :public.................................................................................................................2192.2.58 next_database_vod_in_queue :public................................................................................................2212.2.59 prev_database_vod_in_queue :public................................................................................................2222.2.60 stop_database_vod :public.................................................................................................................2232.2.61 start_database_pod :public.................................................................................................................224
2.3 system..........................................................................................................................................................2262.3.1 get_mac_address :public......................................................................................................................2272.3.2 get_firmware_version :public..............................................................................................................2282.3.3 get_nmt_version :public.......................................................................................................................2292.3.4 check_nmt_exist :public.......................................................................................................................2302.3.5 list_nmt_services :public......................................................................................................................2312.3.6 set_nmt_service_status :public.............................................................................................................2322.3.7 get_nmt_services_status :public...........................................................................................................2332.3.8 set_nmt_device_name :public..............................................................................................................2342.3.9 get_nmt_device_name :public..............................................................................................................2352.3.10 set_nmt_samba_workgroup :public...................................................................................................2362.3.11 get_nmt_samba_workgroup :public...................................................................................................2372.3.12 set_nmt_ftp_password :public...........................................................................................................2382.3.13 set_nmt_media_destination :public....................................................................................................2392.3.14 install_nmt :public..............................................................................................................................2402.3.15 list_devices :public.............................................................................................................................2412.3.16 list_drives :public...............................................................................................................................2422.3.17 get_device_info :public......................................................................................................................2432.3.18 list_all_active_apps :public................................................................................................................2442.3.19 get_current_app :public......................................................................................................................2452.3.20 get_mute_status :public......................................................................................................................2462.3.21 set_mute_status :public......................................................................................................................2472.3.22 get_system_volume :public................................................................................................................2482.3.23 set_system_volume :public................................................................................................................2492.3.24 list_key :public...................................................................................................................................2502.3.25 send_key :public.................................................................................................................................2522.3.26 load_page :public...............................................................................................................................2532.3.27 get_connection_status :public............................................................................................................2542.3.28 get_linkup_status :public...................................................................................................................2552.3.29 suspend_screensaver :public..............................................................................................................2562.3.30 get_board_id :public...........................................................................................................................2572.3.31 get_time :public..................................................................................................................................2582.3.32 load_appcenter :public.......................................................................................................................2592.3.33 load_launcher :public.........................................................................................................................2602.3.34 load_phf :public.................................................................................................................................261
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 6
2.3.35 load_widget :public............................................................................................................................2622.3.36 list_webservices_option :public.........................................................................................................2632.3.37 update_firmware :public....................................................................................................................2652.3.38 set_system_led :public.......................................................................................................................2662.3.39 capture_screen :public........................................................................................................................267
2.4 file_operation...............................................................................................................................................2682.4.1 list_user_storage_file :public...............................................................................................................2692.4.2 search_user_storage_file :public..........................................................................................................2722.4.3 create_user_storage_file :public...........................................................................................................2752.4.4 write_user_storage_file :public............................................................................................................2762.4.5 read_user_storage_file :public.............................................................................................................2772.4.6 get_user_storage_file_info :public.......................................................................................................2782.4.7 copy_user_storage_file :public............................................................................................................2792.4.8 move_user_storage_file :public...........................................................................................................2802.4.9 delete_user_storage_file :public...........................................................................................................2812.4.10 create_user_storage_directory :public................................................................................................2822.4.11 rename_user_storage_file :public.......................................................................................................2832.4.12 select_user_storage_file_to_list :public.............................................................................................2842.4.13 delete_user_storage_file_from_list :public........................................................................................2852.4.14 copy_user_storage_file_from_list :public..........................................................................................2862.4.15 move_user_storage_file_from_list :public.........................................................................................2872.4.16 create_app_storage :public.................................................................................................................2882.4.17 change_app_storage_password :public..............................................................................................2892.4.18 create_app_storage_file :public..........................................................................................................2902.4.19 write_app_storage_file :public...........................................................................................................2912.4.20 read_app_storage_file :public............................................................................................................2932.4.21 get_app_storage_file_info :public......................................................................................................2952.4.22 copy_app_storage_file :public...........................................................................................................2962.4.23 delete_app_storage :public.................................................................................................................2972.4.24 delete_app_storage_file :public..........................................................................................................2982.4.25 ripping :public....................................................................................................................................299
2.5 download_manager......................................................................................................................................3012.5.1 get_download_agent_status :public.....................................................................................................3022.5.2 start_download_agent :public..............................................................................................................3032.5.3 stop_download_agent :public...............................................................................................................3042.5.4 set_download_agent_settings :public...................................................................................................3052.5.5 get_download_agent_settings :public..................................................................................................3072.5.6 create_download_task :public..............................................................................................................3082.5.7 list_download_tasks :public.................................................................................................................3102.5.8 get_download_task_info :public..........................................................................................................3112.5.9 list_download_task_info :public..........................................................................................................3132.5.10 start_download_task :public...............................................................................................................3152.5.11 stop_download_task :public...............................................................................................................3162.5.12 stop_all_download_task:public..........................................................................................................3172.5.13 delete_download_task :public............................................................................................................3182.5.14 delete_all_download_task :public......................................................................................................3192.5.15 start_all_download_task :public.........................................................................................................3202.5.16 delete_download_task_and_data :public............................................................................................321
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 7
2.5.17 delete_all_download_task_and_data :public......................................................................................3222.5.18 list_setting_torrent_schedule :public..................................................................................................3232.5.19 list_setting_downloaded_schedule :public.........................................................................................3262.5.20 list_bandwidth_schedule :public........................................................................................................3282.5.21 list_torrent_schedule :public..............................................................................................................3312.5.22 list_downloaded_schedule :public.....................................................................................................3332.5.23 add_bandwidth_schedule :public.......................................................................................................3352.5.24 add_torrent_schedule :public.............................................................................................................3372.5.25 add_downloaded_schedule :public....................................................................................................3392.5.26 delete_schedule :public......................................................................................................................3412.5.27 reset_bandwidth_schedule :public.....................................................................................................3432.5.28 reset_torrent_schedule :public............................................................................................................3442.5.29 reset_downloaded_schedule :public...................................................................................................345
2.6 deployment...................................................................................................................................................3462.6.1 get_database :public.............................................................................................................................3472.6.2 set_database :public..............................................................................................................................348
2.7 metadata.......................................................................................................................................................3492.7.1 list_all_metadata :public......................................................................................................................3502.7.2 get_metadata :public............................................................................................................................3512.7.3 set_metadata :public.............................................................................................................................3522.7.4 get_reference_file :public.....................................................................................................................3532.7.5 delete_metadata :public........................................................................................................................3542.7.6 delete_all_metadata :public..................................................................................................................355
2.8 upnp..............................................................................................................................................................3562.8.1 list_upnp_server :public.......................................................................................................................3572.8.2 list_upnp_server_files :public..............................................................................................................358
2.9 network_browse...........................................................................................................................................3602.9.1 list_network_resource :public..............................................................................................................3612.9.2 list_network_content :public................................................................................................................363
2.10 metadata database......................................................................................................................................3652.10.1 list_total_album_photo :public...........................................................................................................3652.10.2 list_compact_photo_wall :public.......................................................................................................3672.10.3 list_total_photo_item :public.............................................................................................................3692.10.4 list_photo_item :public.......................................................................................................................3702.10.5 get_photo_info :public.......................................................................................................................3722.10.6 jump_photo_index :public.................................................................................................................3742.10.7 delete_photo :public...........................................................................................................................3762.10.8 list_total_category_video :public.......................................................................................................3772.10.9 list_compact_video_wall :public........................................................................................................3782.10.10 list_total_video_item :public............................................................................................................3802.10.11 list_video_item :public.....................................................................................................................3812.10.12 get_video_info :public.....................................................................................................................3832.10.13 jump_video_index :public................................................................................................................3872.10.14 delete_video :public.........................................................................................................................3892.10.15 update_video_rating :public.............................................................................................................3902.10.16 search_video :public.........................................................................................................................3912.10.17 replace_video_info :public...............................................................................................................3932.10.18 set_video_watched :public...............................................................................................................394
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 8
2.10.19 search_person :public.......................................................................................................................3952.10.20 replace_video_image :public............................................................................................................3972.10.21 download_video_image :public.......................................................................................................3982.10.22 list_total_category_music :public....................................................................................................3992.10.23 list_compact_music_wall :public.....................................................................................................4002.10.24 list_total_music_item :public...........................................................................................................4022.10.25 list_music_item :public....................................................................................................................4032.10.26 list_all_music_playlist :public..........................................................................................................4062.10.27 get_particular_music_album_info :public........................................................................................4072.10.28 get_particular_music_song_info :public..........................................................................................4092.10.29 get_particular_music_playlist_info :public......................................................................................4112.10.30 edit_music_playlist :public..............................................................................................................4132.10.31 create_music_playlist :public...........................................................................................................4142.10.32 add_item_to_music_playlist :public................................................................................................4152.10.33 delete_music :public.........................................................................................................................4162.10.34 jump_music_index :public...............................................................................................................4182.10.35 update_music_rating :public............................................................................................................4202.10.36 search_music :public........................................................................................................................4212.10.37 search_artist :public..........................................................................................................................4232.11.38 list_all_total_item :public.................................................................................................................4252.11.39 list_all_item :public..........................................................................................................................4262.11.40 get_all_index :public........................................................................................................................4282.11.41 get_recent_activities :public.............................................................................................................4302.11.42 scanner_start :public.........................................................................................................................4322.11.43 scanner_pause :public.......................................................................................................................4332.11.44 scanner_stop :public.........................................................................................................................4342.11.45 add_scandir :public...........................................................................................................................4352.11.46 list_scandir :public...........................................................................................................................4362.11.47 remove_scandir :public....................................................................................................................4372.11.48 update_scandir :public......................................................................................................................4382.11.49 check_database :public.....................................................................................................................4392.11.50 update_database :public...................................................................................................................4402.11.51 check_scanner_status :public...........................................................................................................4412.11.52 check_download_target_status :public.............................................................................................4422.11.52 download_subtitle :public................................................................................................................4432.11.52 rename_subtitle :public....................................................................................................................444
3 Error Code Reference Table :public....................................................................................................................445
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 9
1 Getting StartedThis API document is intent for TheDavidBox platform development and provide the access to the services available in this platform.
1.1 Request Samplehttp://:/?arg0=&arg1=&......&argn=
Field Value Description 127.0.0.1 Fixed for local server IP address 8008 Fixed for local service port number setting Command module(s) module dependent Arguments
Note: Maximun HTTP GET query length: 4095 bytes
1.2 Response SampleAll the responses are formatted in UTF-8 XML as below
1.2.1 Success Response
.........setting
...
0
1.2.2 Failed Response
1
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 10
2 Module
Module Name Description Versionsetting Interface with device settings 0.1playback Interface with media playback module 0.2system Interface with restrited system calls 0.2file_operation File system access 0.2download_manager Interface to BT, HTTP download manager 0.2deployment Interface with application installation module 0.2metadata Interface with metadata module 0.2upnp Interface with upnp client 0.2network_browse Interface with network media source such as Samba and
NFS0.2
metadata_database Interface with metadata database. 0.3
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 11
2.1 settingThis module is use to configure the device setting such as network setting, TV mode, audio setting and etc.
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 12
2.1.1 list_language :publicList all the supported system languages.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_language
Success Response Example
list_languagesetting
englishsimplified chinesetraditional chinese germangreekdutchrussianfrenchitalianczechswedishspanishpolishportugesebulgariannorwegianhungarianslovenianjapaneseturkishvietnamthaidanishhebrew
0
Failed Response ExampleReferred to section 3
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 13
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 14
2.1.2 set_language :publicSet the system language
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_language function String
Request Examplehttp://:/setting?arg0=set_language&arg1=english
Success Response Example
set_languageenglishsetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 15
2.1.3 get_language :publicRetrieve current system language
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_language
Success Response Example
get_languagesetting
english
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 16
2.1.4 list_subtitle_language :publicList all the supported subtitle languages.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_subtitle_language
Success Response Example
list_subtitle_languagesetting
offenglishsimplified chinesetraditional chinesegermangreekdutchrussianfrenchitalianczechswedishspanishpolishportugesebulgariannorwegianhungarianslovenianjapaneseturkishvietnamthaidanishhebrew
0
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 17
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 18
2.1.5 set_subtitle_language :publicEnable/disable or set current subtitle language.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_subtitle_language function String
Request Examplehttp://:/setting?arg0=set_subtitle_language&arg1=english
Success Response Example
set_subtitle_languageenglishsetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 19
2.1.6 get_subtitle_language :publicRetrieve current subtitle language
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_subtitle_language
Success Response Example
get_subtitle_languagesetting
english
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 20
2.1.7 list_repeat_mode :publicList all the supported play modes
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_repeat_mode
Success Response Example
list_repeat_modesetting
repeat offrepeat onerepeat all
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 21
2.1.8 set_repeat_mode :publicSet current repeat mode.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_repeat_mode function String
Request Examplehttp://:/setting?arg0=set_repeat_mode&arg1=repeat%20one
Success Response Example
set_repeat_moderepeat onesetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 22
2.1.9 get_repeat_mode :publicRetrieve current repeat mode.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0= get_repeat_mode
Success Response Example
get_repeat_modesetting
repeat one
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 23
2.1.10 list_slide_show_effect :publicList all the supported slide show transition effects
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_slide_show_effect
Success Response Example
list_slide_show_effectsetting
offfadezoomslidespiralrandom
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 24
2.1.11 set_slide_show_effect :publicEnable/disable or set current slide show transition effect.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_slide_show_effect function String
Request Examplehttp://:/setting?arg0=set_slide_show_effect&arg1=fade
Success Response Example
set_slide_show_effectfadesetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 25
2.1.12 get_slide_show_effect :publicRetrieve current slide show effect.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0= get_slide_show_effect
Success Response Example
get_slide_show_effectsetting
fade
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 26
2.1.13 list_photo_interval :publicList all the supported photo interval time in second(s).
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_photo_interval
Success Response Example
list_photo_intervalsetting
12346810152030405060120300600
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 27
2.1.14 set_photo_interval :publicSet current photo interval time.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_photo_interval function Number
Request Examplehttp://:/setting?arg0=set_photo_interval&arg1=1
Success Response Example
set_photo_interval1setting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 28
2.1.15 get_photo_interval :publicRetrieve current photo interval time in second(s).
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_photo_interval
Success Response Example
get_photo_intervalsetting
1
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 29
2.1.16 list_screen_saver_time :publicList all the supported screen saver time in second(s).
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_screen_saver_time
Success Response Example
list_screen_saver_timesetting
off1510153060
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 30
2.1.17 set_screen_saver_time :publicEnable/disable or set current screen saver time in second(s).
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_screen_saver_time function String
Request Examplehttp://:/setting?arg0=set_screen_saver_time&arg1=1
Success Response Example
set_screen_saver_time1setting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 31
2.1.18 get_screen_saver_time :public
Retrieve current screen saver time in second(s).
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_screen_saver_time
Success Response Example
get_screen_saver_timesetting
1
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 32
2.1.19 set_setup_page_lock :publicEnable/disable setup page lock.
Parameter Description Data Typearg0 Function name Stringarg1 Enable/disable setup page lock Boolean
Request Examplehttp://:/setting?arg0=set_setup_page_lock&arg1=true
Success Response Example
set_setup_page_locktruesetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 33
2.1.20 get_setup_page_lock :publicRetrieve current setup page lock status.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_setup_page_lock
Success Response Example
get_setup_page_locksetting
true
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 34
2.1.21 list_video_output :publicList all the supported video outputs.
Parameter Description Data typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_video_output
Success Response Example
list_video_outputsetting
autontscpal480p576p720p 60hz720p 50hz1080i 60hz1080i 50hz1080p 60hz1080p 50hz1080p 24hz
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 35
2.1.22 set_video_output :publicSet current video output.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_video_output function String
Request Examplehttp://:/setting?arg0=set_video_output&arg1=auto
Success Response Example
set_video_outputautosetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 36
2.1.23 get_video_output :publicRetrieve current video output.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_video_output
Success Response Example
get_video_outputsetting
auto
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 37
2.1.24 list_ framerate_sync :publicList all the supported frame rate synchronizes.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_framerate_sync
Success Response Example
list_framerate_syncsetting
offedid autontsc/palntsc/24pntsc/pal/24p
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 38
2.1.25 set_framerate_sync :publicEnable/disable or set current frame rate synchronize.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_framerate_sync function Boolean
Request Examplehttp://:/setting?arg0=set_framerate_sync&arg1=edid%20auto
Success Response Example
set_framerate_syncedid autosetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 39
2.1.26 get_framerate_sync :publicRetrieve current frame rate synchronize.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_framerate_sync
Success Response Example
get_framerate_syncsetting
edid auto
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 40
2.1.27 list_ video_zoom :publicList all the supported video zoom modes.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_ video_zoom
Success Response Example
list_video_zoomsetting
actual sizefit to screencropfull screen
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 41
2.1.28 set_video_zoom :publicSet current video zoom mode.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_video_zoom function String
Request Examplehttp://:/setting?arg0=set_video_zoom&arg1=actual%20size
Success Response Example
set_video_zoomactual sizesetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 42
2.1.29 get_video_zoom :publicRetrieve current video zoom mode.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_video_zoom
Success Response Example
get_video_zoomsetting
actual size
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 43
2.1.30 list_tv_type :publicList all the supported TV types.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_tv_type
Success Response Example
list_tv_typesetting
4:316:916:10
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 44
2.1.31 set_tv_type :publicSet current TV type.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_tv_type function String
Request Examplehttp://:/setting?arg0=set_tv_type&arg1=4:3
Success Response Example
set_tv_type4:3setting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 45
2.1.32 get_tv_type :publicRetrieve current TV type.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_tv_type
Success Response Example
get_tv_typesetting
4:3
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 46
2.1.33 list_color_space :publicList all the supported color spaces.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_color_space
Success Response Example
list_color_spacesetting
16-2350-235
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 47
2.1.34 set_color_space :publicSet current color space.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_color_space function String
Request Examplehttp://:/setting?arg0=set_color_space&arg1=16-235
Success Response Example
set_color_space16-235setting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 48
2.1.35 get_color_space :publicRetrieve current color space.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_color_space
Success Response Example
get_color_spacesetting
16-235
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 49
2.1.36 set_hdmi_audio :publicSet current HDMI audio setting.
Parameter Description Data Typearg0 Function name Stringarg1 Enable/disable HDMI audio Boolean
Request Examplehttp://:/setting?arg0=set_hdmi_audio&arg1=true
Success Response Example
set_hdmi_audiotruesetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 50
2.1.37 get_hdmi_audio :publicRetrieve current HDMI audio setting.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_hdmi_audio
Success Response Example
get_hdmi_audiosetting
true
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 51
2.1.38 list_surround_mode :publicThis command is no longer supported. (obsolete)
2.1.39 set_surround_mode :publicThis command is no longer supported. (obsolete)
2.1.40 get_surround_mode :publicThis command is no longer supported. (obsolete)
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 52
2.1.41 list_dts_audio_mode :publicList all the supported DTS audio modes.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_dts_audio_mode
Success Response Example
list_dts_audio_modesetting
DownmixPassthrough
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 53
2.1.42 set_dts_audio_mode :publicSet current DTS audio mode.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_dts_audio_mode function String
Request Examplehttp://:/setting?arg0=set_dts_audio_mode&arg1=downmix
Success Response Example
set_dts_audio_modeDownmixsetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 54
2.1.43 get_dts_audio_mode :publicRetrieve current DTS audio mode.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_dts_audio_mode
Success Response Example
get_dts_audio_modesetting
Downmix
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 55
2.1.44 list_ac3_audio_mode :publicList all the supported AC3 audio modes.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_ac3_audio_mode
Success Response Example
list_ac3_audio_modesetting
DownmixPassthrough
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 56
2.1.45 set_ac3_audio_mode :publicSet current AC3 audio mode.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_ac3_audio_mode function String
Request Examplehttp://:/setting?arg0=set_ac3_audio_mode&arg1=downmix
Success Response Example
set_ac3_audio_modeDownmixsetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 57
2.1.46 get_ac3_audio_mode :publicRetrieve current AC3 audio mode.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_ac3_audio_mode
Success Response Example
get_ac3_audio_modesetting
Downmix
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 58
2.1.47 list_aac_audio_mode :publicList all the supported AAC audio modes.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_aac_audio_mode
Success Response Example
list_aac_audio_modesetting
DownmixPassthrough
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 59
2.1.48 set_aac_audio_mode :publicSet current AAC audio mode.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_aac_audio_mode function String
Request Examplehttp://:/setting?arg0=set_aac_audio_mode&arg1=downmix
Success Response Example
set_aac_audio_modeDownmixsetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 60
2.1.49 get_aac_audio_mode :publicRetrieve current AAC audio mode.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_aac_audio_mode
Success Response Example
get_aac_audio_modesetting
Downmix
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 61
2.1.50 list_wma_pro_audio_mode :publicList all the supported WMA Pro audio modes.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_wma_pro_audio_mode
Success Response Example
list_wma_pro_audio_modesetting
DownmixPassthrough
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 62
2.1.51 set_wma_pro_audio_mode :publicSet current WMA Pro audio mode.
Parameter Description Data Typearg0 Function name Stringarg1 Any options returns from list_wma_pro_audio_mode function String
Request Examplehttp://:/setting?arg0=set_wma_pro_audio_mode&arg1=downmix
Success Response Example
set_wma_pro_audio_modeDownmixsetting
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 63
2.1.52 get_wma_pro_audio_mode :publicRetrieve current WMA Pro audio mode.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=get_wma_pro_audio_mode
Success Response Example
settingget_wma_pro_audio_mode
Downmix
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidBox SDK API Confidential Draft ©2009 by Syabas Technology Inc. 64
2.1.53 list_pcm_audio_mode :publicList all the supported PCM audio modes.
Parameter Description Data Typearg0 Function name String
Request Examplehttp://:/setting?arg0=list_pcm_audio_mode
Success Response Example
list_pcm_audio_modesetting
DownmixPassthrough
0
Failed Response ExampleReferred to section 3
Error CodesThe following errors may be returned: •0: Success•1: Fail
TheDavidB
Top Related