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.



402
403
404
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 402

def initialize(client)
  super(client)
end

Instance Method Details

#add(caption_params) ⇒ Object

Add new Caption Params



408
409
410
411
412
413
414
415
416
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 408

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



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

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



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

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

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



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

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

Update Caption Params by ID



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

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