Theme file explanation
[ouya-store-api.git] / api / devs.ouya.tv / api-v1-themes.rst
1 ==========================================
2 ``GET https://devs.ouya.tv/api/v1/themes``
3 ==========================================
4
5 Load the main menu background image/video.
6
7
8 Usage
9 =====
10 #. During startup before loading the main menu
11 #. Every three hours
12
13
14 HTTP request
15 ============
16 Protocol
17   ``https``
18 Method
19   ``GET``
20 Host
21   ``devs.ouya.tv``
22 Path
23   ``/api/v1/themes``
24 Headers
25   Standard headers.
26 GET parameters
27   ``auth_token``
28     May be empty.
29
30     Does not seem to have any influence on the response.
31
32
33 HTTP response
34 =============
35
36 Status code
37   ``200 OK``
38 Content type
39   ``application/json; charset=utf-8``
40
41
42 Response body definition
43 ------------------------
44
45 ``background_style``
46   Supported until at least ODK 1.0.12.
47   Latest firmware 1.2.1427 does not support it anymore.
48
49   ``static`` meant that the image would be scaled.
50   Any value other than ``static`` would make the image pan around.
51 ``background``
52   Full URL to a backgroud image
53 ``video``
54   Supported until at least ODK 1.0.12.
55   Latest firmware 1.2.1427 does not support it anymore.
56
57   Video URL had preference over background image URL.
58
59 Example
60 -------
61
62 .. include:: api-v1-themes.response.json
63    :code:
64
65 FIXME: get response with video/image set.