TVIP Provisioning scheme
TVIP Provisioning scheme
- Overview of what provisioning is
- Overview of the base structure
- Provisioning options
- File example
What is Provisioning?
Provisioning gives you the possibility to configure advanced settings to improve the end-user experience and to preconfigure the STB for your clients as needed. Whether you want to personalize your branding on your STB, include a multi-portal, preconfigure security settings, or hide parts of the UI. In the following text you will find the building blocks you need to make this possible and learn how to create a provisioning file. How to use a provisioning file can be found here.
<?xml version="1.0"?> <provision reload="86400"> <!-- Modules --> </provision>
<time tz="Asia/Singapore" ntp="pool.ntp.org" time_format="12" />
<tv_protocols devices="s605,s530" override="true" default="jsonapi" autostart="true" > <protocol type="jsonapi" server="http://example.com" /> </tv_protocols> <tv_protocols devices="" override="true" default="jsonapi" autostart="true" > <protocol type="jsonapi" server="https://example2.com" /> </tv_protocols>
Remote Control & Monitoring
<tr69_server url="http://myacs.net/TR-069" user="test" password="test" />
<syslog_host name="1.1.1.1"/>
<statistics url="http://domain/stbstat/index.php" accum_period="45"> <media /> <network period="20" /> </statistics>
<provision_server name="http://tvipstb.net" />
<provision_server name="" />
<restart value="reboot" />
Updated Management
<update_server name="update.tvip.tv" />
<update_types> <device id="s400a"> <type name="Android/Beta" os="android" type="beta" /> <type name="Linux-Qt/Release" os="linux-qt" /> </device> <device id="s410" force_type="release" force_os="linux-qt"> </device> </update_types>
<updates> <update_background force="true" value="true" /> <update_force force="true" value="true" /> <update_period force="true" value="60" /> </updates>
<appstore_server url="https://operator.com/appstore/appstore.json" />
Content source Configuration (IPTV/OTT) & Apps
<webapps> <app name="lk" title="User Account" icon="account" uiwidth="1280" uiheight="720" url="http://private.provider.com" api="mag" /> <app name="plex" /> <app name="youtube" hidden="true" /> </webapps>
<webapps override="true"> </webapps>
<android_apps> <app name="MediaCenter" title="MyMediaCenter" package="com.droidlogic.mediacenter" hidden="false" bgr="http://tvip.com/myMediaCenter.png" /> <app name="VideoPlayer" title="MyVidoPlayer" package="com.droidlogic.videoplayer" hidden="true" icon="http://tvip.com/icon.png" /> </android_apps>
<tv_stream type="multicast" tsbuffer="100" tsboost="false" hls_version="4" />
<tv_stream type="udpxy" server="http://user:pwd@host.tv:4022" />
<tv_protocols default="jsonapi" force="jsonapi"> </tv_protocols>
<tv_protocols default="jsonapi"> <protocol type="jsonapi" server="http://api.domain.com" hidden="true" /> </tv_protocols>
<tv_protocols default="m3u"> <protocols type="m3u" m3u="http://operator.com/channels.m3u" epg="http://operator.com/epg.zip" /> </tv_protocols>
<tv_protocols default="browser"> <protocol type="browser" server="http://provider.net/stalker_portal" /> </tv_protocols>
<protocol type="androidapp" package="xxxxx" autostart="false" />
<media> <default_audio_language force="true" value="bul bg eng en" /> <default_subtitle_language force="true" value="en eng" /> </media>
<mountpoints> <mountpoint type="smb" mountname="SMB Share"> <address value="192.168.1.1" /> <folder value="Movies" /> <password value="pass" /> <username value="login" /> </mountpoint> <mountpoint type="nfs" mountname="NFS Share"> <address value="nfs.operator.com" /> <folder value="/home/sharing/Movies" /> </mountpoint> </mountpoints>
<cctv_sources> <source name="Cameras" url="http://cam.operator.com/cameras.m3u" /> <source name="Our Office" url="rtsp://cam.operator.com/office" /> </cctv_sources>
<system_locks> <ctv enabled="true" url="http://your_stream.com" volume="30" /> </system_locks>
UI-Adjustments, Security & User rights
<operator name="Operator_Name" />
- tv_app_name – Defines the name of the Watch TV app.
- tv_app_icon – Defines the icon of the Watch TV app.
<logo url="http://tvipstb.net/prov/logo.png" />
- Left and right: up to 145 px.
- Top: up to 45 px.
<banner url="http://tvipstb.net/prov/banner.png" uri="tvplayer/?channel=1"/>
- url – Defines the image URL;
- uri – Defines the system URI that will be executed when a user clicks on the banner (from firmware 4.1.9).
<bootlogo url="http://tvipstb.net/prov/tvip_splash.bmp" />
<main_menu_background url="https://www.my_background.png" refresh="3600" />
- url – The server address from which the background image will be loaded.
- refresh – Update interval in seconds.
- mediaplayer – Mediaplayer
- dvr – DVR
- cctv – CCTV
- vod – Movies
- tv – TV
- navigator – Web Browser
- settings – Settings
- apps – (All Android) Apps
- search – The search function
<features> <mediaplayer enabled="true" /> <dvr enabled="true" /> <cctv enabled="true" /> <vod enabled="false" /> <timeshift enabled="false" /> <appstore enabled="false" /> </features>
- timeshift – When set to “true”, it enables local timeshift; when set to “false”, it is disabled.
- appstore – Available only for the 7xx models and defines the App Store.
<security> <enabled value="true" force="true" /> <password value="0000" force="true" /> <autolock_timeout value="600" force="true" /> <channel_default_locked value="true" /> <channel_adult_lock value="true" /> <operator_forced_age value="18" /> <disabled_apps force="true" value="vidimax,youtube" /> </security>
- enabled – Activates security mode, which forces the user to use an unlock code (password). To force security mode even if the user tries to disable it, use the force attribute.
- autolock_timeout – Sets the time period (in seconds) after which the user must enter the unlock code again.
- channel_default_locked – Blocked-channel mode: When true, only channels in the blacklist are blocked. To block all channels that are not on the whitelist, use false.
- operator_force_age – Blocks channels with an age tag equal to or greater than the value (firmware 4.0.11+).
- channel_adult_lock – Blocks adult channels (adult channels should be set by the middleware; from firmware 3.8).
- disabled_apps – Blocks apps. To block multiple apps, use a comma between the app names.
<display> <hd_format value="720p50" /> <hdmi_autofr value="false" /> <sd_format value="auto" /> <aspect value="box" /> <cec value="false" force="true" /> <sync_standby value="true" /> <cec_name value="anyName" /> </display>
- hd_format – HDMI output resolution (auto, 2160p50, 1080p50, 1080p60, 1080i50, 720p60, 720p60, 576i50).
- sd_format – A/V output (auto, pal, ntsc).
- hdmi_autofr – HDMI output.
- cec – Enables HDMI-CEC.
- aspect – Default aspect ratio (box, zoom, full). To use the default, set an empty value =””
- sync_standby – The STB goes to sleep/wake when the TV goes to sleep/wake (not supported by all Media Centers and TVs; from fw. 4.0.13).
- cec_name – Allows you to choose a device name via HDMI on compatible TVs. Character format (Aa – Zz, -, _, 0-9) (supported from fw. 5.1.26).
- To force certain settings to apply, use the force attribute with the value =”true”.
<auto_standby timeout="3600" force="true" />
- timeout – Defines the time in seconds until the STB goes into standby mode (possible values: 60 to 2500000 seconds, or 0 to disable it).
- force – When true, overrides the user’s settings.
<appearance> <uialpha value="50" /> <animation value="true" force="true" /> <listlooped value="true" /> <uipadding value="large" /> <tv_preview_mode value="true" force="true" /> <display_channel_numbers value="true" /> <channel_icons_aspect value="1.777"/> <display_channel_has_archive value="true" /> <background_picture value="Custom" force="true"> <picture name="Custom" url="http://domain/Custom.png"/> </background_picture> <media_freeze_animation value="false" /> <back_as_recall value="true" /> <menu_as_home value="true" /> <menu_as_audio_track value="true" /> </appearance>
- uialpha – UI transparency (0-100 %) not available after firmware version 4.0.
- animation – Enables (true) or disables (false) UI animations.
- listlooped – Enables or disables looping of the channel list.
- uipadding – Overscan setup (“small”, “medium”, “large”).
- tv_preview_mode – Enables or disables preview mode in the channel list.
- false – No preview mode.
- true – Preview mode for the currently active stream.
- hybrid – Preview window displays the channel currently selected by the cursor.
- tv_cursor_mode – Allows simple TV control mode. In this mode, the cursor keys control the volume and channel switching.
- display_channel_numbers – Enables (true) or disables (false) the display of channel numbers (supported from fw. 4.0.17).
- channel_icons_aspect – Channel icon aspect ratio (aspect = width/height). Can be used to optimize the UI for the channel layout (supported from fw. 4.0.20).
- home_uri – Defines the system URI that will be executed when pressing the Home key instead of launching the home screen (supported from fw. 4.2.12).
- display_channel_has_archive – When true, shows an archive-active icon in the channel list (supported from fw. 4.2.16).
- background_picture – Defines a monochrome image in the main menu (and some other apps). value sets an identifier for this image. The identifier can be internal (e.g. waves, triangles) or can be a <picture> tag. Attributes of the <picture> tag: name – Background identifier; url – URL of an 8-bit monochrome PNG image (supported from fw. 4.2.16).
- media_freeze_animation – Controls “freeze” animations: true disables animations and false enables animations (supported from fw. 4.2.33).
- back_as_recall – Allows you to assign the Back button to return to the previous channel (supported from fw. 5.0.67).
- menu_as_home – Allows you to use the menu button to trigger the home action, except when used for its intended purpose. This functionality works only in the TV application (supported from fw. 5.1.45).
- menu_as_home – Allows you to use the menu button to switch audio tracks.
- To force certain features, use the force attribute with the value =”true”.
<appearance> <color_schemes value="true" override="true" default="Berries" force="Berries"> <scheme name="TVIP brand color"> <color name="CL_MAIN" value="#ff2A50A3" /> <color name="CL_BACKGROUND" value="#ff14A2DC"/> <color name="CL_CONTRAST_MAIN" value="#ffCAE2F5"/> <color name="CL_CONTRAST_BACKGROUND" value="#ffCAE2F5"/> <color name="CL_SECOND" value="#ffF37121"/> <color name="CL_button_casual" >CL_BACKGROUND</color> </scheme> <scheme name="Berries"> </scheme> </color_schemes> </appearance>
| Color | Dependency | Transparency | Description |
|---|---|---|---|
| CL_on_main_casual | CL_CONTRAST_MAIN | 1,00 | General color for elements on top of the main color. |
| CL_text_on_main_casual | CL_on_main_casual | 1,00 | Base text color displayed on top of the main color. |
| CL_text_on_main_active | CL_on_main_casual | 1,00 | Active/selected text color displayed on the main color. |
| CL_text_on_main_dimmed | CL_on_main_casual | 0,55 | Dimmed text color displayed on top of the main color. |
| CL_on_background_casual | CL_CONTRAST_BACKGROUND | 1,00 | General color for elements in the center or inside a table. |
| CL_text_on_background_casual | CL_on_background_casual | 1,00 | Base text color inside a table. |
| CL_text_on_background_active | CL_on_background_casual | 1,00 | Active/selected text color inside a table. |
| CL_text_on_background_dimmed | CL_on_background_casual | 0,55 | Dimmed text color for inactive elements in tables and some secondary text. |
| CL_wallpaper | CL_BACKGROUND | 0,90 | Background color for most UI widgets. |
| CL_fade | CL_BACKGROUND | 0,90 | Video overlay color for fullscreen elements. |
| CL_additional | CL_BACKGROUND | 0,40 | Additional color for active widgets and active table columns. |
| CL_bgr_color | CL_MAIN | 1,00 | Color of the background image in the home screen (when no video) and for some other elements. |
| CL_bumper | CL_MAIN | 0,94 | Color of the top and bottom panels. |
| CL_header | CL_bumper | – | Background color of elements at the top of the screen. |
| CL_footer | CL_bumper | – | Background color of elements at the bottom of the screen. |
| CL_popup | CL_MAIN | 1,00 | Color of dialog windows, extended settings, and system messages. |
| CL_popup_contrast | CL_CONTRAST_MAIN | 1,00 | Content color inside dialog windows. |
| CL_plate | CL_MAIN | 1,00 | “Plates” (home screen, VoD elements, etc.) color. |
| CL_plate_contrast | CL_CONTRAST_MAIN | 1,00 | Content (text, buttons) color inside “plates”. |
| CL_selector | CL_SECOND | – | Selector color for active/selected control elements: cursor, active buttons, etc. |
| CL_empty | CL_SECOND | 1,00 | Color of the inactive part of the progress bar. |
| CL_inactive | CL_SECOND | 0,35 | Color for disabled UI elements (buttons). |
| CL_full | CL_CONTRAST_MAIN | 1,00 | Color of the active part of a progress bar. |
| CL_button_selected | CL_selector | 1,00 | Color of a selected button. |
| CL_button_casual | CL_selector | 0,35 | Color of a disabled button. |
| CL_on_button | CL_on_background_casual | – | Text and icon color for a button. |
- pref_system – System
- pref_appearance – Appearance
- pref_network – Network
- pref_display – Display
- pref_tv – TV
- pref_security – Security
- pref_os – Restrict access to Android OS settings (for Android OS devices).
<preferences> <pref_network visible="false" /> </preferences>
- pref_system_language – System language
- pref_system_updatetype – Update type
- pref_system_updateperiod – Update period
- pref_system_updatebackground – Background installation
- pref_system_timezone – Timezone
- pref_system_timeserver – NTP server address
- pref_system_timeformat – Time format
- pref_system_auto_standby – Auto standby
- pref_system_audiolanguage – Default audio language
- pref_system_subtitlelanguage – Default subtitle language
- pref_system_digitalsoundmode – Digital sound
- pref_system_dial – Multiscreen
- pref_system_button_bluetooth_remote – Bluetooth setup
- pref_system_button_checkupdates – Check updates
- pref_system_button_info – Info button
- pref_appearance_alpha – UI transparency
- pref_appearance_anim – Animated UI
- pref_appearance_channel_numbers – Channel numbers
- pref_appearance_channel_icons – Display channel icons
- pref_appearance_listlooped – Looped channel list
- pref_appearance_padding – Overscan
- pref_appearance_tv_preview_mode – TV preview mode
- pref_appearance_tv_cursor_mode – TV cursor mode
- pref_appearance_color_preset – UI color preset
- pref_appearance_background – UI background
- pref_network_iface – Interface type (Eth/Wlan)
- pref_network_iface_enabled – Network interface enabled
- pref_network_wlan_ssid – Wi-Fi access point
- pref_network_config – Config (DHCP/Manual)
- pref_network_ip – IP address
- pref_network_mask – Mask
- pref_network_gateway – Gateway
- pref_network_dns1 – DNS1
- pref_network_dns2 – DNS2
- pref_network_router_mode – Network sharing
- pref_display_hdformat – HD format
- pref_display_hdhdmienable – HDMI enable
- pref_display_hdcomponentenable – Component enable
- pref_display_sdformat – SD format
- pref_display_sdrcaenable – RCA enable
- pref_display_sdsvideoenable – S-Video enable
- pref_display_aspect – Aspect ratio
- pref_display_cec – HDMI-CEC
- pref_tv_streamtype – Stream type
- pref_tv_udpxyaddress – UDPXY address
- pref_tv_mpegts_buffer – MPEG-TS buffer
- pref_tv_dvr_deviceid – DVR storage
- pref_tv_timeshift_deviceid – Timeshift storage
- pref_tv_autotimeshift – Autotimeshift
- pref_tv_middleware – Content source
- pref_tv_button_midd_setup – Content source setup
- pref_tv_inter_apps – Interactive apps
- pref_security_enable – Enable security
- pref_security_timeout – Autoblock timeout
- pref_security_tvfiltertype – Filtering type (blacklist/whitelist)
- pref_security_operatorlock – Adult channel block
- pref_security_allowtv – Enable/disable Watch TV
- pref_security_allowmediaplayer – Enable/disable Mediaplayer
- pref_security_allowdvr – Enable/disable DVR
- pref_security_allowcctv – Enable/disable CCTV
- pref_security_allowwebapps – Enable/disable web apps
- pref_security_allowapps – Enable/disable Android apps
<preferences> <pref_network visible="false" /> <pref_tv> <pref_tv_streamtype visible="false" /> <pref_tv_udpxyaddress visible="false" /> <pref_tv_middleware disabled="true" /> </pref_tv> </preferences>
tvip_provision.xml Example:
<?xml version=”1.0″?>
<provision reload=”3600″><!–Update time in seconds –>
<!– Update server setup –>
<update_server name=”update.tvip.tv” />
<!– Logo setup –>
<logo url=”http://operator.com/prov/logo.png” />
<!– Hider DVR App –>
<features>
<dvr enabled=”false” />
</features>
<!– UDP-proxy setup –>
<tv_stream type=”udpxy” server=”login:pass@udpxy.operator.com” />
<!– M3U and EPG setup –>
<tv_protocols default=”m3u”>
<protocol type=”m3u” m3u=”http://operator.com/channels.m3u” epg=”http://operator.com/epg.zip” />
</tv_protocols>
<!– Add video source –>
<mountpoints>
<mountpoint type=”smb” mountname=”SMB Share”>
<address value=”192.168.1.1″ />
<folder value=”Movies” />
<password value=”pass” />
<username value=”login” />
</mountpoint>
</mountpoints>
<!– CCTV setup –>
<cctv_sources>
<source name=”Cameras” url=”http://cam.operator.com/cameras.m3u” />
</cctv_sources>
<!– Disable network user-preference. Middleware change restriction. –>
<preferences>
<pref_network visible=”false” />
<pref_tv>
<pref_tv_streamtype visible=”false” />
<pref_tv_udpxyaddress visible=”false” />
<pref_tv_middleware disabled=”true” />
</pref_tv>
</preferences>
</provision>