Class: Kaltura::KalturaCaptionAssetService
- Inherits:
-
KalturaServiceBase
- Object
- KalturaServiceBase
- Kaltura::KalturaCaptionAssetService
- Defined in:
- lib/kaltura_plugins/kaltura_caption_client_plugin.rb
Overview
Retrieve information and invoke actions on caption Asset
Instance Attribute Summary
Attributes inherited from KalturaServiceBase
Instance Method Summary collapse
-
#add(entry_id, caption_asset) ⇒ KalturaCaptionAsset
Add caption asset.
-
#delete(caption_asset_id) ⇒ Object
[].
-
#export(asset_id, storage_profile_id) ⇒ KalturaFlavorAsset
manually export an asset.
- #get(caption_asset_id) ⇒ KalturaCaptionAsset
-
#get_remote_paths(id) ⇒ KalturaRemotePathListResponse
Get remote storage existing paths for the asset.
-
#get_url(id, storage_id = KalturaNotImplemented) ⇒ string
Get download URL for the asset.
-
#initialize(client) ⇒ KalturaCaptionAssetService
constructor
A new instance of KalturaCaptionAssetService.
-
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaCaptionAssetListResponse
List caption Assets by filter and pager.
-
#serve(caption_asset_id) ⇒ file
Serves caption by its id.
-
#serve_by_entry_id(entry_id, caption_param_id = KalturaNotImplemented) ⇒ file
Serves caption by entry id and thumnail params id.
-
#serve_web_vtt(caption_asset_id, segment_duration = 30, segment_index = KalturaNotImplemented, local_timestamp = 10000) ⇒ file
Serves caption by its id converting it to segmented WebVTT.
-
#set_as_default(caption_asset_id) ⇒ Object
Markss the caption as default and removes that mark from all other caption assets of the entry.
-
#set_content(id, content_resource) ⇒ KalturaCaptionAsset
Update content of caption asset.
-
#update(id, caption_asset) ⇒ KalturaCaptionAsset
Update caption asset.
Constructor Details
#initialize(client) ⇒ KalturaCaptionAssetService
Returns a new instance of KalturaCaptionAssetService.
419 420 421 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 419 def initialize(client) super(client) end |
Instance Method Details
#add(entry_id, caption_asset) ⇒ KalturaCaptionAsset
Add caption asset
425 426 427 428 429 430 431 432 433 434 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 425 def add(entry_id, ) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'captionAsset', ) client.queue_service_action_call('caption_captionasset', 'add', 'KalturaCaptionAsset', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#delete(caption_asset_id) ⇒ Object
Returns [].
437 438 439 440 441 442 443 444 445 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 437 def delete() kparams = {} client.add_param(kparams, 'captionAssetId', ) client.queue_service_action_call('caption_captionasset', 'delete', '', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#export(asset_id, storage_profile_id) ⇒ KalturaFlavorAsset
manually export an asset
449 450 451 452 453 454 455 456 457 458 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 449 def export(asset_id, storage_profile_id) kparams = {} client.add_param(kparams, 'assetId', asset_id) client.add_param(kparams, 'storageProfileId', storage_profile_id) client.queue_service_action_call('caption_captionasset', 'export', 'KalturaFlavorAsset', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#get(caption_asset_id) ⇒ KalturaCaptionAsset
461 462 463 464 465 466 467 468 469 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 461 def get() kparams = {} client.add_param(kparams, 'captionAssetId', ) client.queue_service_action_call('caption_captionasset', 'get', 'KalturaCaptionAsset', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#get_remote_paths(id) ⇒ KalturaRemotePathListResponse
Get remote storage existing paths for the asset
473 474 475 476 477 478 479 480 481 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 473 def get_remote_paths(id) kparams = {} client.add_param(kparams, 'id', id) client.queue_service_action_call('caption_captionasset', 'getRemotePaths', 'KalturaRemotePathListResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#get_url(id, storage_id = KalturaNotImplemented) ⇒ string
Get download URL for the asset
485 486 487 488 489 490 491 492 493 494 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 485 def get_url(id, storage_id=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'id', id) client.add_param(kparams, 'storageId', storage_id) client.queue_service_action_call('caption_captionasset', 'getUrl', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaCaptionAssetListResponse
List caption Assets by filter and pager
498 499 500 501 502 503 504 505 506 507 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 498 def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filter', filter) client.add_param(kparams, 'pager', pager) client.queue_service_action_call('caption_captionasset', 'list', 'KalturaCaptionAssetListResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#serve(caption_asset_id) ⇒ file
Serves caption by its id
511 512 513 514 515 516 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 511 def serve() kparams = {} client.add_param(kparams, 'captionAssetId', ) client.queue_service_action_call('caption_captionasset', 'serve', 'file', kparams) return client.get_serve_url() end |
#serve_by_entry_id(entry_id, caption_param_id = KalturaNotImplemented) ⇒ file
Serves caption by entry id and thumnail params id
520 521 522 523 524 525 526 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 520 def serve_by_entry_id(entry_id, =KalturaNotImplemented) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'captionParamId', ) client.queue_service_action_call('caption_captionasset', 'serveByEntryId', 'file', kparams) return client.get_serve_url() end |
#serve_web_vtt(caption_asset_id, segment_duration = 30, segment_index = KalturaNotImplemented, local_timestamp = 10000) ⇒ file
Serves caption by its id converting it to segmented WebVTT
530 531 532 533 534 535 536 537 538 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 530 def serve_web_vtt(, segment_duration=30, segment_index=KalturaNotImplemented, =10000) kparams = {} client.add_param(kparams, 'captionAssetId', ) client.add_param(kparams, 'segmentDuration', segment_duration) client.add_param(kparams, 'segmentIndex', segment_index) client.add_param(kparams, 'localTimestamp', ) client.queue_service_action_call('caption_captionasset', 'serveWebVTT', 'file', kparams) return client.get_serve_url() end |
#set_as_default(caption_asset_id) ⇒ Object
Markss the caption as default and removes that mark from all other caption assets of the entry.
542 543 544 545 546 547 548 549 550 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 542 def set_as_default() kparams = {} client.add_param(kparams, 'captionAssetId', ) client.queue_service_action_call('caption_captionasset', 'setAsDefault', '', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#set_content(id, content_resource) ⇒ KalturaCaptionAsset
Update content of caption asset
554 555 556 557 558 559 560 561 562 563 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 554 def set_content(id, content_resource) kparams = {} client.add_param(kparams, 'id', id) client.add_param(kparams, 'contentResource', content_resource) client.queue_service_action_call('caption_captionasset', 'setContent', 'KalturaCaptionAsset', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#update(id, caption_asset) ⇒ KalturaCaptionAsset
Update caption asset
567 568 569 570 571 572 573 574 575 576 |
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 567 def update(id, ) kparams = {} client.add_param(kparams, 'id', id) client.add_param(kparams, 'captionAsset', ) client.queue_service_action_call('caption_captionasset', 'update', 'KalturaCaptionAsset', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |