class Kaltura::KalturaMixingService

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.

Public Class Methods

new(client) click to toggle source
Calls superclass method
# File lib/kaltura_client.rb, line 3266
def initialize(client)
        super(client)
end

Public Instance Methods

add(mix_entry) click to toggle source

Adds a new mix.

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

@return [KalturaMixEntry]

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

Anonymously rank a mix entry, no validation is done on duplicate rankings @return []

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

Appends a media entry to the end of the mix timeline, this will save the mix timeline as a new version. @return [KalturaMixEntry]

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

Clones an existing mix. @return [KalturaMixEntry]

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

Count mix entries by filter. @return [int]

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

Delete a mix entry. @return []

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

Get mix entry by id. @return [KalturaMixEntry]

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

Get the mixes in which the media entry is included @return [array]

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

Get all ready media entries that exist in the given mix id @return [array]

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

List entries by filter with paging support.

Return parameter is an array of mix entries.

@return [KalturaMixListResponse]

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

Update mix entry. Only the properties that were set will be updated. @return [KalturaMixEntry]

# File lib/kaltura_client.rb, line 3399
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