MuxRuby::LiveStreamsApi

All URIs are relative to https://api.mux.com

Method	HTTP request	Description
create_live_stream	POST /video/v1/live-streams	Create a live stream
create_live_stream_playback_id	POST /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids	Create a live stream playback ID
create_live_stream_simulcast_target	POST /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets	Create a live stream simulcast target
delete_live_stream	DELETE /video/v1/live-streams/{LIVE_STREAM_ID}	Delete a live stream
delete_live_stream_playback_id	DELETE /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}	Delete a live stream playback ID
delete_live_stream_simulcast_target	DELETE /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}	Delete a Live Stream Simulcast Target
disable_live_stream	PUT /video/v1/live-streams/{LIVE_STREAM_ID}/disable	Disable a live stream
enable_live_stream	PUT /video/v1/live-streams/{LIVE_STREAM_ID}/enable	Enable a live stream
get_live_stream	GET /video/v1/live-streams/{LIVE_STREAM_ID}	Retrieve a live stream
get_live_stream_simulcast_target	GET /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}	Retrieve a Live Stream Simulcast Target
list_live_streams	GET /video/v1/live-streams	List live streams
reset_stream_key	POST /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key	Reset a live stream’s stream key
signal_live_stream_complete	PUT /video/v1/live-streams/{LIVE_STREAM_ID}/complete	Signal a live stream is finished

create_live_stream

LiveStreamResponse create_live_stream(create_live_stream_request)

Create a live stream

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
create_live_stream_request = MuxRuby::CreateLiveStreamRequest.new # CreateLiveStreamRequest | 

begin
  #Create a live stream
  result = api_instance.create_live_stream(create_live_stream_request)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->create_live_stream: #{e}"
end

Parameters

Name	Type	Description	Notes
create_live_stream_request	CreateLiveStreamRequest

Return type

LiveStreamResponse

Authorization

accessToken

HTTP request headers

Content-Type: application/json
Accept: application/json

create_live_stream_playback_id

CreatePlaybackIDResponse create_live_stream_playback_id(live_stream_id, create_playback_id_request)

Create a live stream playback ID

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID
create_playback_id_request = MuxRuby::CreatePlaybackIDRequest.new # CreatePlaybackIDRequest | 

begin
  #Create a live stream playback ID
  result = api_instance.create_live_stream_playback_id(live_stream_id, create_playback_id_request)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->create_live_stream_playback_id: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID
create_playback_id_request	CreatePlaybackIDRequest

Return type

CreatePlaybackIDResponse

Authorization

accessToken

HTTP request headers

Content-Type: application/json
Accept: application/json

create_live_stream_simulcast_target

SimulcastTargetResponse create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)

Create a live stream simulcast target

Create a simulcast target for the parent live stream. Simulcast target can only be created when the parent live stream is in idle state. Only one simulcast target can be created at a time with this API.

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID
create_simulcast_target_request = MuxRuby::CreateSimulcastTargetRequest.new # CreateSimulcastTargetRequest | 

begin
  #Create a live stream simulcast target
  result = api_instance.create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->create_live_stream_simulcast_target: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID
create_simulcast_target_request	CreateSimulcastTargetRequest

Return type

SimulcastTargetResponse

Authorization

accessToken

HTTP request headers

Content-Type: application/json
Accept: application/json

delete_live_stream

delete_live_stream(live_stream_id)

Delete a live stream

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID

begin
  #Delete a live stream
  api_instance.delete_live_stream(live_stream_id)
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->delete_live_stream: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID

Return type

nil (empty response body)

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: Not defined

delete_live_stream_playback_id

delete_live_stream_playback_id(live_stream_id, playback_id)

Delete a live stream playback ID

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID
playback_id = 'playback_id_example' # String | The live stream's playback ID.

begin
  #Delete a live stream playback ID
  api_instance.delete_live_stream_playback_id(live_stream_id, playback_id)
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->delete_live_stream_playback_id: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID
playback_id	String	The live stream's playback ID.

Return type

nil (empty response body)

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: Not defined

delete_live_stream_simulcast_target

delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)

Delete a Live Stream Simulcast Target

Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID
simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.

begin
  #Delete a Live Stream Simulcast Target
  api_instance.delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->delete_live_stream_simulcast_target: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID
