Player Settings
Settings – All settings
Request URL: http://api.buto.tv/settings/
Request Method: GET
Requires Authentication: Yes
This call returns all settings ‘files’ created on the authenticated user’s Buto account. The data format for responses is detailed at the bottom of this page. Valid responses will be returned with a 200 status code, authentication errors will trigger a 400 range status code and error output rather than XML.
<settings_files>
<settings>
...
</settings>
<settings>
...
</settings>
</settings_files>
Settings – Individual settings
Request URL: http://api.buto.tv/settings/setting/{#settings id}
Request Method: GET
Requires Authentication: Yes
To request a single settings file, simply append the URL with the ID of the settings file to retrieve. An invalid settings ID will return error output and a 404 not found status header. Successful requests will return XML in the format below:
<settings>
...
</settings>
Settings – Response structure
All individual settings responses follow the structure below:
<settings>
<id>'String'</id>
<name>'String'</name>
<comments_status>'moderated, enabled, or disabled'</comments_status>
<pre_buffer_enabled>'Boolean'</pre_buffer_enabled>
<auto_play>'Boolean'</auto_play>
<show_title_bar>'Boolean'</show_title_bar>
<throttle_bandwidth>'Boolean'</throttle_bandwidth>
<sharing_enabled>'Boolean'</sharing_enabled>
<!-- Optional Information -->
<rss>'String - path to RSS Feed'</rss>
<pre_roll_path>'String - Http path'</pre_roll_path>
<logo_path>'String - Http path'</logo_path>
<logo_click_url>'String - Http path'</logo_click_url>
<ga_tracker_id>'String - Http path'</ga_tracker_id>
<!-- End of optional information -->
<created_at>'ISO date'</created_at>
<creator_id>'String - user ID'</creator_id>
<modified_at>'ISO date'</modified_at>
<modifier_id>'String - user ID'</modifier_id>
</settings>