Class: KalturaApi::KalturaCuePointService

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

Overview

Cue Point service

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaCuePointService

Returns a new instance of KalturaCuePointService.



179
180
181
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 179

def initialize(client)
	super(client)
end

Instance Method Details

#add(cue_point) ⇒ Object

Allows you to add an cue point object associated with an entry



185
186
187
188
189
190
191
192
193
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 185

def add(cue_point)
	kparams = {}
	client.add_param(kparams, 'cuePoint', cue_point);
	client.queue_service_action_call('cuepoint_cuepoint', 'add', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#add_from_bulk(file_data) ⇒ Object

Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions



197
198
199
200
201
202
203
204
205
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 197

def add_from_bulk(file_data)
	kparams = {}
	client.add_param(kparams, 'fileData', file_data);
	client.queue_service_action_call('cuepoint_cuepoint', 'addFromBulk', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#count(filter = KalturaNotImplemented) ⇒ Object

count cue point objects by filter



244
245
246
247
248
249
250
251
252
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 244

def count(filter=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter);
	client.queue_service_action_call('cuepoint_cuepoint', 'count', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#delete(id) ⇒ Object

delete cue point by id, and delete all children cue points



269
270
271
272
273
274
275
276
277
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 269

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

#get(id) ⇒ Object

Retrieve an CuePoint object by id



219
220
221
222
223
224
225
226
227
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 219

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

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

List cue point objects by filter and pager



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 231

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter);
	client.add_param(kparams, 'pager', pager);
	client.queue_service_action_call('cuepoint_cuepoint', 'list', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

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

Download multiple cue points objects as XML definitions



209
210
211
212
213
214
215
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 209

def serve_bulk(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter);
	client.add_param(kparams, 'pager', pager);
	client.queue_service_action_call('cuepoint_cuepoint', 'serveBulk', kparams);
	return client.get_serve_url();
end

#update(id, cue_point) ⇒ Object

Update cue point by id



256
257
258
259
260
261
262
263
264
265
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 256

def update(id, cue_point)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.add_param(kparams, 'cuePoint', cue_point);
	client.queue_service_action_call('cuepoint_cuepoint', 'update', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end