-
Notifications
You must be signed in to change notification settings - Fork 2
/
propresenter.ts
1820 lines (1778 loc) · 51.9 KB
/
propresenter.ts
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
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
export type JSONValue =
| {
data: any;
status: number;
command: string;
}
| Promise<JSONValue>;
export class ProPresenter {
ip: string;
port: number;
constructor(ip: string, port: number) {
this.ip = ip;
this.port = port;
}
//
/**
* API wrapper function, use fetch to send/retrieve the data from ProPresenter
* @param path
* @param userOptions (optional)
* @returns Promise from fetch
*/
private getDataFromProPresenter = (path: string, userOptions?: any) => {
// Define default options
const defaultOptions = {};
// Define default headers
const defaultHeaders = {};
if (!userOptions) userOptions = [];
const options = {
// Merge options
...defaultOptions,
...userOptions,
// Merge headers
headers: {
...defaultHeaders,
...userOptions.headers,
},
};
// Build Url
const url = `http://${this.ip}:${this.port}${path}`;
const resultObj: JSONValue = { data: null, status: null, command: path };
return fetch(url, options)
.then((response) => {
resultObj.status = response.status;
return response.json();
})
.then((result) => {
resultObj.data = result;
return resultObj;
});
};
/**
* ANNOUNCEMENT
*/
/**
* Requests the currently active announcement presentation.
* @returns the currently active announcement presentation.
*/
announcementGetActive() {
return this.getDataFromProPresenter("/v1/announcement/active");
}
/**
* Requests the index of the current slide/cue within the currently active announcement.
* @returns The index of the current slide/cue within the currently active announcement.
*/
announcementGetSlideIndex() {
return this.getDataFromProPresenter("/v1/announcement/slide_index");
}
/**
* Focuses the currently active announcement presentation.
*/
announcementActiveFocus() {
return this.getDataFromProPresenter("/v1/announcement/active/focus");
}
/**
* Retriggers the currently active announcement presentation (starts from the beginning).
*/
announcementTrigger() {
return this.getDataFromProPresenter("/v1/announcement/active/trigger");
}
/**
* Triggers the next cue in the active announcement presentation (if there is one).
*/
announcementNextTrigger() {
return this.getDataFromProPresenter("/v1/announcement/active/next/trigger");
}
/**
* Triggers the previous cue in the currently active announcement presentation (if there is one).
*/
announcementPreviousTrigger() {
return this.getDataFromProPresenter(
"/v1/announcement/active/previous/trigger"
);
}
/**
* Triggers the specified cue in the currently active announcement presentation.
* @param {string} index
*/
announcementActiveIndexTrigger(index: string | number) {
return this.getDataFromProPresenter(
`/v1/announcement/active/${index}/trigger`
);
}
/**
* Performs the requested timeline operation for the active announcment presentation.
* @param {play,pause,rewind} operation
*/
announcementActiveTimelineOperation(operation) {
return this.getDataFromProPresenter(
`/v1/announcement/active/timeline/${operation}`
);
}
/**
* Requests the current state of the active announcement timeline.
* @returns The current state of the active announcement timeline.
*/
announcementGetActiveTimelineOperation() {
return this.getDataFromProPresenter(`/v1/announcement/active/timeline`);
}
/**
* AUDIO
*/
/**
* Requests a list with all the configured audio playlists.
* @returns a list with all the configured audio playlists.
*/
audioGetPlaylists() {
return this.getDataFromProPresenter(`/v1/audio/playlists`);
}
/**
* Requests a list of all the audio items in the specified audio playlist.
* @param {string} playlist_id
* @returns a list of all the audio items in the specified audio playlist.
*/
audioGetPlaylistsByPlaylistId(playlist_id) {
return this.getDataFromProPresenter(`/v1/audio/playlists/${playlist_id}`);
}
/**
* Requests a chunked data update every time the specified audio playlist changes.
* @param {string} playlist_id
* @returns a chunked data update every time the specified audio playlist changes.
*/
audioGetPlaylistsByPlaylistIdUpdates(playlist_id) {
return this.getDataFromProPresenter(
`/v1/audio/playlists/${playlist_id}/updates`
);
}
/**
* Requests the currently focused audio playlist
* @returns The currently focused audio playlist
*/
audioGetPlaylistsFocused() {
return this.getDataFromProPresenter(`/v1/audio/playlists/focused`);
}
/**
* Requests the currently active audio playlist
* @returns The currently active audio playlist
*/
audioGetPlaylistsActive() {
return this.getDataFromProPresenter(`/v1/audio/playlists/active`);
}
/**
* Focuses the next audio playlist.
*/
audioPlaylistsNextFocus() {
return this.getDataFromProPresenter(`/v1/audio/playlists/next/focus`);
}
/**
* Focuses the previous audio playlist.
*/
audioPlaylistsPreviousFocus() {
return this.getDataFromProPresenter(`/v1/audio/playlists/previous/focus`);
}
/**
* Focuses the active audio playlist.
*/
audioPlaylistsActiveFocus() {
return this.getDataFromProPresenter(`/v1/audio/playlists/active/focus`);
}
/**
* Focuses the specified audio playlist.
* @param {string} playlist_id
*/
audioPlaylistsByPlaylistIdFocus(playlist_id) {
return this.getDataFromProPresenter(
`/v1/audio/playlists/${playlist_id}/focus`
);
}
/**
* Triggers the focused audio playlist.
*/
audioPlaylistsFocusedTrigger() {
return this.getDataFromProPresenter(`/v1/audio/playlists/focused/trigger`);
}
/**
* Triggers the active audio playlist (restarts from the beginning).
*/
audioPlaylistsActiveTrigger() {
return this.getDataFromProPresenter(`/v1/audio/playlists/active/trigger`);
}
/**
* Triggers the specified audio playlist.
* @param {string} playlist_id
*/
audioPlaylistsByPlaylistIdTrigger(playlist_id) {
return this.getDataFromProPresenter(
`/v1/audio/playlists/${playlist_id}/trigger`
);
}
/**
* Triggers the next item in the focused audio playlist.
*/
audioPlaylistsFocusedNextTrigger() {
return this.getDataFromProPresenter(
`/v1/audio/playlists/focused/next/trigger`
);
}
/**
* Triggers the previous item in the focused audio playlist.
*/
audioPlaylistsFocusedPreviousTrigger() {
return this.getDataFromProPresenter(
`/v1/audio/playlists/focused/previous/trigger`
);
}
/**
* Triggers the specified item in the focused audio playlist.
* @params {string} id
*/
audioPlaylistsFocusedIdTrigger(id) {
return this.getDataFromProPresenter(
`/v1/audio/playlists/focused/${id}/trigger`
);
}
/**
* Triggers the next item in the active audio playlist.
*/
audioPlaylistsActiveNextTrigger() {
return this.getDataFromProPresenter(
`/v1/audio/playlists/active/next/trigger`
);
}
/**
* Triggers the previous item in the active audio playlist.
*/
audioPlaylistsActivedPreviousTrigger() {
return this.getDataFromProPresenter(
`/v1/audio/playlists/active/previous/trigger`
);
}
/**
* Triggers the specified item in the active audio playlist.
* @params {string} id
*/
audioPlaylistsActiveIdTrigger(id) {
return this.getDataFromProPresenter(
`/v1/audio/playlists/active/${id}/trigger`
);
}
/**
* Triggers the next item in the specified audio playlist.
* @param {string} playlist_id
*/
audioPlaylistsByPlaylistIdNextTrigger(playlist_id) {
return this.getDataFromProPresenter(
`/v1/audio/playlists/${playlist_id}/next/trigger`
);
}
/**
* Triggers the previous item in the specified audio playlist.
* @param {string} playlist_id
*/
audioPlaylistsByPlaylistIdPreviousTrigger(playlist_id) {
return this.getDataFromProPresenter(
`/v1/audio/playlists/${playlist_id}/previous/trigger`
);
}
/**
* CAPTURE
*/
/**
* Requests the current capture status and capture time.
* @returns The current capture status and capture time.
*/
captureGetStatus() {
return this.getDataFromProPresenter(`/v1/capture/status`);
}
/**
* Performs the requested capture operation (start, stop).
* @param operation (start, stop)
*/
captureOperation(operation: "start" | "stop") {
return this.getDataFromProPresenter(`/v1/capture/${operation}`);
}
/**
* Requests the current capture settings.
* @returns The current capture settings.
*/
captureGetsettings() {
return this.getDataFromProPresenter(`/v1/capture/settings`);
}
/**
* Requests a list of all available capture modes for the capture type (disk, rtmp, resi).
* @param type (disk, rtmp, resi)
* @returns A list of all available capture modes for the capture type (disk, rtmp, resi).
*/
captureEncodingsType(type: "disk" | "rtmp" | "resi") {
return this.getDataFromProPresenter(`/v1/capture/encodings/${type}`);
}
/**
* CLEAR
*/
/**
* Clears the specified layer (audio, props, messages, announcements, slide, media, video_input).
* @param {string} layer (audio, props, messages, announcements, slide, media, video_input)
*/
clearLayer(
layer:
| "audio"
| "props"
| "messages"
| "announcements"
| "slide"
| "media"
| "video_input"
) {
return this.getDataFromProPresenter(`/v1/clear/layer/${layer}`);
}
/**
* Requests the details of the specified clear group.
* @param {string} id (name, index or UUID)
* @returns The details of the specified clear group.
*/
clearGetGroupId(id: string) {
return this.getDataFromProPresenter(`/v1/clear/group/${id}`);
}
/**
* Sets the details of the specified clear group.
* @param {string} id (name, index or UUID)
* @returns The details of the specified clear group.
*/
clearSetGroupId(id: string) {
return this.getDataFromProPresenter(`/v1/clear/group/${id}`, {
method: "PUT",
});
}
/**
* Deletes the specified clear group.
* @param {string} id (name, index or UUID)
*/
clearDeleteGroupId(id: string) {
return this.getDataFromProPresenter(`/v1/clear/group/${id}`, {
method: "DELETE",
});
}
/**
* Requests the image data for the icon of the specified clear group.
* @param {string} id (name, index or UUID)
* @returns The image data for the icon of the specified clear group.
*/
clearGetGroupIdIcon(id: string) {
return this.getDataFromProPresenter(`/v1/clear/group/${id}/icon`);
}
/**
* Sets the custom icon of the specified clear group.
* @param {string} id (name, index or UUID)
* @returns
*/
clearSetGroupIdIcon(id: string) {
return this.getDataFromProPresenter(`/v1/clear/group/${id}/icon`, {
method: "PUT",
});
}
/**
* Triggers the specified clear group.
* @param {string} id (name, index or UUID)
*/
clearGroupIdTrigger(id: string) {
return this.getDataFromProPresenter(`/v1/clear/group/${id}/trigger`);
}
/**
* Requests a list of all the configured clear groups.
* @returns A list of all the configured clear groups.
*/
clearGetGroup() {
return this.getDataFromProPresenter(`/v1/clear/groups`);
}
/**
* DOUBLE CHECK THIS FOR MISSING PARAMS
* Create a clear group with the details specified.
* @param {sting} name
* @param {string[]} layers
* @param {boolean} stop_timeline_announcements
* @param {boolean} stop_timeline_presentation
* @param {boolean} clear_next_presentation
* @returns The created group.
*/
clearCreateGroup(
name: string,
layers: string[],
stop_timeline_announcements: boolean,
stop_timeline_presentation: boolean,
clear_next_presentation: boolean
) {
return this.getDataFromProPresenter(`/v1/clear/groups`, {
method: "POST",
body: {
id: {
id: "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D", // ignored
name: name,
index: 3, // ignored
},
icon: "All",
tint: {
red: 0,
green: 0.54,
blue: 0.87,
alpha: 1,
},
layers: layers,
stop_timeline_announcements: stop_timeline_announcements,
stop_timeline_presentation: stop_timeline_presentation,
clear_next_presentation: clear_next_presentation,
},
});
}
/**
* GLOBAL GROUPS
*/
/**
* Requests a list of all the configured global groups.
* @returns A list of all the configured global groups.
*/
groupsGet() {
return this.getDataFromProPresenter(`/v1/groups`);
}
/**
* LIBRARY
*/
/**
* Requests a list of all the configured libraries.
* @returns A list of all the configured libraries.
*/
libraryGet() {
return this.getDataFromProPresenter(`/v1/libraries`);
}
/**
* Requests an array of all items in the specified library.
* @params { string } id (UUID, name, or index)
* @returns An array of all items in the specified library.
*/
libraryGetById(id: string) {
return this.getDataFromProPresenter(`/v1/library/${id}`);
}
/**
* Triggers the first cue of the specified presentation in the specified library.
* @param library_id
* @param presentation_id
*/
libraryByIdPresentationIdTrigger(
library_id: string,
presentation_id: string
) {
return this.getDataFromProPresenter(
`/v1/library/${library_id}/${presentation_id}/trigger`
);
}
/**
* Triggers the specified cue of the specified presentation in the specified library.
* @param library_id
* @param presentation_id
* @param cue
*/
libraryByIdPresentationIdCueTrigger(
library_id: string,
presentation_id: string,
cue: string
) {
return this.getDataFromProPresenter(
`/v1/library/${library_id}/${presentation_id}/${cue}/trigger`
);
}
/**
* LOOKS
*/
/**
* Requests a list of all configured audience looks, except the live look.
* @returns A list of all configured audience looks, except the live look.
*/
lookGet() {
return this.getDataFromProPresenter(`/v1/looks`);
}
// /**
// * Creates a new audience look with the specified details.
// */
// lookCreate() {
// return this.getDataFromProPresenter(`/v1/looks`, { method: "POST" });
// }
/**
* Requests the details of the currently live audience look.
* @returns The details of the currently live audience look.
*/
lookGetCurrent() {
return this.getDataFromProPresenter(`/v1/looks/current`);
}
/**
* Requests the details of the currently live audience look.
* @returns The details of the currently live audience look.
*/
lookSetCurrent() {
return this.getDataFromProPresenter(`/v1/looks/current`, { method: "PUT" });
}
/**
* Requests the details of the specified audience look.
* @param {string} id
* @returns The details of the specified audience look.
*/
lookGetId(id: string) {
return this.getDataFromProPresenter(`/v1/looks${id}`);
}
/**
* Sets the details of the specified audience look.
* @param {string} id
*/
lookSetId(id: string) {
return this.getDataFromProPresenter(`/v1/looks${id}`, { method: "PUT" });
}
/**
* Deletes the specified audience look from the saved looks.
* @param {string} id
*/
lookDeleteId(id: string) {
return this.getDataFromProPresenter(`/v1/looks${id}`, { method: "DELETE" });
}
/**
* Triggers the specified audience look to make it the live/current look.
* @param {string} id
*/
lookIdTrigger(id: string) {
return this.getDataFromProPresenter(`/v1/looks${id}/trigger`);
}
/**
* MACRO
*/
/**
* Requests a list of all the configured macros.
* @returns A list of all the configured macros.
*/
marcosGet() {
return this.getDataFromProPresenter(`/v1/macros`);
}
/**
* Requests the details of the specified macro.
* @param {string} id
* @returns The details of the specified macro.
*/
marcosIdGet(id: string) {
return this.getDataFromProPresenter(`/v1/macros${id}`);
}
/**
* Sets the details of the specified macro.
* @param {string} id
*/
marcosIdSet(id: string) {
return this.getDataFromProPresenter(`/v1/macros${id}`, { method: "PUT" });
}
/**
* Deletes the specified macro.
* @param {string} id
*/
marcosIdDelete(id: string) {
return this.getDataFromProPresenter(`/v1/macros${id}`, {
method: "DELETE",
});
}
/**
* Triggers the specified macro.
* @param {string} id
*/
marcosIdTriggerGet(id: string) {
return this.getDataFromProPresenter(`/v1/macros${id}/trigger`);
}
/**
* MASKS
*/
/**
* Requests a list of all configured masks.
* @returns A list of all configured masks.
*/
masksGet() {
return this.getDataFromProPresenter(`/v1/masks`);
}
/**
* Requests the details of the specified mask.
* @param {string} id
* @returns The details of the specified mask.
*/
masksIdGet(id: string) {
return this.getDataFromProPresenter(`/v1/masks/${id}`);
}
/**
* Requests a thumbnail image of the specified mask at the given quality value.
* @param {string} id
* @returns A thumbnail image of the specified mask at the given quality value.
*/
masksIdThumbnailGet(id: string) {
return this.getDataFromProPresenter(`/v1/masks/${id}/thumbnail`);
}
/**
* MEDIA
*/
/**
* Requests a list of all the configured media playlists.
* @returns A list of all the configured media playlists.
*/
mediaPlaylistsGet() {
return this.getDataFromProPresenter(`/v1/media/playlists`);
}
/**
* Requests a list of all the media items in the specified media playlist.
* @param {string} playlist_id
* @returns A list of all the media items in the specified media playlist.
*/
mediaPlaylistByPlaylistIdGet(playlist_id: string) {
return this.getDataFromProPresenter(`/v1/media/playlist/${playlist_id}`);
}
/**
* Requests a chunked data update every time the specified media playlist changes.
* @param {string} playlist_id
* @returns A chunked data update every time the specified media playlist changes.
*/
mediaPlaylistByPlaylistIdUpdatesGet(playlist_id: string) {
return this.getDataFromProPresenter(
`/v1/media/playlist/${playlist_id}/updates`
);
}
/**
* Requests a thumbnail image of the specified media item at the given quality value.
* @param {string} playlist_id
* @returns A thumbnail image of the specified media item at the given quality value.
*/
mediaByUUIDThumbnailsGet(uuid: string) {
return this.getDataFromProPresenter(`/v1/media/${uuid}/thumbnail`);
}
/**
* Returns the identifier of the currently focused media playlist
* @returns The identifier of the currently focused media playlist
*/
mediaPlaylistFocusedGet() {
return this.getDataFromProPresenter(`/v1/media/playlist/focused`);
}
/**
* Returns the identifier of the currently active media playlist.
* @returns The identifier of the currently active media playlist
*/
mediaPlaylistActiveGet() {
return this.getDataFromProPresenter(`/v1/media/playlist/active`);
}
/**
* Sets the focus to the next media playlist.
*/
mediaPlaylistNextFocus() {
return this.getDataFromProPresenter(`/v1/media/playlist/next/focus`);
}
/**
* Sets the focus to the previous media playlist.
*/
mediaPlaylistPreviousFocus() {
return this.getDataFromProPresenter(`/v1/media/playlist/previous/focus`);
}
/**
* Sets the focus to the active media playlist.
*/
mediaPlaylistActiveFocus() {
return this.getDataFromProPresenter(`/v1/media/playlist/active/focus`);
}
/**
* Sets the focus to the specified media playlist.
* @param {string} playlist_id
*/
mediaPlaylistPlaylistIdFocus(playlist_id: string) {
return this.getDataFromProPresenter(
`/v1/media/playlist/${playlist_id}/focus`
);
}
/**
* Triggers the first item in the focused media playlist.
*/
mediaPlaylistFocusedTrigger() {
return this.getDataFromProPresenter(`/v1/media/playlist/focused/trigger`);
}
/**
* Triggers the first item in the active media playlist.
*/
mediaPlaylistActiveTrigger() {
return this.getDataFromProPresenter(`/v1/media/playlist/active/trigger`);
}
/**
* Triggers the first item in the specified media playlist.
* @param {string} playlist_id
*/
mediaPlaylistPlaylistIdTrigger(playlist_id: string) {
return this.getDataFromProPresenter(
`/v1/media/playlist/${playlist_id}/trigger`
);
}
/**
* Triggers the next item in the focused media playlist.
*/
mediaPlaylistFocusedNextTrigger() {
return this.getDataFromProPresenter(
`/v1/media/playlist/focused/next/trigger`
);
}
/**
* Triggers the previous item in the focused media playlist.
*/
mediaPlaylistFocusedPreviousTrigger() {
return this.getDataFromProPresenter(
`/v1/media/playlist/focused/previous/trigger`
);
}
/**
* Triggers the specified item in the focused media playlist.
* @param {string} media_id
*/
mediaPlaylistFocusedMediaIdTrigger(media_id: string) {
return this.getDataFromProPresenter(
`/v1/media/playlist/focused/${media_id}/trigger`
);
}
/**
* Triggers the next item in the active media playlist.
*/
mediaPlaylistActiveNextTrigger() {
return this.getDataFromProPresenter(
`/v1/media/playlist/active/next/trigger`
);
}
/**
* Triggers the previous item in the active media playlist.
*/
mediaPlaylistActivePreviousTrigger() {
return this.getDataFromProPresenter(
`/v1/media/playlist/active/previous/trigger`
);
}
/**
* Triggers the specified item in the active media playlist.
* @param {string} media_id
*/
mediaPlaylistActiveMediaIdTrigger(media_id: string) {
return this.getDataFromProPresenter(
`/v1/media/playlist/active/${media_id}/trigger`
);
}
/**
* Triggers the next item in the specified media playlist.
* @param {string} playlist_id
*/
mediaPlaylistPlaylistIdNextTrigger(playlist_id: string) {
return this.getDataFromProPresenter(
`/v1/media/playlist/${playlist_id}/next/trigger`
);
}
/**
* Triggers the previous item in the specified media playlist.
* @param {string} playlist_id
*/
mediaPlaylistPlaylistIdPreviousTrigger(playlist_id: string) {
return this.getDataFromProPresenter(
`/v1/media/playlist/${playlist_id}/previous/trigger`
);
}
/**
* Triggers the previous item in the specified media playlist.
* @param {string} playlist_id
* @param {string} media_id
*/
mediaPlaylistPlaylistIdMediaIdTrigger(playlist_id: string, media_id: string) {
return this.getDataFromProPresenter(
`/v1/media/playlist/${playlist_id}/${media_id}/trigger`
);
}
/**
* MESSAGE
*/
/**
* Requests a list of all configured messages.
* @returns A list of all configured messages.
*/
messagesGet() {
return this.getDataFromProPresenter(`/v1/messages`);
}
// /**
// * Creates a new message with specified details.
// * @param TODO
// */
// messagesCreate() {
// return this.getDataFromProPresenter(`/v1/message`, { method: "POST" });
// }
/**
* Requests the details of the specified message.
* @returns The details of the specified message.
* @param {string} id
*/
messagesIdGet(id: string) {
return this.getDataFromProPresenter(`/v1/message${id}`);
}
/**
* Sets the details of the specified message.
* @param {string} id
*/
messagesIdSet(id: string) {
return this.getDataFromProPresenter(`/v1/message${id}`, { method: "PUT" });
}
/**
* Deletes the specified message.
* @param {string} id
*/
messagesIdDelete(id: string) {
return this.getDataFromProPresenter(`/v1/message${id}`, {
method: "DELETE",
});
}
// /**
// * Triggers / Shows the specified message.
// * @param {string} id
// */
// messagesIdTrigger(id: string) {
// return this.getDataFromProPresenter(`/v1/message${id}/trigger`, {
// method: "POST",
// });
// }
/**
* Clears / Hides the specified message.
* @param {string} id
*/
messagesIdClear(id: string) {
return this.getDataFromProPresenter(`/v1/message${id}/clear`);
}
/**
* MISCELLANEOUS
*/
/**
* Executes the "Find My Mouse" operation.
*/
findMyMouse() {
return this.getDataFromProPresenter(`/v1/find_my_mouse`);
}
/**
* PLAYLIST
*/
/**
* Requests a list of all configured playlists.
* @returns A list of all configured playlists.
*/
playlistsGet() {
return this.getDataFromProPresenter(`/v1/playlists`);
}
// /**
// * Creates a playlist with the specified details.
// */
// playlistsCreate() {
// return this.getDataFromProPresenter(`/v1/playlists`, { method: "POST" });
// }
/**
* Requests a list of the items in the specified playlist.
* @returns Alist of the items in the specified playlist.
*/
playlistPlaylistIdGet(playlist_id: string) {
return this.getDataFromProPresenter(`/v1/playlist/${playlist_id}`);
}
/**
* Sets the contents of the specified playlist.
*/
playlistPlaylistIdSet(playlist_id: string) {
return this.getDataFromProPresenter(`/v1/playlist/${playlist_id}`, {
method: "PUT",
});
}
// /**
// * Creates a playlist with the specified details underneath the specified playlist or playlist folder.
// */
// playlistPlaylistIdCreate(playlist_id: string) {
// return this.getDataFromProPresenter(`/v1/playlist/${playlist_id}`, {
// method: "POST",
// });
// }
/**
* Requests the details of the active playlist.
* @returns The details of the active playlist.
*/
playlistActiveGet() {
return this.getDataFromProPresenter(`/v1/playlist/active`);
}
/**
* Requests the details of the currently focused playlist.
* @returns The details of the currently focused playlist.
*/
playlistFocusedGet() {
return this.getDataFromProPresenter(`/v1/playlist/focused`);
}
/**
* Moves the focus to the next playlist.
*/
playlistNextFocus() {
return this.getDataFromProPresenter(`/v1/playlist/next/focus`);
}
/**
* Moves the focus to the previous playlist.
*/
playlistPreviousFocus() {
return this.getDataFromProPresenter(`/v1/playlist/previous/focus`);
}
/**
* Moves the focus to the currently active playlist for the presentation destination.
*/
playlistActivePresentationFocus() {
return this.getDataFromProPresenter(
`/v1/playlist/active/presentation/focus`
);
}
/**
* Moves the focus to the currently active playlist for the announcement destination.
*/
playlistActiveAnnouncementFocus() {
return this.getDataFromProPresenter(
`/v1/playlist/active/announcement/focus`
);
}
/**
* Triggers the first item in the currently focused playlist.
*/
playlistFocusedTrigger() {
return this.getDataFromProPresenter(`/v1/playlist/focused/trigger`);
}
/**
* Triggers the first item in the currently active playlist for the presentation destination.
*/
playlistActivePresentationTrigger() {
return this.getDataFromProPresenter(
`/v1/playlist/active/presentation/trigger`
);
}
/**
* Triggers the first item in the currently active playlist for the announcement destination.
*/
playlistActiveAnnouncementTrigger() {
return this.getDataFromProPresenter(
`/v1/playlist/active/announcement/trigger`
);
}
/**
* Triggers the next item in the currently focused playlist.
*/
playlistFocusedNextTrigger() {
return this.getDataFromProPresenter(`/v1/playlist/focused/next/trigger`);
}
/**
* Triggers the previous item in the currently focused playlist.
*/
playlistFocusedPreviousTrigger() {
return this.getDataFromProPresenter(
`/v1/playlist/focused/previous/trigger`
);
}
/**
* Requests a chunked data update every time the specified audio playlist changes.
* @param {string} identifier
* @returns A chunked data update every time the specified audio playlist changes.
*/
playlistIdentifierUpdates(identifier: string) {
return this.getDataFromProPresenter(`/v1/playlist/${identifier}/updates`);
}
/**
* Moves the focus to the specified playlist.
* @param {string} identifier
*/
playlistIdentifierFocus(identifier: string) {
return this.getDataFromProPresenter(`/v1/playlist/${identifier}/focus`);