|
| 1 | +# MuxRuby::DRMConfigurationsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.mux.com* |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +| ------ | ------------ | ----------- | |
| 7 | +| [**get_drm_configuration**](DRMConfigurationsApi.md#get_drm_configuration) | **GET** /video/v1/drm-configurations/{DRM_CONFIGURATION_ID} | Retrieve a DRM Configuration | |
| 8 | +| [**list_drm_configurations**](DRMConfigurationsApi.md#list_drm_configurations) | **GET** /video/v1/drm-configurations | List DRM Configurations | |
| 9 | + |
| 10 | + |
| 11 | +## get_drm_configuration |
| 12 | + |
| 13 | +> <DRMConfigurationResponse> get_drm_configuration(drm_configuration_id) |
| 14 | +
|
| 15 | +Retrieve a DRM Configuration |
| 16 | + |
| 17 | +Retrieves a single DRM Configuration. |
| 18 | + |
| 19 | +### Examples |
| 20 | + |
| 21 | +```ruby |
| 22 | +require 'time' |
| 23 | +require 'mux_ruby' |
| 24 | +# setup authorization |
| 25 | +MuxRuby.configure do |config| |
| 26 | + # Configure HTTP basic authorization: accessToken |
| 27 | + config.username = 'YOUR USERNAME' |
| 28 | + config.password = 'YOUR PASSWORD' |
| 29 | +end |
| 30 | + |
| 31 | +api_instance = MuxRuby::DRMConfigurationsApi.new |
| 32 | +drm_configuration_id = 'drm_configuration_id_example' # String | The DRM Configuration ID. |
| 33 | + |
| 34 | +begin |
| 35 | + # Retrieve a DRM Configuration |
| 36 | + result = api_instance.get_drm_configuration(drm_configuration_id) |
| 37 | + p result |
| 38 | +rescue MuxRuby::ApiError => e |
| 39 | + puts "Error when calling DRMConfigurationsApi->get_drm_configuration: #{e}" |
| 40 | +end |
| 41 | +``` |
| 42 | + |
| 43 | +#### Using the get_drm_configuration_with_http_info variant |
| 44 | + |
| 45 | +This returns an Array which contains the response data, status code and headers. |
| 46 | + |
| 47 | +> <Array(<DRMConfigurationResponse>, Integer, Hash)> get_drm_configuration_with_http_info(drm_configuration_id) |
| 48 | +
|
| 49 | +```ruby |
| 50 | +begin |
| 51 | + # Retrieve a DRM Configuration |
| 52 | + data, status_code, headers = api_instance.get_drm_configuration_with_http_info(drm_configuration_id) |
| 53 | + p status_code # => 2xx |
| 54 | + p headers # => { ... } |
| 55 | + p data # => <DRMConfigurationResponse> |
| 56 | +rescue MuxRuby::ApiError => e |
| 57 | + puts "Error when calling DRMConfigurationsApi->get_drm_configuration_with_http_info: #{e}" |
| 58 | +end |
| 59 | +``` |
| 60 | + |
| 61 | +### Parameters |
| 62 | + |
| 63 | +| Name | Type | Description | Notes | |
| 64 | +| ---- | ---- | ----------- | ----- | |
| 65 | +| **drm_configuration_id** | **String** | The DRM Configuration ID. | | |
| 66 | + |
| 67 | +### Return type |
| 68 | + |
| 69 | +[**DRMConfigurationResponse**](DRMConfigurationResponse.md) |
| 70 | + |
| 71 | +### Authorization |
| 72 | + |
| 73 | +[accessToken](../README.md#accessToken) |
| 74 | + |
| 75 | +### HTTP request headers |
| 76 | + |
| 77 | +- **Content-Type**: Not defined |
| 78 | +- **Accept**: application/json |
| 79 | + |
| 80 | + |
| 81 | +## list_drm_configurations |
| 82 | + |
| 83 | +> <ListDRMConfigurationsResponse> list_drm_configurations(opts) |
| 84 | +
|
| 85 | +List DRM Configurations |
| 86 | + |
| 87 | +Returns a list of DRM Configurations |
| 88 | + |
| 89 | +### Examples |
| 90 | + |
| 91 | +```ruby |
| 92 | +require 'time' |
| 93 | +require 'mux_ruby' |
| 94 | +# setup authorization |
| 95 | +MuxRuby.configure do |config| |
| 96 | + # Configure HTTP basic authorization: accessToken |
| 97 | + config.username = 'YOUR USERNAME' |
| 98 | + config.password = 'YOUR PASSWORD' |
| 99 | +end |
| 100 | + |
| 101 | +api_instance = MuxRuby::DRMConfigurationsApi.new |
| 102 | +opts = { |
| 103 | + page: 56, # Integer | Offset by this many pages, of the size of `limit` |
| 104 | + limit: 56 # Integer | Number of items to include in the response |
| 105 | +} |
| 106 | + |
| 107 | +begin |
| 108 | + # List DRM Configurations |
| 109 | + result = api_instance.list_drm_configurations(opts) |
| 110 | + p result |
| 111 | +rescue MuxRuby::ApiError => e |
| 112 | + puts "Error when calling DRMConfigurationsApi->list_drm_configurations: #{e}" |
| 113 | +end |
| 114 | +``` |
| 115 | + |
| 116 | +#### Using the list_drm_configurations_with_http_info variant |
| 117 | + |
| 118 | +This returns an Array which contains the response data, status code and headers. |
| 119 | + |
| 120 | +> <Array(<ListDRMConfigurationsResponse>, Integer, Hash)> list_drm_configurations_with_http_info(opts) |
| 121 | +
|
| 122 | +```ruby |
| 123 | +begin |
| 124 | + # List DRM Configurations |
| 125 | + data, status_code, headers = api_instance.list_drm_configurations_with_http_info(opts) |
| 126 | + p status_code # => 2xx |
| 127 | + p headers # => { ... } |
| 128 | + p data # => <ListDRMConfigurationsResponse> |
| 129 | +rescue MuxRuby::ApiError => e |
| 130 | + puts "Error when calling DRMConfigurationsApi->list_drm_configurations_with_http_info: #{e}" |
| 131 | +end |
| 132 | +``` |
| 133 | + |
| 134 | +### Parameters |
| 135 | + |
| 136 | +| Name | Type | Description | Notes | |
| 137 | +| ---- | ---- | ----------- | ----- | |
| 138 | +| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] | |
| 139 | +| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] | |
| 140 | + |
| 141 | +### Return type |
| 142 | + |
| 143 | +[**ListDRMConfigurationsResponse**](ListDRMConfigurationsResponse.md) |
| 144 | + |
| 145 | +### Authorization |
| 146 | + |
| 147 | +[accessToken](../README.md#accessToken) |
| 148 | + |
| 149 | +### HTTP request headers |
| 150 | + |
| 151 | +- **Content-Type**: Not defined |
| 152 | +- **Accept**: application/json |
| 153 | + |
0 commit comments