-
Notifications
You must be signed in to change notification settings - Fork 17
/
skin-schema.json
1665 lines (1665 loc) · 70.1 KB
/
skin-schema.json
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
{
"description": "This JSON schema describes the base UI configuration for the Ooyala Player, which can be customized in the <a href=\"https://github.com/ooyala/skin-config.git\">skin.json</a> file. Also see <a href=\"https://facebook.github.io/react\">https://facebook.github.io/react</a> and <a href=\"https://facebook.github.io/react-native\">https://facebook.github.io/react-native</a>.",
"type": "object",
"additionalProperties": false,
"required": ["general", "startScreen", "pauseScreen", "endScreen", "upNext", "moreOptionsScreen", "castControls", "discoveryScreen", "closedCaptionOptions", "icons", "buttons", "controlBar", "shareScreen", "localization"],
"properties": {
"general": {
"description": "Configuration of things that do not appear in only one part of the UI.",
"type": "object",
"properties": {
"watermark": {
"description": "An object that defines the URL of a watermark on the player screen.",
"type": "object",
"additionalProperties": false,
"properties": {
"imageResource": { "$ref": "#/definitions/image" },
"position": {
"description": "Defines the position of watermark image on the video screen",
"enum": ["topLeft", "topRight", "bottomLeft", "bottomRight", "centerBottom", "centerTop", "rightCenter", "leftCenter"],
"default": "bottomRight"
},
"clickUrl": {
"description": "Defines the url to open when watermark is clicked",
"type": "string",
"default":""
},
"target": {
"description": "Defines the target for the watermark url to open",
"type": "string",
"default":"_blank"
},
"transparency": {
"description": "A floating-point number ranging from 0.0 (fully transparent) to 1.0 (fully opaque).",
"type": "number",
"default": "1"
},
"scalingOption": {
"description": "Defines watermark scaling option. If 'default' is chosen, watermark is scaled to 10% of player width",
"enum": ["none", "width", "height", "default"],
"default": "none"
},
"scalingPercentage": {
"description": "An integer number ranging from 0 to 100, scales watermark according to scalintOption parameter",
"type": "number",
"default": "0"
}
},
"example": "\"watermark\": {\"imageResource\": {\"url\": \"assets/images/ooyala-watermark.png\"} }"
},
"loadingImage": {
"description": "An object that defines the URL of a loading image on the player screen",
"type": "object",
"additionalProperties": false,
"properties": {
"imageResource": { "$ref": "#/definitions/image" }
},
"example": "\"loadingImage\": {\"imageResource\": {\"url\": \"assets/images/loading.png\"} }"
},
"bufferingSpinnerDelay": {
"description": "The time in milliseconds that the player should wait before displaying the buffering spinner when playback stalls. Set to 0 in order to show the spinner immediately.",
"type": "number",
"minimum": 0,
"maximum": 60000
},
"accentColor": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string",
"platform support": {
"iOS SDK": "v4.21.0+",
"Android SDK": "v4.21.0+ Note: the toggle switch color cannot be customized"
}
}
}
},
"localization": {
"description": "Defines the string values used in the player. Languages listed in the array require a separate json file included in the bundle, named '<language>.json' e.g. 'en.json'.",
"type": "object",
"properties": {
"defaultLanguage": {
"description": "The default language of the localizable strings on the player.",
"type": "string", "pattern": "^[a-z]{2}$",
"valid values": "\"en\", \"es\", \"zh\", \"ja\", \"ko\"",
"default": "en"
},
"availableLanguageFile": {
"description": "An array of languages. Defines the string values used in the player. Languages listed in the array require a separate json file included in the bundle, named '<language>.json' e.g. 'en.json'.",
"type": "array",
"items": {"type": "object", "pattern": "^[a-z]{2}$"},
"default": "{\"language\": \"en\", \"languageFile\": \"config/en.json\"}, {\"language\": \"es\", \"languageFile\": \"config/es.json\"}, {\"language\": \"zh\", \"languageFile\": \"config/zh.json\"}, {\"language\": \"ja\", \"languageFile\": \"config/ja.json\"}, {\"language\": \"ko\", \"languageFile\": \"config/ko.json\"}",
"language": {
"description": "Defines the language. For this release, valid languages are English (en), Spanish (es), Simplified Chinese (zh), Japanese (ja) and Korean (ko).",
"type": "string",
"valid values": "\"en\" | \"es\" | \"zh\" | \"ja\" | \"ko\""
},
"languageFile": {
"description": "Path to the localized language file.",
"type": "string"
},
"androidResource": {
"description": "Path to the localized language file in android.",
"type": "string"
},
"iosResource": {
"description": "Path to the localized language file in ios.",
"type": "string"
}
}
},
"required": ["defaultLanguage"]
},
"languageDirections": {
"ar": "rtl",
"dv": "rtl",
"he": "rtl",
"fa": "rtl",
"ks": "rtl",
"ku": "rtl",
"pa": "rtl",
"ps": "rtl",
"sd": "rtl",
"tk": "rtl",
"ug": "rtl",
"ur": "rtl",
"yi": "rtl"
},
"responsive": {
"description": "Defines values needed for Responsive Design Rules",
"properties": {
"breakpoints": {
"description": "Widths which video player responds to target style",
"type": "object",
"items": {"type": "object", "pattern": "^[a-z]{2}$"},
"size": {
"description": "Label for breakpoint style. Used for CSS className. CSS selector for target style must match this value.",
"type": "string"
},
"minWidth": {
"description": "Minimum breakpoint width",
"type": "number"
},
"maxWidth": {
"description": "Maximum breakpoint width",
"type": "number"
},
"multiplier": {
"description": "Calculates responsive values as - value * multiplier.",
"type": "number"
}
},
"aspectRatio": {
"description": "Aspect ratio of video. Used to set dimensions of responsive player skin. (height/width) * 100. For example, 16:9 aspect ratio would be (9/16) * 100 = 56.25.",
"default": "auto",
"oneOf": [
{
"type": "string",
"enum": ["auto"]
},
{
"type": "number",
"minimum": 0,
"maximum": 100
}
]
}
}
},
"startScreen": {
"description": "The screen displayed after an asset loads, but before playback begins.",
"type": "object",
"properties": {
"playIconStyle": {
"description": "Defines the style of the play button icon. The default color is white with an opacity of 1.",
"$ref": "#/definitions/iconStyle"
},
// TODO: showPromo could be folded into promoImageSize as a 'none' enum value.
"showPromo": {
"description": "Show the promo image on the start screen if set to true. Hide it if set to false.",
"type": "boolean",
"default": true
},
"promoImageSize": {
// TODO: "deafult" could be called "fullscreen"?
"description": "Configure how large the promo image should be when displayed. The 'small' setting will use styling out of the style sheets.",
"enum": ["default", "small"],
"default": "default"
},
// TODO: showPlayButton could be folded into playButtonPosition as a 'none' enum value.
"showPlayButton": {
"description": "Show the play button on the start screen if set to true. Hide it if set to false.",
"type": "boolean",
"default": true
},
"playButtonPosition": {
"description": "Defines the position of the play button on the start screen.",
"enum": [ "center", "topLeft", "topRight", "bottomLeft", "bottomRight" ],
"default": "center"
},
"showTitle": { "description": "Show the video title on the start screen if set to true. Hide it if set to false.", "type": "boolean", "default": true },
"showDescription": {
"description": "Show the video description on the start screen if set to true. Hide it if set to false.",
"type": "boolean",
"default": true
},
"titleFont": {
"description": "Defines the color of the font of the video title on the start screen. The default color is white.",
"type": "object",
"additionalProperties": false,
"properties": {
"color": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
}
}
/*"$ref": "#/definitions/fontStyle"*/
},
"descriptionFont": {
"description": "Defines the font of the video description on the start screen. The default font family is ArialMT, the default size is 16, and the default color is white.",
"type": "object",
"additionalProperties": false,
"properties": {
"color": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
}
}
/*"$ref": "#/definitions/fontStyle"*/
},
// TODO: could we support a 'none' enum?
"infoPanelPosition": {
"description": "Defines the position of the information panel on the start screen.",
"enum": [ "topLeft", "topRight", "bottomLeft", "bottomRight" ],
"default": "topLeft"
}
}
},
"pauseScreen": {
"description": "The screen displayed when playback is paused.",
"type": "object",
"properties": {
"pauseIconStyle": {
"description": "Default color is white with an opacity of 1.",
"$ref": "#/definitions/iconStyle"
},
"screenToShowOnPause": { // TODO: this is not used in the mobile code, that I could find with grep,
// TODO: what is "default"!? We could use more explicit naming.
"description": "Defines the screen to show when the player is paused.",
"enum": ["default", "discovery"],
"default": "default"
},
// TODO: showPauseIcon could be folded into pauseIconPosition as a 'none' enum value.
"showPauseIcon": {
"description": "Show the pause icon on the pause screen if set to true. Hide it if set to false.",
"type": "boolean",
"default": true
},
"pauseIconPosition": {
"description": "Defines the position of the pause icon on the pause screen.",
"enum": [ "center", "topLeft", "topRight", "bottomLeft", "bottomRight" ],
"default": "center"
},
"showTitle": {
"description": "Show the video title on the pause screen if set to true. Hide it if set to false.",
"type": "boolean",
"default": true
},
"showDescription": {
"description": "Show the video description on the pause screen if set to true. Hide it if set to false.",
"type": "boolean",
"default": true
},
"infoPanelPosition": {
"description": "Defines the position of the information panel on the pause screen.",
"enum": [ "topLeft", "topRight", "bottomLeft", "bottomRight" ],
"default": "topLeft"
}
}
},
"endScreen": {
"description": "The screen displayed after an asset has completed playing.",
"type": "object",
"properties": {
"replayIconStyle": {
"description": "The default color is white with an opacity of 1.",
/**/
"type": "object",
"additionalProperties": false,
"properties": {
"color": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"opacity": {
"description": "A floating-point number ranging from 0.0 (fully transparent) to 1.0 (fully opaque).",
"type": "number"
},
"active": {
"color": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"opacity": {
"description": "A floating-point number ranging from 0.0 (fully transparent) to 1.0 (fully opaque).",
"type": "number"
}
},
"inactive": {
"color": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"opacity": {
"description": "A floating-point number ranging from 0.0 (fully transparent) to 1.0 (fully opaque).",
"type": "number"
}
},
"shadowColor": {
"type": "string"
},
"shadowOffset": {
"type": "object",
"properties": {
"width": {"type": "number"},
"height": {"type": "number"}
}
},
"shadowOpacity": {
"type": "number"
},
"shadowRadius": {
"type": "number"
},
"borderColor": {
"type": "string"
},
"borderRadius": {
"type": "number"
},
"borderWidth": {
"type": "number"
},
"borderStyle": {
"type": "string",
"enum": ["solid", "dotted", "dashed"]
}
}
/*"$ref": "#/definitions/iconStyle"*/
},
"screenToShowOnEnd": {
"description": "Defines the screen to show when the video playback has ended.",
"type": "string",
// TODO: what is "default"!? We could use more explicit naming.
"enum": ["default", "discovery"],
"default": "discovery"
},
"showReplayButton": {
"description": "Set to true to show the replay button on the end screen. Set to false otherwise.",
"type": "boolean",
"default": "true"
},
"showTitle": {
"description": "Show the video title on the end screen if set to true. Hide it if set to false.",
"type": "boolean",
"default": false
},
"showDescription": {
"description": "Show the video description on the end screen if set to true. Hide it if set to false.",
"type": "boolean",
"default": false
},
"infoPanelPosition": {
"description": "Defines the position of the information panel on the end screen.",
"enum": [ "topLeft", "topRight", "bottomLeft", "bottomRight" ],
"default": "topLeft"
}
}
},
"adScreen": {
"description": "The screen to show during ads playback",
"type": "object",
"properties": {
"showAdMarquee": {
"description": "Show the ad marquee during ad playback if set to true, hide it if set to false.",
"type": "boolean",
"default": "true"
},
"showAdCountDown": {
"description": "Show the ad count down during ad playback if set to true, hide it if set to false.",
"type": "boolean",
"default": "true"
},
"showControlBar": {
"description": "Show the player control bar during ad playback if set to true. Hide the control bar when a video ad is playing by setting showControlBar to false. If showControlBar is missing or set to true, the control bar will appear while an ad is playing on your player.",
"type": "boolean",
"default": "false"
}
}
},
"discoveryScreen": {
"description": "The screen showing other recommended content.",
"type": "object",
"properties": {
"panelTitle": {
"description": "Defines properties of the title panel in the Discovery screen.",
"type": "object",
"additionalProperties": false,
"required": [ "titleFont" ],
"properties": {
"titleFont": {
"type": "object",
"description": "The font of the title",
"$ref": "#/definitions/fontStyle"
}
}
},
"contentTitle": {
"description": "The setting for Discovery content title.",
"type": "object",
"additionalProperties": false,
"required": [ "show", "font" ],
"properties": {
"show": {
"description": "Set to true to display the video duration on the Discovery screen, set to false otherwise.",
"type": "boolean",
"default": true
},
"font": {"$ref": "#/definitions/fontStyle"}
}
},
"showCountDownTimerOnEndScreen": {
"description": "Whether or not to show the countdown timer for autoplay.",
"type": "boolean",
"default": false
},
"countDownTime": {
"description": "How many seconds to wait before automatically playing the recommended video",
"type": "number"
}
}
},
"shareScreen": {
"description": "The social share panel setting",
"type": "object",
"properties": {
"shareContent": {
"description": "Describes which tabs should be shown on social screen (social, embed)",
"type": "array",
"default": ["social", "embed"]
},
"socialContent": {
"description": "Describes which buttons should be shown on the social share tab of the share panel",
"type": "array",
"default": ["twitter", "facebook", "google+", "email"]
},
"embed": {
"description": "The setting for embed tabs in social share screen",
"type": "object",
"properties": {
"source": {"type": "string"}
}
}
}
},
"moreOptionsScreen": {
"description": "The more options / overflow panel. The set of items to show comes from the 'buttons' part of the schema.",
"type": "object",
"required": ["iconSize", "color"], // TODO: anything else? Are there defaults in code for the opacities?
"additionalProperties": false,
"patternProperties": {
"brightOpacity": {"type": "number"},
"darkOpacity": {"type": "number"}
},
"properties": {
"iconSize": {"type": "number"},
"color": {"$ref": "#/definitions/color"},
"iconStyle": {
"description": "Default color is white with an opacity of 1",
"$ref": "#/definitions/iconStyle"
}
}
},
"closedCaptionOptions": {
"description": "Settings regarding closed captioning.",
"type": "object",
"properties": {
// TODO: What is "defaultEnabled"? Mobile doesn't use it anywhere.
"defaultEnabled": {
"description": "Enabled closed captions by default if set to true, disable otherwise.",
"type": "boolean",
"default": true
},
"defaultLanguage": {
"description": "Set the default closed-caption language. This is a string of the form \"en\" for English, \"fr\" for French, etc.",
"type": "string",
"default": "en"
}
}
},
"upNext": {
"description": "The screen to show as an asset is ending, indicating what assets can follow.",
"type": "object",
"properties": {
// TODO: showUpNext could be folded into timeToShow using "oneOf".
"showUpNext": {
"description": "Optional parameter used to show the Up Next screen if set to true, or hide the screen if set to false.",
"type": "boolean",
"default": "If no value is provided for showUpNext and timeToShow, showUpNext will default to false."
},
"timeToShow": {
"description": "Optional floating-point parameter used to set the time relative to the video length to show the Up Next screen. When timeToShow is set to a value greater than 1.0, the player interprets that number as the number of seconds before the end of the video to show the Up Next screen. However, when timeToShow is less than 1.0, the player treats the decimal value as a percentage of the video length and shows the Up Next screen at that point in the video. For example, if timeToShow is set to 0.9 in a 60-second video, the Up Next screen will show at 54 seconds. If timeToShow is set to 5.0 in a 60-second video, the Up Next screen will show at 55 seconds.",
"type": "number",
"default": "If showUpNext is set to true and no value is given for timeToShow, the Up Next dialog will default to showing 10 seconds prior to the end of the video. If no value is given for showUpNext, or it is set to false, the value set in timeToShow has no effect because the Up Next screen is never shown."
}
}
},
"playbackSpeed": {
"description": "Configuration values for the \"Playback Speed\" controls",
"type": "object",
"required": [ "options" ],
"properties": {
"options": {
"description": "The list of playback speed rates that are shown in the \"Playback Speed\" menu",
"type": "array",
"default": "Will contain the following values by default: 0.5, 0.75, 1, 1.25, 1.5, 2",
"minItems": 2,
"maxItems": 10,
"uniqueItems": true,
"items": {
"type": "number",
"minimum": 0.5,
"maximum": 2
}
}
}
},
"skipControls": {
"description": "Toolbar which contains buttons that allow skipping back or forward and switching to the previous or next videos.",
"type": "object",
"required": [ "enabled", "skipBackwardTime", "skipForwardTime", "buttons", "controlBarSkipControls" ],
"properties": {
"enabled": {
"description": "Show the \"Skip Controls\" toolbar if set to true, hide if set to false.",
"type": "boolean"
},
"skipBackwardTime": {
"description": "An integer number ranging from 1 to 60. Controls the amount of seconds that the playhead moves when the \"Skip Backward\" button is clicked.",
"type": "number",
"minimum": 1,
"maximum": 99
},
"skipForwardTime": {
"description": "An integer number ranging from 1 to 60. Controls the amount of seconds that the playhead moves when the \"Skip Forward\" button is clicked.",
"type": "number",
"minimum": 1,
"maximum": 99
},
"buttons": {
"description": "The collection of buttons that can be displayed on the \"Skip Controls\" toolbar.",
"type": "object",
"properties": {
"previousVideo": {
"description": "Button that allows switching to the last video that was played or to the previous video in a playlist.",
"$ref": "#/definitions/skipControlsButton"
},
"skipBackward": {
"description": "Button that allows skipping the video backward the amount of seconds defined in \"skipBackwardTime\".",
"$ref": "#/definitions/skipControlsButton"
},
"skipForward": {
"description": "Button that allows skipping the video forward the amount of seconds defined in \"skipForwardTime\".",
"$ref": "#/definitions/skipControlsButton"
},
"nextVideo": {
"description": "Button that allows switching to the next video recommendation or to the next video in a playlist.",
"$ref": "#/definitions/skipControlsButton"
}
}
},
"controlBarSkipControls": {
"description": "The collection of skip controls buttons that can be displayed in the control bar.",
"type": "object",
"properties": {
"previousVideo": {
"description": "Button that allows switching to the last video that was played or to the previous video in a playlist.",
"$ref": "#/definitions/skipControlsButton"
},
"skipBackward": {
"description": "Button that allows skipping the video backward the amount of seconds defined in \"skipBackwardTime\".",
"$ref": "#/definitions/skipControlsButton"
},
"skipForward": {
"description": "Button that allows skipping the video forward the amount of seconds defined in \"skipForwardTime\".",
"$ref": "#/definitions/skipControlsButton"
},
"nextVideo": {
"description": "Button that allows switching to the next video recommendation or to the next video in a playlist.",
"$ref": "#/definitions/skipControlsButton"
},
"playPause": {
"description": "Button that allows playback or pausing of the video.",
"$ref": "#/definitions/skipControlsButton"
}
}
}
}
},
"castControls": {
"description": "Toolbar for cast which contains buttons that allow skipping back or forward, switching to the previous or next videos in cast mode and show button to display cast devices",
"type": "object",
"required": [
"enabled",
"skipBackwardTime",
"skipForwardTime",
"buttons",
"iconStyle"
],
"properties": {
"enabled": {
"description": "Show the \"Cast button\" if set to true, hide if set to false.",
"type": "boolean",
"default": false
},
"skipBackwardTime": {
"description": "An integer number ranging from 1 to 60. Controls the amount of seconds that the playhead moves when the \"Skip Backward\" button is clicked in cast mode.",
"type": "number",
"minimum": 1,
"maximum": 60,
"default": 15
},
"skipForwardTime": {
"description": "An integer number ranging from 1 to 60. Controls the amount of seconds that the playhead moves when the \"Skip Forward\" button is clicked in cast mode.",
"type": "number",
"minimum": 1,
"maximum": 60,
"default": 15
},
"buttons": {
"description": "The collection of buttons that can be displayed on the \"Cast Controls\" toolbar.",
"type": "object",
"properties": {
"previousVideo": {
"description": "Button that allows switching to the last video that was played or to the previous video in a playlist.",
"$ref": "#/definitions/castControlsButton"
},
"skipBackward": {
"description": "Button that allows skipping the video backward the amount of seconds defined in \"skipBackwardTime\".",
"$ref": "#/definitions/castControlsButton"
},
"skipForward": {
"description": "Button that allows skipping the video forward the amount of seconds defined in \"skipForwardTime\".",
"$ref": "#/definitions/castControlsButton"
},
"nextVideo": {
"description": "Button that allows switching to the next video recommendation or to the next video in a playlist.",
"$ref": "#/definitions/castControlsButton"
}
}
},
"iconStyle": {
"description": "Provide possibility to change color of cast elements. The default color is #3eb5f7",
"type": "object",
"additionalProperties": false,
"properties": {
"active": {
"color": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string",
"default": "#3eb5f7"
}
},
"inactive": {
"color": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string",
"default": "#FFFFFF"
}
}
}
}
}
},
"controlBar": {
"description": "The playback control bar. Generally contains a play-pause button, scrubber control, etc. The set of items to show comes from the 'buttons' part of the schema.",
"type": "object",
"additionalProperties": false,
"required": [ "height", "autoHide", "logo" ],
"properties": {
"enabled": {
"description": "Show the control bar if set to true. Hide the control bar if set to false. Default is true.",
"type": "boolean",
"default": true
},
"volumeControl": {
"description": "Defines color of volume control in control bar.",
"type": "object",
"color": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string",
"platform support": {
"iOS SDK": "Unsupported",
"Android SDK": "v4.21.0+"
}
}
},
"iconStyle": {
"description": "The default color is #8E8E8E with an opacity of 1.",
"type": "object",
"additionalProperties": false,
"properties": {
"active": {
"color": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"opacity": {
"description": "A floating-point number ranging from 0.0 (fully transparent) to 1.0 (fully opaque).",
"type": "number"
}
},
"inactive": {
"color": {
"description": "Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"opacity": {
"description": "A floating-point number ranging from 0.0 (fully transparent) to 1.0 (fully opaque).",
"type": "number"
}
},
"shadowColor": {
"type": "string"
},
"shadowOffset": {
"type": "object",
"properties": {
"width": {"type": "number"},
"height": {"type": "number"}
}
},
"shadowOpacity": {
"type": "number"
},
"shadowRadius": {
"type": "number"
},
"borderColor": {
"type": "string"
},
"borderRadius": {
"type": "number"
},
"borderWidth": {
"type": "number"
},
"borderStyle": {
"type": "string",
"enum": ["solid", "dotted", "dashed"]
}
}
/*"$ref": "#/definitions/iconStyle"*/
},
"height": {
"height": "Height of the control bar.",
"type": "number",
"default": 90
},
"autoHide": {
"description": "The control bar is automatically hidden during video playback when the mouse is not in the control bar area if and only if this parameter is set to true.",
"type": "boolean",
"default": true
},
"logo": {
"description": "An object that defines the content and position of the logo image on the control bar.",
"type": "object",
"additionalProperties": false,
"properties": {
"imageResource": { "$ref": "#/definitions/image" },
"clickUrl": {"type": "string"},
"target": {"type": "string"},
"width": {"type": "number"},
"height": {"type": "number"}
}
},
"scrubberBar": {
"additionalProperties": false,
"properties": {
"backgroundColor": {
"description": "The color of the scrubber bar background. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"bufferedColor": {
"description": "The color to indicate buffered content in the scrubber bar. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"playedColor": {
"description": "The color to indicate played content in the scrubber bar. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"scrubberHandleColor": {
"description": "The color of the draggable scrubber object in the scrubber bar. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string",
"platform support": {
"iOS SDK": "v4.21.0+",
"Android SDK": "v4.21.0+"
}
},
"scrubberHandleBorderColor": {
"description": "The color of the border around the scrubber handle. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string",
"platform support": {
"iOS SDK": "v4.21.0+",
"Android SDK": "v4.21.0+"
}
},
"thumbnailPreview": {
"description": "The color to the draggable scrubber object in the scrubber bar. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "boolean"
}
}
},
"adScrubberBar": {
"additionalProperties": false,
"properties": {
"backgroundColor": {
"description": "The color of the scrubber bar background. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"bufferedColor": {
"description": "The color to indicate buffered content in the scrubber bar. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"playedColor": {
"description": "The color to indicate played content in the scrubber bar. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string"
},
"scrubberHandleColor": {
"description": "The color to the draggable scrubber object in the scrubber bar. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string",
"platform support": {
"iOS SDK": "v4.21.0+",
"Android SDK": "v4.21.0+"
}
},
"scrubberHandleBorderColor": {
"description": "The color of the border around the scrubber handle. Any valid CSS color value (named colors, three-digit hex color, six-digit hex color, RGB colors).",
"type": "string",
"platform support": {
"iOS SDK": "v4.21.0+",
"Android SDK": "v4.21.0+"
}
}
}
},
"tooltips":{
"description": "Configuration for the control bar items tooltips.",
"type": "object",
"properties":{
"enabled": {
"description": "Show the control bar items tooltips if set to true. Hide the control bar items tooltips if set to false. Default is false.",
"type": "boolean",
"default": "false"
}
}
},
"qualitySelection":{
"description":"Configuration for the control bar quality selection panel/popover",
"type":"object",
"properties":{
"format":{
"description":"Determine the format of the quality options. Available formats: bitrate only, resolution only, and resolution + bitrate.",
"type":"string",
"enum": ["bitrate", "resolution", "resolution bitrate"],
"default":"bitrate"
}
}
}
}
},
"live": {
"description": "Configuration for UI when it playbacks live assets.",
"type": "object",
"additionalProperties": false,
"required": [ "forceDvrDisabled" ],
"properties": {
"forceDvrDisabled": {
"descriptipon": "Force the Scrubber bar to be hidden during live streams, regardless of if DVR is available",
"type": "boolean"
}
}
},
"isVrAnimationEnabled": {
"description": "Show vrNotification or vrIcon if vrNotification or vrNotification are marked as true",
"type": "object",
"properties": {
"vrNotification": {
"description": "Vr notification should be shown",
"type": "boolean",
"default": "If no value is provided for vrNotification, vrNotification will default to true."
},
"vrIcon": {
"description": "Vr icon should be shown",
"type": "boolean",
"default": "If no value is provided for vrIcon, vrIcon will default to false."
}
}
},
"audio": {
"description": "Configuration for audio",
"type": "object",
"properties": {
"audioLanguage": {
"description": "Set the default audio language. This is a string of the form \"en\" for English, \"fr\" for French, etc.",
"type": "string",
"default": "en"
}
}
},
"animationDurations": {
"description": "Sets duration for VR animation",
"type": "object",
"vrNotification": {
"description": "Duration for VR Notification",
"type": "number",
"default": 5
},
"vrIcon": {
"description": "Duration for vrIcon",
"type": "number",
"default": 4
}
},
"buttons": {
"description": "Defines the buttons that can appear on the controlBar and/or the moreOptions panel. Desktop and Mobile platforms can be configured individually.",
"type": "object",
"additionalProperties": false,
"required": ["desktopContent", "mobileContent", "audioOnly"],
"properties": {
"desktopContent": { "$ref": "#/definitions/buttonArray" },
"desktopAd": { "$ref": "#/definitions/buttonArray" },
"mobileContent": { "$ref": "#/definitions/buttonArray" },
"mobileAd": { "$ref": "#/definitions/buttonArray" },
"audioOnly": {
"description": "Defines the buttons that can appear in the audio only view on the controlBar and/or the moreOptions panel. Desktop and Mobile platforms can be configured individually.",
"type": "object",
"required": ["desktop", "mobile"],
"additionalProperties": false,
"properties": {
"desktop": { "$ref": "#/definitions/buttonArray" },
"mobile": { "$ref": "#/definitions/buttonArray" }
}
}
}
},
"icons": {
"description": "The set of all required icons, for rendering all the various buttons' states.",
"type": "object",
"patternProperties": { "": { "$ref": "#/definitions/icon" } },
"required": ["play", "pause", "volume", "volumeOff", "expand", "compress", "ellipsis", "replay", "next", "previous", "forward", "share", "cc", "discovery", "quality", "setting", "dismiss", "toggleOff", "toggleOn", "left", "right", "audioAndCC", "selected"],
"example": ["\"icons\": {",
"\"play\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u003e\", \"fontStyleClass\": \"icon icon-play\"},",
"\"pause\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0067\", \"fontStyleClass\": \"icon icon-pause\"},",
"\"volume\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0061\", \"fontStyleClass\": \"icon icon-volume-desktop\"},",
"\"volumeOff\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0070\", \"fontStyleClass\": \"icon icon-volume-desktop\"},",
"\"expand\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0069\", \"fontStyleClass\": \"icon icon-resize-large\"},",
"\"compress\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u006a\", \"fontStyleClass\": \"icon icon-resize-small\"},",
"\"ellipsis\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0066\", \"fontStyleClass\": \"icon icon-menu\"},",
"\"replay\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0063\", \"fontStyleClass\": \"icon icon-upnext-replay\"},",
"\"next\": {\"fontFamilyName\": \"alice", "fontString\": \"\\u0044\", \"fontStyleClass\": \"icon icon-next\"},",
"\"previous\": {\"fontFamilyName\": \"alice", "fontString\": \"\\u003c\", \"fontStyleClass\": \"icon icon-previous\"},",
"\"forward\": {\"fontFamilyName\": \"alice", "fontString\": \"\\u0028\", \"fontStyleClass\": \"icon icon-forward\"},",
"\"share\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u006f\", \"fontStyleClass\": \"icon icon-topmenu-share\"},",
"\"cc\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u006B\", \"fontStyleClass\": \"icon icon-topmenu-cc\"},",
"\"discovery\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u006C\", \"fontStyleClass\": \"icon icon-topmenu-discovery\"},",
"\"quality\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u006D\", \"fontStyleClass\": \"icon icon-topmenu-quality\"},",
"\"setting\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u006E\", \"fontStyleClass\": \"icon icon-topmenu-settings\"},",
"\"dismiss\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0065\", \"fontStyleClass\": \"icon icon-close\"},",
"\"toggleOn\": { \"fontFamilyName\": \"fontawesome\", \"fontString\": \"\\uf205\", \"fontStyleClass\": \"\"},",
"\"toggleOff\": { \"fontFamilyName\": \"fontawesome\", \"fontString\": \"\\uf204\", \"fontStyleClass\": \"\"},",
"\"left\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0072\", \"fontStyleClass\": \"icon icon-left\"},",
"\"right\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0073\", \"fontStyleClass\": \"icon icon-right\"},",
"\"learn\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0074\", \"fontStyleClass\": \"icon icon-learn\"},",
"\"skip\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0075\", \"fontStyleClass\": \"icon icon-skip\"}",
"\"audioAndCC\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u005F\", \"fontStyleClass\": \"icon icon-audio-and-cc\"}",
"\"selected\": { \"fontFamilyName\": \"alice\", \"fontString\": \"\\u0040\", \"fontStyleClass\": \"icon icon-selected\"}",
"\"chromecast-connected\": {\"fontFamilyName\": \"ooyala-slick-type\", \"fontString\": \"\\u003B\", \"fontStyleClass\": \"oo-icon\"}",
"\"chromecast-disconnected\": {\"fontFamilyName\": \"ooyala-slick-type\", \"fontString\": \"\\u003A\", \"fontStyleClass\": \"oo-icon\"}",
"}"],
"play": {
"description": "Set the styling for the play icon on mobile devices.",
"type": "object",
"required": ["fontFamilyName", "fontString", "fontStyleClass"],
"fontFamilyName": {
"description": "The name of the font family to use.",
"type": "string",
"default": "alice"
},
"fontString": {
"description": "The string used for displaying the icon. (Usually a single Unicode code point.)",
"type": "string",
"default": "\\u0068"
},