Class: Kaltura::KalturaMixingService
- Inherits:
-
KalturaServiceBase
- Object
- KalturaServiceBase
- Kaltura::KalturaMixingService
- 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
Instance Method Summary collapse
-
#add(mix_entry) ⇒ KalturaMixEntry
Adds a new mix.
-
#anonymous_rank(entry_id, rank) ⇒ Object
Anonymously rank a mix entry, no validation is done on duplicate rankings.
-
#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.
-
#clone(entry_id) ⇒ KalturaMixEntry
Clones an existing mix.
-
#count(filter = KalturaNotImplemented) ⇒ int
Count mix entries by filter.
-
#delete(entry_id) ⇒ Object
Delete a mix entry.
-
#get(entry_id, version = -1)) ⇒ KalturaMixEntry
Get mix entry by id.
-
#get_mixes_by_media_id(media_entry_id) ⇒ array
Get the mixes in which the media entry is included.
-
#get_ready_media_entries(mix_id, version = -1)) ⇒ array
Get all ready media entries that exist in the given mix id.
-
#initialize(client) ⇒ KalturaMixingService
constructor
A new instance of KalturaMixingService.
-
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaMixListResponse
List entries by filter with paging support.
-
#update(entry_id, mix_entry) ⇒ KalturaMixEntry
Update mix entry.
Constructor Details
#initialize(client) ⇒ KalturaMixingService
Returns a new instance of KalturaMixingService.
3188 3189 3190 |
# File 'lib/kaltura_client.rb', line 3188 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.
3195 3196 3197 3198 3199 3200 3201 3202 3203 |
# File 'lib/kaltura_client.rb', line 3195 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
3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 |
# File 'lib/kaltura_client.rb', line 3207 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.
3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 |
# File 'lib/kaltura_client.rb', line 3220 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.
3233 3234 3235 3236 3237 3238 3239 3240 3241 |
# File 'lib/kaltura_client.rb', line 3233 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.
3245 3246 3247 3248 3249 3250 3251 3252 3253 |
# File 'lib/kaltura_client.rb', line 3245 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.
3257 3258 3259 3260 3261 3262 3263 3264 3265 |
# File 'lib/kaltura_client.rb', line 3257 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.
3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 |
# File 'lib/kaltura_client.rb', line 3269 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
3282 3283 3284 3285 3286 3287 3288 3289 3290 |
# File 'lib/kaltura_client.rb', line 3282 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
3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 |
# File 'lib/kaltura_client.rb', line 3294 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.
3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 |
# File 'lib/kaltura_client.rb', line 3308 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.
3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 |
# File 'lib/kaltura_client.rb', line 3321 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 |