mux_ruby 1.6.0 → 2.0.0.pre.rc.2
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 -23
- data/docs/AssetErrors.md +15 -4
- data/docs/AssetMaster.md +15 -4
- data/docs/AssetNonStandardInputReasons.md +34 -0
- data/docs/AssetRecordingTimes.md +20 -0
- data/docs/AssetResponse.md +13 -3
- data/docs/AssetStaticRenditions.md +15 -4
- data/docs/AssetStaticRenditionsFiles.md +23 -8
- data/docs/AssetsApi.md +396 -161
- data/docs/BreakdownValue.md +21 -7
- data/docs/CreateAssetRequest.md +27 -10
- data/docs/CreateLiveStreamRequest.md +27 -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 +20 -0
- data/docs/DimensionsApi.md +156 -0
- data/docs/DirectUploadsApi.md +131 -56
- data/docs/DisableLiveStreamResponse.md +18 -0
- data/docs/EnableLiveStreamResponse.md +18 -0
- data/docs/Error.md +27 -10
- data/docs/ErrorsApi.md +38 -20
- data/docs/ExportsApi.md +33 -14
- data/docs/FilterValue.md +15 -4
- data/docs/FiltersApi.md +73 -35
- data/docs/GetAssetInputInfoResponse.md +13 -3
- data/docs/GetAssetOrLiveStreamIdResponse.md +18 -0
- data/docs/GetAssetOrLiveStreamIdResponseData.md +22 -0
- data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +20 -0
- data/docs/GetAssetPlaybackIDResponse.md +13 -3
- data/docs/GetMetricTimeseriesDataResponse.md +17 -5
- data/docs/GetOverallValuesResponse.md +17 -5
- data/docs/GetRealTimeBreakdownResponse.md +22 -0
- data/docs/GetRealTimeHistogramTimeseriesResponse.md +24 -0
- data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +18 -0
- data/docs/GetRealTimeTimeseriesResponse.md +22 -0
- data/docs/Incident.md +58 -0
- data/docs/IncidentBreakdown.md +22 -0
- data/docs/IncidentNotification.md +22 -0
- data/docs/IncidentNotificationRule.md +26 -0
- data/docs/IncidentResponse.md +20 -0
- data/docs/IncidentsApi.md +242 -0
- data/docs/InputFile.md +15 -4
- data/docs/InputInfo.md +15 -4
- data/docs/InputSettings.md +31 -10
- 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 +22 -0
- data/docs/ListDimensionsResponse.md +22 -0
- 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 +22 -0
- data/docs/ListInsightsResponse.md +17 -5
- data/docs/ListLiveStreamsResponse.md +13 -3
- data/docs/ListRealTimeDimensionsResponse.md +22 -0
- data/docs/ListRealTimeDimensionsResponseData.md +20 -0
- data/docs/ListRealTimeMetricsResponse.md +22 -0
- data/docs/ListRelatedIncidentsResponse.md +22 -0
- data/docs/ListSigningKeysResponse.md +13 -3
- data/docs/ListUploadsResponse.md +13 -3
- data/docs/ListVideoViewsResponse.md +17 -5
- data/docs/LiveStream.md +39 -15
- data/docs/LiveStreamResponse.md +13 -3
- data/docs/LiveStreamsApi.md +497 -145
- data/docs/Metric.md +21 -7
- data/docs/MetricsApi.md +211 -117
- data/docs/NotificationRule.md +22 -0
- data/docs/OverallValues.md +19 -6
- data/docs/PlaybackID.md +15 -4
- data/docs/PlaybackIDApi.md +78 -0
- data/docs/PlaybackPolicy.md +10 -2
- data/docs/RealTimeApi.md +376 -0
- data/docs/RealTimeBreakdownValue.md +26 -0
- data/docs/RealTimeHistogramTimeseriesBucket.md +20 -0
- data/docs/RealTimeHistogramTimeseriesBucketValues.md +20 -0
- data/docs/RealTimeHistogramTimeseriesDatapoint.md +30 -0
- data/docs/RealTimeTimeseriesDatapoint.md +22 -0
- 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/examples/data/exercise-dimensions.rb +29 -0
- data/examples/data/exercise-incidents.rb +29 -0
- data/examples/data/exercise-realtime.rb +60 -0
- data/examples/video/exercise-assets.rb +21 -0
- data/examples/video/exercise-live-streams.rb +30 -0
- 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.rb +43 -2
- data/lib/mux_ruby/api/assets_api.rb +291 -152
- data/lib/mux_ruby/api/delivery_usage_api.rb +32 -16
- data/lib/mux_ruby/api/dimensions_api.rb +154 -0
- 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 +30 -14
- data/lib/mux_ruby/api/filters_api.rb +57 -31
- data/lib/mux_ruby/api/incidents_api.rb +259 -0
- data/lib/mux_ruby/api/live_streams_api.rb +381 -133
- data/lib/mux_ruby/api/metrics_api.rb +185 -114
- data/lib/mux_ruby/api/playback_id_api.rb +85 -0
- data/lib/mux_ruby/api/real_time_api.rb +373 -0
- 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 +106 -91
- 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 +157 -53
- data/lib/mux_ruby/models/asset_errors.rb +52 -15
- data/lib/mux_ruby/models/asset_master.rb +85 -15
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +370 -0
- data/lib/mux_ruby/models/asset_recording_times.rb +229 -0
- data/lib/mux_ruby/models/asset_response.rb +48 -14
- data/lib/mux_ruby/models/asset_static_renditions.rb +55 -19
- data/lib/mux_ruby/models/asset_static_renditions_files.rb +60 -25
- data/lib/mux_ruby/models/breakdown_value.rb +52 -18
- data/lib/mux_ruby/models/create_asset_request.rb +70 -30
- data/lib/mux_ruby/models/create_live_stream_request.rb +68 -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 +65 -27
- 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 +227 -0
- data/lib/mux_ruby/models/disable_live_stream_response.rb +218 -0
- data/lib/mux_ruby/models/enable_live_stream_response.rb +218 -0
- data/lib/mux_ruby/models/error.rb +63 -21
- 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 +218 -0
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +237 -0
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +264 -0
- 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 +240 -0
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +249 -0
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +220 -0
- data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +240 -0
- data/lib/mux_ruby/models/incident.rb +404 -0
- data/lib/mux_ruby/models/incident_breakdown.rb +236 -0
- data/lib/mux_ruby/models/incident_notification.rb +236 -0
- data/lib/mux_ruby/models/incident_notification_rule.rb +256 -0
- data/lib/mux_ruby/models/incident_response.rb +229 -0
- 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 +91 -30
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +68 -26
- 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 +240 -0
- data/lib/mux_ruby/models/list_dimensions_response.rb +238 -0
- 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 +240 -0
- 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 +240 -0
- data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +227 -0
- data/lib/mux_ruby/models/list_real_time_metrics_response.rb +240 -0
- data/lib/mux_ruby/models/list_related_incidents_response.rb +240 -0
- 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_views_response.rb +50 -16
- data/lib/mux_ruby/models/live_stream.rb +121 -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 +236 -0
- data/lib/mux_ruby/models/overall_values.rb +51 -17
- data/lib/mux_ruby/models/playback_id.rb +50 -15
- data/lib/mux_ruby/models/playback_policy.rb +12 -6
- data/lib/mux_ruby/models/real_time_breakdown_value.rb +254 -0
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +227 -0
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +227 -0
- data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +274 -0
- data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +236 -0
- 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 +55 -21
- data/lib/mux_ruby/models/simulcast_target_response.rb +48 -14
- data/lib/mux_ruby/models/track.rb +92 -33
- data/lib/mux_ruby/models/update_asset_master_access_request.rb +51 -17
- data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +51 -17
- data/lib/mux_ruby/models/upload.rb +62 -26
- 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/mux_ruby.gemspec +15 -15
- data/spec/api/assets_api_spec.rb +2 -0
- data/spec/api/dimensions_api_spec.rb +55 -0
- data/spec/api/filters_api_spec.rb +2 -2
- data/spec/api/incidents_api_spec.rb +73 -0
- data/spec/api/live_streams_api_spec.rb +24 -0
- data/spec/api/playback_id_api_spec.rb +40 -0
- data/spec/api/real_time_api_spec.rb +93 -0
- data/spec/api_client_spec.rb +10 -3
- data/spec/configuration_spec.rb +9 -2
- data/spec/models/asset_master_spec.rb +4 -0
- data/spec/models/asset_non_standard_input_reasons_spec.rb +98 -0
- data/spec/models/asset_recording_times_spec.rb +40 -0
- data/spec/models/asset_spec.rb +26 -0
- data/spec/models/dimension_value_spec.rb +40 -0
- data/spec/models/disable_live_stream_response_spec.rb +34 -0
- data/spec/models/enable_live_stream_response_spec.rb +34 -0
- data/spec/models/get_asset_or_live_stream_id_response_data_object_spec.rb +44 -0
- data/spec/models/get_asset_or_live_stream_id_response_data_spec.rb +46 -0
- data/spec/models/get_asset_or_live_stream_id_response_spec.rb +34 -0
- data/spec/models/get_real_time_breakdown_response_spec.rb +46 -0
- data/spec/models/get_real_time_histogram_timeseries_response_meta_spec.rb +34 -0
- data/spec/models/get_real_time_histogram_timeseries_response_spec.rb +52 -0
- data/spec/models/get_real_time_timeseries_response_spec.rb +46 -0
- data/spec/models/incident_breakdown_spec.rb +46 -0
- data/spec/models/incident_notification_rule_spec.rb +58 -0
- data/spec/models/incident_notification_spec.rb +46 -0
- data/spec/models/incident_response_spec.rb +40 -0
- data/spec/models/incident_spec.rb +154 -0
- data/spec/models/input_settings_spec.rb +12 -0
- data/spec/models/list_dimension_values_response_spec.rb +46 -0
- data/spec/models/list_dimensions_response_spec.rb +46 -0
- data/spec/models/list_incidents_response_spec.rb +46 -0
- data/spec/models/list_real_time_dimensions_response_data_spec.rb +40 -0
- data/spec/models/list_real_time_dimensions_response_spec.rb +46 -0
- data/spec/models/list_real_time_metrics_response_spec.rb +46 -0
- data/spec/models/list_related_incidents_response_spec.rb +46 -0
- data/spec/models/notification_rule_spec.rb +46 -0
- data/spec/models/real_time_breakdown_value_spec.rb +58 -0
- data/spec/models/real_time_histogram_timeseries_bucket_spec.rb +40 -0
- data/spec/models/real_time_histogram_timeseries_bucket_values_spec.rb +40 -0
- data/spec/models/real_time_histogram_timeseries_datapoint_spec.rb +70 -0
- data/spec/models/real_time_timeseries_datapoint_spec.rb +46 -0
- data/spec/models/track_spec.rb +4 -0
- data/spec/spec_helper.rb +9 -2
- metadata +246 -209
data/docs/ListFiltersResponse.md
CHANGED
@@ -1,10 +1,22 @@
|
|
1
1
|
# MuxRuby::ListFiltersResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) | | [optional]
|
7
|
-
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<Integer>** | | [optional]
|
9
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) | | [optional] |
|
8
|
+
| **total_row_count** | **Integer** | | [optional] |
|
9
|
+
| **timeframe** | **Array<Integer>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::ListFiltersResponse.new(
|
17
|
+
data: null,
|
18
|
+
total_row_count: null,
|
19
|
+
timeframe: null
|
20
|
+
)
|
21
|
+
```
|
10
22
|
|
@@ -1,9 +1,20 @@
|
|
1
1
|
# MuxRuby::ListFiltersResponseData
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**basic** | **Array<String>** | | [optional]
|
7
|
-
**advanced** | **Array<String>** | | [optional]
|
8
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **basic** | **Array<String>** | | [optional] |
|
8
|
+
| **advanced** | **Array<String>** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'mux_ruby'
|
14
|
+
|
15
|
+
instance = MuxRuby::ListFiltersResponseData.new(
|
16
|
+
basic: null,
|
17
|
+
advanced: null
|
18
|
+
)
|
19
|
+
```
|
9
20
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MuxRuby::ListIncidentsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<Incident>**](Incident.md) | | [optional] |
|
8
|
+
| **total_row_count** | **Integer** | | [optional] |
|
9
|
+
| **timeframe** | **Array<Integer>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::ListIncidentsResponse.new(
|
17
|
+
data: null,
|
18
|
+
total_row_count: null,
|
19
|
+
timeframe: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -1,10 +1,22 @@
|
|
1
1
|
# MuxRuby::ListInsightsResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<Insight>**](Insight.md) | | [optional]
|
7
|
-
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<Integer>** | | [optional]
|
9
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<Insight>**](Insight.md) | | [optional] |
|
8
|
+
| **total_row_count** | **Integer** | | [optional] |
|
9
|
+
| **timeframe** | **Array<Integer>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::ListInsightsResponse.new(
|
17
|
+
data: null,
|
18
|
+
total_row_count: null,
|
19
|
+
timeframe: null
|
20
|
+
)
|
21
|
+
```
|
10
22
|
|
@@ -1,8 +1,18 @@
|
|
1
1
|
# MuxRuby::ListLiveStreamsResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<LiveStream>**](LiveStream.md) | | [optional]
|
7
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<LiveStream>**](LiveStream.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::ListLiveStreamsResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
8
18
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MuxRuby::ListRealTimeDimensionsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<ListRealTimeDimensionsResponseData>**](ListRealTimeDimensionsResponseData.md) | | [optional] |
|
8
|
+
| **total_row_count** | **Integer** | | [optional] |
|
9
|
+
| **timeframe** | **Array<Integer>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::ListRealTimeDimensionsResponse.new(
|
17
|
+
data: null,
|
18
|
+
total_row_count: null,
|
19
|
+
timeframe: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MuxRuby::ListRealTimeDimensionsResponseData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | [optional] |
|
8
|
+
| **display_name** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'mux_ruby'
|
14
|
+
|
15
|
+
instance = MuxRuby::ListRealTimeDimensionsResponseData.new(
|
16
|
+
name: null,
|
17
|
+
display_name: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MuxRuby::ListRealTimeMetricsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<ListRealTimeDimensionsResponseData>**](ListRealTimeDimensionsResponseData.md) | | [optional] |
|
8
|
+
| **total_row_count** | **Integer** | | [optional] |
|
9
|
+
| **timeframe** | **Array<Integer>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::ListRealTimeMetricsResponse.new(
|
17
|
+
data: null,
|
18
|
+
total_row_count: null,
|
19
|
+
timeframe: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MuxRuby::ListRelatedIncidentsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<Incident>**](Incident.md) | | [optional] |
|
8
|
+
| **total_row_count** | **Integer** | | [optional] |
|
9
|
+
| **timeframe** | **Array<Integer>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::ListRelatedIncidentsResponse.new(
|
17
|
+
data: null,
|
18
|
+
total_row_count: null,
|
19
|
+
timeframe: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -1,8 +1,18 @@
|
|
1
1
|
# MuxRuby::ListSigningKeysResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<SigningKey>**](SigningKey.md) | | [optional]
|
7
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<SigningKey>**](SigningKey.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::ListSigningKeysResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
8
18
|
|
data/docs/ListUploadsResponse.md
CHANGED
@@ -1,8 +1,18 @@
|
|
1
1
|
# MuxRuby::ListUploadsResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<Upload>**](Upload.md) | | [optional]
|
7
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<Upload>**](Upload.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::ListUploadsResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
8
18
|
|
@@ -1,10 +1,22 @@
|
|
1
1
|
# MuxRuby::ListVideoViewsResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<AbridgedVideoView>**](AbridgedVideoView.md) | | [optional]
|
7
|
-
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<Integer>** | | [optional]
|
9
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<AbridgedVideoView>**](AbridgedVideoView.md) | | [optional] |
|
8
|
+
| **total_row_count** | **Integer** | | [optional] |
|
9
|
+
| **timeframe** | **Array<Integer>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::ListVideoViewsResponse.new(
|
17
|
+
data: null,
|
18
|
+
total_row_count: null,
|
19
|
+
timeframe: null
|
20
|
+
)
|
21
|
+
```
|
10
22
|
|
data/docs/LiveStream.md
CHANGED
@@ -1,20 +1,44 @@
|
|
1
1
|
# MuxRuby::LiveStream
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**id** | **String** | | [optional]
|
7
|
-
**created_at** | **String** | | [optional]
|
8
|
-
**stream_key** | **String** | | [optional]
|
9
|
-
**active_asset_id** | **String** | | [optional]
|
10
|
-
**recent_asset_ids** | **Array<String>** | | [optional]
|
11
|
-
**status** | **String** | | [optional]
|
12
|
-
**playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) | | [optional]
|
13
|
-
**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional]
|
14
|
-
**passthrough** | **String** | | [optional]
|
15
|
-
**reconnect_window** | **Float** | | [optional]
|
16
|
-
**reduced_latency** | **BOOLEAN** | | [optional]
|
17
|
-
**simulcast_targets** | [**Array<SimulcastTarget>**](SimulcastTarget.md) | | [optional]
|
18
|
-
**test** | **BOOLEAN** | | [optional]
|
19
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique identifier for the Live Stream. Max 255 characters. | [optional] |
|
8
|
+
| **created_at** | **String** | Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
|
9
|
+
| **stream_key** | **String** | Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming. | [optional] |
|
10
|
+
| **active_asset_id** | **String** | The Asset that is currently being created if there is an active broadcast. | [optional] |
|
11
|
+
| **recent_asset_ids** | **Array<String>** | An array of strings with the most recent Assets that were created from this live stream. | [optional] |
|
12
|
+
| **status** | **String** | `idle` indicates that there is no active broadcast. `active` indicates that there is an active broadcast and `disabled` status indicates that no future RTMP streams can be published. | [optional] |
|
13
|
+
| **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] |
|
14
|
+
| **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] |
|
15
|
+
| **passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] |
|
16
|
+
| **audio_only** | **Boolean** | The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted. | [optional] |
|
17
|
+
| **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. **Min**: 0.1s. **Max**: 300s (5 minutes). | [optional][default to 60] |
|
18
|
+
| **reduced_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. **Note**: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] |
|
19
|
+
| **simulcast_targets** | [**Array<SimulcastTarget>**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). | [optional] |
|
20
|
+
| **test** | **Boolean** | True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] |
|
21
|
+
|
22
|
+
## Example
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'mux_ruby'
|
26
|
+
|
27
|
+
instance = MuxRuby::LiveStream.new(
|
28
|
+
id: null,
|
29
|
+
created_at: null,
|
30
|
+
stream_key: null,
|
31
|
+
active_asset_id: null,
|
32
|
+
recent_asset_ids: null,
|
33
|
+
status: null,
|
34
|
+
playback_ids: null,
|
35
|
+
new_asset_settings: null,
|
36
|
+
passthrough: null,
|
37
|
+
audio_only: null,
|
38
|
+
reconnect_window: null,
|
39
|
+
reduced_latency: null,
|
40
|
+
simulcast_targets: null,
|
41
|
+
test: null
|
42
|
+
)
|
43
|
+
```
|
20
44
|
|
data/docs/LiveStreamResponse.md
CHANGED
@@ -1,8 +1,18 @@
|
|
1
1
|
# MuxRuby::LiveStreamResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**LiveStream**](.md) | | [optional]
|
7
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**LiveStream**](.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::LiveStreamResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
8
18
|
|
data/docs/LiveStreamsApi.md
CHANGED
@@ -2,29 +2,33 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api.mux.com*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**create_live_stream**](LiveStreamsApi.md#create_live_stream) | **POST** /video/v1/live-streams | Create a live stream
|
8
|
-
[**create_live_stream_playback_id**](LiveStreamsApi.md#create_live_stream_playback_id) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids | Create a live stream playback ID
|
9
|
-
[**create_live_stream_simulcast_target**](LiveStreamsApi.md#create_live_stream_simulcast_target) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets | Create a live stream simulcast target
|
10
|
-
[**delete_live_stream**](LiveStreamsApi.md#delete_live_stream) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID} | Delete a live stream
|
11
|
-
[**delete_live_stream_playback_id**](LiveStreamsApi.md#delete_live_stream_playback_id) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Delete a live stream playback ID
|
12
|
-
[**delete_live_stream_simulcast_target**](LiveStreamsApi.md#delete_live_stream_simulcast_target) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a Live Stream Simulcast Target
|
13
|
-
[**
|
14
|
-
[**
|
15
|
-
[**
|
16
|
-
[**
|
17
|
-
[**
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_live_stream**](LiveStreamsApi.md#create_live_stream) | **POST** /video/v1/live-streams | Create a live stream |
|
8
|
+
| [**create_live_stream_playback_id**](LiveStreamsApi.md#create_live_stream_playback_id) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids | Create a live stream playback ID |
|
9
|
+
| [**create_live_stream_simulcast_target**](LiveStreamsApi.md#create_live_stream_simulcast_target) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets | Create a live stream simulcast target |
|
10
|
+
| [**delete_live_stream**](LiveStreamsApi.md#delete_live_stream) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID} | Delete a live stream |
|
11
|
+
| [**delete_live_stream_playback_id**](LiveStreamsApi.md#delete_live_stream_playback_id) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Delete a live stream playback ID |
|
12
|
+
| [**delete_live_stream_simulcast_target**](LiveStreamsApi.md#delete_live_stream_simulcast_target) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a Live Stream Simulcast Target |
|
13
|
+
| [**disable_live_stream**](LiveStreamsApi.md#disable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream |
|
14
|
+
| [**enable_live_stream**](LiveStreamsApi.md#enable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream |
|
15
|
+
| [**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream |
|
16
|
+
| [**get_live_stream_simulcast_target**](LiveStreamsApi.md#get_live_stream_simulcast_target) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a Live Stream Simulcast Target |
|
17
|
+
| [**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams |
|
18
|
+
| [**reset_stream_key**](LiveStreamsApi.md#reset_stream_key) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream’s stream key |
|
19
|
+
| [**signal_live_stream_complete**](LiveStreamsApi.md#signal_live_stream_complete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished |
|
20
|
+
|
21
|
+
|
22
|
+
## create_live_stream
|
23
|
+
|
24
|
+
> <LiveStreamResponse> create_live_stream(create_live_stream_request)
|
22
25
|
|
23
26
|
Create a live stream
|
24
27
|
|
25
|
-
###
|
28
|
+
### Examples
|
29
|
+
|
26
30
|
```ruby
|
27
|
-
|
31
|
+
require 'time'
|
28
32
|
require 'mux_ruby'
|
29
33
|
# setup authorization
|
30
34
|
MuxRuby.configure do |config|
|
@@ -37,19 +41,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
37
41
|
create_live_stream_request = MuxRuby::CreateLiveStreamRequest.new # CreateLiveStreamRequest |
|
38
42
|
|
39
43
|
begin
|
40
|
-
#Create a live stream
|
44
|
+
# Create a live stream
|
41
45
|
result = api_instance.create_live_stream(create_live_stream_request)
|
42
46
|
p result
|
43
47
|
rescue MuxRuby::ApiError => e
|
44
|
-
puts "
|
48
|
+
puts "Error when calling LiveStreamsApi->create_live_stream: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
#### Using the create_live_stream_with_http_info variant
|
53
|
+
|
54
|
+
This returns an Array which contains the response data, status code and headers.
|
55
|
+
|
56
|
+
> <Array(<LiveStreamResponse>, Integer, Hash)> create_live_stream_with_http_info(create_live_stream_request)
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
begin
|
60
|
+
# Create a live stream
|
61
|
+
data, status_code, headers = api_instance.create_live_stream_with_http_info(create_live_stream_request)
|
62
|
+
p status_code # => 2xx
|
63
|
+
p headers # => { ... }
|
64
|
+
p data # => <LiveStreamResponse>
|
65
|
+
rescue MuxRuby::ApiError => e
|
66
|
+
puts "Error when calling LiveStreamsApi->create_live_stream_with_http_info: #{e}"
|
45
67
|
end
|
46
68
|
```
|
47
69
|
|
48
70
|
### Parameters
|
49
71
|
|
50
|
-
Name | Type | Description
|
51
|
-
|
52
|
-
**create_live_stream_request** | [**CreateLiveStreamRequest**](CreateLiveStreamRequest.md)| |
|
72
|
+
| Name | Type | Description | Notes |
|
73
|
+
| ---- | ---- | ----------- | ----- |
|
74
|
+
| **create_live_stream_request** | [**CreateLiveStreamRequest**](CreateLiveStreamRequest.md) | | |
|
53
75
|
|
54
76
|
### Return type
|
55
77
|
|
@@ -61,19 +83,20 @@ Name | Type | Description | Notes
|
|
61
83
|
|
62
84
|
### HTTP request headers
|
63
85
|
|
64
|
-
|
65
|
-
|
86
|
+
- **Content-Type**: application/json
|
87
|
+
- **Accept**: application/json
|
66
88
|
|
67
89
|
|
90
|
+
## create_live_stream_playback_id
|
68
91
|
|
69
|
-
|
70
|
-
> CreatePlaybackIDResponse create_live_stream_playback_id(live_stream_id, create_playback_id_request)
|
92
|
+
> <CreatePlaybackIDResponse> create_live_stream_playback_id(live_stream_id, create_playback_id_request)
|
71
93
|
|
72
94
|
Create a live stream playback ID
|
73
95
|
|
74
|
-
###
|
96
|
+
### Examples
|
97
|
+
|
75
98
|
```ruby
|
76
|
-
|
99
|
+
require 'time'
|
77
100
|
require 'mux_ruby'
|
78
101
|
# setup authorization
|
79
102
|
MuxRuby.configure do |config|
|
@@ -87,20 +110,38 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
87
110
|
create_playback_id_request = MuxRuby::CreatePlaybackIDRequest.new # CreatePlaybackIDRequest |
|
88
111
|
|
89
112
|
begin
|
90
|
-
#Create a live stream playback ID
|
113
|
+
# Create a live stream playback ID
|
91
114
|
result = api_instance.create_live_stream_playback_id(live_stream_id, create_playback_id_request)
|
92
115
|
p result
|
93
116
|
rescue MuxRuby::ApiError => e
|
94
|
-
puts "
|
117
|
+
puts "Error when calling LiveStreamsApi->create_live_stream_playback_id: #{e}"
|
118
|
+
end
|
119
|
+
```
|
120
|
+
|
121
|
+
#### Using the create_live_stream_playback_id_with_http_info variant
|
122
|
+
|
123
|
+
This returns an Array which contains the response data, status code and headers.
|
124
|
+
|
125
|
+
> <Array(<CreatePlaybackIDResponse>, Integer, Hash)> create_live_stream_playback_id_with_http_info(live_stream_id, create_playback_id_request)
|
126
|
+
|
127
|
+
```ruby
|
128
|
+
begin
|
129
|
+
# Create a live stream playback ID
|
130
|
+
data, status_code, headers = api_instance.create_live_stream_playback_id_with_http_info(live_stream_id, create_playback_id_request)
|
131
|
+
p status_code # => 2xx
|
132
|
+
p headers # => { ... }
|
133
|
+
p data # => <CreatePlaybackIDResponse>
|
134
|
+
rescue MuxRuby::ApiError => e
|
135
|
+
puts "Error when calling LiveStreamsApi->create_live_stream_playback_id_with_http_info: #{e}"
|
95
136
|
end
|
96
137
|
```
|
97
138
|
|
98
139
|
### Parameters
|
99
140
|
|
100
|
-
Name | Type | Description
|
101
|
-
|
102
|
-
**live_stream_id** | **String
|
103
|
-
**create_playback_id_request** | [**CreatePlaybackIDRequest**](CreatePlaybackIDRequest.md)| |
|
141
|
+
| Name | Type | Description | Notes |
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
143
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
144
|
+
| **create_playback_id_request** | [**CreatePlaybackIDRequest**](CreatePlaybackIDRequest.md) | | |
|
104
145
|
|
105
146
|
### Return type
|
106
147
|
|
@@ -112,21 +153,22 @@ Name | Type | Description | Notes
|
|
112
153
|
|
113
154
|
### HTTP request headers
|
114
155
|
|
115
|
-
|
116
|
-
|
156
|
+
- **Content-Type**: application/json
|
157
|
+
- **Accept**: application/json
|
117
158
|
|
118
159
|
|
160
|
+
## create_live_stream_simulcast_target
|
119
161
|
|
120
|
-
|
121
|
-
> SimulcastTargetResponse create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
|
162
|
+
> <SimulcastTargetResponse> create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
|
122
163
|
|
123
164
|
Create a live stream simulcast target
|
124
165
|
|
125
166
|
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.
|
126
167
|
|
127
|
-
###
|
168
|
+
### Examples
|
169
|
+
|
128
170
|
```ruby
|
129
|
-
|
171
|
+
require 'time'
|
130
172
|
require 'mux_ruby'
|
131
173
|
# setup authorization
|
132
174
|
MuxRuby.configure do |config|
|
@@ -137,23 +179,41 @@ end
|
|
137
179
|
|
138
180
|
api_instance = MuxRuby::LiveStreamsApi.new
|
139
181
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
140
|
-
create_simulcast_target_request = MuxRuby::CreateSimulcastTargetRequest.new # CreateSimulcastTargetRequest |
|
182
|
+
create_simulcast_target_request = MuxRuby::CreateSimulcastTargetRequest.new({url: 'url_example'}) # CreateSimulcastTargetRequest |
|
141
183
|
|
142
184
|
begin
|
143
|
-
#Create a live stream simulcast target
|
185
|
+
# Create a live stream simulcast target
|
144
186
|
result = api_instance.create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
|
145
187
|
p result
|
146
188
|
rescue MuxRuby::ApiError => e
|
147
|
-
puts "
|
189
|
+
puts "Error when calling LiveStreamsApi->create_live_stream_simulcast_target: #{e}"
|
190
|
+
end
|
191
|
+
```
|
192
|
+
|
193
|
+
#### Using the create_live_stream_simulcast_target_with_http_info variant
|
194
|
+
|
195
|
+
This returns an Array which contains the response data, status code and headers.
|
196
|
+
|
197
|
+
> <Array(<SimulcastTargetResponse>, Integer, Hash)> create_live_stream_simulcast_target_with_http_info(live_stream_id, create_simulcast_target_request)
|
198
|
+
|
199
|
+
```ruby
|
200
|
+
begin
|
201
|
+
# Create a live stream simulcast target
|
202
|
+
data, status_code, headers = api_instance.create_live_stream_simulcast_target_with_http_info(live_stream_id, create_simulcast_target_request)
|
203
|
+
p status_code # => 2xx
|
204
|
+
p headers # => { ... }
|
205
|
+
p data # => <SimulcastTargetResponse>
|
206
|
+
rescue MuxRuby::ApiError => e
|
207
|
+
puts "Error when calling LiveStreamsApi->create_live_stream_simulcast_target_with_http_info: #{e}"
|
148
208
|
end
|
149
209
|
```
|
150
210
|
|
151
211
|
### Parameters
|
152
212
|
|
153
|
-
Name | Type | Description
|
154
|
-
|
155
|
-
**live_stream_id** | **String
|
156
|
-
**create_simulcast_target_request** | [**CreateSimulcastTargetRequest**](CreateSimulcastTargetRequest.md)| |
|
213
|
+
| Name | Type | Description | Notes |
|
214
|
+
| ---- | ---- | ----------- | ----- |
|
215
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
216
|
+
| **create_simulcast_target_request** | [**CreateSimulcastTargetRequest**](CreateSimulcastTargetRequest.md) | | |
|
157
217
|
|
158
218
|
### Return type
|
159
219
|
|
@@ -165,19 +225,20 @@ Name | Type | Description | Notes
|
|
165
225
|
|
166
226
|
### HTTP request headers
|
167
227
|
|
168
|
-
|
169
|
-
|
228
|
+
- **Content-Type**: application/json
|
229
|
+
- **Accept**: application/json
|
170
230
|
|
171
231
|
|
232
|
+
## delete_live_stream
|
172
233
|
|
173
|
-
# **delete_live_stream**
|
174
234
|
> delete_live_stream(live_stream_id)
|
175
235
|
|
176
236
|
Delete a live stream
|
177
237
|
|
178
|
-
###
|
238
|
+
### Examples
|
239
|
+
|
179
240
|
```ruby
|
180
|
-
|
241
|
+
require 'time'
|
181
242
|
require 'mux_ruby'
|
182
243
|
# setup authorization
|
183
244
|
MuxRuby.configure do |config|
|
@@ -190,18 +251,36 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
190
251
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
191
252
|
|
192
253
|
begin
|
193
|
-
#Delete a live stream
|
254
|
+
# Delete a live stream
|
194
255
|
api_instance.delete_live_stream(live_stream_id)
|
195
256
|
rescue MuxRuby::ApiError => e
|
196
|
-
puts "
|
257
|
+
puts "Error when calling LiveStreamsApi->delete_live_stream: #{e}"
|
258
|
+
end
|
259
|
+
```
|
260
|
+
|
261
|
+
#### Using the delete_live_stream_with_http_info variant
|
262
|
+
|
263
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
264
|
+
|
265
|
+
> <Array(nil, Integer, Hash)> delete_live_stream_with_http_info(live_stream_id)
|
266
|
+
|
267
|
+
```ruby
|
268
|
+
begin
|
269
|
+
# Delete a live stream
|
270
|
+
data, status_code, headers = api_instance.delete_live_stream_with_http_info(live_stream_id)
|
271
|
+
p status_code # => 2xx
|
272
|
+
p headers # => { ... }
|
273
|
+
p data # => nil
|
274
|
+
rescue MuxRuby::ApiError => e
|
275
|
+
puts "Error when calling LiveStreamsApi->delete_live_stream_with_http_info: #{e}"
|
197
276
|
end
|
198
277
|
```
|
199
278
|
|
200
279
|
### Parameters
|
201
280
|
|
202
|
-
Name | Type | Description
|
203
|
-
|
204
|
-
**live_stream_id** | **String
|
281
|
+
| Name | Type | Description | Notes |
|
282
|
+
| ---- | ---- | ----------- | ----- |
|
283
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
205
284
|
|
206
285
|
### Return type
|
207
286
|
|
@@ -213,19 +292,20 @@ nil (empty response body)
|
|
213
292
|
|
214
293
|
### HTTP request headers
|
215
294
|
|
216
|
-
|
217
|
-
|
295
|
+
- **Content-Type**: Not defined
|
296
|
+
- **Accept**: Not defined
|
218
297
|
|
219
298
|
|
299
|
+
## delete_live_stream_playback_id
|
220
300
|
|
221
|
-
# **delete_live_stream_playback_id**
|
222
301
|
> delete_live_stream_playback_id(live_stream_id, playback_id)
|
223
302
|
|
224
303
|
Delete a live stream playback ID
|
225
304
|
|
226
|
-
###
|
305
|
+
### Examples
|
306
|
+
|
227
307
|
```ruby
|
228
|
-
|
308
|
+
require 'time'
|
229
309
|
require 'mux_ruby'
|
230
310
|
# setup authorization
|
231
311
|
MuxRuby.configure do |config|
|
@@ -239,19 +319,37 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
239
319
|
playback_id = 'playback_id_example' # String | The live stream's playback ID.
|
240
320
|
|
241
321
|
begin
|
242
|
-
#Delete a live stream playback ID
|
322
|
+
# Delete a live stream playback ID
|
243
323
|
api_instance.delete_live_stream_playback_id(live_stream_id, playback_id)
|
244
324
|
rescue MuxRuby::ApiError => e
|
245
|
-
puts "
|
325
|
+
puts "Error when calling LiveStreamsApi->delete_live_stream_playback_id: #{e}"
|
326
|
+
end
|
327
|
+
```
|
328
|
+
|
329
|
+
#### Using the delete_live_stream_playback_id_with_http_info variant
|
330
|
+
|
331
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
332
|
+
|
333
|
+
> <Array(nil, Integer, Hash)> delete_live_stream_playback_id_with_http_info(live_stream_id, playback_id)
|
334
|
+
|
335
|
+
```ruby
|
336
|
+
begin
|
337
|
+
# Delete a live stream playback ID
|
338
|
+
data, status_code, headers = api_instance.delete_live_stream_playback_id_with_http_info(live_stream_id, playback_id)
|
339
|
+
p status_code # => 2xx
|
340
|
+
p headers # => { ... }
|
341
|
+
p data # => nil
|
342
|
+
rescue MuxRuby::ApiError => e
|
343
|
+
puts "Error when calling LiveStreamsApi->delete_live_stream_playback_id_with_http_info: #{e}"
|
246
344
|
end
|
247
345
|
```
|
248
346
|
|
249
347
|
### Parameters
|
250
348
|
|
251
|
-
Name | Type | Description
|
252
|
-
|
253
|
-
**live_stream_id** | **String
|
254
|
-
**playback_id** | **String
|
349
|
+
| Name | Type | Description | Notes |
|
350
|
+
| ---- | ---- | ----------- | ----- |
|
351
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
352
|
+
| **playback_id** | **String** | The live stream's playback ID. | |
|
255
353
|
|
256
354
|
### Return type
|
257
355
|
|
@@ -263,21 +361,22 @@ nil (empty response body)
|
|
263
361
|
|
264
362
|
### HTTP request headers
|
265
363
|
|
266
|
-
|
267
|
-
|
364
|
+
- **Content-Type**: Not defined
|
365
|
+
- **Accept**: Not defined
|
268
366
|
|
269
367
|
|
368
|
+
## delete_live_stream_simulcast_target
|
270
369
|
|
271
|
-
# **delete_live_stream_simulcast_target**
|
272
370
|
> delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
273
371
|
|
274
372
|
Delete a Live Stream Simulcast Target
|
275
373
|
|
276
374
|
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.
|
277
375
|
|
278
|
-
###
|
376
|
+
### Examples
|
377
|
+
|
279
378
|
```ruby
|
280
|
-
|
379
|
+
require 'time'
|
281
380
|
require 'mux_ruby'
|
282
381
|
# setup authorization
|
283
382
|
MuxRuby.configure do |config|
|
@@ -291,19 +390,37 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
291
390
|
simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
|
292
391
|
|
293
392
|
begin
|
294
|
-
#Delete a Live Stream Simulcast Target
|
393
|
+
# Delete a Live Stream Simulcast Target
|
295
394
|
api_instance.delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
296
395
|
rescue MuxRuby::ApiError => e
|
297
|
-
puts "
|
396
|
+
puts "Error when calling LiveStreamsApi->delete_live_stream_simulcast_target: #{e}"
|
397
|
+
end
|
398
|
+
```
|
399
|
+
|
400
|
+
#### Using the delete_live_stream_simulcast_target_with_http_info variant
|
401
|
+
|
402
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
403
|
+
|
404
|
+
> <Array(nil, Integer, Hash)> delete_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id)
|
405
|
+
|
406
|
+
```ruby
|
407
|
+
begin
|
408
|
+
# Delete a Live Stream Simulcast Target
|
409
|
+
data, status_code, headers = api_instance.delete_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id)
|
410
|
+
p status_code # => 2xx
|
411
|
+
p headers # => { ... }
|
412
|
+
p data # => nil
|
413
|
+
rescue MuxRuby::ApiError => e
|
414
|
+
puts "Error when calling LiveStreamsApi->delete_live_stream_simulcast_target_with_http_info: #{e}"
|
298
415
|
end
|
299
416
|
```
|
300
417
|
|
301
418
|
### Parameters
|
302
419
|
|
303
|
-
Name | Type | Description
|
304
|
-
|
305
|
-
**live_stream_id** | **String
|
306
|
-
**simulcast_target_id** | **String
|
420
|
+
| Name | Type | Description | Notes |
|
421
|
+
| ---- | ---- | ----------- | ----- |
|
422
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
423
|
+
| **simulcast_target_id** | **String** | The ID of the simulcast target. | |
|
307
424
|
|
308
425
|
### Return type
|
309
426
|
|
@@ -315,21 +432,162 @@ nil (empty response body)
|
|
315
432
|
|
316
433
|
### HTTP request headers
|
317
434
|
|
318
|
-
|
319
|
-
|
435
|
+
- **Content-Type**: Not defined
|
436
|
+
- **Accept**: Not defined
|
437
|
+
|
438
|
+
|
439
|
+
## disable_live_stream
|
440
|
+
|
441
|
+
> <DisableLiveStreamResponse> disable_live_stream(live_stream_id)
|
442
|
+
|
443
|
+
Disable a live stream
|
444
|
+
|
445
|
+
Disables a live stream, making it reject incoming RTMP streams until re-enabled. The API also ends the live stream recording immediately when active. Ending the live stream recording adds the `EXT-X-ENDLIST` tag to the HLS manifest which notifies the player that this live stream is over. Mux also closes the encoder connection immediately. Any attempt from the encoder to re-establish connection will fail till the live stream is re-enabled.
|
446
|
+
|
447
|
+
### Examples
|
448
|
+
|
449
|
+
```ruby
|
450
|
+
require 'time'
|
451
|
+
require 'mux_ruby'
|
452
|
+
# setup authorization
|
453
|
+
MuxRuby.configure do |config|
|
454
|
+
# Configure HTTP basic authorization: accessToken
|
455
|
+
config.username = 'YOUR USERNAME'
|
456
|
+
config.password = 'YOUR PASSWORD'
|
457
|
+
end
|
458
|
+
|
459
|
+
api_instance = MuxRuby::LiveStreamsApi.new
|
460
|
+
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
461
|
+
|
462
|
+
begin
|
463
|
+
# Disable a live stream
|
464
|
+
result = api_instance.disable_live_stream(live_stream_id)
|
465
|
+
p result
|
466
|
+
rescue MuxRuby::ApiError => e
|
467
|
+
puts "Error when calling LiveStreamsApi->disable_live_stream: #{e}"
|
468
|
+
end
|
469
|
+
```
|
470
|
+
|
471
|
+
#### Using the disable_live_stream_with_http_info variant
|
472
|
+
|
473
|
+
This returns an Array which contains the response data, status code and headers.
|
474
|
+
|
475
|
+
> <Array(<DisableLiveStreamResponse>, Integer, Hash)> disable_live_stream_with_http_info(live_stream_id)
|
476
|
+
|
477
|
+
```ruby
|
478
|
+
begin
|
479
|
+
# Disable a live stream
|
480
|
+
data, status_code, headers = api_instance.disable_live_stream_with_http_info(live_stream_id)
|
481
|
+
p status_code # => 2xx
|
482
|
+
p headers # => { ... }
|
483
|
+
p data # => <DisableLiveStreamResponse>
|
484
|
+
rescue MuxRuby::ApiError => e
|
485
|
+
puts "Error when calling LiveStreamsApi->disable_live_stream_with_http_info: #{e}"
|
486
|
+
end
|
487
|
+
```
|
488
|
+
|
489
|
+
### Parameters
|
490
|
+
|
491
|
+
| Name | Type | Description | Notes |
|
492
|
+
| ---- | ---- | ----------- | ----- |
|
493
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
494
|
+
|
495
|
+
### Return type
|
496
|
+
|
497
|
+
[**DisableLiveStreamResponse**](DisableLiveStreamResponse.md)
|
498
|
+
|
499
|
+
### Authorization
|
500
|
+
|
501
|
+
[accessToken](../README.md#accessToken)
|
502
|
+
|
503
|
+
### HTTP request headers
|
504
|
+
|
505
|
+
- **Content-Type**: Not defined
|
506
|
+
- **Accept**: application/json
|
507
|
+
|
508
|
+
|
509
|
+
## enable_live_stream
|
510
|
+
|
511
|
+
> <EnableLiveStreamResponse> enable_live_stream(live_stream_id)
|
512
|
+
|
513
|
+
Enable a live stream
|
514
|
+
|
515
|
+
Enables a live stream, allowing it to accept an incoming RTMP stream.
|
516
|
+
|
517
|
+
### Examples
|
518
|
+
|
519
|
+
```ruby
|
520
|
+
require 'time'
|
521
|
+
require 'mux_ruby'
|
522
|
+
# setup authorization
|
523
|
+
MuxRuby.configure do |config|
|
524
|
+
# Configure HTTP basic authorization: accessToken
|
525
|
+
config.username = 'YOUR USERNAME'
|
526
|
+
config.password = 'YOUR PASSWORD'
|
527
|
+
end
|
320
528
|
|
529
|
+
api_instance = MuxRuby::LiveStreamsApi.new
|
530
|
+
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
321
531
|
|
532
|
+
begin
|
533
|
+
# Enable a live stream
|
534
|
+
result = api_instance.enable_live_stream(live_stream_id)
|
535
|
+
p result
|
536
|
+
rescue MuxRuby::ApiError => e
|
537
|
+
puts "Error when calling LiveStreamsApi->enable_live_stream: #{e}"
|
538
|
+
end
|
539
|
+
```
|
322
540
|
|
323
|
-
|
324
|
-
|
541
|
+
#### Using the enable_live_stream_with_http_info variant
|
542
|
+
|
543
|
+
This returns an Array which contains the response data, status code and headers.
|
544
|
+
|
545
|
+
> <Array(<EnableLiveStreamResponse>, Integer, Hash)> enable_live_stream_with_http_info(live_stream_id)
|
546
|
+
|
547
|
+
```ruby
|
548
|
+
begin
|
549
|
+
# Enable a live stream
|
550
|
+
data, status_code, headers = api_instance.enable_live_stream_with_http_info(live_stream_id)
|
551
|
+
p status_code # => 2xx
|
552
|
+
p headers # => { ... }
|
553
|
+
p data # => <EnableLiveStreamResponse>
|
554
|
+
rescue MuxRuby::ApiError => e
|
555
|
+
puts "Error when calling LiveStreamsApi->enable_live_stream_with_http_info: #{e}"
|
556
|
+
end
|
557
|
+
```
|
558
|
+
|
559
|
+
### Parameters
|
560
|
+
|
561
|
+
| Name | Type | Description | Notes |
|
562
|
+
| ---- | ---- | ----------- | ----- |
|
563
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
564
|
+
|
565
|
+
### Return type
|
566
|
+
|
567
|
+
[**EnableLiveStreamResponse**](EnableLiveStreamResponse.md)
|
568
|
+
|
569
|
+
### Authorization
|
570
|
+
|
571
|
+
[accessToken](../README.md#accessToken)
|
572
|
+
|
573
|
+
### HTTP request headers
|
574
|
+
|
575
|
+
- **Content-Type**: Not defined
|
576
|
+
- **Accept**: application/json
|
577
|
+
|
578
|
+
|
579
|
+
## get_live_stream
|
580
|
+
|
581
|
+
> <LiveStreamResponse> get_live_stream(live_stream_id)
|
325
582
|
|
326
583
|
Retrieve a live stream
|
327
584
|
|
328
585
|
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.
|
329
586
|
|
330
|
-
###
|
587
|
+
### Examples
|
588
|
+
|
331
589
|
```ruby
|
332
|
-
|
590
|
+
require 'time'
|
333
591
|
require 'mux_ruby'
|
334
592
|
# setup authorization
|
335
593
|
MuxRuby.configure do |config|
|
@@ -342,19 +600,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
342
600
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
343
601
|
|
344
602
|
begin
|
345
|
-
#Retrieve a live stream
|
603
|
+
# Retrieve a live stream
|
346
604
|
result = api_instance.get_live_stream(live_stream_id)
|
347
605
|
p result
|
348
606
|
rescue MuxRuby::ApiError => e
|
349
|
-
puts "
|
607
|
+
puts "Error when calling LiveStreamsApi->get_live_stream: #{e}"
|
608
|
+
end
|
609
|
+
```
|
610
|
+
|
611
|
+
#### Using the get_live_stream_with_http_info variant
|
612
|
+
|
613
|
+
This returns an Array which contains the response data, status code and headers.
|
614
|
+
|
615
|
+
> <Array(<LiveStreamResponse>, Integer, Hash)> get_live_stream_with_http_info(live_stream_id)
|
616
|
+
|
617
|
+
```ruby
|
618
|
+
begin
|
619
|
+
# Retrieve a live stream
|
620
|
+
data, status_code, headers = api_instance.get_live_stream_with_http_info(live_stream_id)
|
621
|
+
p status_code # => 2xx
|
622
|
+
p headers # => { ... }
|
623
|
+
p data # => <LiveStreamResponse>
|
624
|
+
rescue MuxRuby::ApiError => e
|
625
|
+
puts "Error when calling LiveStreamsApi->get_live_stream_with_http_info: #{e}"
|
350
626
|
end
|
351
627
|
```
|
352
628
|
|
353
629
|
### Parameters
|
354
630
|
|
355
|
-
Name | Type | Description
|
356
|
-
|
357
|
-
**live_stream_id** | **String
|
631
|
+
| Name | Type | Description | Notes |
|
632
|
+
| ---- | ---- | ----------- | ----- |
|
633
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
358
634
|
|
359
635
|
### Return type
|
360
636
|
|
@@ -366,21 +642,22 @@ Name | Type | Description | Notes
|
|
366
642
|
|
367
643
|
### HTTP request headers
|
368
644
|
|
369
|
-
|
370
|
-
|
645
|
+
- **Content-Type**: Not defined
|
646
|
+
- **Accept**: application/json
|
371
647
|
|
372
648
|
|
649
|
+
## get_live_stream_simulcast_target
|
373
650
|
|
374
|
-
|
375
|
-
> SimulcastTargetResponse get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
651
|
+
> <SimulcastTargetResponse> get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
376
652
|
|
377
653
|
Retrieve a Live Stream Simulcast Target
|
378
654
|
|
379
655
|
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.
|
380
656
|
|
381
|
-
###
|
657
|
+
### Examples
|
658
|
+
|
382
659
|
```ruby
|
383
|
-
|
660
|
+
require 'time'
|
384
661
|
require 'mux_ruby'
|
385
662
|
# setup authorization
|
386
663
|
MuxRuby.configure do |config|
|
@@ -394,20 +671,38 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
394
671
|
simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
|
395
672
|
|
396
673
|
begin
|
397
|
-
#Retrieve a Live Stream Simulcast Target
|
674
|
+
# Retrieve a Live Stream Simulcast Target
|
398
675
|
result = api_instance.get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
399
676
|
p result
|
400
677
|
rescue MuxRuby::ApiError => e
|
401
|
-
puts "
|
678
|
+
puts "Error when calling LiveStreamsApi->get_live_stream_simulcast_target: #{e}"
|
679
|
+
end
|
680
|
+
```
|
681
|
+
|
682
|
+
#### Using the get_live_stream_simulcast_target_with_http_info variant
|
683
|
+
|
684
|
+
This returns an Array which contains the response data, status code and headers.
|
685
|
+
|
686
|
+
> <Array(<SimulcastTargetResponse>, Integer, Hash)> get_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id)
|
687
|
+
|
688
|
+
```ruby
|
689
|
+
begin
|
690
|
+
# Retrieve a Live Stream Simulcast Target
|
691
|
+
data, status_code, headers = api_instance.get_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id)
|
692
|
+
p status_code # => 2xx
|
693
|
+
p headers # => { ... }
|
694
|
+
p data # => <SimulcastTargetResponse>
|
695
|
+
rescue MuxRuby::ApiError => e
|
696
|
+
puts "Error when calling LiveStreamsApi->get_live_stream_simulcast_target_with_http_info: #{e}"
|
402
697
|
end
|
403
698
|
```
|
404
699
|
|
405
700
|
### Parameters
|
406
701
|
|
407
|
-
Name | Type | Description
|
408
|
-
|
409
|
-
**live_stream_id** | **String
|
410
|
-
**simulcast_target_id** | **String
|
702
|
+
| Name | Type | Description | Notes |
|
703
|
+
| ---- | ---- | ----------- | ----- |
|
704
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
705
|
+
| **simulcast_target_id** | **String** | The ID of the simulcast target. | |
|
411
706
|
|
412
707
|
### Return type
|
413
708
|
|
@@ -419,19 +714,20 @@ Name | Type | Description | Notes
|
|
419
714
|
|
420
715
|
### HTTP request headers
|
421
716
|
|
422
|
-
|
423
|
-
|
717
|
+
- **Content-Type**: Not defined
|
718
|
+
- **Accept**: application/json
|
424
719
|
|
425
720
|
|
721
|
+
## list_live_streams
|
426
722
|
|
427
|
-
|
428
|
-
> ListLiveStreamsResponse list_live_streams(opts)
|
723
|
+
> <ListLiveStreamsResponse> list_live_streams(opts)
|
429
724
|
|
430
725
|
List live streams
|
431
726
|
|
432
|
-
###
|
727
|
+
### Examples
|
728
|
+
|
433
729
|
```ruby
|
434
|
-
|
730
|
+
require 'time'
|
435
731
|
require 'mux_ruby'
|
436
732
|
# setup authorization
|
437
733
|
MuxRuby.configure do |config|
|
@@ -442,25 +738,45 @@ end
|
|
442
738
|
|
443
739
|
api_instance = MuxRuby::LiveStreamsApi.new
|
444
740
|
opts = {
|
445
|
-
limit:
|
446
|
-
page:
|
741
|
+
limit: 56, # Integer | Number of items to include in the response
|
742
|
+
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
743
|
+
stream_key: 'stream_key_example' # String | Filter response to return live stream for this stream key only
|
447
744
|
}
|
448
745
|
|
449
746
|
begin
|
450
|
-
#List live streams
|
747
|
+
# List live streams
|
451
748
|
result = api_instance.list_live_streams(opts)
|
452
749
|
p result
|
453
750
|
rescue MuxRuby::ApiError => e
|
454
|
-
puts "
|
751
|
+
puts "Error when calling LiveStreamsApi->list_live_streams: #{e}"
|
752
|
+
end
|
753
|
+
```
|
754
|
+
|
755
|
+
#### Using the list_live_streams_with_http_info variant
|
756
|
+
|
757
|
+
This returns an Array which contains the response data, status code and headers.
|
758
|
+
|
759
|
+
> <Array(<ListLiveStreamsResponse>, Integer, Hash)> list_live_streams_with_http_info(opts)
|
760
|
+
|
761
|
+
```ruby
|
762
|
+
begin
|
763
|
+
# List live streams
|
764
|
+
data, status_code, headers = api_instance.list_live_streams_with_http_info(opts)
|
765
|
+
p status_code # => 2xx
|
766
|
+
p headers # => { ... }
|
767
|
+
p data # => <ListLiveStreamsResponse>
|
768
|
+
rescue MuxRuby::ApiError => e
|
769
|
+
puts "Error when calling LiveStreamsApi->list_live_streams_with_http_info: #{e}"
|
455
770
|
end
|
456
771
|
```
|
457
772
|
|
458
773
|
### Parameters
|
459
774
|
|
460
|
-
Name | Type | Description
|
461
|
-
|
462
|
-
**limit** | **Integer
|
463
|
-
**page** | **Integer
|
775
|
+
| Name | Type | Description | Notes |
|
776
|
+
| ---- | ---- | ----------- | ----- |
|
777
|
+
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
778
|
+
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
779
|
+
| **stream_key** | **String** | Filter response to return live stream for this stream key only | [optional] |
|
464
780
|
|
465
781
|
### Return type
|
466
782
|
|
@@ -472,21 +788,22 @@ Name | Type | Description | Notes
|
|
472
788
|
|
473
789
|
### HTTP request headers
|
474
790
|
|
475
|
-
|
476
|
-
|
791
|
+
- **Content-Type**: Not defined
|
792
|
+
- **Accept**: application/json
|
477
793
|
|
478
794
|
|
795
|
+
## reset_stream_key
|
479
796
|
|
480
|
-
|
481
|
-
> LiveStreamResponse reset_stream_key(live_stream_id)
|
797
|
+
> <LiveStreamResponse> reset_stream_key(live_stream_id)
|
482
798
|
|
483
799
|
Reset a live stream’s stream key
|
484
800
|
|
485
801
|
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.
|
486
802
|
|
487
|
-
###
|
803
|
+
### Examples
|
804
|
+
|
488
805
|
```ruby
|
489
|
-
|
806
|
+
require 'time'
|
490
807
|
require 'mux_ruby'
|
491
808
|
# setup authorization
|
492
809
|
MuxRuby.configure do |config|
|
@@ -499,19 +816,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
499
816
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
500
817
|
|
501
818
|
begin
|
502
|
-
#Reset a live stream’s stream key
|
819
|
+
# Reset a live stream’s stream key
|
503
820
|
result = api_instance.reset_stream_key(live_stream_id)
|
504
821
|
p result
|
505
822
|
rescue MuxRuby::ApiError => e
|
506
|
-
puts "
|
823
|
+
puts "Error when calling LiveStreamsApi->reset_stream_key: #{e}"
|
824
|
+
end
|
825
|
+
```
|
826
|
+
|
827
|
+
#### Using the reset_stream_key_with_http_info variant
|
828
|
+
|
829
|
+
This returns an Array which contains the response data, status code and headers.
|
830
|
+
|
831
|
+
> <Array(<LiveStreamResponse>, Integer, Hash)> reset_stream_key_with_http_info(live_stream_id)
|
832
|
+
|
833
|
+
```ruby
|
834
|
+
begin
|
835
|
+
# Reset a live stream’s stream key
|
836
|
+
data, status_code, headers = api_instance.reset_stream_key_with_http_info(live_stream_id)
|
837
|
+
p status_code # => 2xx
|
838
|
+
p headers # => { ... }
|
839
|
+
p data # => <LiveStreamResponse>
|
840
|
+
rescue MuxRuby::ApiError => e
|
841
|
+
puts "Error when calling LiveStreamsApi->reset_stream_key_with_http_info: #{e}"
|
507
842
|
end
|
508
843
|
```
|
509
844
|
|
510
845
|
### Parameters
|
511
846
|
|
512
|
-
Name | Type | Description
|
513
|
-
|
514
|
-
**live_stream_id** | **String
|
847
|
+
| Name | Type | Description | Notes |
|
848
|
+
| ---- | ---- | ----------- | ----- |
|
849
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
515
850
|
|
516
851
|
### Return type
|
517
852
|
|
@@ -523,21 +858,22 @@ Name | Type | Description | Notes
|
|
523
858
|
|
524
859
|
### HTTP request headers
|
525
860
|
|
526
|
-
|
527
|
-
|
861
|
+
- **Content-Type**: Not defined
|
862
|
+
- **Accept**: application/json
|
528
863
|
|
529
864
|
|
865
|
+
## signal_live_stream_complete
|
530
866
|
|
531
|
-
|
532
|
-
> SignalLiveStreamCompleteResponse signal_live_stream_complete(live_stream_id)
|
867
|
+
> <SignalLiveStreamCompleteResponse> signal_live_stream_complete(live_stream_id)
|
533
868
|
|
534
869
|
Signal a live stream is finished
|
535
870
|
|
536
|
-
(Optional)
|
871
|
+
(Optional) End the live stream recording immediately instead of waiting for the reconnect_window. `EXT-X-ENDLIST` tag is added to the HLS manifest which notifies the player that this live stream is over. Mux does not close the encoder connection immediately. Encoders are often configured to re-establish connections immediately which would result in a new recorded asset. For this reason, Mux waits for 60s before closing the connection with the encoder. This 60s timeframe is meant to give encoder operators a chance to disconnect from their end.
|
872
|
+
|
873
|
+
### Examples
|
537
874
|
|
538
|
-
### Example
|
539
875
|
```ruby
|
540
|
-
|
876
|
+
require 'time'
|
541
877
|
require 'mux_ruby'
|
542
878
|
# setup authorization
|
543
879
|
MuxRuby.configure do |config|
|
@@ -550,19 +886,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
550
886
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
551
887
|
|
552
888
|
begin
|
553
|
-
#Signal a live stream is finished
|
889
|
+
# Signal a live stream is finished
|
554
890
|
result = api_instance.signal_live_stream_complete(live_stream_id)
|
555
891
|
p result
|
556
892
|
rescue MuxRuby::ApiError => e
|
557
|
-
puts "
|
893
|
+
puts "Error when calling LiveStreamsApi->signal_live_stream_complete: #{e}"
|
894
|
+
end
|
895
|
+
```
|
896
|
+
|
897
|
+
#### Using the signal_live_stream_complete_with_http_info variant
|
898
|
+
|
899
|
+
This returns an Array which contains the response data, status code and headers.
|
900
|
+
|
901
|
+
> <Array(<SignalLiveStreamCompleteResponse>, Integer, Hash)> signal_live_stream_complete_with_http_info(live_stream_id)
|
902
|
+
|
903
|
+
```ruby
|
904
|
+
begin
|
905
|
+
# Signal a live stream is finished
|
906
|
+
data, status_code, headers = api_instance.signal_live_stream_complete_with_http_info(live_stream_id)
|
907
|
+
p status_code # => 2xx
|
908
|
+
p headers # => { ... }
|
909
|
+
p data # => <SignalLiveStreamCompleteResponse>
|
910
|
+
rescue MuxRuby::ApiError => e
|
911
|
+
puts "Error when calling LiveStreamsApi->signal_live_stream_complete_with_http_info: #{e}"
|
558
912
|
end
|
559
913
|
```
|
560
914
|
|
561
915
|
### Parameters
|
562
916
|
|
563
|
-
Name | Type | Description
|
564
|
-
|
565
|
-
**live_stream_id** | **String
|
917
|
+
| Name | Type | Description | Notes |
|
918
|
+
| ---- | ---- | ----------- | ----- |
|
919
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
566
920
|
|
567
921
|
### Return type
|
568
922
|
|
@@ -574,8 +928,6 @@ Name | Type | Description | Notes
|
|
574
928
|
|
575
929
|
### HTTP request headers
|
576
930
|
|
577
|
-
|
578
|
-
|
579
|
-
|
580
|
-
|
931
|
+
- **Content-Type**: Not defined
|
932
|
+
- **Accept**: application/json
|
581
933
|
|