forked from kaltura/developer-platform
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ovp.LucyBot.yml
559 lines (512 loc) · 21.4 KB
/
ovp.LucyBot.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
specifications:
kaltura:
- openapi: ./ovp.openapi.json
css:
- assets/ovp.css
workflowDirectory: workflows/ovp
sitemap:
hostname: https://developer.kaltura.com
discussionURL: '/discussion/{{slug}}?title={{title}}'
routes:
default: /404-not-found
/:
redirect: '/api-docs'
/404-not-found:
title: Page not found
ui: markdown
markdownFile: './markdown/404.html'
/api-docs:
title: Kaltura API Documentation
for: kaltura
navigation: operationNavigation
meta:
title: "Kaltura VPaaS API Documentation"
description: "Full documentation for the Kaltura VPaaS API"
/console:
ui: console
for: kaltura
title: Kaltura API Console
meta:
title: "Kaltura VPaaS API Console"
description: "Make test calls to the Kaltura VPaaS API"
/workflows:
ui: workflows
for: kaltura
navigation: workflowNavigation
intro: |
Interactive workflows on this page will help you dive straight
into coding the various building blocks of your application.
Here you will find working code workflows together with detailed
explanations and documentation references.
#### What do you want to do today?
title: Workflows
icons: offset
meta:
title: "Kaltura API Workflows"
description: "Learn how to work with the Kaltura API using interactive workflows"
/new-workflow:
ui: workflow
for: kaltura
/preview-workflow:
ui: workflow
for: kaltura
/recipes:
redirect: '/workflows'
/recipes/ad_cue_points:
redirect: '/workflows/Engage_and_Publish/Advertisement_Cue_Points'
/recipes/analytics:
redirect: '/workflows/Review_Media_Analytics/Analytics_Reports'
/recipes/app_tokens:
redirect: '/workflows/Generate_API_Sessions/App_Token_Authentication'
/recipes/authentication:
redirect: '/workflows/Generate_API_Sessions/Authentication'
/recipes/backend_notifications:
redirect: '/workflows/Integration_Scheduling_and_Hooks/Backend_and_Email_Notifications'
/recipes/captions:
redirect: '/workflows/Enrich_and_Organize_Metadata/Captions'
/recipes/code_cue_points:
redirect: '/workflows/Engage_and_Publish/Cue_Points'
/recipes/dynamic_thumbnails:
redirect: '/workflows/Engage_and_Publish/Animated_Thumbnails_with_CSS_Stripes'
/recipes/leaderboard_reports:
redirect: '/workflows/Integration_Scheduling_and_Hooks/Leaderboard_Reports'
/recipes/live_broadcast:
redirect: '/workflows/Live_Stream_and_Broadcast'
/recipes/metadata:
redirect: '/workflows/Enrich_and_Organize_Metadata/Working_with_metadata'
/recipes/player_external_skin_overrides:
redirect: '/workflows/Engage_and_Publish/Kaltura_Player_External_Skin_Overrides'
/recipes/player_uiconf:
redirect: '/workflows/Engage_and_Publish/Player_UI_conf'
/recipes/quiz:
redirect: '/workflows/Engage_and_Publish/Quiz'
/recipes/upload:
redirect: '/workflows/Ingest_and_Upload_Media'
/recipes/using_css_states:
redirect: '/workflows/Engage_and_Publish/Using_CSS_states'
/recipes/video_search:
redirect: '/workflows/Search_Discover_and_Personalize/Kaltura_Media_Library_Search'
/recipes/webvtt_captions:
redirect: '/workflows/Enrich_and_Organize_Metadata/Serve_WebVTT_Captions'
operationNavigation:
- title: "Overview"
markdownURL: /assets/documentation/overview.html
discussionURL: null
meta:
title: "Kaltura VPaaS API Overview"
description: "Learn how to use the Kaltura VPaaS API"
- title: "VPaaS API Getting Started"
path: "/VPaaS-API-Getting-Started"
children:
- title: "Get Started with Kaltura VPaaS"
markdownURL: /assets/documentation/VPaaS-API-Getting-Started/Getting-Started-VPaaS-API.html
path: "/VPaaS-API-Getting-Started/Getting-Started-VPaaS-API.html"
discussionURL: null
- title: "How to Create a Kaltura Session"
markdownURL: /assets/documentation/VPaaS-API-Getting-Started/how-to-create-kaltura-session.html
path: "/VPaaS-API-Getting-Started/how-to-create-kaltura-session.html"
discussionURL: null
- title: "Kaltura API Authentication and Security"
markdownURL: /assets/documentation/VPaaS-API-Getting-Started/Kaltura_API_Authentication_and_Security.html
path: "/VPaaS-API-Getting-Started/Kaltura_API_Authentication_and_Security.html"
discussionURL: null
- title: "Introduction to Kaltura's Client Libraries"
markdownURL: /assets/documentation/VPaaS-API-Getting-Started/introduction-kaltura-client-libraries.html
path: "/VPaaS-API-Getting-Started/introduction-kaltura-client-libraries.html"
discussionURL: null
- title: "How to use Kaltura's API Abstract Classes"
markdownURL: /assets/documentation/VPaaS-API-Getting-Started/how-use-kaltura-api-abstract-classes.html
path: "/VPaaS-API-Getting-Started/how-use-kaltura-api-abstract-classes.html"
discussionURL: null
- title: "Application Token Session Management"
markdownURL: /assets/documentation/VPaaS-API-Getting-Started/application-token-session-management.html
path: "/VPaaS-API-Getting-Started/application-token-session-management.html"
discussionURL: null
- title: "Creating an Application Token"
markdownURL: /assets/documentation/VPaaS-API-Getting-Started/Account-Representative-Steps.html
path: "/VPaaS-API-Getting-Started/Account-Representative-Steps.html"
discussionURL: null
- title: "Authorizing with an Application Token"
markdownURL: /assets/documentation/VPaaS-API-Getting-Started/Authorizing-With-Application-Token.html
path: "/VPaaS-API-Getting-Started/Authorizing-With-Application-Token.html"
discussionURL: null
- title: "Generating Kaltura Sessions with Application Tokens"
markdownURL: /assets/documentation/VPaaS-API-Getting-Started/Generating-KS-with-App-Tokens.html
path: "/VPaaS-API-Getting-Started/Generating-KS-with-App-Tokens.html"
discussionURL: null
- title: "Client Libraries"
markdownFile: ./markdown/generated/client_libraries.md
disableEditLink: true
discussionURL: null
meta:
title: "Native Client Libraries"
description: "Download and learn how to use Kaltura's client libraries"
children:
- title: "Support Matrix"
markdownFile: ./markdown/generated/support_matrix.md
disableEditLink: true
- title: "XML Schemas"
markdownFile: ./markdown/schemas.md
children:
- title: 'Syndication Feed'
markdownURL: /assets/markdown/generated/syndication.md
disableEditLink: true
- title: 'Bulk Upload'
markdownURL: /assets/markdown/generated/bulkUploadXml.bulkUploadXML.md
disableEditLink: true
- title: 'Bulk Upload Results'
markdownURL: /assets/markdown/generated/bulkUploadXml.bulkUploadResultXML.md
disableEditLink: true
- title: 'Cue Point Serve'
markdownURL: /assets/markdown/generated/cuePoint.serveAPI.md
disableEditLink: true
- title: 'Cue Point Ingest'
markdownURL: /assets/markdown/generated/cuePoint.ingestAPI.md
disableEditLink: true
- title: 'Drop Folder'
markdownURL: /assets/markdown/generated/dropFolderXmlBulkUpload.dropFolderXml.md
disableEditLink: true
- title: "Generate API Sessions"
children:
- title: "session"
tag: "session"
children:
- operation: "session.start"
- operation: "session.end"
- operation: "session.get"
- operation: "session.impersonate"
- operation: "session.impersonateByKs"
- operation: "session.startWidgetSession"
- tag: "appToken"
- operation: 'user.loginByLoginId'
- title: "Ingest and Upload Media"
children:
- title: "Introduction to Content Preparation & Transcoding"
markdownURL: /assets/documentation/Ingest_and_Upload_Media/Content-Ingestion-Transcoding.html
path: "/Ingest_and_Upload_Media/Content-Ingestion-Transcoding.html"
discussionURL: null
- title: "Playlist Management"
markdownURL: /assets/documentation/Ingest_and_Upload_Media/playlist-management.html
path: "/Ingest_and_Upload_Media/playlist-management.html"
discussionURL: null
- title: "Bulk Content Ingestion API"
markdownURL: /assets/documentation/Ingest_and_Upload_Media/Bulk-Content-Ingestion.html
path: "/Ingest_and_Upload_Media/Bulk-Content-Ingestion.html"
discussionURL: null
- title: "Kaltura's Scheduling API Service"
markdownURL: /assets/documentation/Ingest_and_Upload_Media/schedulingAPI.html
path: "/Ingest_and_Upload_Media/schedulingAPI.html"
discussionURL: null
- title: "How to Ingest a Media File Bundled with Metadata (CSV, XML, API)"
markdownURL: /assets/documentation/Ingest_and_Upload_Media/how-ingest-media-file-bundled-metadata-csv-xml-api.html
path: "/Ingest_and_Upload_Media/how-ingest-media-file-bundled-metadata-csv-xml-api.html"
discussionURL: null
- title: "Create a New Kaltura Entry and Upload Video File using the Kaltura API"
markdownURL: /assets/documentation/Ingest_and_Upload_Media/create-new-kaltura-entry-and-upload-video-file-using-kaltura-api.html
path: "/Ingest_and_Upload_Media/create-new-kaltura-entry-and-upload-video-file-using-kaltura-api.html"
discussionURL: null
- tag: "uploadToken"
- tag: "media"
- tag: "captionAsset"
- tag: "captionParams"
- tag: "thumbAsset"
- tag: "attachmentAsset"
- tag: "externalMedia"
# `upload` service was deprecated in favour of `UploadToken`
- tag: "upload"
hide: true
- title: "Execute Bulk Ingest and Updates"
prerender: false
children:
- operation: "media.bulkUploadAdd"
- operation: "user.addFromBulkUpload"
- operation: "category.addFromBulkUpload"
- operation: "cuePoint.addFromBulk"
- operation: "categoryEntry.addFromBulkUpload"
- operation: "categoryUser.addFromBulkUpload"
- tag: "bulk"
- tag: "schema"
- tag: "dropFolder"
- tag: "dropFolderFile"
- tag: "virusScanProfile"
hide: true
- tag: "aspera"
hide: true
# `bulkUpload` service was deprecated in favour of `bulk`
- tag: "bulkUpload"
hide: true
- title: "Convert and Transcode Media"
children:
- title: "How to use the API to Add a New Conversion Profile"
markdownURL: /assets/documentation/Convert-and-Transcode-Media/how-use-api-add-new-conversion-profile.html
path: "/Convert-and-Transcode-Media/how-use-api-add-new-conversion-profile.html"
discussionURL: null
- title: "How to use the API to Add New Flavor Params"
markdownURL: /assets/documentation/Convert-and-Transcode-Media/how-use-api-add-new-flavor-params.html
path: "/Convert-and-Transcode-Media/how-use-api-add-new-flavor-params.html"
discussionURL: null
- title: "How to Use the API to Create a New Flavor Asset for an Existing Entry"
markdownURL: /assets/documentation/Convert-and-Transcode-Media/how-use-api-create-new-flavor-asset-existing-entry.html
path: "/Convert-and-Transcode-Media/how-use-api-create-new-flavor-asset-existing-entry.html"
discussionURL: null
- tag: "flavorAsset"
- tag: "flavorParams"
- tag: "flavorParamsOutput"
- tag: "conversionProfile"
- tag: "conversionProfileAssetParams"
- tag: "mediaInfo"
- title: "Live Stream and Broadcast"
prerender: false
children:
- tag: "liveStream"
- title: "Enrich and Organize Metadata"
children:
- title: "How to Retrieve Metadata of a Media Entry using the API?"
markdownURL: /assets/documentation/Enrich-and-Organize-Metadata/how-retrieve-metadata-media-entry-using-api.html
path: "/Enrich-and-Organize-Metadata/how-retrieve-metadata-media-entry-using-api.html"
discussionURL: null
- tag: "baseEntry"
- tag: "category"
- tag: "categoryEntry"
- tag: "categoryUser"
- tag: "media"
- tag: "metadata"
- tag: "metadataProfile"
- tag: "captionAsset"
- tag: "captionParams"
- tag: "captionAssetItem"
- tag: "attachmentAsset"
- tag: "thumbAsset"
- tag: "thumbParams"
- tag: "tag"
- title: "Search, Discover and Personalize"
children:
- title: "How to perform AND, OR, NOT and Exact Match searches in API"
markdownURL: /assets/documentation/Search--Discover-and-Personalize/how-search-kaltura-works-how-perform-and-or-not-and-exact-match-searches-api.html
path: "/Search--Discover-and-Personalize/how-search-kaltura-works-how-perform-and-or-not-and-exact-match-searches-api.html"
discussionURL: null
- operation: "baseEntry.list"
- tag: "media"
- tag: "captionAssetItem"
- tag: "playlist"
- tag: "like"
- tag: "shortLink"
- tag: "tag"
- tag: "user"
- tag: "groupUser"
- title: "Engage and Publish"
children:
- title: "Adding a Thumbnail Flavor Parameter that Supports Resizing Auto-generated Thumbnails"
markdownURL: /assets/documentation/Engage_and_Publish/how-add-thumbnail-flavor-param-supports-resizing-auto-generated-thumbnails-transcoding-profile.html
path: "/Engage_and_Publish/how-add-thumbnail-flavor-param-supports-resizing-auto-generated-thumbnails-transcoding-profile.html"
discussionURL: null
- title: "How To Create a Video Thumbnail Rotator in JavaScript"
markdownURL: /assets/documentation/Engage_and_Publish/how-create-video-thumbnail-rotator-javascript.html
path: "/Engage_and_Publish/how-create-video-thumbnail-rotator-javascript.html"
discussionURL: null
- title: "Kaltura Video Thumbnail and Image Transformation API"
markdownURL: /assets/documentation/Engage_and_Publish/kaltura-thumbnail-api.html
path: "/Engage_and_Publish/kaltura-thumbnail-api.html"
discussionURL: null
- tag: "playlist"
- tag: "thumbAsset"
- tag: "cuePoint"
- tag: "quiz"
- tag: "userEntry"
- tag: "like"
- tag: "uiConf"
- tag: "annotation"
hide: true
- title: "Media Analytics"
prerender: false
children:
- title: "How to Generate Interactive Video Quiz Reports Using the Kaltura API?"
markdownURL: /assets/documentation/Video-Analytics-and-Insights/how-generate-interactive-video-quiz-reports-using-kaltura-api.html
path: "/Video-Analytics-and-Insights/how-generate-interactive-video-quiz-reports-using-kaltura-api.html"
discussionURL: null
- title: "Kaltura's Media Analytics"
markdownURL: /assets/documentation/Video-Analytics-and-Insights/media-analytics.html
path: "/Video-Analytics-and-Insights/media-analytics.html"
discussionURL: null
- tag: "analytics"
- tag: "report"
- tag: "liveReports"
- tag: "liveStats"
- tag: "stats"
- title: "Deliver and Distribute Media"
prerender: false
children:
- title: "Video Search Engine Optimization (SEO)"
markdownURL: /assets/documentation/Deliver-and-Distribute-Media/videoSEO.html
path: "/Deliver-and-Distribute-Media/videoSEO.html"
discussionURL: null
- title: "The playManifest Service: Streaming API for Videos and Playlists"
markdownURL: /assets/documentation/Deliver-and-Distribute-Media/playManifest-streaming-api.html
path: "/Deliver-and-Distribute-Media/playManifest-streaming-api.html"
discussionURL: null
- tag: "playManifest"
- tag: "syndicationFeed"
- tag: "entryDistribution"
- tag: "distributionProfile"
- tag: "distributionProvider"
- tag: "deliveryProfile"
hide: true
- tag: "storageProfile"
- title: "Secure, Control and Govern"
children:
- title: "Content Categories Management"
markdownURL: /assets/documentation/Secure_Control_and_Govern/Content-Categories-Management.html
path: "/Secure_Control_and_Govern/Content-Categories-Management.html"
discussionURL: null
seeAlso:
- operation: "category.add"
- operation: "categoryEntry.add"
- operation: "categoryEntry.delete"
- title: "Content Entitlements and Privacy Enforcement"
markdownURL: /assets/documentation/Secure_Control_and_Govern/Content-Entitlements-Privacy-Enforcement.html
path: "/Secure_Control_and_Govern/Content-Entitlements-Privacy-Enforcement.html"
discussionURL: null
- title: "Access Control and Content Retrieval on Connected Devices"
markdownURL: /assets/documentation/Secure_Control_and_Govern/Access-Control-and-Content-Retrieval-on-Connected-Devices.html
path: "/Secure_Control_and_Govern/Access-Control-and-Content-Retrieval-on-Connected-Devices.html"
discussionURL: null
- title: "The Kaltura Media Access Control Model"
markdownURL: /assets/documentation/Secure_Control_and_Govern/kaltura-media-access-control-model.html
path: "/Secure_Control_and_Govern/kaltura-media-access-control-model.html"
discussionURL: null
- title: "Kaltura Audit-Trail - Viewer Example Application"
markdownURL: /assets/documentation/Secure_Control_and_Govern/Kaltura_Audit-Trail_Viewer_Example_Application.html
path: "/Secure_Control_and_Govern/Kaltura_Audit-Trail_Viewer_Example_Application.html"
discussionURL: null
- tag: "partner"
- tag: "user"
- tag: "userRole"
- tag: "groupUser"
- tag: "accessControlProfile"
- tag: "categoryEntry"
- tag: "categoryUser"
- tag: "permission"
- tag: "permissionItem"
# `accessControl` service was deprecated in favour of `accessControlProfile`
- tag: "accessControl"
hide: true
- tag: "adminUser"
hide: true
- tag: "auditTrail"
- title: "Optimize API Requests"
prerender: false
children:
- tag: "multirequest"
- tag: "responseProfile"
- title: "Integration, Scheduling and Hooks"
prerender: false
children:
- title: "How To Handle Kaltura Server Notifications in PHP"
markdownURL: /assets/documentation/Integration-Scheduling-and-Hooks/how-handle-kaltura-server-notifications-in-php.html
path: "/Integration-Scheduling-and-Hooks/how-handle-kaltura-server-notifications-in-php.html"
discussionURL: null
- tag: "eventNotificationTemplate"
- tag: "scheduledTaskProfile"
- title: "Scheduling Triggers using iCal"
markdownFile: ./markdown/scheduling.md
children:
- tag: "scheduleEvent"
- tag: "scheduleEventResource"
- tag: "scheduleResource"
- tag: "integration"
- tag: "businessProcessCase"
# `notification` service was deprecated in favour of `eventNotificationTemplate`
- tag: "notification"
hide: true
- title: "Encrypt and License Content"
prerender: false
children:
- tag: "drmLicenseAccess"
- tag: "drmPolicy"
- tag: "drmProfile"
- tag: "playReadyDrm"
- tag: "widevineDrm"
- tag: "deliveryProfile"
hide: true
- title: "Manage Documents and Other Assets"
prerender: false
children:
- tag: "baseEntry"
- tag: "data"
- tag: "documents"
- title: "Manage and Deliver Apps and Widgets"
prerender: false
children:
- tag: "uiConf"
- tag: "widget"
- tag: "fileAsset"
- tag: "captureSpace"
- title: "Manage Backend and Storage"
prerender: false
children:
- tag: "system"
- tag: "storageProfile"
- title: "Miscellaneous"
prerender: false
isMiscellaneous: true
hide: true
searchable: true
- title: "Contribute"
children:
- title: "Article Style and Structure Guidelines
VPaaS Website Sample Article"
markdownURL: /assets/documentation/Contribute/Article-Style-Structure-Guidelines.html
path: "/Contribute/Article-Style-Structure-Guidelines.html"
discussionURL: null
workflowNavigation:
- title: Generate API Sessions
icon: assets/img/icons/administrative.png
children:
- workflow: authentication
- workflow: app_token_auth
- title: Secure, Control and Govern
icon: users
children:
- workflow: group_management
- title: Ingest and Upload Media
icon: assets/img/icons/upload.png
workflow: upload
- title: Enrich and Organize Metadata
icon: assets/img/icons/distribute.png
children:
- workflow: metadata
- workflow: captions
- workflow: webvtt_captions
- title: Search, Discover and Personalize
icon: assets/img/icons/publish.png
children:
- workflow: video_search
- title: Engage and Publish
icon: assets/img/icons/engage.png
children:
- workflow: dynamic_thumbnails
- workflow: player_uiconf
- workflow: player_external_skin_overrides
- workflow: using_css_states
- workflow: code_cue_points
- workflow: quiz
- workflow: ad_cue_points
- title: Integration, Scheduling and Hooks
icon: assets/img/icons/other.png
children:
- workflow: backend_notifications
- title: Review Media Analytics
icon: assets/img/icons/analytic.png
children:
- workflow: analytics
- workflow: leaderboard_reports
- title: Manage and Deliver Apps and Widgets
icon: assets/img/icons/manage.png
children:
- workflow: app_token_auth
- title: Add a Workflow
icon: plus
isAdd: true
- title: Contact Us
icon: assets/img/icons/contact.png
isContact: true