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.



126
127
128
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 126

def initialize(client)
	super(client)
end

Instance Method Details

#add(annotation) ⇒ Object

Allows you to add an annotation object associated with an entry



132
133
134
135
136
137
138
139
140
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 132

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



170
171
172
173
174
175
176
177
178
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 170

def add_from_bulk(file_data)
	kparams = {}
	client.add_param(kparams, 'fileData', file_data);
	client.queue_service_action_call('annotation_annotation', 'addFromBulk', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#count(filter = KalturaNotImplemented) ⇒ Object

count cue point objects by filter



204
205
206
207
208
209
210
211
212
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 204

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



216
217
218
219
220
221
222
223
224
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 216

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



192
193
194
195
196
197
198
199
200
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 192

def get(id)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.queue_service_action_call('annotation_annotation', 'get', 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



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 157

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', 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



182
183
184
185
186
187
188
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 182

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

#update(id, annotation) ⇒ Object

Update annotation by id



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/kaltura_plugins/kaltura_annotation_client_plugin.rb', line 144

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', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end