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.



3289
3290
3291
 
# File 'lib/kaltura_client.rb', line 3289

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:



3296
3297
3298
3299
3300
3301
3302
3303
3304
 
# File 'lib/kaltura_client.rb', line 3296

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:



3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
 
# File 'lib/kaltura_client.rb', line 3308

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:



3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
 
# File 'lib/kaltura_client.rb', line 3321

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:



3334
3335
3336
3337
3338
3339
3340
3341
3342
 
# File 'lib/kaltura_client.rb', line 3334

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) 


3346
3347
3348
3349
3350
3351
3352
3353
3354
 
# File 'lib/kaltura_client.rb', line 3346

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:



3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/kaltura_client.rb', line 3358

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:



3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
 
# File 'lib/kaltura_client.rb', line 3370

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) 


3383
3384
3385
3386
3387
3388
3389
3390
3391
 
# File 'lib/kaltura_client.rb', line 3383

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) 


3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
 
# File 'lib/kaltura_client.rb', line 3395

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:



3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
 
# File 'lib/kaltura_client.rb', line 3409

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:



3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
 
# File 'lib/kaltura_client.rb', line 3422

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