-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathproperties.schema
252 lines (252 loc) · 8.58 KB
/
properties.schema
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
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"id": "http://jsonschema.net",
"$ref": "http://localhost/plugins/content/component/model.schema",
"globals": {
"ariaRegion": {
"type": "string",
"required": true,
"title": "YouTube: ARIA region",
"default": "This is a media component which displays a YouTube video. Select the play / pause button to watch it.",
"inputType": "Text",
"validators": []
},
"skipToTranscript": {
"type": "string",
"required": true,
"default": "Skip to transcript",
"inputType": "Text",
"validators": [],
"translatable": true
}
},
"properties": {
"_supportedLayout": {
"type": "string",
"required": true,
"enum": ["full-width", "half-width", "both"],
"default": "both",
"editorOnly": true
},
"instruction": {
"type": "string",
"required": false,
"default": "Select the play button to start the video.",
"inputType": "Text",
"validators": [],
"help": "This is the instruction text",
"translatable": true
},
"_setCompletionOn": {
"type": "string",
"required": true,
"enum": ["inview", "play", "ended"],
"default": "play",
"title": "Set completion of Video on",
"inputType": {"type": "Select", "options":["inview", "play", "ended"]},
"validators": ["required"],
"help": "Defines what media event should trigger completion of this component."
},
"_media": {
"type": "object",
"required": true,
"title": "Media settings",
"properties": {
"_source": {
"type": "string",
"required": true,
"default": "",
"title": "Source URL",
"inputType": "Text",
"editorAttrs": {
"placeholder": "//www.youtube.com/embed/jNQXAC9IVRw"
},
"validators": [],
"help": "The 'embed' URL of the YouTube video you want to be displayed"
},
"_controls": {
"type": "boolean",
"required": false,
"default": true,
"title": "Show Player Controls",
"inputType": "Checkbox",
"validators": [],
"help": "Specifies whether or not the player controls are displayed."
},
"_allowFullscreen": {
"type": "boolean",
"required": false,
"default": true,
"title": "Allow Fullscreen?",
"inputType": "Checkbox",
"validators": []
},
"_playsinline": {
"type": "boolean",
"required": false,
"default": false,
"title": "If enabled, videos will play 'inline' on iPhones (the same way they do on iPads).",
"inputType": "Checkbox",
"validators": []
},
"_aspectRatio": {
"type": "number",
"required": false,
"default": 1.778,
"title": "Aspect ratio",
"inputType": "Text",
"validators": [],
"help": "The aspect ratio of the video as a decimal number. If the aspect ratio is 16:9 then you calculate the decimal version by dividing 16 by 9 i.e. 1.778. 4:3 aspect ratio is 1.33"
},
"_autoplay": {
"type": "boolean",
"required": false,
"default": false,
"title": "Autoplay",
"inputType": "Checkbox",
"validators": [],
"help": "Specifies whether or not the video will automatically start to play when the player loads (not supported on iOS)."
},
"_showRelated": {
"type": "boolean",
"required": false,
"default": false,
"title": "Show related videos",
"inputType": "Checkbox",
"validators": [],
"help": "Since Sept 2018 the YouTube player no longer allows you to prevent related videos from being shown - see https://developers.google.com/youtube/player_parameters#rel"
},
"_loop": {
"type": "boolean",
"required": false,
"default": false,
"title": "Loop",
"inputType": "Checkbox",
"validators": [],
"help": "Whether to play the video on a loop or not."
},
"_modestBranding": {
"type": "boolean",
"required": false,
"default": true,
"title": "Modest branding",
"inputType": "Checkbox",
"validators": [],
"help": "This parameter lets you use a YouTube player that does not show a YouTube logo. Set to true to prevent the YouTube logo from displaying in the control bar. Note that a small YouTube text label will still display in the upper-right corner of a paused video when the user's mouse pointer hovers over the player."
},
"_playbackQuality": {
"type": "string",
"required": false,
"default": "default",
"title": "Playback quality",
"enum": ["default", "small", "medium", "large", "hd720", "hd1080", "highres"],
"inputType": {
"type": "Select",
"options": ["default", "small", "medium", "large", "hd720", "hd1080", "highres"]
},
"validators": [],
"help": "The suggested video quality for the video. You should select a playback quality that corresponds to the size of your video player. For example, if your page displays a 1280px by 720px video player, a hd720 quality video will actually look better than an hd1080 quality video."
},
"_showAnnotations": {
"type": "boolean",
"required": false,
"default": false,
"title": "Video annotations",
"inputType": "Checkbox",
"validators": [],
"help": "Whether video annotations should be shown or not."
},
"_progressColor": {
"type": "string",
"required": false,
"default": "default",
"title": "Progress bar color",
"enum": ["red", "white"],
"inputType": {
"type": "Select",
"options": ["red", "white"]
},
"validators": [],
"help": "The colour that will be used in the player's video progress bar to highlight the amount of the video that the viewer has already seen. Setting this to 'white' will disable the 'modest branding' option."
}
}
},
"_transcript": {
"type": "object",
"required": false,
"title": "Transcript Options",
"properties": {
"_setCompletionOnView": {
"type": "boolean",
"required": false,
"default": true,
"title": "Mark this component as complete when transcript is shown",
"inputType": "Checkbox",
"validators": []
},
"_inlineTranscript": {
"type": "boolean",
"required": false,
"default": false,
"title": "Enable inline transcript",
"inputType": "Checkbox",
"validators": []
},
"_externalTranscript": {
"type": "boolean",
"required": false,
"default": false,
"title": "Enable linked transcript file",
"inputType": "Checkbox",
"validators": []
},
"inlineTranscriptButton": {
"type": "string",
"required": false,
"default": "",
"title": "Inline transcript open button label",
"inputType": "Text",
"validators": [],
"translatable": true
},
"inlineTranscriptCloseButton": {
"type": "string",
"required": false,
"default": "",
"title": "Inline transcript close button label",
"inputType": "Text",
"validators": [],
"translatable": true
},
"inlineTranscriptBody": {
"type": "string",
"required": false,
"default": "",
"title": "Inline Transcript",
"inputType": "TextArea",
"validators": [],
"translatable": true
},
"transcriptLinkButton": {
"type": "string",
"required": false,
"default": "",
"title": "Linked transcript file button label",
"inputType": "Text",
"validators": [],
"translatable": true
},
"transcriptLink": {
"type": "string",
"required": false,
"default": "",
"title": "Linked transcript file source",
"inputType": "Asset:other",
"validators": [],
"help": "Select a file for the transcript link"
}
}
}
}
}