Class: Kaltura::KalturaCaptionAssetService

Inherits:
KalturaServiceBase show all
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

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaCaptionAssetService

Returns a new instance of KalturaCaptionAssetService.



409
410
411
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 409

def initialize(client)
	super(client)
end

Instance Method Details

#add(entry_id, caption_asset) ⇒ KalturaCaptionAsset

Add caption asset

Returns:



415
416
417
418
419
420
421
422
423
424
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 415

def add(entry_id, caption_asset)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id)
	client.add_param(kparams, 'captionAsset', caption_asset)
	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 [].

Returns:



427
428
429
430
431
432
433
434
435
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 427

def delete(caption_asset_id)
	kparams = {}
	client.add_param(kparams, 'captionAssetId', caption_asset_id)
	client.queue_service_action_call('caption_captionasset', 'delete', '', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get(caption_asset_id) ⇒ KalturaCaptionAsset

Returns:



438
439
440
441
442
443
444
445
446
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 438

def get(caption_asset_id)
	kparams = {}
	client.add_param(kparams, 'captionAssetId', caption_asset_id)
	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

Returns:



450
451
452
453
454
455
456
457
458
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 450

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

Returns:

  • (string) 


462
463
464
465
466
467
468
469
470
471
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 462

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

Returns:



475
476
477
478
479
480
481
482
483
484
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 475

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

Returns:

  • (file) 


488
489
490
491
492
493
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 488

def serve(caption_asset_id)
	kparams = {}
	client.add_param(kparams, 'captionAssetId', caption_asset_id)
	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

Returns:

  • (file) 


497
498
499
500
501
502
503
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 497

def serve_by_entry_id(entry_id, caption_param_id=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id)
	client.add_param(kparams, 'captionParamId', caption_param_id)
	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

Returns:

  • (file) 


507
508
509
510
511
512
513
514
515
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 507

def serve_web_vtt(caption_asset_id, segment_duration=30, segment_index=KalturaNotImplemented, local_timestamp=10000)
	kparams = {}
	client.add_param(kparams, 'captionAssetId', caption_asset_id)
	client.add_param(kparams, 'segmentDuration', segment_duration)
	client.add_param(kparams, 'segmentIndex', segment_index)
	client.add_param(kparams, 'localTimestamp', local_timestamp)
	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.

Returns:



519
520
521
522
523
524
525
526
527
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 519

def set_as_default(caption_asset_id)
	kparams = {}
	client.add_param(kparams, 'captionAssetId', caption_asset_id)
	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

Returns:



531
532
533
534
535
536
537
538
539
540
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 531

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

Returns:



544
545
546
547
548
549
550
551
552
553
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 544

def update(id, caption_asset)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'captionAsset', caption_asset)
	client.queue_service_action_call('caption_captionasset', 'update', 'KalturaCaptionAsset', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end