Class: Kaltura::KalturaCaptionParamsService

Inherits:

KalturaServiceBase

• Object
• KalturaServiceBase
• Kaltura::KalturaCaptionParamsService

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

• #add(caption_params) ⇒ Object

  Add new Caption Params.

• #delete(id) ⇒ Object

  Delete Caption Params by ID.

• #get(id) ⇒ Object

  Get Caption Params by ID.

• #initialize(client) ⇒ KalturaCaptionParamsService constructor

  A new instance of KalturaCaptionParamsService.

• #list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object

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

• #update(id, caption_params) ⇒ Object

  Update Caption Params by ID.

Constructor Details

#initialize(client) ⇒ KalturaCaptionParamsService

Returns a new instance of KalturaCaptionParamsService.

# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 322

def initialize(client)
	super(client)
end

Instance Method Details

#add(caption_params) ⇒ Object

Add new Caption Params

# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 328

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

#delete(id) ⇒ Object

Delete Caption Params by ID

# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 365

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) ⇒ Object

Get Caption Params by ID

# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 340

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

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

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

# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 377

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

#update(id, caption_params) ⇒ Object

Update Caption Params by ID

# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 352

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