Class: Kaltura::KalturaMixingService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

A Mix is an XML unique format invented by Kaltura, it allows the user to create a mix of videos and images, in and out points, transitions, text overlays, soundtrack, effects and much more…

Mixing service lets you create a new mix, manage its metadata and make basic manipulations.

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaMixingService

Returns a new instance of KalturaMixingService.



3089
3090
3091
 
# File 'lib/kaltura_client.rb', line 3089

def initialize(client)
	super(client)
end

Instance Method Details

#add(mix_entry) ⇒ Object

Adds a new mix. If the dataContent is null, a default timeline will be created.



3096
3097
3098
3099
3100
3101
3102
3103
3104
 
# File 'lib/kaltura_client.rb', line 3096

def add(mix_entry)
	kparams = {}
	client.add_param(kparams, 'mixEntry', mix_entry)
	client.queue_service_action_call('mixing', 'add', 'KalturaMixEntry', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#anonymous_rank(entry_id, rank) ⇒ Object

Anonymously rank a mix entry, no validation is done on duplicate rankings



3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
 
# File 'lib/kaltura_client.rb', line 3222

def anonymous_rank(entry_id, rank)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id)
	client.add_param(kparams, 'rank', rank)
	client.queue_service_action_call('mixing', 'anonymousRank', '', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#append_media_entry(mix_entry_id, media_entry_id) ⇒ Object

Appends a media entry to a the end of the mix timeline, this will save the mix timeline as a new version.



3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
 
# File 'lib/kaltura_client.rb', line 3184

def append_media_entry(mix_entry_id, media_entry_id)
	kparams = {}
	client.add_param(kparams, 'mixEntryId', mix_entry_id)
	client.add_param(kparams, 'mediaEntryId', media_entry_id)
	client.queue_service_action_call('mixing', 'appendMediaEntry', 'KalturaMixEntry', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#clone(entry_id) ⇒ Object

Clones an existing mix.



3172
3173
3174
3175
3176
3177
3178
3179
3180
 
# File 'lib/kaltura_client.rb', line 3172

def clone(entry_id)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id)
	client.queue_service_action_call('mixing', 'clone', 'KalturaMixEntry', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#count(filter = KalturaNotImplemented) ⇒ Object

Count mix entries by filter.



3160
3161
3162
3163
3164
3165
3166
3167
3168
 
# File 'lib/kaltura_client.rb', line 3160

def count(filter=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter)
	client.queue_service_action_call('mixing', 'count', 'int', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#delete(entry_id) ⇒ Object

Delete a mix entry.



3134
3135
3136
3137
3138
3139
3140
3141
3142
 
# File 'lib/kaltura_client.rb', line 3134

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

#get(entry_id, version = -1)) ⇒ Object

Get mix entry by id.



3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
 
# File 'lib/kaltura_client.rb', line 3108

def get(entry_id, version=-1)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id)
	client.add_param(kparams, 'version', version)
	client.queue_service_action_call('mixing', 'get', 'KalturaMixEntry', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get_mixes_by_media_id(media_entry_id) ⇒ Object

Get the mixes in which the media entry is included



3197
3198
3199
3200
3201
3202
3203
3204
3205
 
# File 'lib/kaltura_client.rb', line 3197

def get_mixes_by_media_id(media_entry_id)
	kparams = {}
	client.add_param(kparams, 'mediaEntryId', media_entry_id)
	client.queue_service_action_call('mixing', 'getMixesByMediaId', 'array', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get_ready_media_entries(mix_id, version = -1)) ⇒ Object

Get all ready media entries that exist in the given mix id



3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
 
# File 'lib/kaltura_client.rb', line 3209

def get_ready_media_entries(mix_id, version=-1)
	kparams = {}
	client.add_param(kparams, 'mixId', mix_id)
	client.add_param(kparams, 'version', version)
	client.queue_service_action_call('mixing', 'getReadyMediaEntries', 'array', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

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

List entries by filter with paging support. Return parameter is an array of mix entries.



3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
 
# File 'lib/kaltura_client.rb', line 3147

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter)
	client.add_param(kparams, 'pager', pager)
	client.queue_service_action_call('mixing', 'list', 'KalturaMixListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update(entry_id, mix_entry) ⇒ Object

Update mix entry. Only the properties that were set will be updated.



3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
 
# File 'lib/kaltura_client.rb', line 3121

def update(entry_id, mix_entry)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id)
	client.add_param(kparams, 'mixEntry', mix_entry)
	client.queue_service_action_call('mixing', 'update', 'KalturaMixEntry', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end