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.



414
415
416
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 414

def initialize(client)
	super(client)
end

Instance Method Details

#add(cue_point) ⇒ KalturaCuePoint

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

Returns:



420
421
422
423
424
425
426
427
428
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 420

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

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

Returns:



432
433
434
435
436
437
438
439
440
441
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 432

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

#clone(id, entry_id) ⇒ KalturaCuePoint

Clone cuePoint with id to given entry

Returns:



445
446
447
448
449
450
451
452
453
454
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 445

def clone(id, entry_id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'entryId', entry_id)
	client.queue_service_action_call('cuepoint_cuepoint', 'clone', 'KalturaCuePoint', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#count(filter = KalturaNotImplemented) ⇒ int

count cue point objects by filter

Returns:

  • (int) 


458
459
460
461
462
463
464
465
466
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 458

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

Returns:



470
471
472
473
474
475
476
477
478
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 470

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

Retrieve an CuePoint object by id

Returns:



482
483
484
485
486
487
488
489
490
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 482

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

List cue point objects by filter and pager

Returns:



494
495
496
497
498
499
500
501
502
503
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 494

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

Download multiple cue points objects as XML definitions

Returns:

  • (file) 


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

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

Update cue point by id

Returns:



517
518
519
520
521
522
523
524
525
526
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 517

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

#update_cue_points_times(id, start_time, end_time = KalturaNotImplemented) ⇒ KalturaCuePoint

Returns:



529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb', line 529

def update_cue_points_times(id, start_time, end_time=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'startTime', start_time)
	client.add_param(kparams, 'endTime', end_time)
	client.queue_service_action_call('cuepoint_cuepoint', 'updateCuePointsTimes', 'KalturaCuePoint', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update_status(id, status) ⇒ Object

Update cuePoint status by id

Returns:



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

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