Class: Kaltura::KalturaLiveChannelService
- Inherits:
-
KalturaServiceBase
- Object
- KalturaServiceBase
- Kaltura::KalturaLiveChannelService
- Defined in:
- lib/kaltura_client.rb
Overview
Live Channel service lets you manage live channels
Instance Attribute Summary
Attributes inherited from KalturaServiceBase
Instance Method Summary collapse
-
#add(live_channel) ⇒ KalturaLiveChannel
Adds new live channel.
-
#append_recording(entry_id, asset_id, media_server_index, resource, duration, is_last_chunk = false) ⇒ KalturaLiveEntry
Append recorded video to live entry.
-
#create_recorded_entry(entry_id, media_server_index, live_entry_status) ⇒ KalturaLiveEntry
Create recorded entry id if it doesn’t exist and make sure it happens on the DC that the live entry was created on.
-
#delete(id) ⇒ Object
Delete a live channel.
-
#get(id) ⇒ KalturaLiveChannel
Get live channel by ID.
-
#initialize(client) ⇒ KalturaLiveChannelService
constructor
A new instance of KalturaLiveChannelService.
-
#is_live(id) ⇒ bool
Delivering the status of a live channel (on-air/offline).
-
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaLiveChannelListResponse
List live channels by filter with paging support.
-
#register_media_server(entry_id, hostname, media_server_index, application_name = KalturaNotImplemented, live_entry_status = 1, should_create_recorded_entry = true) ⇒ KalturaLiveEntry
Register media server to live entry.
-
#set_recorded_content(entry_id, media_server_index, resource, duration, recorded_entry_id = KalturaNotImplemented, flavor_params_id = KalturaNotImplemented) ⇒ KalturaLiveEntry
Set recorded video to live entry.
-
#unregister_media_server(entry_id, hostname, media_server_index) ⇒ KalturaLiveEntry
Unregister media server from live entry.
-
#update(id, live_channel) ⇒ KalturaLiveChannel
Update live channel.
-
#validate_registered_media_servers(entry_id) ⇒ Object
Validates all registered media servers.
Constructor Details
#initialize(client) ⇒ KalturaLiveChannelService
Returns a new instance of KalturaLiveChannelService.
2201 2202 2203 |
# File 'lib/kaltura_client.rb', line 2201 def initialize(client) super(client) end |
Instance Method Details
#add(live_channel) ⇒ KalturaLiveChannel
Adds new live channel.
2207 2208 2209 2210 2211 2212 2213 2214 2215 |
# File 'lib/kaltura_client.rb', line 2207 def add(live_channel) kparams = {} client.add_param(kparams, 'liveChannel', live_channel) client.queue_service_action_call('livechannel', 'add', 'KalturaLiveChannel', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#append_recording(entry_id, asset_id, media_server_index, resource, duration, is_last_chunk = false) ⇒ KalturaLiveEntry
Append recorded video to live entry
2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 |
# File 'lib/kaltura_client.rb', line 2219 def append_recording(entry_id, asset_id, media_server_index, resource, duration, is_last_chunk=false) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'assetId', asset_id) client.add_param(kparams, 'mediaServerIndex', media_server_index) client.add_param(kparams, 'resource', resource) client.add_param(kparams, 'duration', duration) client.add_param(kparams, 'isLastChunk', is_last_chunk) client.queue_service_action_call('livechannel', 'appendRecording', 'KalturaLiveEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#create_recorded_entry(entry_id, media_server_index, live_entry_status) ⇒ KalturaLiveEntry
Create recorded entry id if it doesn’t exist and make sure it happens on the DC that the live entry was created on.
2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 |
# File 'lib/kaltura_client.rb', line 2236 def create_recorded_entry(entry_id, media_server_index, live_entry_status) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'mediaServerIndex', media_server_index) client.add_param(kparams, 'liveEntryStatus', live_entry_status) client.queue_service_action_call('livechannel', 'createRecordedEntry', 'KalturaLiveEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#delete(id) ⇒ Object
Delete a live channel.
2250 2251 2252 2253 2254 2255 2256 2257 2258 |
# File 'lib/kaltura_client.rb', line 2250 def delete(id) kparams = {} client.add_param(kparams, 'id', id) client.queue_service_action_call('livechannel', 'delete', '', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#get(id) ⇒ KalturaLiveChannel
Get live channel by ID.
2262 2263 2264 2265 2266 2267 2268 2269 2270 |
# File 'lib/kaltura_client.rb', line 2262 def get(id) kparams = {} client.add_param(kparams, 'id', id) client.queue_service_action_call('livechannel', 'get', 'KalturaLiveChannel', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#is_live(id) ⇒ bool
Delivering the status of a live channel (on-air/offline)
2274 2275 2276 2277 2278 2279 2280 2281 2282 |
# File 'lib/kaltura_client.rb', line 2274 def is_live(id) kparams = {} client.add_param(kparams, 'id', id) client.queue_service_action_call('livechannel', 'isLive', 'bool', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaLiveChannelListResponse
List live channels by filter with paging support.
2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 |
# File 'lib/kaltura_client.rb', line 2286 def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filter', filter) client.add_param(kparams, 'pager', pager) client.queue_service_action_call('livechannel', 'list', 'KalturaLiveChannelListResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#register_media_server(entry_id, hostname, media_server_index, application_name = KalturaNotImplemented, live_entry_status = 1, should_create_recorded_entry = true) ⇒ KalturaLiveEntry
Register media server to live entry
2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 |
# File 'lib/kaltura_client.rb', line 2299 def register_media_server(entry_id, hostname, media_server_index, application_name=KalturaNotImplemented, live_entry_status=1, should_create_recorded_entry=true) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'hostname', hostname) client.add_param(kparams, 'mediaServerIndex', media_server_index) client.add_param(kparams, 'applicationName', application_name) client.add_param(kparams, 'liveEntryStatus', live_entry_status) client.add_param(kparams, 'shouldCreateRecordedEntry', should_create_recorded_entry) client.queue_service_action_call('livechannel', 'registerMediaServer', 'KalturaLiveEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#set_recorded_content(entry_id, media_server_index, resource, duration, recorded_entry_id = KalturaNotImplemented, flavor_params_id = KalturaNotImplemented) ⇒ KalturaLiveEntry
Set recorded video to live entry
2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 |
# File 'lib/kaltura_client.rb', line 2316 def set_recorded_content(entry_id, media_server_index, resource, duration, recorded_entry_id=KalturaNotImplemented, flavor_params_id=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'mediaServerIndex', media_server_index) client.add_param(kparams, 'resource', resource) client.add_param(kparams, 'duration', duration) client.add_param(kparams, 'recordedEntryId', recorded_entry_id) client.add_param(kparams, 'flavorParamsId', flavor_params_id) client.queue_service_action_call('livechannel', 'setRecordedContent', 'KalturaLiveEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#unregister_media_server(entry_id, hostname, media_server_index) ⇒ KalturaLiveEntry
Unregister media server from live entry
2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 |
# File 'lib/kaltura_client.rb', line 2333 def unregister_media_server(entry_id, hostname, media_server_index) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'hostname', hostname) client.add_param(kparams, 'mediaServerIndex', media_server_index) client.queue_service_action_call('livechannel', 'unregisterMediaServer', 'KalturaLiveEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#update(id, live_channel) ⇒ KalturaLiveChannel
Update live channel. Only the properties that were set will be updated.
2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 |
# File 'lib/kaltura_client.rb', line 2347 def update(id, live_channel) kparams = {} client.add_param(kparams, 'id', id) client.add_param(kparams, 'liveChannel', live_channel) client.queue_service_action_call('livechannel', 'update', 'KalturaLiveChannel', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#validate_registered_media_servers(entry_id) ⇒ Object
Validates all registered media servers
2360 2361 2362 2363 2364 2365 2366 2367 2368 |
# File 'lib/kaltura_client.rb', line 2360 def validate_registered_media_servers(entry_id) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.queue_service_action_call('livechannel', 'validateRegisteredMediaServers', '', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |