mux_ruby 1.9.0 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +3 -1
- data/Gemfile.lock +26 -37
- data/README.md +37 -13
- data/docs/AbridgedVideoView.md +33 -13
- data/docs/Asset.md +59 -26
- data/docs/AssetErrors.md +15 -4
- data/docs/AssetMaster.md +15 -4
- data/docs/AssetNonStandardInputReasons.md +29 -11
- data/docs/AssetRecordingTimes.md +15 -4
- data/docs/AssetResponse.md +13 -3
- data/docs/AssetStaticRenditions.md +15 -4
- data/docs/AssetStaticRenditionsFiles.md +23 -8
- data/docs/AssetsApi.md +396 -163
- data/docs/BreakdownValue.md +21 -7
- data/docs/CreateAssetRequest.md +27 -10
- data/docs/CreateLiveStreamRequest.md +29 -9
- data/docs/CreatePlaybackIDRequest.md +13 -3
- data/docs/CreatePlaybackIDResponse.md +13 -3
- data/docs/CreateSimulcastTargetRequest.md +17 -5
- data/docs/CreateTrackRequest.md +25 -9
- data/docs/CreateTrackResponse.md +13 -3
- data/docs/CreateUploadRequest.md +19 -6
- data/docs/DeliveryReport.md +27 -9
- data/docs/DeliveryUsageApi.md +41 -23
- data/docs/DimensionValue.md +15 -4
- data/docs/DimensionsApi.md +72 -34
- data/docs/DirectUploadsApi.md +131 -56
- data/docs/DisableLiveStreamResponse.md +13 -3
- data/docs/EnableLiveStreamResponse.md +13 -3
- data/docs/Error.md +27 -10
- data/docs/ErrorsApi.md +38 -20
- data/docs/ExportDate.md +20 -0
- data/docs/ExportFile.md +22 -0
- data/docs/ExportsApi.md +99 -12
- data/docs/FilterValue.md +15 -4
- data/docs/FiltersApi.md +71 -33
- data/docs/GetAssetInputInfoResponse.md +13 -3
- data/docs/GetAssetOrLiveStreamIdResponse.md +13 -3
- data/docs/GetAssetOrLiveStreamIdResponseData.md +17 -5
- data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +15 -4
- data/docs/GetAssetPlaybackIDResponse.md +13 -3
- data/docs/GetMetricTimeseriesDataResponse.md +17 -5
- data/docs/GetOverallValuesResponse.md +17 -5
- data/docs/GetRealTimeBreakdownResponse.md +17 -5
- data/docs/GetRealTimeHistogramTimeseriesResponse.md +19 -6
- data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +13 -3
- data/docs/GetRealTimeTimeseriesResponse.md +17 -5
- data/docs/Incident.md +53 -23
- data/docs/IncidentBreakdown.md +17 -5
- data/docs/IncidentNotification.md +17 -5
- data/docs/IncidentNotificationRule.md +21 -7
- data/docs/IncidentResponse.md +15 -4
- data/docs/IncidentsApi.md +118 -62
- data/docs/InputFile.md +15 -4
- data/docs/InputInfo.md +15 -4
- data/docs/InputSettings.md +31 -12
- data/docs/InputSettingsOverlaySettings.md +25 -9
- data/docs/InputTrack.md +29 -11
- data/docs/Insight.md +23 -8
- data/docs/ListAllMetricValuesResponse.md +17 -5
- data/docs/ListAssetsResponse.md +13 -3
- data/docs/ListBreakdownValuesResponse.md +17 -5
- data/docs/ListDeliveryUsageResponse.md +19 -6
- data/docs/ListDimensionValuesResponse.md +17 -5
- data/docs/ListDimensionsResponse.md +17 -5
- data/docs/ListErrorsResponse.md +17 -5
- data/docs/ListExportsResponse.md +17 -5
- data/docs/ListFilterValuesResponse.md +17 -5
- data/docs/ListFiltersResponse.md +17 -5
- data/docs/ListFiltersResponseData.md +15 -4
- data/docs/ListIncidentsResponse.md +17 -5
- data/docs/ListInsightsResponse.md +17 -5
- data/docs/ListLiveStreamsResponse.md +13 -3
- data/docs/ListRealTimeDimensionsResponse.md +17 -5
- data/docs/ListRealTimeDimensionsResponseData.md +15 -4
- data/docs/ListRealTimeMetricsResponse.md +17 -5
- data/docs/ListRelatedIncidentsResponse.md +17 -5
- data/docs/ListSigningKeysResponse.md +13 -3
- data/docs/ListUploadsResponse.md +13 -3
- data/docs/ListVideoViewExportsResponse.md +22 -0
- data/docs/ListVideoViewsResponse.md +17 -5
- data/docs/LiveStream.md +41 -15
- data/docs/LiveStreamResponse.md +13 -3
- data/docs/LiveStreamsApi.md +418 -170
- data/docs/Metric.md +21 -7
- data/docs/MetricsApi.md +211 -117
- data/docs/NotificationRule.md +17 -5
- data/docs/OverallValues.md +19 -6
- data/docs/PlaybackID.md +15 -4
- data/docs/PlaybackIDApi.md +35 -17
- data/docs/PlaybackPolicy.md +10 -2
- data/docs/RealTimeApi.md +177 -81
- data/docs/RealTimeBreakdownValue.md +21 -7
- data/docs/RealTimeHistogramTimeseriesBucket.md +15 -4
- data/docs/RealTimeHistogramTimeseriesBucketValues.md +15 -4
- data/docs/RealTimeHistogramTimeseriesDatapoint.md +25 -9
- data/docs/RealTimeTimeseriesDatapoint.md +17 -5
- data/docs/Score.md +23 -8
- data/docs/SignalLiveStreamCompleteResponse.md +13 -3
- data/docs/SigningKey.md +17 -5
- data/docs/SigningKeyResponse.md +13 -3
- data/docs/SimulcastTarget.md +21 -7
- data/docs/SimulcastTargetResponse.md +13 -3
- data/docs/Track.md +37 -15
- data/docs/URLSigningKeysApi.md +130 -54
- data/docs/UpdateAssetMP4SupportRequest.md +13 -3
- data/docs/UpdateAssetMasterAccessRequest.md +13 -3
- data/docs/Upload.md +29 -11
- data/docs/UploadError.md +15 -4
- data/docs/UploadResponse.md +13 -3
- data/docs/VideoView.md +251 -114
- data/docs/VideoViewEvent.md +19 -6
- data/docs/VideoViewResponse.md +15 -4
- data/docs/VideoViewsApi.md +78 -41
- data/gen/.gitignore +7 -0
- data/gen/Makefile +31 -0
- data/gen/generator-config.json +11 -0
- data/gen/openapitools.json +7 -0
- data/gen/package.json +17 -0
- data/gen/templates/Gemfile.mustache +11 -0
- data/gen/templates/README.mustache +158 -0
- data/gen/templates/Rakefile.mustache +10 -0
- data/gen/templates/api.mustache +206 -0
- data/gen/templates/api_client.mustache +264 -0
- data/gen/templates/api_client_faraday_partial.mustache +138 -0
- data/gen/templates/api_client_spec.mustache +220 -0
- data/gen/templates/api_client_typhoeus_partial.mustache +183 -0
- data/gen/templates/api_doc.mustache +118 -0
- data/gen/templates/api_error.mustache +67 -0
- data/gen/templates/api_info.mustache +12 -0
- data/gen/templates/api_test.mustache +47 -0
- data/gen/templates/base_object.mustache +120 -0
- data/gen/templates/configuration.mustache +349 -0
- data/gen/templates/configuration_spec.mustache +34 -0
- data/gen/templates/configuration_tls_faraday_partial.mustache +29 -0
- data/gen/templates/configuration_tls_typhoeus_partial.mustache +34 -0
- data/gen/templates/gem.mustache +40 -0
- data/gen/templates/gemspec.mustache +35 -0
- data/gen/templates/gitignore.mustache +39 -0
- data/gen/templates/model.mustache +26 -0
- data/gen/templates/model_doc.mustache +12 -0
- data/gen/templates/model_test.mustache +77 -0
- data/gen/templates/partial_model_enum_class.mustache +20 -0
- data/gen/templates/partial_model_generic.mustache +371 -0
- data/gen/templates/partial_model_generic_doc.mustache +28 -0
- data/gen/templates/partial_oneof_module.mustache +137 -0
- data/gen/templates/partial_oneof_module_doc.mustache +92 -0
- data/gen/templates/rspec.mustache +2 -0
- data/gen/templates/rubocop.mustache +148 -0
- data/gen/templates/spec_helper.mustache +103 -0
- data/gen/templates/version.mustache +7 -0
- data/gen/yarn.lock +1878 -0
- data/lib/mux_ruby/api/assets_api.rb +293 -156
- data/lib/mux_ruby/api/delivery_usage_api.rb +32 -16
- data/lib/mux_ruby/api/dimensions_api.rb +55 -29
- data/lib/mux_ruby/api/direct_uploads_api.rb +90 -44
- data/lib/mux_ruby/api/errors_api.rb +34 -18
- data/lib/mux_ruby/api/exports_api.rb +86 -13
- data/lib/mux_ruby/api/filters_api.rb +53 -27
- data/lib/mux_ruby/api/incidents_api.rb +94 -52
- data/lib/mux_ruby/api/live_streams_api.rb +299 -157
- data/lib/mux_ruby/api/metrics_api.rb +193 -122
- data/lib/mux_ruby/api/playback_id_api.rb +33 -17
- data/lib/mux_ruby/api/real_time_api.rb +149 -87
- data/lib/mux_ruby/api/url_signing_keys_api.rb +95 -48
- data/lib/mux_ruby/api/video_views_api.rb +60 -33
- data/lib/mux_ruby/api_client.rb +94 -79
- data/lib/mux_ruby/api_error.rb +35 -7
- data/lib/mux_ruby/configuration.rb +50 -14
- data/lib/mux_ruby/models/abridged_video_view.rb +58 -24
- data/lib/mux_ruby/models/asset.rb +100 -63
- data/lib/mux_ruby/models/asset_errors.rb +50 -15
- data/lib/mux_ruby/models/asset_master.rb +52 -17
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +70 -35
- data/lib/mux_ruby/models/asset_recording_times.rb +50 -16
- data/lib/mux_ruby/models/asset_response.rb +48 -14
- data/lib/mux_ruby/models/asset_static_renditions.rb +53 -17
- data/lib/mux_ruby/models/asset_static_renditions_files.rb +58 -23
- data/lib/mux_ruby/models/breakdown_value.rb +52 -18
- data/lib/mux_ruby/models/create_asset_request.rb +64 -30
- data/lib/mux_ruby/models/create_live_stream_request.rb +78 -23
- data/lib/mux_ruby/models/create_playback_id_request.rb +48 -14
- data/lib/mux_ruby/models/create_playback_id_response.rb +48 -14
- data/lib/mux_ruby/models/create_simulcast_target_request.rb +50 -16
- data/lib/mux_ruby/models/create_track_request.rb +60 -26
- data/lib/mux_ruby/models/create_track_response.rb +48 -14
- data/lib/mux_ruby/models/create_upload_request.rb +52 -18
- data/lib/mux_ruby/models/delivery_report.rb +106 -21
- data/lib/mux_ruby/models/dimension_value.rb +49 -15
- data/lib/mux_ruby/models/disable_live_stream_response.rb +48 -14
- data/lib/mux_ruby/models/enable_live_stream_response.rb +48 -14
- data/lib/mux_ruby/models/error.rb +63 -21
- data/lib/mux_ruby/models/export_date.rb +229 -0
- data/lib/mux_ruby/models/export_file.rb +236 -0
- data/lib/mux_ruby/models/filter_value.rb +49 -15
- data/lib/mux_ruby/models/get_asset_input_info_response.rb +48 -14
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +48 -14
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +50 -16
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +51 -17
- data/lib/mux_ruby/models/get_asset_playback_id_response.rb +48 -14
- data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +50 -16
- data/lib/mux_ruby/models/get_overall_values_response.rb +50 -16
- data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +50 -16
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +51 -17
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +48 -14
- data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +50 -16
- data/lib/mux_ruby/models/incident.rb +68 -34
- data/lib/mux_ruby/models/incident_breakdown.rb +50 -16
- data/lib/mux_ruby/models/incident_notification.rb +50 -16
- data/lib/mux_ruby/models/incident_notification_rule.rb +52 -18
- data/lib/mux_ruby/models/incident_response.rb +49 -15
- data/lib/mux_ruby/models/input_file.rb +49 -15
- data/lib/mux_ruby/models/input_info.rb +49 -15
- data/lib/mux_ruby/models/input_settings.rb +64 -30
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +58 -24
- data/lib/mux_ruby/models/input_track.rb +56 -22
- data/lib/mux_ruby/models/insight.rb +53 -19
- data/lib/mux_ruby/models/list_all_metric_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_assets_response.rb +48 -14
- data/lib/mux_ruby/models/list_breakdown_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_delivery_usage_response.rb +51 -17
- data/lib/mux_ruby/models/list_dimension_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_dimensions_response.rb +50 -16
- data/lib/mux_ruby/models/list_errors_response.rb +50 -16
- data/lib/mux_ruby/models/list_exports_response.rb +50 -16
- data/lib/mux_ruby/models/list_filter_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_filters_response.rb +50 -16
- data/lib/mux_ruby/models/list_filters_response_data.rb +49 -15
- data/lib/mux_ruby/models/list_incidents_response.rb +50 -16
- data/lib/mux_ruby/models/list_insights_response.rb +50 -16
- data/lib/mux_ruby/models/list_live_streams_response.rb +48 -14
- data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +50 -16
- data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +49 -15
- data/lib/mux_ruby/models/list_real_time_metrics_response.rb +50 -16
- data/lib/mux_ruby/models/list_related_incidents_response.rb +50 -16
- data/lib/mux_ruby/models/list_signing_keys_response.rb +48 -14
- data/lib/mux_ruby/models/list_uploads_response.rb +48 -14
- data/lib/mux_ruby/models/list_video_view_exports_response.rb +240 -0
- data/lib/mux_ruby/models/list_video_views_response.rb +50 -16
- data/lib/mux_ruby/models/live_stream.rb +131 -29
- data/lib/mux_ruby/models/live_stream_response.rb +48 -14
- data/lib/mux_ruby/models/metric.rb +52 -18
- data/lib/mux_ruby/models/notification_rule.rb +50 -16
- data/lib/mux_ruby/models/overall_values.rb +51 -17
- data/lib/mux_ruby/models/playback_id.rb +49 -15
- data/lib/mux_ruby/models/playback_policy.rb +12 -6
- data/lib/mux_ruby/models/real_time_breakdown_value.rb +52 -18
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +50 -16
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +49 -15
- data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +54 -20
- data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +50 -16
- data/lib/mux_ruby/models/score.rb +53 -19
- data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +48 -14
- data/lib/mux_ruby/models/signing_key.rb +53 -16
- data/lib/mux_ruby/models/signing_key_response.rb +48 -14
- data/lib/mux_ruby/models/simulcast_target.rb +54 -20
- data/lib/mux_ruby/models/simulcast_target_response.rb +48 -14
- data/lib/mux_ruby/models/track.rb +67 -33
- data/lib/mux_ruby/models/update_asset_master_access_request.rb +50 -16
- data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +50 -16
- data/lib/mux_ruby/models/upload.rb +61 -25
- data/lib/mux_ruby/models/upload_error.rb +51 -15
- data/lib/mux_ruby/models/upload_response.rb +48 -14
- data/lib/mux_ruby/models/video_view.rb +242 -136
- data/lib/mux_ruby/models/video_view_event.rb +51 -17
- data/lib/mux_ruby/models/video_view_response.rb +49 -15
- data/lib/mux_ruby/version.rb +10 -3
- data/lib/mux_ruby.rb +12 -2
- data/mux_ruby.gemspec +15 -17
- data/spec/api_client_spec.rb +10 -3
- data/spec/configuration_spec.rb +9 -2
- data/spec/models/export_date_spec.rb +40 -0
- data/spec/models/export_file_spec.rb +46 -0
- data/spec/models/list_video_view_exports_response_spec.rb +46 -0
- data/spec/spec_helper.rb +9 -2
- metadata +149 -240
data/docs/AssetRecordingTimes.md
CHANGED
@@ -1,9 +1,20 @@
|
|
1
1
|
# MuxRuby::AssetRecordingTimes
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**started_at** | **DateTime** | The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format. | [optional]
|
7
|
-
**duration** | **Float** | The duration of the live stream recorded. The time value is in seconds. | [optional]
|
8
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **started_at** | **Time** | The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format. | [optional] |
|
8
|
+
| **duration** | **Float** | The duration of the live stream recorded. The time value is in seconds. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'mux_ruby'
|
14
|
+
|
15
|
+
instance = MuxRuby::AssetRecordingTimes.new(
|
16
|
+
started_at: null,
|
17
|
+
duration: null
|
18
|
+
)
|
19
|
+
```
|
9
20
|
|
data/docs/AssetResponse.md
CHANGED
@@ -1,8 +1,18 @@
|
|
1
1
|
# MuxRuby::AssetResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Asset**](.md) | | [optional]
|
7
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Asset**](.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::AssetResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
8
18
|
|
@@ -1,9 +1,20 @@
|
|
1
1
|
# MuxRuby::AssetStaticRenditions
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**status** | **String** | Indicates the status of downloadable MP4 versions of this asset. | [optional] [default to 'disabled']
|
7
|
-
**files** | [**Array<AssetStaticRenditionsFiles>**](AssetStaticRenditionsFiles.md) | | [optional]
|
8
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | Indicates the status of downloadable MP4 versions of this asset. | [optional][default to 'disabled'] |
|
8
|
+
| **files** | [**Array<AssetStaticRenditionsFiles>**](AssetStaticRenditionsFiles.md) | Array of file objects. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'mux_ruby'
|
14
|
+
|
15
|
+
instance = MuxRuby::AssetStaticRenditions.new(
|
16
|
+
status: null,
|
17
|
+
files: null
|
18
|
+
)
|
19
|
+
```
|
9
20
|
|
@@ -1,13 +1,28 @@
|
|
1
1
|
# MuxRuby::AssetStaticRenditionsFiles
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | | [optional]
|
7
|
-
**ext** | **String** | Extension of the static rendition file | [optional]
|
8
|
-
**height** | **Integer** | The height of the static rendition's file in pixels | [optional]
|
9
|
-
**width** | **Integer** | The width of the static rendition's file in pixels | [optional]
|
10
|
-
**bitrate** | **Integer** | The bitrate in bits per second | [optional]
|
11
|
-
**filesize** | **String** | | [optional]
|
12
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | [optional] |
|
8
|
+
| **ext** | **String** | Extension of the static rendition file | [optional] |
|
9
|
+
| **height** | **Integer** | The height of the static rendition's file in pixels | [optional] |
|
10
|
+
| **width** | **Integer** | The width of the static rendition's file in pixels | [optional] |
|
11
|
+
| **bitrate** | **Integer** | The bitrate in bits per second | [optional] |
|
12
|
+
| **filesize** | **String** | The file size in bytes | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'mux_ruby'
|
18
|
+
|
19
|
+
instance = MuxRuby::AssetStaticRenditionsFiles.new(
|
20
|
+
name: null,
|
21
|
+
ext: null,
|
22
|
+
height: null,
|
23
|
+
width: null,
|
24
|
+
bitrate: null,
|
25
|
+
filesize: null
|
26
|
+
)
|
27
|
+
```
|
13
28
|
|
data/docs/AssetsApi.md
CHANGED
@@ -2,32 +2,34 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api.mux.com*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**create_asset**](AssetsApi.md#create_asset) | **POST** /video/v1/assets | Create an asset
|
8
|
-
[**create_asset_playback_id**](AssetsApi.md#create_asset_playback_id) | **POST** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID
|
9
|
-
[**create_asset_track**](AssetsApi.md#create_asset_track) | **POST** /video/v1/assets/{ASSET_ID}/tracks | Create an asset track
|
10
|
-
[**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset
|
11
|
-
[**delete_asset_playback_id**](AssetsApi.md#delete_asset_playback_id) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID
|
12
|
-
[**delete_asset_track**](AssetsApi.md#delete_asset_track) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track
|
13
|
-
[**get_asset**](AssetsApi.md#get_asset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset
|
14
|
-
[**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info
|
15
|
-
[**get_asset_playback_id**](AssetsApi.md#get_asset_playback_id) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID
|
16
|
-
[**list_assets**](AssetsApi.md#list_assets) | **GET** /video/v1/assets | List assets
|
17
|
-
[**update_asset_master_access**](AssetsApi.md#update_asset_master_access) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access
|
18
|
-
[**update_asset_mp4_support**](AssetsApi.md#update_asset_mp4_support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_asset**](AssetsApi.md#create_asset) | **POST** /video/v1/assets | Create an asset |
|
8
|
+
| [**create_asset_playback_id**](AssetsApi.md#create_asset_playback_id) | **POST** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID |
|
9
|
+
| [**create_asset_track**](AssetsApi.md#create_asset_track) | **POST** /video/v1/assets/{ASSET_ID}/tracks | Create an asset track |
|
10
|
+
| [**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset |
|
11
|
+
| [**delete_asset_playback_id**](AssetsApi.md#delete_asset_playback_id) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID |
|
12
|
+
| [**delete_asset_track**](AssetsApi.md#delete_asset_track) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track |
|
13
|
+
| [**get_asset**](AssetsApi.md#get_asset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset |
|
14
|
+
| [**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info |
|
15
|
+
| [**get_asset_playback_id**](AssetsApi.md#get_asset_playback_id) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID |
|
16
|
+
| [**list_assets**](AssetsApi.md#list_assets) | **GET** /video/v1/assets | List assets |
|
17
|
+
| [**update_asset_master_access**](AssetsApi.md#update_asset_master_access) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access |
|
18
|
+
| [**update_asset_mp4_support**](AssetsApi.md#update_asset_mp4_support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support |
|
19
|
+
|
20
|
+
|
21
|
+
## create_asset
|
22
|
+
|
23
|
+
> <AssetResponse> create_asset(create_asset_request)
|
23
24
|
|
24
25
|
Create an asset
|
25
26
|
|
26
|
-
Create a new Mux Video asset.
|
27
|
+
Create a new Mux Video asset.
|
28
|
+
|
29
|
+
### Examples
|
27
30
|
|
28
|
-
### Example
|
29
31
|
```ruby
|
30
|
-
|
32
|
+
require 'time'
|
31
33
|
require 'mux_ruby'
|
32
34
|
# setup authorization
|
33
35
|
MuxRuby.configure do |config|
|
@@ -40,19 +42,37 @@ api_instance = MuxRuby::AssetsApi.new
|
|
40
42
|
create_asset_request = MuxRuby::CreateAssetRequest.new # CreateAssetRequest |
|
41
43
|
|
42
44
|
begin
|
43
|
-
#Create an asset
|
45
|
+
# Create an asset
|
44
46
|
result = api_instance.create_asset(create_asset_request)
|
45
47
|
p result
|
46
48
|
rescue MuxRuby::ApiError => e
|
47
|
-
puts "
|
49
|
+
puts "Error when calling AssetsApi->create_asset: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
#### Using the create_asset_with_http_info variant
|
54
|
+
|
55
|
+
This returns an Array which contains the response data, status code and headers.
|
56
|
+
|
57
|
+
> <Array(<AssetResponse>, Integer, Hash)> create_asset_with_http_info(create_asset_request)
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
begin
|
61
|
+
# Create an asset
|
62
|
+
data, status_code, headers = api_instance.create_asset_with_http_info(create_asset_request)
|
63
|
+
p status_code # => 2xx
|
64
|
+
p headers # => { ... }
|
65
|
+
p data # => <AssetResponse>
|
66
|
+
rescue MuxRuby::ApiError => e
|
67
|
+
puts "Error when calling AssetsApi->create_asset_with_http_info: #{e}"
|
48
68
|
end
|
49
69
|
```
|
50
70
|
|
51
71
|
### Parameters
|
52
72
|
|
53
|
-
Name | Type | Description
|
54
|
-
|
55
|
-
**create_asset_request** | [**CreateAssetRequest**](CreateAssetRequest.md)| |
|
73
|
+
| Name | Type | Description | Notes |
|
74
|
+
| ---- | ---- | ----------- | ----- |
|
75
|
+
| **create_asset_request** | [**CreateAssetRequest**](CreateAssetRequest.md) | | |
|
56
76
|
|
57
77
|
### Return type
|
58
78
|
|
@@ -64,19 +84,20 @@ Name | Type | Description | Notes
|
|
64
84
|
|
65
85
|
### HTTP request headers
|
66
86
|
|
67
|
-
|
68
|
-
|
87
|
+
- **Content-Type**: application/json
|
88
|
+
- **Accept**: application/json
|
69
89
|
|
70
90
|
|
91
|
+
## create_asset_playback_id
|
71
92
|
|
72
|
-
|
73
|
-
> CreatePlaybackIDResponse create_asset_playback_id(asset_id, create_playback_id_request)
|
93
|
+
> <CreatePlaybackIDResponse> create_asset_playback_id(asset_id, create_playback_id_request)
|
74
94
|
|
75
95
|
Create a playback ID
|
76
96
|
|
77
|
-
###
|
97
|
+
### Examples
|
98
|
+
|
78
99
|
```ruby
|
79
|
-
|
100
|
+
require 'time'
|
80
101
|
require 'mux_ruby'
|
81
102
|
# setup authorization
|
82
103
|
MuxRuby.configure do |config|
|
@@ -90,20 +111,38 @@ asset_id = 'asset_id_example' # String | The asset ID.
|
|
90
111
|
create_playback_id_request = MuxRuby::CreatePlaybackIDRequest.new # CreatePlaybackIDRequest |
|
91
112
|
|
92
113
|
begin
|
93
|
-
#Create a playback ID
|
114
|
+
# Create a playback ID
|
94
115
|
result = api_instance.create_asset_playback_id(asset_id, create_playback_id_request)
|
95
116
|
p result
|
96
117
|
rescue MuxRuby::ApiError => e
|
97
|
-
puts "
|
118
|
+
puts "Error when calling AssetsApi->create_asset_playback_id: #{e}"
|
119
|
+
end
|
120
|
+
```
|
121
|
+
|
122
|
+
#### Using the create_asset_playback_id_with_http_info variant
|
123
|
+
|
124
|
+
This returns an Array which contains the response data, status code and headers.
|
125
|
+
|
126
|
+
> <Array(<CreatePlaybackIDResponse>, Integer, Hash)> create_asset_playback_id_with_http_info(asset_id, create_playback_id_request)
|
127
|
+
|
128
|
+
```ruby
|
129
|
+
begin
|
130
|
+
# Create a playback ID
|
131
|
+
data, status_code, headers = api_instance.create_asset_playback_id_with_http_info(asset_id, create_playback_id_request)
|
132
|
+
p status_code # => 2xx
|
133
|
+
p headers # => { ... }
|
134
|
+
p data # => <CreatePlaybackIDResponse>
|
135
|
+
rescue MuxRuby::ApiError => e
|
136
|
+
puts "Error when calling AssetsApi->create_asset_playback_id_with_http_info: #{e}"
|
98
137
|
end
|
99
138
|
```
|
100
139
|
|
101
140
|
### Parameters
|
102
141
|
|
103
|
-
Name | Type | Description
|
104
|
-
|
105
|
-
**asset_id** | **String
|
106
|
-
**create_playback_id_request** | [**CreatePlaybackIDRequest**](CreatePlaybackIDRequest.md)| |
|
142
|
+
| Name | Type | Description | Notes |
|
143
|
+
| ---- | ---- | ----------- | ----- |
|
144
|
+
| **asset_id** | **String** | The asset ID. | |
|
145
|
+
| **create_playback_id_request** | [**CreatePlaybackIDRequest**](CreatePlaybackIDRequest.md) | | |
|
107
146
|
|
108
147
|
### Return type
|
109
148
|
|
@@ -115,19 +154,20 @@ Name | Type | Description | Notes
|
|
115
154
|
|
116
155
|
### HTTP request headers
|
117
156
|
|
118
|
-
|
119
|
-
|
157
|
+
- **Content-Type**: application/json
|
158
|
+
- **Accept**: application/json
|
120
159
|
|
121
160
|
|
161
|
+
## create_asset_track
|
122
162
|
|
123
|
-
|
124
|
-
> CreateTrackResponse create_asset_track(asset_id, create_track_request)
|
163
|
+
> <CreateTrackResponse> create_asset_track(asset_id, create_track_request)
|
125
164
|
|
126
165
|
Create an asset track
|
127
166
|
|
128
|
-
###
|
167
|
+
### Examples
|
168
|
+
|
129
169
|
```ruby
|
130
|
-
|
170
|
+
require 'time'
|
131
171
|
require 'mux_ruby'
|
132
172
|
# setup authorization
|
133
173
|
MuxRuby.configure do |config|
|
@@ -138,23 +178,41 @@ end
|
|
138
178
|
|
139
179
|
api_instance = MuxRuby::AssetsApi.new
|
140
180
|
asset_id = 'asset_id_example' # String | The asset ID.
|
141
|
-
create_track_request = MuxRuby::CreateTrackRequest.new # CreateTrackRequest |
|
181
|
+
create_track_request = MuxRuby::CreateTrackRequest.new({url: 'url_example', type: 'text', text_type: 'subtitles', language_code: 'language_code_example'}) # CreateTrackRequest |
|
142
182
|
|
143
183
|
begin
|
144
|
-
#Create an asset track
|
184
|
+
# Create an asset track
|
145
185
|
result = api_instance.create_asset_track(asset_id, create_track_request)
|
146
186
|
p result
|
147
187
|
rescue MuxRuby::ApiError => e
|
148
|
-
puts "
|
188
|
+
puts "Error when calling AssetsApi->create_asset_track: #{e}"
|
189
|
+
end
|
190
|
+
```
|
191
|
+
|
192
|
+
#### Using the create_asset_track_with_http_info variant
|
193
|
+
|
194
|
+
This returns an Array which contains the response data, status code and headers.
|
195
|
+
|
196
|
+
> <Array(<CreateTrackResponse>, Integer, Hash)> create_asset_track_with_http_info(asset_id, create_track_request)
|
197
|
+
|
198
|
+
```ruby
|
199
|
+
begin
|
200
|
+
# Create an asset track
|
201
|
+
data, status_code, headers = api_instance.create_asset_track_with_http_info(asset_id, create_track_request)
|
202
|
+
p status_code # => 2xx
|
203
|
+
p headers # => { ... }
|
204
|
+
p data # => <CreateTrackResponse>
|
205
|
+
rescue MuxRuby::ApiError => e
|
206
|
+
puts "Error when calling AssetsApi->create_asset_track_with_http_info: #{e}"
|
149
207
|
end
|
150
208
|
```
|
151
209
|
|
152
210
|
### Parameters
|
153
211
|
|
154
|
-
Name | Type | Description
|
155
|
-
|
156
|
-
**asset_id** | **String
|
157
|
-
**create_track_request** | [**CreateTrackRequest**](CreateTrackRequest.md)| |
|
212
|
+
| Name | Type | Description | Notes |
|
213
|
+
| ---- | ---- | ----------- | ----- |
|
214
|
+
| **asset_id** | **String** | The asset ID. | |
|
215
|
+
| **create_track_request** | [**CreateTrackRequest**](CreateTrackRequest.md) | | |
|
158
216
|
|
159
217
|
### Return type
|
160
218
|
|
@@ -166,21 +224,22 @@ Name | Type | Description | Notes
|
|
166
224
|
|
167
225
|
### HTTP request headers
|
168
226
|
|
169
|
-
|
170
|
-
|
227
|
+
- **Content-Type**: application/json
|
228
|
+
- **Accept**: application/json
|
171
229
|
|
172
230
|
|
231
|
+
## delete_asset
|
173
232
|
|
174
|
-
# **delete_asset**
|
175
233
|
> delete_asset(asset_id)
|
176
234
|
|
177
235
|
Delete an asset
|
178
236
|
|
179
|
-
Deletes a video asset and all its data
|
237
|
+
Deletes a video asset and all its data.
|
238
|
+
|
239
|
+
### Examples
|
180
240
|
|
181
|
-
### Example
|
182
241
|
```ruby
|
183
|
-
|
242
|
+
require 'time'
|
184
243
|
require 'mux_ruby'
|
185
244
|
# setup authorization
|
186
245
|
MuxRuby.configure do |config|
|
@@ -193,18 +252,36 @@ api_instance = MuxRuby::AssetsApi.new
|
|
193
252
|
asset_id = 'asset_id_example' # String | The asset ID.
|
194
253
|
|
195
254
|
begin
|
196
|
-
#Delete an asset
|
255
|
+
# Delete an asset
|
197
256
|
api_instance.delete_asset(asset_id)
|
198
257
|
rescue MuxRuby::ApiError => e
|
199
|
-
puts "
|
258
|
+
puts "Error when calling AssetsApi->delete_asset: #{e}"
|
259
|
+
end
|
260
|
+
```
|
261
|
+
|
262
|
+
#### Using the delete_asset_with_http_info variant
|
263
|
+
|
264
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
265
|
+
|
266
|
+
> <Array(nil, Integer, Hash)> delete_asset_with_http_info(asset_id)
|
267
|
+
|
268
|
+
```ruby
|
269
|
+
begin
|
270
|
+
# Delete an asset
|
271
|
+
data, status_code, headers = api_instance.delete_asset_with_http_info(asset_id)
|
272
|
+
p status_code # => 2xx
|
273
|
+
p headers # => { ... }
|
274
|
+
p data # => nil
|
275
|
+
rescue MuxRuby::ApiError => e
|
276
|
+
puts "Error when calling AssetsApi->delete_asset_with_http_info: #{e}"
|
200
277
|
end
|
201
278
|
```
|
202
279
|
|
203
280
|
### Parameters
|
204
281
|
|
205
|
-
Name | Type | Description
|
206
|
-
|
207
|
-
**asset_id** | **String
|
282
|
+
| Name | Type | Description | Notes |
|
283
|
+
| ---- | ---- | ----------- | ----- |
|
284
|
+
| **asset_id** | **String** | The asset ID. | |
|
208
285
|
|
209
286
|
### Return type
|
210
287
|
|
@@ -216,19 +293,20 @@ nil (empty response body)
|
|
216
293
|
|
217
294
|
### HTTP request headers
|
218
295
|
|
219
|
-
|
220
|
-
|
296
|
+
- **Content-Type**: Not defined
|
297
|
+
- **Accept**: Not defined
|
221
298
|
|
222
299
|
|
300
|
+
## delete_asset_playback_id
|
223
301
|
|
224
|
-
# **delete_asset_playback_id**
|
225
302
|
> delete_asset_playback_id(asset_id, playback_id)
|
226
303
|
|
227
304
|
Delete a playback ID
|
228
305
|
|
229
|
-
###
|
306
|
+
### Examples
|
307
|
+
|
230
308
|
```ruby
|
231
|
-
|
309
|
+
require 'time'
|
232
310
|
require 'mux_ruby'
|
233
311
|
# setup authorization
|
234
312
|
MuxRuby.configure do |config|
|
@@ -242,19 +320,37 @@ asset_id = 'asset_id_example' # String | The asset ID.
|
|
242
320
|
playback_id = 'playback_id_example' # String | The live stream's playback ID.
|
243
321
|
|
244
322
|
begin
|
245
|
-
#Delete a playback ID
|
323
|
+
# Delete a playback ID
|
246
324
|
api_instance.delete_asset_playback_id(asset_id, playback_id)
|
247
325
|
rescue MuxRuby::ApiError => e
|
248
|
-
puts "
|
326
|
+
puts "Error when calling AssetsApi->delete_asset_playback_id: #{e}"
|
327
|
+
end
|
328
|
+
```
|
329
|
+
|
330
|
+
#### Using the delete_asset_playback_id_with_http_info variant
|
331
|
+
|
332
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
333
|
+
|
334
|
+
> <Array(nil, Integer, Hash)> delete_asset_playback_id_with_http_info(asset_id, playback_id)
|
335
|
+
|
336
|
+
```ruby
|
337
|
+
begin
|
338
|
+
# Delete a playback ID
|
339
|
+
data, status_code, headers = api_instance.delete_asset_playback_id_with_http_info(asset_id, playback_id)
|
340
|
+
p status_code # => 2xx
|
341
|
+
p headers # => { ... }
|
342
|
+
p data # => nil
|
343
|
+
rescue MuxRuby::ApiError => e
|
344
|
+
puts "Error when calling AssetsApi->delete_asset_playback_id_with_http_info: #{e}"
|
249
345
|
end
|
250
346
|
```
|
251
347
|
|
252
348
|
### Parameters
|
253
349
|
|
254
|
-
Name | Type | Description
|
255
|
-
|
256
|
-
**asset_id** | **String
|
257
|
-
**playback_id** | **String
|
350
|
+
| Name | Type | Description | Notes |
|
351
|
+
| ---- | ---- | ----------- | ----- |
|
352
|
+
| **asset_id** | **String** | The asset ID. | |
|
353
|
+
| **playback_id** | **String** | The live stream's playback ID. | |
|
258
354
|
|
259
355
|
### Return type
|
260
356
|
|
@@ -266,19 +362,22 @@ nil (empty response body)
|
|
266
362
|
|
267
363
|
### HTTP request headers
|
268
364
|
|
269
|
-
|
270
|
-
|
365
|
+
- **Content-Type**: Not defined
|
366
|
+
- **Accept**: Not defined
|
271
367
|
|
272
368
|
|
369
|
+
## delete_asset_track
|
273
370
|
|
274
|
-
# **delete_asset_track**
|
275
371
|
> delete_asset_track(asset_id, track_id)
|
276
372
|
|
277
373
|
Delete an asset track
|
278
374
|
|
279
|
-
|
375
|
+
Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
|
376
|
+
|
377
|
+
### Examples
|
378
|
+
|
280
379
|
```ruby
|
281
|
-
|
380
|
+
require 'time'
|
282
381
|
require 'mux_ruby'
|
283
382
|
# setup authorization
|
284
383
|
MuxRuby.configure do |config|
|
@@ -292,19 +391,37 @@ asset_id = 'asset_id_example' # String | The asset ID.
|
|
292
391
|
track_id = 'track_id_example' # String | The track ID.
|
293
392
|
|
294
393
|
begin
|
295
|
-
#Delete an asset track
|
394
|
+
# Delete an asset track
|
296
395
|
api_instance.delete_asset_track(asset_id, track_id)
|
297
396
|
rescue MuxRuby::ApiError => e
|
298
|
-
puts "
|
397
|
+
puts "Error when calling AssetsApi->delete_asset_track: #{e}"
|
398
|
+
end
|
399
|
+
```
|
400
|
+
|
401
|
+
#### Using the delete_asset_track_with_http_info variant
|
402
|
+
|
403
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
404
|
+
|
405
|
+
> <Array(nil, Integer, Hash)> delete_asset_track_with_http_info(asset_id, track_id)
|
406
|
+
|
407
|
+
```ruby
|
408
|
+
begin
|
409
|
+
# Delete an asset track
|
410
|
+
data, status_code, headers = api_instance.delete_asset_track_with_http_info(asset_id, track_id)
|
411
|
+
p status_code # => 2xx
|
412
|
+
p headers # => { ... }
|
413
|
+
p data # => nil
|
414
|
+
rescue MuxRuby::ApiError => e
|
415
|
+
puts "Error when calling AssetsApi->delete_asset_track_with_http_info: #{e}"
|
299
416
|
end
|
300
417
|
```
|
301
418
|
|
302
419
|
### Parameters
|
303
420
|
|
304
|
-
Name | Type | Description
|
305
|
-
|
306
|
-
**asset_id** | **String
|
307
|
-
**track_id** | **String
|
421
|
+
| Name | Type | Description | Notes |
|
422
|
+
| ---- | ---- | ----------- | ----- |
|
423
|
+
| **asset_id** | **String** | The asset ID. | |
|
424
|
+
| **track_id** | **String** | The track ID. | |
|
308
425
|
|
309
426
|
### Return type
|
310
427
|
|
@@ -316,21 +433,22 @@ nil (empty response body)
|
|
316
433
|
|
317
434
|
### HTTP request headers
|
318
435
|
|
319
|
-
|
320
|
-
|
436
|
+
- **Content-Type**: Not defined
|
437
|
+
- **Accept**: Not defined
|
321
438
|
|
322
439
|
|
440
|
+
## get_asset
|
323
441
|
|
324
|
-
|
325
|
-
> AssetResponse get_asset(asset_id)
|
442
|
+
> <AssetResponse> get_asset(asset_id)
|
326
443
|
|
327
444
|
Retrieve an asset
|
328
445
|
|
329
446
|
Retrieves the details of an asset that has previously been created. Supply the unique asset ID that was returned from your previous request, and Mux will return the corresponding asset information. The same information is returned when creating an asset.
|
330
447
|
|
331
|
-
###
|
448
|
+
### Examples
|
449
|
+
|
332
450
|
```ruby
|
333
|
-
|
451
|
+
require 'time'
|
334
452
|
require 'mux_ruby'
|
335
453
|
# setup authorization
|
336
454
|
MuxRuby.configure do |config|
|
@@ -343,19 +461,37 @@ api_instance = MuxRuby::AssetsApi.new
|
|
343
461
|
asset_id = 'asset_id_example' # String | The asset ID.
|
344
462
|
|
345
463
|
begin
|
346
|
-
#Retrieve an asset
|
464
|
+
# Retrieve an asset
|
347
465
|
result = api_instance.get_asset(asset_id)
|
348
466
|
p result
|
349
467
|
rescue MuxRuby::ApiError => e
|
350
|
-
puts "
|
468
|
+
puts "Error when calling AssetsApi->get_asset: #{e}"
|
469
|
+
end
|
470
|
+
```
|
471
|
+
|
472
|
+
#### Using the get_asset_with_http_info variant
|
473
|
+
|
474
|
+
This returns an Array which contains the response data, status code and headers.
|
475
|
+
|
476
|
+
> <Array(<AssetResponse>, Integer, Hash)> get_asset_with_http_info(asset_id)
|
477
|
+
|
478
|
+
```ruby
|
479
|
+
begin
|
480
|
+
# Retrieve an asset
|
481
|
+
data, status_code, headers = api_instance.get_asset_with_http_info(asset_id)
|
482
|
+
p status_code # => 2xx
|
483
|
+
p headers # => { ... }
|
484
|
+
p data # => <AssetResponse>
|
485
|
+
rescue MuxRuby::ApiError => e
|
486
|
+
puts "Error when calling AssetsApi->get_asset_with_http_info: #{e}"
|
351
487
|
end
|
352
488
|
```
|
353
489
|
|
354
490
|
### Parameters
|
355
491
|
|
356
|
-
Name | Type | Description
|
357
|
-
|
358
|
-
**asset_id** | **String
|
492
|
+
| Name | Type | Description | Notes |
|
493
|
+
| ---- | ---- | ----------- | ----- |
|
494
|
+
| **asset_id** | **String** | The asset ID. | |
|
359
495
|
|
360
496
|
### Return type
|
361
497
|
|
@@ -367,21 +503,22 @@ Name | Type | Description | Notes
|
|
367
503
|
|
368
504
|
### HTTP request headers
|
369
505
|
|
370
|
-
|
371
|
-
|
506
|
+
- **Content-Type**: Not defined
|
507
|
+
- **Accept**: application/json
|
372
508
|
|
373
509
|
|
510
|
+
## get_asset_input_info
|
374
511
|
|
375
|
-
|
376
|
-
> GetAssetInputInfoResponse get_asset_input_info(asset_id)
|
512
|
+
> <GetAssetInputInfoResponse> get_asset_input_info(asset_id)
|
377
513
|
|
378
514
|
Retrieve asset input info
|
379
515
|
|
380
516
|
Returns a list of the input objects that were used to create the asset along with any settings that were applied to each input.
|
381
517
|
|
382
|
-
###
|
518
|
+
### Examples
|
519
|
+
|
383
520
|
```ruby
|
384
|
-
|
521
|
+
require 'time'
|
385
522
|
require 'mux_ruby'
|
386
523
|
# setup authorization
|
387
524
|
MuxRuby.configure do |config|
|
@@ -394,19 +531,37 @@ api_instance = MuxRuby::AssetsApi.new
|
|
394
531
|
asset_id = 'asset_id_example' # String | The asset ID.
|
395
532
|
|
396
533
|
begin
|
397
|
-
#Retrieve asset input info
|
534
|
+
# Retrieve asset input info
|
398
535
|
result = api_instance.get_asset_input_info(asset_id)
|
399
536
|
p result
|
400
537
|
rescue MuxRuby::ApiError => e
|
401
|
-
puts "
|
538
|
+
puts "Error when calling AssetsApi->get_asset_input_info: #{e}"
|
539
|
+
end
|
540
|
+
```
|
541
|
+
|
542
|
+
#### Using the get_asset_input_info_with_http_info variant
|
543
|
+
|
544
|
+
This returns an Array which contains the response data, status code and headers.
|
545
|
+
|
546
|
+
> <Array(<GetAssetInputInfoResponse>, Integer, Hash)> get_asset_input_info_with_http_info(asset_id)
|
547
|
+
|
548
|
+
```ruby
|
549
|
+
begin
|
550
|
+
# Retrieve asset input info
|
551
|
+
data, status_code, headers = api_instance.get_asset_input_info_with_http_info(asset_id)
|
552
|
+
p status_code # => 2xx
|
553
|
+
p headers # => { ... }
|
554
|
+
p data # => <GetAssetInputInfoResponse>
|
555
|
+
rescue MuxRuby::ApiError => e
|
556
|
+
puts "Error when calling AssetsApi->get_asset_input_info_with_http_info: #{e}"
|
402
557
|
end
|
403
558
|
```
|
404
559
|
|
405
560
|
### Parameters
|
406
561
|
|
407
|
-
Name | Type | Description
|
408
|
-
|
409
|
-
**asset_id** | **String
|
562
|
+
| Name | Type | Description | Notes |
|
563
|
+
| ---- | ---- | ----------- | ----- |
|
564
|
+
| **asset_id** | **String** | The asset ID. | |
|
410
565
|
|
411
566
|
### Return type
|
412
567
|
|
@@ -418,19 +573,20 @@ Name | Type | Description | Notes
|
|
418
573
|
|
419
574
|
### HTTP request headers
|
420
575
|
|
421
|
-
|
422
|
-
|
576
|
+
- **Content-Type**: Not defined
|
577
|
+
- **Accept**: application/json
|
423
578
|
|
424
579
|
|
580
|
+
## get_asset_playback_id
|
425
581
|
|
426
|
-
|
427
|
-
> GetAssetPlaybackIDResponse get_asset_playback_id(asset_id, playback_id)
|
582
|
+
> <GetAssetPlaybackIDResponse> get_asset_playback_id(asset_id, playback_id)
|
428
583
|
|
429
584
|
Retrieve a playback ID
|
430
585
|
|
431
|
-
###
|
586
|
+
### Examples
|
587
|
+
|
432
588
|
```ruby
|
433
|
-
|
589
|
+
require 'time'
|
434
590
|
require 'mux_ruby'
|
435
591
|
# setup authorization
|
436
592
|
MuxRuby.configure do |config|
|
@@ -444,20 +600,38 @@ asset_id = 'asset_id_example' # String | The asset ID.
|
|
444
600
|
playback_id = 'playback_id_example' # String | The live stream's playback ID.
|
445
601
|
|
446
602
|
begin
|
447
|
-
#Retrieve a playback ID
|
603
|
+
# Retrieve a playback ID
|
448
604
|
result = api_instance.get_asset_playback_id(asset_id, playback_id)
|
449
605
|
p result
|
450
606
|
rescue MuxRuby::ApiError => e
|
451
|
-
puts "
|
607
|
+
puts "Error when calling AssetsApi->get_asset_playback_id: #{e}"
|
608
|
+
end
|
609
|
+
```
|
610
|
+
|
611
|
+
#### Using the get_asset_playback_id_with_http_info variant
|
612
|
+
|
613
|
+
This returns an Array which contains the response data, status code and headers.
|
614
|
+
|
615
|
+
> <Array(<GetAssetPlaybackIDResponse>, Integer, Hash)> get_asset_playback_id_with_http_info(asset_id, playback_id)
|
616
|
+
|
617
|
+
```ruby
|
618
|
+
begin
|
619
|
+
# Retrieve a playback ID
|
620
|
+
data, status_code, headers = api_instance.get_asset_playback_id_with_http_info(asset_id, playback_id)
|
621
|
+
p status_code # => 2xx
|
622
|
+
p headers # => { ... }
|
623
|
+
p data # => <GetAssetPlaybackIDResponse>
|
624
|
+
rescue MuxRuby::ApiError => e
|
625
|
+
puts "Error when calling AssetsApi->get_asset_playback_id_with_http_info: #{e}"
|
452
626
|
end
|
453
627
|
```
|
454
628
|
|
455
629
|
### Parameters
|
456
630
|
|
457
|
-
Name | Type | Description
|
458
|
-
|
459
|
-
**asset_id** | **String
|
460
|
-
**playback_id** | **String
|
631
|
+
| Name | Type | Description | Notes |
|
632
|
+
| ---- | ---- | ----------- | ----- |
|
633
|
+
| **asset_id** | **String** | The asset ID. | |
|
634
|
+
| **playback_id** | **String** | The live stream's playback ID. | |
|
461
635
|
|
462
636
|
### Return type
|
463
637
|
|
@@ -469,21 +643,22 @@ Name | Type | Description | Notes
|
|
469
643
|
|
470
644
|
### HTTP request headers
|
471
645
|
|
472
|
-
|
473
|
-
|
646
|
+
- **Content-Type**: Not defined
|
647
|
+
- **Accept**: application/json
|
474
648
|
|
475
649
|
|
650
|
+
## list_assets
|
476
651
|
|
477
|
-
|
478
|
-
> ListAssetsResponse list_assets(opts)
|
652
|
+
> <ListAssetsResponse> list_assets(opts)
|
479
653
|
|
480
654
|
List assets
|
481
655
|
|
482
|
-
List all Mux assets.
|
656
|
+
List all Mux assets.
|
657
|
+
|
658
|
+
### Examples
|
483
659
|
|
484
|
-
### Example
|
485
660
|
```ruby
|
486
|
-
|
661
|
+
require 'time'
|
487
662
|
require 'mux_ruby'
|
488
663
|
# setup authorization
|
489
664
|
MuxRuby.configure do |config|
|
@@ -494,25 +669,47 @@ end
|
|
494
669
|
|
495
670
|
api_instance = MuxRuby::AssetsApi.new
|
496
671
|
opts = {
|
497
|
-
limit:
|
498
|
-
page:
|
672
|
+
limit: 56, # Integer | Number of items to include in the response
|
673
|
+
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
674
|
+
live_stream_id: 'live_stream_id_example', # String | Filter response to return all the assets for this live stream only
|
675
|
+
upload_id: 'upload_id_example' # String | Filter response to return an asset created from this direct upload only
|
499
676
|
}
|
500
677
|
|
501
678
|
begin
|
502
|
-
#List assets
|
679
|
+
# List assets
|
503
680
|
result = api_instance.list_assets(opts)
|
504
681
|
p result
|
505
682
|
rescue MuxRuby::ApiError => e
|
506
|
-
puts "
|
683
|
+
puts "Error when calling AssetsApi->list_assets: #{e}"
|
684
|
+
end
|
685
|
+
```
|
686
|
+
|
687
|
+
#### Using the list_assets_with_http_info variant
|
688
|
+
|
689
|
+
This returns an Array which contains the response data, status code and headers.
|
690
|
+
|
691
|
+
> <Array(<ListAssetsResponse>, Integer, Hash)> list_assets_with_http_info(opts)
|
692
|
+
|
693
|
+
```ruby
|
694
|
+
begin
|
695
|
+
# List assets
|
696
|
+
data, status_code, headers = api_instance.list_assets_with_http_info(opts)
|
697
|
+
p status_code # => 2xx
|
698
|
+
p headers # => { ... }
|
699
|
+
p data # => <ListAssetsResponse>
|
700
|
+
rescue MuxRuby::ApiError => e
|
701
|
+
puts "Error when calling AssetsApi->list_assets_with_http_info: #{e}"
|
507
702
|
end
|
508
703
|
```
|
509
704
|
|
510
705
|
### Parameters
|
511
706
|
|
512
|
-
Name | Type | Description
|
513
|
-
|
514
|
-
**limit** | **Integer
|
515
|
-
**page** | **Integer
|
707
|
+
| Name | Type | Description | Notes |
|
708
|
+
| ---- | ---- | ----------- | ----- |
|
709
|
+
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
710
|
+
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
711
|
+
| **live_stream_id** | **String** | Filter response to return all the assets for this live stream only | [optional] |
|
712
|
+
| **upload_id** | **String** | Filter response to return an asset created from this direct upload only | [optional] |
|
516
713
|
|
517
714
|
### Return type
|
518
715
|
|
@@ -524,21 +721,22 @@ Name | Type | Description | Notes
|
|
524
721
|
|
525
722
|
### HTTP request headers
|
526
723
|
|
527
|
-
|
528
|
-
|
724
|
+
- **Content-Type**: Not defined
|
725
|
+
- **Accept**: application/json
|
529
726
|
|
530
727
|
|
728
|
+
## update_asset_master_access
|
531
729
|
|
532
|
-
|
533
|
-
> AssetResponse update_asset_master_access(asset_id, update_asset_master_access_request)
|
730
|
+
> <AssetResponse> update_asset_master_access(asset_id, update_asset_master_access_request)
|
534
731
|
|
535
732
|
Update master access
|
536
733
|
|
537
|
-
Allows you add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
|
734
|
+
Allows you to add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
|
735
|
+
|
736
|
+
### Examples
|
538
737
|
|
539
|
-
### Example
|
540
738
|
```ruby
|
541
|
-
|
739
|
+
require 'time'
|
542
740
|
require 'mux_ruby'
|
543
741
|
# setup authorization
|
544
742
|
MuxRuby.configure do |config|
|
@@ -552,20 +750,38 @@ asset_id = 'asset_id_example' # String | The asset ID.
|
|
552
750
|
update_asset_master_access_request = MuxRuby::UpdateAssetMasterAccessRequest.new # UpdateAssetMasterAccessRequest |
|
553
751
|
|
554
752
|
begin
|
555
|
-
#Update master access
|
753
|
+
# Update master access
|
556
754
|
result = api_instance.update_asset_master_access(asset_id, update_asset_master_access_request)
|
557
755
|
p result
|
558
756
|
rescue MuxRuby::ApiError => e
|
559
|
-
puts "
|
757
|
+
puts "Error when calling AssetsApi->update_asset_master_access: #{e}"
|
758
|
+
end
|
759
|
+
```
|
760
|
+
|
761
|
+
#### Using the update_asset_master_access_with_http_info variant
|
762
|
+
|
763
|
+
This returns an Array which contains the response data, status code and headers.
|
764
|
+
|
765
|
+
> <Array(<AssetResponse>, Integer, Hash)> update_asset_master_access_with_http_info(asset_id, update_asset_master_access_request)
|
766
|
+
|
767
|
+
```ruby
|
768
|
+
begin
|
769
|
+
# Update master access
|
770
|
+
data, status_code, headers = api_instance.update_asset_master_access_with_http_info(asset_id, update_asset_master_access_request)
|
771
|
+
p status_code # => 2xx
|
772
|
+
p headers # => { ... }
|
773
|
+
p data # => <AssetResponse>
|
774
|
+
rescue MuxRuby::ApiError => e
|
775
|
+
puts "Error when calling AssetsApi->update_asset_master_access_with_http_info: #{e}"
|
560
776
|
end
|
561
777
|
```
|
562
778
|
|
563
779
|
### Parameters
|
564
780
|
|
565
|
-
Name | Type | Description
|
566
|
-
|
567
|
-
**asset_id** | **String
|
568
|
-
**update_asset_master_access_request** | [**UpdateAssetMasterAccessRequest**](UpdateAssetMasterAccessRequest.md)| |
|
781
|
+
| Name | Type | Description | Notes |
|
782
|
+
| ---- | ---- | ----------- | ----- |
|
783
|
+
| **asset_id** | **String** | The asset ID. | |
|
784
|
+
| **update_asset_master_access_request** | [**UpdateAssetMasterAccessRequest**](UpdateAssetMasterAccessRequest.md) | | |
|
569
785
|
|
570
786
|
### Return type
|
571
787
|
|
@@ -577,21 +793,22 @@ Name | Type | Description | Notes
|
|
577
793
|
|
578
794
|
### HTTP request headers
|
579
795
|
|
580
|
-
|
581
|
-
|
796
|
+
- **Content-Type**: application/json
|
797
|
+
- **Accept**: application/json
|
582
798
|
|
583
799
|
|
800
|
+
## update_asset_mp4_support
|
584
801
|
|
585
|
-
|
586
|
-
> AssetResponse update_asset_mp4_support(asset_id, update_asset_mp4_support_request)
|
802
|
+
> <AssetResponse> update_asset_mp4_support(asset_id, update_asset_mp4_support_request)
|
587
803
|
|
588
804
|
Update MP4 support
|
589
805
|
|
590
|
-
Allows you add or remove mp4 support for assets that were created without it. Currently there are two values supported in this request, `standard` and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
|
806
|
+
Allows you to add or remove mp4 support for assets that were created without it. Currently there are two values supported in this request, `standard` and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
|
807
|
+
|
808
|
+
### Examples
|
591
809
|
|
592
|
-
### Example
|
593
810
|
```ruby
|
594
|
-
|
811
|
+
require 'time'
|
595
812
|
require 'mux_ruby'
|
596
813
|
# setup authorization
|
597
814
|
MuxRuby.configure do |config|
|
@@ -605,20 +822,38 @@ asset_id = 'asset_id_example' # String | The asset ID.
|
|
605
822
|
update_asset_mp4_support_request = MuxRuby::UpdateAssetMP4SupportRequest.new # UpdateAssetMP4SupportRequest |
|
606
823
|
|
607
824
|
begin
|
608
|
-
#Update MP4 support
|
825
|
+
# Update MP4 support
|
609
826
|
result = api_instance.update_asset_mp4_support(asset_id, update_asset_mp4_support_request)
|
610
827
|
p result
|
611
828
|
rescue MuxRuby::ApiError => e
|
612
|
-
puts "
|
829
|
+
puts "Error when calling AssetsApi->update_asset_mp4_support: #{e}"
|
830
|
+
end
|
831
|
+
```
|
832
|
+
|
833
|
+
#### Using the update_asset_mp4_support_with_http_info variant
|
834
|
+
|
835
|
+
This returns an Array which contains the response data, status code and headers.
|
836
|
+
|
837
|
+
> <Array(<AssetResponse>, Integer, Hash)> update_asset_mp4_support_with_http_info(asset_id, update_asset_mp4_support_request)
|
838
|
+
|
839
|
+
```ruby
|
840
|
+
begin
|
841
|
+
# Update MP4 support
|
842
|
+
data, status_code, headers = api_instance.update_asset_mp4_support_with_http_info(asset_id, update_asset_mp4_support_request)
|
843
|
+
p status_code # => 2xx
|
844
|
+
p headers # => { ... }
|
845
|
+
p data # => <AssetResponse>
|
846
|
+
rescue MuxRuby::ApiError => e
|
847
|
+
puts "Error when calling AssetsApi->update_asset_mp4_support_with_http_info: #{e}"
|
613
848
|
end
|
614
849
|
```
|
615
850
|
|
616
851
|
### Parameters
|
617
852
|
|
618
|
-
Name | Type | Description
|
619
|
-
|
620
|
-
**asset_id** | **String
|
621
|
-
**update_asset_mp4_support_request** | [**UpdateAssetMP4SupportRequest**](UpdateAssetMP4SupportRequest.md)| |
|
853
|
+
| Name | Type | Description | Notes |
|
854
|
+
| ---- | ---- | ----------- | ----- |
|
855
|
+
| **asset_id** | **String** | The asset ID. | |
|
856
|
+
| **update_asset_mp4_support_request** | [**UpdateAssetMP4SupportRequest**](UpdateAssetMP4SupportRequest.md) | | |
|
622
857
|
|
623
858
|
### Return type
|
624
859
|
|
@@ -630,8 +865,6 @@ Name | Type | Description | Notes
|
|
630
865
|
|
631
866
|
### HTTP request headers
|
632
867
|
|
633
|
-
|
634
|
-
|
635
|
-
|
636
|
-
|
868
|
+
- **Content-Type**: application/json
|
869
|
+
- **Accept**: application/json
|
637
870
|
|