simulcast_target_id	String	The ID of the simulcast target.

Return type

nil (empty response body)

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: Not defined

disable_live_stream

DisableLiveStreamResponse disable_live_stream(live_stream_id)

Disable a live stream

Disables a live stream, making it reject incoming RTMP streams until re-enabled.

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID

begin
  #Disable a live stream
  result = api_instance.disable_live_stream(live_stream_id)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->disable_live_stream: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID

Return type

DisableLiveStreamResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

enable_live_stream

EnableLiveStreamResponse enable_live_stream(live_stream_id)

Enable a live stream

Enables a live stream, allowing it to accept an incoming RTMP stream.

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID

begin
  #Enable a live stream
  result = api_instance.enable_live_stream(live_stream_id)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->enable_live_stream: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID

Return type

EnableLiveStreamResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_live_stream

LiveStreamResponse get_live_stream(live_stream_id)

Retrieve a live stream

Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream.

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID

begin
  #Retrieve a live stream
  result = api_instance.get_live_stream(live_stream_id)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->get_live_stream: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID

Return type

LiveStreamResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_live_stream_simulcast_target

SimulcastTargetResponse get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)

Retrieve a Live Stream Simulcast Target

Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID
simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.

begin
  #Retrieve a Live Stream Simulcast Target
  result = api_instance.get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->get_live_stream_simulcast_target: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID
simulcast_target_id	String	The ID of the simulcast target.

Return type

SimulcastTargetResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

list_live_streams

ListLiveStreamsResponse list_live_streams(opts)

List live streams

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
opts = {
  limit: 25, # Integer | Number of items to include in the response
  page: 1 # Integer | Offset by this many pages, of the size of `limit`
}

begin
  #List live streams
  result = api_instance.list_live_streams(opts)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->list_live_streams: #{e}"
end

Parameters

Name	Type	Description	Notes
limit	Integer	Number of items to include in the response	[optional] [default to 25]
page	Integer	Offset by this many pages, of the size of `limit`	[optional] [default to 1]

Return type

ListLiveStreamsResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

reset_stream_key

LiveStreamResponse reset_stream_key(live_stream_id)

Reset a live stream’s stream key

Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts.

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID

begin
  #Reset a live stream’s stream key
  result = api_instance.reset_stream_key(live_stream_id)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->reset_stream_key: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID

Return type

LiveStreamResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

signal_live_stream_complete

SignalLiveStreamCompleteResponse signal_live_stream_complete(live_stream_id)

Signal a live stream is finished

(Optional) Make the recorded asset available immediately instead of waiting for the reconnect_window.

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::LiveStreamsApi.new
live_stream_id = 'live_stream_id_example' # String | The live stream ID

begin
  #Signal a live stream is finished
  result = api_instance.signal_live_stream_complete(live_stream_id)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling LiveStreamsApi->signal_live_stream_complete: #{e}"
end

Parameters

Name	Type	Description	Notes
live_stream_id	String	The live stream ID

Return type

SignalLiveStreamCompleteResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

FilesExpand file tree

LiveStreamsApi.md

Latest commit

History

LiveStreamsApi.md

File metadata and controls

MuxRuby::LiveStreamsApi

create_live_stream

Example

Parameters

Return type

Authorization

HTTP request headers

create_live_stream_playback_id

Example

Parameters

Return type

Authorization

HTTP request headers

create_live_stream_simulcast_target

Example

Parameters

Return type

Authorization

HTTP request headers

delete_live_stream

Example

Parameters

Return type

Authorization

HTTP request headers

delete_live_stream_playback_id

Example

Parameters

Return type

Authorization

HTTP request headers

delete_live_stream_simulcast_target

Example

Parameters

Return type

Authorization

HTTP request headers

disable_live_stream

Example

Parameters

Return type

Authorization

HTTP request headers

enable_live_stream

Example

Parameters

Return type

Authorization

HTTP request headers

get_live_stream

Example

Parameters

Return type

Authorization

HTTP request headers

get_live_stream_simulcast_target

Example

Parameters

Return type

Authorization

HTTP request headers

list_live_streams

Example

Parameters

Return type

Authorization

HTTP request headers

reset_stream_key

Example

Parameters

Return type

Authorization

HTTP request headers

signal_live_stream_complete