Class: Kaltura::KalturaAnnotationService

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

Overview

Annotation service - Video Annotation

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaAnnotationService

Returns a new instance of KalturaAnnotationService.



180
181
182
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 180

def initialize(client)
  super(client)
end

Instance Method Details

#add(annotation) ⇒ Object

Allows you to add an annotation object associated with an entry



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

def add(annotation)
  kparams = {}
  client.add_param(kparams, 'annotation', annotation)
  client.queue_service_action_call('annotation_annotation', 'add', 'KalturaAnnotation', 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



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 224

def add_from_bulk(file_data)
  kparams = {}
  kfiles = {}
  client.add_param(kfiles, 'fileData', file_data)
  client.queue_service_action_call('annotation_annotation', '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



259
260
261
262
263
264
265
266
267
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 259

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



271
272
273
274
275
276
277
278
279
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 271

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

#get(id) ⇒ Object

Retrieve an CuePoint object by id



247
248
249
250
251
252
253
254
255
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 247

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

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

List annotation objects by filter and pager



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 211

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'filter', filter)
  client.add_param(kparams, 'pager', pager)
  client.queue_service_action_call('annotation_annotation', 'list', 'KalturaAnnotationListResponse', 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



237
238
239
240
241
242
243
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 237

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

#update(id, annotation) ⇒ Object

Update annotation by id



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 198

def update(id, annotation)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.add_param(kparams, 'annotation', annotation)
  client.queue_service_action_call('annotation_annotation', 'update', 'KalturaAnnotation', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end