SettingsUpdate Interface Reference

Update the current server settings. More...


Detailed Description

Update the current server settings.

Path: /settings/update

Parameters:
[in]profileidThe id of the device profile (typically a GUI but not necessarily). Special values are: autodetect never alwaysaudio c\ alwaysvideo
[in]transcodingwhenA set of literals indicating when to transcode. Possible values are: pprofile, never, always
[in]transcodingoptimizeA set of literals indicating what should be optimized. Possible values are speed, quality
[in]compressionHow much to compress when transcoding. Possible values are: low, medium, high
[in]transcodevideowidthThe maximum width of the video resulting from transcoding
[in]transcodevideoheightThe maximum height of the video resulting from transcoding
[in]transcodeimagewidthThe maximum width of the image resulting from transcoding
[in]transcodeimageheightThe maximum height of the image resulting from transcoding
[in]downsampletomatchspeedA boolesan value incdicating if media with bitrate that is higher than the connection speed should be downsampled to lower bitrate
[in]timeshiftintervalThe time in minutes that live streams should be cached for pausing and rewinding purposes
[in]disabledecodingclockA boolesan value incdicating if the transcoding should happen as fast as possible or just as fast as needed to meet real-time playback requirements
[in]connectionspeedThe speed of the connection. Possible values are WIRED, WIFI_G, WIFI_B
[in]connectionqualityThe quality of the connection (mainly relevant to wireless connections). Possible values are: low, medium, high
[in]wmencodedshowA boolean values indicating if ecoding to WMV should be done via DirectShow or via ffmpeg
[in]wmprofileThe Windows Media profile to use when doing an encoding to WMV via DirectShow. Possible values are mp43, wmv7, wmv8, wmv9
[in]stereoMixA boolean value indicating id live audio capturing should rely on stereo mix
[in]driftCompThreshAudio drift compensaton threashold to be used when capturing audio via stereo mix. A value of zero means no compensation is to be performed.
[in]sortfolderbyfileA boolean values indicating if items organized by folder structure should be sorted by their file name or title extracted from their tags
[in]prettytagsA boolean values indicating if tags should be modified for beter readibility
[in]longtitleA boolean values indicating if long titles should be used such tha the folder to which files belong is made a apart of the file name. This is only useful with devices that can only display one long list of items (Xbox 360 used ot be that way).
[in]readavitagsA boolean values indicating if tags should b read from AVI tags or ignored
[in]refreshstarttimeThe time of day in which automatic library refresh should be done first time after the service started (offset in minutes for midnight).
[in]refreshintervalThe interval for subsequent automatic library refreshes (offset in minutes for midnight). A value of zero means never refresh automatically.
[in]cachesizeMaximum allowed size for cache area in megabytes
[in]rootThe root menu to make active. There can be only one active set of menus at any given point in time, however several sets of menus can co-exist and be maintained up to date.
[in]listenportThe TCP port on which the server should listen
[in]listenipThe IP address of the network interface on which the server should listen (leave empty for all interfaces)
[in]listenallowremoteA boolean value indicating if remote connection to the server are allowed (remote connection are connections outside the server LAN)
[in]autostartA boolean values indicating if the sharing should automatically start after a reboot
[in]proxyhttpA boolean values indicating if HTTP requests should be proxied
[in]adminUserA username for administrating the application and for remote access
[in]adminPasswordA password for administrating the application and for remote access
[in]maxdlcountMaximum number of concurrent downloads that can occur in the background
[in]feeddlcountMaximum number of items enclosed in a given feed that should be pre-downloaded (as opposed to be downloaded upon an actual request to play them)
[in]maxdlbpsMaximum bandwidth in bps that background download are allowed to consume
[in]maxitemsperfeedMaximum number of items per RSS/ATOM/RDF feed or playlists that TVersity should display
Returns:
An XML documnt with the top level element response and two attributes status and message. The status can be either success or failure and the message describes the cause of the error in a user friendly manner.