-
Notifications
You must be signed in to change notification settings - Fork 11
/
playlet-web-api.yml
644 lines (637 loc) · 18.3 KB
/
playlet-web-api.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
openapi: 3.0.0
info:
title: Playlet Web API
version: 0.27.1
description:
Playlet Web API is a RESTful API for controlling the Playlet app on
Roku devices. The API is intended to be used by the Playlet web app, but can
also be used by other apps.
contact:
name: Brahim Hadriche
url: https://github.com/iBicha
email: [email protected]
servers:
- url: http://{ROKU_DEV_TARGET}:{PORT}
description: Playlet server
variables:
ROKU_DEV_TARGET:
description: The IP address of the Roku device
default: 192.168.1.x
PORT:
description: The port number of the Playlet server
default: "8888"
paths:
/api/state:
get:
summary: Get Playlet app state
description: >
Get the current state of the Playlet app. The `key` parameter is
optional and can be omitted to get the entire state. If the `key`
parameter is specified, only the specified key(s) will be returned.
operationId: getPlayletState
parameters:
- name: key
in: query
description: specific key(s) to get
required: false
schema:
type: array
items:
type: string
enum:
- app
- device
- invidious
- preferences
- profiles
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/PlayletAppState"
/api/preferences:
get:
summary: Get preferences
description: |
Get the current user preferences.
operationId: getPreferences
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/PreferencesObject"
put:
summary: Set preferences
description: >
Set the current user preferences. The request body can contain some or
all of the preferences. Any preferences not specified in the request
body will be left unchanged.
operationId: setPreferences
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PreferencesObject"
responses:
"204":
description: No Content
"400":
description: Bad Request
delete:
summary: Reset preferences
description: |
Reset the current user preferences to their default values.
operationId: resetPreferences
responses:
"204":
description: No Content
/api/search-history:
get:
summary: Get search history
description: |
Get the current search history.
operationId: getSearchHistory
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: string
post:
summary: Add to search history
description: |
Add a query to the search history.
operationId: addToSearchHistory
requestBody:
content:
application/json:
schema:
type: object
properties:
query:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: string
"400":
description: Bad Request
delete:
summary: Clear search history
description: |
Clear the search history.
operationId: clearSearchHistory
responses:
"204":
description: No Content
/api/queue:
get:
summary: Get video queue
description: Get the current videos in the queue.
operationId: getVideoQueue
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/VideoQueueObject"
index:
type: integer
nowPlaying:
$ref: "#/components/schemas/VideoQueueObject"
post:
summary: Add to video queue
description: Add a video or a playlist to the queue.
operationId: addToVideoQueue
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/VideoQueueObject"
responses:
"204":
description: No Content
delete:
summary: Clear video queue
description: Clear the video queue.
operationId: clearVideoQueue
responses:
"204":
description: No Content
/api/queue/play:
post:
summary: Play video
description: Play a video or playlist. This adds the video or playlist to the current position in the queue and plays it.
operationId: playVideoQueue
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/VideoQueueObject"
responses:
"204":
description: No Content
/api/view/open:
get:
summary: Open a channel view or a playlist view
description: Open a channel view or a playlist view. If a video is playing in full screen, it is shrinked.
operationId: openView
parameters:
- name: channelId
in: query
description: The ID of the channel to open
required: false
schema:
type: string
- name: playlistId
in: query
description: The ID of the playlist to open
required: false
schema:
type: string
responses:
"204":
description: No Content
"400":
description: Bad Request
/api/home-layout:
get:
summary: Get home layout
description: Get the current home layout. This is the layout of the home screen, based on user preferences.
operationId: getHomeLayout
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
feedSources:
type: array
items:
type: object
properties:
apiType:
type: string
endpoint:
type: string
id:
type: string
queryParams:
type: object
additionalProperties: true
title:
type: string
/api/playlet-lib-urls:
get:
summary: Get Playlet lib URLs
description: Get the currently loaded Playlet lib url, and the saved ones to be loaded on next start.
operationId: getPlayletLibUrls
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
loaded:
type: object
properties:
link:
type: string
type:
type: string
saved:
type: array
items:
type: object
properties:
link:
type: string
type:
type: string
post:
summary: Set Playlet lib URLs
description: >
Set a list of Playlet lib URLs to be loaded on next start. Playlet will try to load them one after the other
until one succeeds.
operationId: setPlayletLibUrls
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
link:
type: string
type:
type: string
responses:
"204":
description: No Content
"400":
description: Bad Request
delete:
summary: Clear Playlet lib URLs
description: Clear the Playlet lib URLs. This affects the saved links in the registry, and will take effect on next start.
operationId: clearPlayletLibUrls
responses:
"204":
description: No Content
/invidious/login:
get:
summary: Redirect to the Invidious auth URL
description: Redirect to the Invidious auth URL, to allow authorizing an access token. Redirects to the Invidious auth URL.
operationId: invidiousLoginUrl
responses:
"302":
description: Found
headers:
Location:
schema:
type: string
format: uri
/api/profiles:
get:
summary: Get profiles
description: Get the logged profiles, and the currently active profile.
operationId: getProfiles
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
currentProfile:
type: string
profiles:
type: array
items:
$ref: "#/components/schemas/ProfileObject"
delete:
summary: Logout from a profile
description: Logout from a profile. This will remove the profile from the list of logged profiles.
operationId: logoutProfile
parameters:
- name: id
in: query
description: The ID of the profile to logout
required: true
schema:
type: string
responses:
"200":
description: OK
"400":
description: Bad Request
"404":
description: Not Found
/api/profiles/activate:
post:
summary: Activate a profile
description: Activate a profile. This will set the profile as the active profile.
operationId: activateProfile
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
responses:
"200":
description: OK
"400":
description: Bad Request
"404":
description: Not Found
# Roku External Control Protocol (ECP)
/input/{appId}:
servers:
- url: http://{ROKU_DEV_TARGET}:8060
description: Roku ECP endpoint
variables:
ROKU_DEV_TARGET:
description: The IP address of the Roku device
default: 192.168.1.x
parameters:
- $ref: "#/components/parameters/ecpAppId"
post:
summary: Send input to Playlet through ECP
description: Send input to Playlet through Roku External Control Protocol (ECP). This enables the deep-linking functionality.
operationId: ecpInput
parameters:
- $ref: "#/components/parameters/ecpContentId"
- $ref: "#/components/parameters/ecpMediaType"
- $ref: "#/components/parameters/ecpVideoId"
- $ref: "#/components/parameters/ecpTimestamp"
- $ref: "#/components/parameters/ecpTitle"
- $ref: "#/components/parameters/ecpAuthor"
responses:
"200":
description: OK
/launch/{appId}:
servers:
- url: http://{ROKU_DEV_TARGET}:8060
description: Roku ECP endpoint
variables:
ROKU_DEV_TARGET:
description: The IP address of the Roku device
default: 192.168.1.x
parameters:
- $ref: "#/components/parameters/ecpAppId"
post:
summary: Launch Playlet using ECP with arguments
description: Launch Playlet through Roku External Control Protocol (ECP) with arguments. This enables the deep-linking functionality.
operationId: ecpLaunch
parameters:
- $ref: "#/components/parameters/ecpClearPlayletLibUrls"
- $ref: "#/components/parameters/ecpContentId"
- $ref: "#/components/parameters/ecpMediaType"
- $ref: "#/components/parameters/ecpVideoId"
- $ref: "#/components/parameters/ecpTimestamp"
- $ref: "#/components/parameters/ecpTitle"
- $ref: "#/components/parameters/ecpAuthor"
responses:
"200":
description: OK
components:
parameters:
ecpAppId:
name: appId
in: path
description: The app ID of the Playlet app
required: true
schema:
type: string
enum:
- "693751" # Playlet app id
- dev
default: "693751"
ecpContentId:
name: contentId
in: query
description: The ID of the content to play. If specified with mediaType=video, this is the videoId.
required: false
schema:
type: string
ecpMediaType:
name: mediaType
in: query
description: The type of the content of ContentId. To be used with the contentId argument.
required: false
schema:
type: string
enum:
- video
ecpVideoId:
name: videoId
in: query
description: The video ID of the video to play. If specified, the video will be played.
required: false
schema:
type: string
ecpTimestamp:
name: timestamp
in: query
description: The timestamp of the video to play. To be used with the contentId argument.
required: false
schema:
type: integer
ecpTitle:
name: title
in: query
description: The title of the video. This is optionally added so we can display the title while loading, or when displaying the "Added to queue" notification.
required: false
schema:
type: string
ecpAuthor:
name: author
in: query
description: The author of the video. This is optionally added so we can display the author while loading, or when displaying the "Added to queue" notification.
required: false
schema:
type: string
ecpClearPlayletLibUrls:
name: clearPlayletLibUrls
in: query
description: If specified, the Playlet lib URLs will be cleared.
required: false
schema:
type: string
schemas:
PlayletAppState:
type: object
properties:
app:
type: object
properties:
id:
type: string
version:
type: string
git_commit_hash:
type: string
lib_version:
type: string
lib_git_commit_hash:
type: string
lib_version_latest:
type: string
lib_url_type:
type: string
device:
type: object
properties:
model:
type: string
model_display_name:
type: string
model_type:
type: string
model_details:
type: object
additionalProperties: true
os_version:
type: object
properties:
build:
type: string
major:
type: string
minor:
type: string
revision:
type: string
display_type:
type: string
display_mode:
type: string
display_aspect_ratio:
type: string
display_size:
type: object
properties:
w:
type: integer
h:
type: integer
video_mode:
type: string
ui_resolution:
type: object
properties:
height:
type: integer
name:
type: string
width:
type: integer
graphics_platform:
type: string
internet_status:
type: boolean
user_country_code:
type: string
friendly_name:
type: string
current_locale:
type: string
invidious:
type: object
properties:
current_instance:
type: string
auth_url:
type: string
preferences:
$ref: "#/components/schemas/PreferencesObject"
profiles:
type: object
properties:
currentProfile:
type: string
profiles:
type: array
items:
$ref: "#/components/schemas/ProfileObject"
PreferencesObject:
type: object
properties:
invidious.instance:
type: string
invidious.proxy_videos:
type: string
enum:
- always
- if_needed
- never
playback.autoplay:
type: string
enum:
- auto
- 720p
playback.preferred_quality:
type: string
sponsorblock.enabled:
type: boolean
sponsorblock.show_notifications:
type: boolean
ProfileObject:
type: object
properties:
id:
type: string
type:
type: string
username:
type: string
serverUrl:
type: string
# TODO:P1 add the rest of properties
VideoQueueObject:
type: object
properties:
videoId:
type: string
playlistId:
type: string
playlistIndex:
type: integer
timestamp:
type: integer
title:
type: string
author:
type: string