Class: Kaltura::KalturaCaptionAssetService

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

Overview

Retrieve information and invoke actions on caption Asset

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaCaptionAssetService

Returns a new instance of KalturaCaptionAssetService.



254
255
256
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 254

def initialize(client)
  super(client)
end

Instance Method Details

#add(entry_id, caption_asset) ⇒ Object

Add caption asset



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 260

def add(entry_id, caption_asset)
  kparams = {}
  client.add_param(kparams, 'entryId', entry_id)
  client.add_param(kparams, 'captionAsset', caption_asset)
  client.queue_service_action_call('caption_captionasset', 'add', 'KalturaCaptionAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#delete(caption_asset_id) ⇒ Object 



388
389
390
391
392
393
394
395
396
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 388

def delete(caption_asset_id)
  kparams = {}
  client.add_param(kparams, 'captionAssetId', caption_asset_id)
  client.queue_service_action_call('caption_captionasset', 'delete', '', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get(caption_asset_id) ⇒ Object 



365
366
367
368
369
370
371
372
373
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 365

def get(caption_asset_id)
  kparams = {}
  client.add_param(kparams, 'captionAssetId', caption_asset_id)
  client.queue_service_action_call('caption_captionasset', 'get', 'KalturaCaptionAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get_remote_paths(id) ⇒ Object

Get remote storage existing paths for the asset



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

def get_remote_paths(id)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.queue_service_action_call('caption_captionasset', 'getRemotePaths', 'KalturaRemotePathListResponse', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get_url(id, storage_id = KalturaNotImplemented) ⇒ Object

Get download URL for the asset



309
310
311
312
313
314
315
316
317
318
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 309

def get_url(id, storage_id=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.add_param(kparams, 'storageId', storage_id)
  client.queue_service_action_call('caption_captionasset', 'getUrl', 'string', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

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

List caption Assets by filter and pager



377
378
379
380
381
382
383
384
385
386
 
# 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_captionasset', 'list', 'KalturaCaptionAssetListResponse', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#serve(caption_asset_id) ⇒ Object

Serves caption by its id



334
335
336
337
338
339
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 334

def serve(caption_asset_id)
  kparams = {}
  client.add_param(kparams, 'captionAssetId', caption_asset_id)
  client.queue_service_action_call('caption_captionasset', 'serve', 'file', kparams)
  return client.get_serve_url()
end

#serve_by_entry_id(entry_id, caption_param_id = KalturaNotImplemented) ⇒ Object

Serves caption by entry id and thumnail params id



299
300
301
302
303
304
305
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 299

def serve_by_entry_id(entry_id, caption_param_id=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'entryId', entry_id)
  client.add_param(kparams, 'captionParamId', caption_param_id)
  client.queue_service_action_call('caption_captionasset', 'serveByEntryId', 'file', kparams)
  return client.get_serve_url()
end

#serve_web_vtt(caption_asset_id, segment_duration = 30, segment_index = KalturaNotImplemented, local_timestamp = 10000) ⇒ Object

Serves caption by its id converting it to segmented WebVTT



343
344
345
346
347
348
349
350
351
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 343

def serve_web_vtt(caption_asset_id, segment_duration=30, segment_index=KalturaNotImplemented, local_timestamp=10000)
  kparams = {}
  client.add_param(kparams, 'captionAssetId', caption_asset_id)
  client.add_param(kparams, 'segmentDuration', segment_duration)
  client.add_param(kparams, 'segmentIndex', segment_index)
  client.add_param(kparams, 'localTimestamp', local_timestamp)
  client.queue_service_action_call('caption_captionasset', 'serveWebVTT', 'file', kparams)
  return client.get_serve_url()
end

#set_as_default(caption_asset_id) ⇒ Object

Markss the caption as default and removes that mark from all other caption assets of the entry.



355
356
357
358
359
360
361
362
363
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 355

def set_as_default(caption_asset_id)
  kparams = {}
  client.add_param(kparams, 'captionAssetId', caption_asset_id)
  client.queue_service_action_call('caption_captionasset', 'setAsDefault', '', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#set_content(id, content_resource) ⇒ Object

Update content of caption asset



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/kaltura_plugins/kaltura_caption_client_plugin.rb', line 273

def set_content(id, content_resource)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.add_param(kparams, 'contentResource', content_resource)
  client.queue_service_action_call('caption_captionasset', 'setContent', 'KalturaCaptionAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#update(id, caption_asset) ⇒ Object

Update caption asset



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

def update(id, caption_asset)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.add_param(kparams, 'captionAsset', caption_asset)
  client.queue_service_action_call('caption_captionasset', 'update', 'KalturaCaptionAsset', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end