Class: Kaltura::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.



281
282
283
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 281

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



287
288
289
290
291
292
293
294
295
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 287

def add(cue_point)
	kparams = {}
	client.add_param(kparams, 'cuePoint', cue_point)
	client.queue_service_action_call('cuepoint_cuepoint', 'add', 'KalturaCuePoint', 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



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 299

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

#count(filter = KalturaNotImplemented) ⇒ Object

count cue point objects by filter



347
348
349
350
351
352
353
354
355
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 347

def count(filter=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter)
	client.queue_service_action_call('cuepoint_cuepoint', 'count', 'int', 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



372
373
374
375
376
377
378
379
380
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 372

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



322
323
324
325
326
327
328
329
330
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 322

def get(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('cuepoint_cuepoint', 'get', 'KalturaCuePoint', 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



334
335
336
337
338
339
340
341
342
343
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 334

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', 'KalturaCuePointListResponse', 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



312
313
314
315
316
317
318
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 312

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', 'file', kparams)
	return client.get_serve_url()
end

#update(id, cue_point) ⇒ Object

Update cue point by id



359
360
361
362
363
364
365
366
367
368
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 359

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