Theme file explanation
[ouya-store-api.git] / api / devs.ouya.tv / api-v1-themes.rst
index 812ac0d9daf4e6734c8628d73b274302374007b0..bb34581a84553b5f6823b3aa9f3358ab97472fea 100644 (file)
@@ -7,7 +7,8 @@ Load the main menu background image/video.
 
 Usage
 =====
-#. FIXME VERIFY: During startup before loading the main menu
+#. During startup before loading the main menu
+#. Every three hours
 
 
 HTTP request
@@ -33,13 +34,32 @@ HTTP response
 =============
 
 Status code
-  ``200 OK`` 
+  ``200 OK``
 Content type
   ``application/json; charset=utf-8``
 
-Example:
 
-.. include:: api-v1-themes-response.json
+Response body definition
+------------------------
+
+``background_style``
+  Supported until at least ODK 1.0.12.
+  Latest firmware 1.2.1427 does not support it anymore.
+
+  ``static`` meant that the image would be scaled.
+  Any value other than ``static`` would make the image pan around.
+``background``
+  Full URL to a backgroud image
+``video``
+  Supported until at least ODK 1.0.12.
+  Latest firmware 1.2.1427 does not support it anymore.
+
+  Video URL had preference over background image URL.
+
+Example
+-------
+
+.. include:: api-v1-themes.response.json
    :code:
 
 FIXME: get response with video/image set.