Class: MuxRuby::PlaybackIDApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/api/playback_id_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PlaybackIDApi

Returns a new instance of PlaybackIDApi.



19
20
21
 
# File 'lib/mux_ruby/api/playback_id_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mux_ruby/api/playback_id_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_asset_or_livestream_id(playback_id, opts = {}) ⇒ GetAssetOrLiveStreamIdResponse

Retrieve an asset or live stream ID Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.

Parameters:

  • playback_id (String) —

    The live stream's playback ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/mux_ruby/api/playback_id_api.rb', line 27

def get_asset_or_livestream_id(playback_id, opts = {})
  data, _status_code, _headers = get_asset_or_livestream_id_with_http_info(playback_id, opts)
  data
end

#get_asset_or_livestream_id_with_http_info(playback_id, opts = {}) ⇒ Array<(GetAssetOrLiveStreamIdResponse, Integer, Hash)>

Retrieve an asset or live stream ID Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.

Parameters:

  • playback_id (String) —

    The live stream&#39;s playback ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/mux_ruby/api/playback_id_api.rb', line 37

def get_asset_or_livestream_id_with_http_info(playback_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaybackIDApi.get_asset_or_livestream_id ...'
  end
  # verify the required parameter 'playback_id' is set
  if @api_client.config.client_side_validation && playback_id.nil?
    fail ArgumentError, "Missing the required parameter 'playback_id' when calling PlaybackIDApi.get_asset_or_livestream_id"
  end
  # resource path
  local_var_path = '/video/v1/playback-ids/{PLAYBACK_ID}'.sub('{' + 'PLAYBACK_ID' + '}', CGI.escape(playback_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetOrLiveStreamIdResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"PlaybackIDApi.get_asset_or_livestream_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaybackIDApi#get_asset_or_livestream_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end