Class: Kaltura::KalturaCaptionParamsService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_plugins/kaltura_caption_client_plugin.rb

Overview

Add & Manage Caption Params

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaCaptionParamsService

Returns a new instance of KalturaCaptionParamsService.



581
582
583
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 581

def initialize(client)
	super(client)
end

Instance Method Details

#add(caption_params) ⇒ KalturaCaptionParams

Add new Caption Params

Returns:



587
588
589
590
591
592
593
594
595
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 587

def add(caption_params)
	kparams = {}
	client.add_param(kparams, 'captionParams', caption_params)
	client.queue_service_action_call('caption_captionparams', 'add', 'KalturaCaptionParams', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#delete(id) ⇒ Object

Delete Caption Params by ID

Returns:



599
600
601
602
603
604
605
606
607
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 599

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

#get(id) ⇒ KalturaCaptionParams

Get Caption Params by ID

Returns:



611
612
613
614
615
616
617
618
619
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 611

def get(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('caption_captionparams', 'get', 'KalturaCaptionParams', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaCaptionParamsListResponse

List Caption Params by filter with paging support (By default - all system default params will be listed too)

Returns:



623
624
625
626
627
628
629
630
631
632
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 623

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_captionparams', 'list', 'KalturaCaptionParamsListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update(id, caption_params) ⇒ KalturaCaptionParams

Update Caption Params by ID

Returns:



636
637
638
639
640
641
642
643
644
645
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 636

def update(id, caption_params)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'captionParams', caption_params)
	client.queue_service_action_call('caption_captionparams', 'update', 'KalturaCaptionParams', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end