class Kaltura::KalturaAnnotationService

Annotation service - Video Annotation

Public Class Methods

new(client) click to toggle source
Calls superclass method Kaltura::KalturaServiceBase::new
# File lib/kaltura_plugins/kaltura_annotation_client_plugin.rb, line 214
def initialize(client)
        super(client)
end

Public Instance Methods

add(annotation) click to toggle source

Allows you to add an annotation object associated with an entry @return [KalturaAnnotation]

# File lib/kaltura_plugins/kaltura_annotation_client_plugin.rb, line 220
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) click to toggle source

Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions @return [KalturaCuePointListResponse]

# File lib/kaltura_plugins/kaltura_annotation_client_plugin.rb, line 232
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
clone(id, entry_id, parent_id=KalturaNotImplemented) click to toggle source

Clone cuePoint with id to given entry @return [KalturaAnnotation]

# File lib/kaltura_plugins/kaltura_annotation_client_plugin.rb, line 245
def clone(id, entry_id, parent_id=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'entryId', entry_id)
        client.add_param(kparams, 'parentId', parent_id)
        client.queue_service_action_call('annotation_annotation', 'clone', 'KalturaAnnotation', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
count(filter=KalturaNotImplemented) click to toggle source

count cue point objects by filter @return [int]

# 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) click to toggle source

delete cue point by id, and delete all children cue points @return []

# 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) click to toggle source

Retrieve an CuePoint object by id @return [KalturaCuePoint]

# File lib/kaltura_plugins/kaltura_annotation_client_plugin.rb, line 283
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) click to toggle source

List annotation objects by filter and pager @return [KalturaAnnotationListResponse]

# File lib/kaltura_plugins/kaltura_annotation_client_plugin.rb, line 295
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) click to toggle source

Download multiple cue points objects as XML definitions @return [file]

# File lib/kaltura_plugins/kaltura_annotation_client_plugin.rb, line 308
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) click to toggle source

Update annotation by id @return [KalturaAnnotation]

# File lib/kaltura_plugins/kaltura_annotation_client_plugin.rb, line 318
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
update_cue_points_times(id, start_time, end_time=KalturaNotImplemented) click to toggle source

@return [KalturaCuePoint]

# File lib/kaltura_plugins/kaltura_annotation_client_plugin.rb, line 330
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('annotation_annotation', 'updateCuePointsTimes', 'KalturaCuePoint', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
update_status(id, status) click to toggle source

Update cuePoint status by id @return []

# File lib/kaltura_plugins/kaltura_annotation_client_plugin.rb, line 344
def update_status(id, status)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'status', status)
        client.queue_service_action_call('annotation_annotation', 'updateStatus', '', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end