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.



3306
3307
3308
 
# File 'lib/kaltura_client.rb', line 3306

def initialize(client)
	super(client)
end

Instance Method Details

#add(mix_entry) ⇒ KalturaMixEntry

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

Returns:



3313
3314
3315
3316
3317
3318
3319
3320
3321
 
# File 'lib/kaltura_client.rb', line 3313

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

Returns:



3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
 
# File 'lib/kaltura_client.rb', line 3325

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) ⇒ KalturaMixEntry

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

Returns:



3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
 
# File 'lib/kaltura_client.rb', line 3338

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) ⇒ KalturaMixEntry

Clones an existing mix.

Returns:



3351
3352
3353
3354
3355
3356
3357
3358
3359
 
# File 'lib/kaltura_client.rb', line 3351

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) ⇒ int

Count mix entries by filter.

Returns:

  • (int) 


3363
3364
3365
3366
3367
3368
3369
3370
3371
 
# File 'lib/kaltura_client.rb', line 3363

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.

Returns:



3375
3376
3377
3378
3379
3380
3381
3382
3383
 
# File 'lib/kaltura_client.rb', line 3375

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)) ⇒ KalturaMixEntry

Get mix entry by id.

Returns:



3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
 
# File 'lib/kaltura_client.rb', line 3387

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) ⇒ array

Get the mixes in which the media entry is included

Returns:

  • (array) 


3400
3401
3402
3403
3404
3405
3406
3407
3408
 
# File 'lib/kaltura_client.rb', line 3400

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

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

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

Returns:

  • (array) 


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'lib/kaltura_client.rb', line 3412

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

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

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

Returns:



3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
 
# File 'lib/kaltura_client.rb', line 3426

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) ⇒ KalturaMixEntry

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

Returns:



3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
 
# File 'lib/kaltura_client.rb', line 3439

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