mux_ruby 1.8.1 → 2.0.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 -25
- 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 -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 +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 +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 +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 -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 +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 +39 -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 +78 -0
- 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/examples/video/exercise-assets.rb +21 -0
- data/examples/video/exercise-live-streams.rb +8 -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 +16 -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 +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 +85 -0
- 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 +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 +129 -58
- 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 +78 -43
- data/lib/mux_ruby/models/asset_recording_times.rb +52 -18
- 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 +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 +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 +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 +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 +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 +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 +50 -16
- 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 +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 +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/playback_id_api_spec.rb +40 -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_spec.rb +10 -0
- data/spec/models/export_date_spec.rb +40 -0
- data/spec/models/export_file_spec.rb +46 -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/input_settings_spec.rb +12 -0
- data/spec/models/list_video_view_exports_response_spec.rb +46 -0
- data/spec/models/track_spec.rb +4 -0
- data/spec/spec_helper.rb +9 -2
- metadata +161 -235
@@ -1,9 +1,20 @@
|
|
1
1
|
# MuxRuby::ListRealTimeDimensionsResponseData
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | | [optional]
|
7
|
-
**display_name** | **String** | | [optional]
|
8
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
|
+
```
|
9
20
|
|
@@ -1,10 +1,22 @@
|
|
1
1
|
# MuxRuby::ListRealTimeMetricsResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<ListRealTimeDimensionsResponseData>**](ListRealTimeDimensionsResponseData.md) | | [optional]
|
7
|
-
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<Integer>** | | [optional]
|
9
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
|
+
```
|
10
22
|
|
@@ -1,10 +1,22 @@
|
|
1
1
|
# MuxRuby::ListRelatedIncidentsResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<Incident>**](Incident.md) | | [optional]
|
7
|
-
**total_row_count** | **Integer** | | [optional]
|
8
|
-
**timeframe** | **Array<Integer>** | | [optional]
|
9
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
|
+
```
|
10
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
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MuxRuby::ListVideoViewExportsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<ExportDate>**](ExportDate.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::ListVideoViewExportsResponse.new(
|
17
|
+
data: null,
|
18
|
+
total_row_count: null,
|
19
|
+
timeframe: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -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,31 +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
|
-
[**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
|
-
|
23
|
-
|
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)
|
24
25
|
|
25
26
|
Create a live stream
|
26
27
|
|
27
|
-
###
|
28
|
+
### Examples
|
29
|
+
|
28
30
|
```ruby
|
29
|
-
|
31
|
+
require 'time'
|
30
32
|
require 'mux_ruby'
|
31
33
|
# setup authorization
|
32
34
|
MuxRuby.configure do |config|
|
@@ -39,19 +41,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
39
41
|
create_live_stream_request = MuxRuby::CreateLiveStreamRequest.new # CreateLiveStreamRequest |
|
40
42
|
|
41
43
|
begin
|
42
|
-
#Create a live stream
|
44
|
+
# Create a live stream
|
43
45
|
result = api_instance.create_live_stream(create_live_stream_request)
|
44
46
|
p result
|
45
47
|
rescue MuxRuby::ApiError => e
|
46
|
-
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}"
|
47
67
|
end
|
48
68
|
```
|
49
69
|
|
50
70
|
### Parameters
|
51
71
|
|
52
|
-
Name | Type | Description
|
53
|
-
|
54
|
-
**create_live_stream_request** | [**CreateLiveStreamRequest**](CreateLiveStreamRequest.md)| |
|
72
|
+
| Name | Type | Description | Notes |
|
73
|
+
| ---- | ---- | ----------- | ----- |
|
74
|
+
| **create_live_stream_request** | [**CreateLiveStreamRequest**](CreateLiveStreamRequest.md) | | |
|
55
75
|
|
56
76
|
### Return type
|
57
77
|
|
@@ -63,19 +83,20 @@ Name | Type | Description | Notes
|
|
63
83
|
|
64
84
|
### HTTP request headers
|
65
85
|
|
66
|
-
|
67
|
-
|
86
|
+
- **Content-Type**: application/json
|
87
|
+
- **Accept**: application/json
|
68
88
|
|
69
89
|
|
90
|
+
## create_live_stream_playback_id
|
70
91
|
|
71
|
-
|
72
|
-
> 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)
|
73
93
|
|
74
94
|
Create a live stream playback ID
|
75
95
|
|
76
|
-
###
|
96
|
+
### Examples
|
97
|
+
|
77
98
|
```ruby
|
78
|
-
|
99
|
+
require 'time'
|
79
100
|
require 'mux_ruby'
|
80
101
|
# setup authorization
|
81
102
|
MuxRuby.configure do |config|
|
@@ -89,20 +110,38 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
89
110
|
create_playback_id_request = MuxRuby::CreatePlaybackIDRequest.new # CreatePlaybackIDRequest |
|
90
111
|
|
91
112
|
begin
|
92
|
-
#Create a live stream playback ID
|
113
|
+
# Create a live stream playback ID
|
93
114
|
result = api_instance.create_live_stream_playback_id(live_stream_id, create_playback_id_request)
|
94
115
|
p result
|
95
116
|
rescue MuxRuby::ApiError => e
|
96
|
-
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}"
|
97
136
|
end
|
98
137
|
```
|
99
138
|
|
100
139
|
### Parameters
|
101
140
|
|
102
|
-
Name | Type | Description
|
103
|
-
|
104
|
-
**live_stream_id** | **String
|
105
|
-
**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) | | |
|
106
145
|
|
107
146
|
### Return type
|
108
147
|
|
@@ -114,21 +153,22 @@ Name | Type | Description | Notes
|
|
114
153
|
|
115
154
|
### HTTP request headers
|
116
155
|
|
117
|
-
|
118
|
-
|
156
|
+
- **Content-Type**: application/json
|
157
|
+
- **Accept**: application/json
|
119
158
|
|
120
159
|
|
160
|
+
## create_live_stream_simulcast_target
|
121
161
|
|
122
|
-
|
123
|
-
> 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)
|
124
163
|
|
125
164
|
Create a live stream simulcast target
|
126
165
|
|
127
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.
|
128
167
|
|
129
|
-
###
|
168
|
+
### Examples
|
169
|
+
|
130
170
|
```ruby
|
131
|
-
|
171
|
+
require 'time'
|
132
172
|
require 'mux_ruby'
|
133
173
|
# setup authorization
|
134
174
|
MuxRuby.configure do |config|
|
@@ -139,23 +179,41 @@ end
|
|
139
179
|
|
140
180
|
api_instance = MuxRuby::LiveStreamsApi.new
|
141
181
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
142
|
-
create_simulcast_target_request = MuxRuby::CreateSimulcastTargetRequest.new # CreateSimulcastTargetRequest |
|
182
|
+
create_simulcast_target_request = MuxRuby::CreateSimulcastTargetRequest.new({url: 'url_example'}) # CreateSimulcastTargetRequest |
|
143
183
|
|
144
184
|
begin
|
145
|
-
#Create a live stream simulcast target
|
185
|
+
# Create a live stream simulcast target
|
146
186
|
result = api_instance.create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
|
147
187
|
p result
|
148
188
|
rescue MuxRuby::ApiError => e
|
149
|
-
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}"
|
150
208
|
end
|
151
209
|
```
|
152
210
|
|
153
211
|
### Parameters
|
154
212
|
|
155
|
-
Name | Type | Description
|
156
|
-
|
157
|
-
**live_stream_id** | **String
|
158
|
-
**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) | | |
|
159
217
|
|
160
218
|
### Return type
|
161
219
|
|
@@ -167,19 +225,20 @@ Name | Type | Description | Notes
|
|
167
225
|
|
168
226
|
### HTTP request headers
|
169
227
|
|
170
|
-
|
171
|
-
|
228
|
+
- **Content-Type**: application/json
|
229
|
+
- **Accept**: application/json
|
172
230
|
|
173
231
|
|
232
|
+
## delete_live_stream
|
174
233
|
|
175
|
-
# **delete_live_stream**
|
176
234
|
> delete_live_stream(live_stream_id)
|
177
235
|
|
178
236
|
Delete a live stream
|
179
237
|
|
180
|
-
###
|
238
|
+
### Examples
|
239
|
+
|
181
240
|
```ruby
|
182
|
-
|
241
|
+
require 'time'
|
183
242
|
require 'mux_ruby'
|
184
243
|
# setup authorization
|
185
244
|
MuxRuby.configure do |config|
|
@@ -192,18 +251,36 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
192
251
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
193
252
|
|
194
253
|
begin
|
195
|
-
#Delete a live stream
|
254
|
+
# Delete a live stream
|
196
255
|
api_instance.delete_live_stream(live_stream_id)
|
197
256
|
rescue MuxRuby::ApiError => e
|
198
|
-
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}"
|
199
276
|
end
|
200
277
|
```
|
201
278
|
|
202
279
|
### Parameters
|
203
280
|
|
204
|
-
Name | Type | Description
|
205
|
-
|
206
|
-
**live_stream_id** | **String
|
281
|
+
| Name | Type | Description | Notes |
|
282
|
+
| ---- | ---- | ----------- | ----- |
|
283
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
207
284
|
|
208
285
|
### Return type
|
209
286
|
|
@@ -215,19 +292,20 @@ nil (empty response body)
|
|
215
292
|
|
216
293
|
### HTTP request headers
|
217
294
|
|
218
|
-
|
219
|
-
|
295
|
+
- **Content-Type**: Not defined
|
296
|
+
- **Accept**: Not defined
|
220
297
|
|
221
298
|
|
299
|
+
## delete_live_stream_playback_id
|
222
300
|
|
223
|
-
# **delete_live_stream_playback_id**
|
224
301
|
> delete_live_stream_playback_id(live_stream_id, playback_id)
|
225
302
|
|
226
303
|
Delete a live stream playback ID
|
227
304
|
|
228
|
-
###
|
305
|
+
### Examples
|
306
|
+
|
229
307
|
```ruby
|
230
|
-
|
308
|
+
require 'time'
|
231
309
|
require 'mux_ruby'
|
232
310
|
# setup authorization
|
233
311
|
MuxRuby.configure do |config|
|
@@ -241,19 +319,37 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
241
319
|
playback_id = 'playback_id_example' # String | The live stream's playback ID.
|
242
320
|
|
243
321
|
begin
|
244
|
-
#Delete a live stream playback ID
|
322
|
+
# Delete a live stream playback ID
|
245
323
|
api_instance.delete_live_stream_playback_id(live_stream_id, playback_id)
|
246
324
|
rescue MuxRuby::ApiError => e
|
247
|
-
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}"
|
248
344
|
end
|
249
345
|
```
|
250
346
|
|
251
347
|
### Parameters
|
252
348
|
|
253
|
-
Name | Type | Description
|
254
|
-
|
255
|
-
**live_stream_id** | **String
|
256
|
-
**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. | |
|
257
353
|
|
258
354
|
### Return type
|
259
355
|
|
@@ -265,21 +361,22 @@ nil (empty response body)
|
|
265
361
|
|
266
362
|
### HTTP request headers
|
267
363
|
|
268
|
-
|
269
|
-
|
364
|
+
- **Content-Type**: Not defined
|
365
|
+
- **Accept**: Not defined
|
270
366
|
|
271
367
|
|
368
|
+
## delete_live_stream_simulcast_target
|
272
369
|
|
273
|
-
# **delete_live_stream_simulcast_target**
|
274
370
|
> delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
275
371
|
|
276
372
|
Delete a Live Stream Simulcast Target
|
277
373
|
|
278
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.
|
279
375
|
|
280
|
-
###
|
376
|
+
### Examples
|
377
|
+
|
281
378
|
```ruby
|
282
|
-
|
379
|
+
require 'time'
|
283
380
|
require 'mux_ruby'
|
284
381
|
# setup authorization
|
285
382
|
MuxRuby.configure do |config|
|
@@ -293,19 +390,37 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
293
390
|
simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
|
294
391
|
|
295
392
|
begin
|
296
|
-
#Delete a Live Stream Simulcast Target
|
393
|
+
# Delete a Live Stream Simulcast Target
|
297
394
|
api_instance.delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
298
395
|
rescue MuxRuby::ApiError => e
|
299
|
-
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}"
|
300
415
|
end
|
301
416
|
```
|
302
417
|
|
303
418
|
### Parameters
|
304
419
|
|
305
|
-
Name | Type | Description
|
306
|
-
|
307
|
-
**live_stream_id** | **String
|
308
|
-
**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. | |
|
309
424
|
|
310
425
|
### Return type
|
311
426
|
|
@@ -317,21 +432,22 @@ nil (empty response body)
|
|
317
432
|
|
318
433
|
### HTTP request headers
|
319
434
|
|
320
|
-
|
321
|
-
|
435
|
+
- **Content-Type**: Not defined
|
436
|
+
- **Accept**: Not defined
|
322
437
|
|
323
438
|
|
439
|
+
## disable_live_stream
|
324
440
|
|
325
|
-
|
326
|
-
> DisableLiveStreamResponse disable_live_stream(live_stream_id)
|
441
|
+
> <DisableLiveStreamResponse> disable_live_stream(live_stream_id)
|
327
442
|
|
328
443
|
Disable a live stream
|
329
444
|
|
330
|
-
Disables a live stream, making it reject incoming RTMP streams until re-enabled.
|
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
|
331
448
|
|
332
|
-
### Example
|
333
449
|
```ruby
|
334
|
-
|
450
|
+
require 'time'
|
335
451
|
require 'mux_ruby'
|
336
452
|
# setup authorization
|
337
453
|
MuxRuby.configure do |config|
|
@@ -344,19 +460,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
344
460
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
345
461
|
|
346
462
|
begin
|
347
|
-
#Disable a live stream
|
463
|
+
# Disable a live stream
|
348
464
|
result = api_instance.disable_live_stream(live_stream_id)
|
349
465
|
p result
|
350
466
|
rescue MuxRuby::ApiError => e
|
351
|
-
puts "
|
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}"
|
352
486
|
end
|
353
487
|
```
|
354
488
|
|
355
489
|
### Parameters
|
356
490
|
|
357
|
-
Name | Type | Description
|
358
|
-
|
359
|
-
**live_stream_id** | **String
|
491
|
+
| Name | Type | Description | Notes |
|
492
|
+
| ---- | ---- | ----------- | ----- |
|
493
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
360
494
|
|
361
495
|
### Return type
|
362
496
|
|
@@ -368,21 +502,22 @@ Name | Type | Description | Notes
|
|
368
502
|
|
369
503
|
### HTTP request headers
|
370
504
|
|
371
|
-
|
372
|
-
|
505
|
+
- **Content-Type**: Not defined
|
506
|
+
- **Accept**: application/json
|
373
507
|
|
374
508
|
|
509
|
+
## enable_live_stream
|
375
510
|
|
376
|
-
|
377
|
-
> EnableLiveStreamResponse enable_live_stream(live_stream_id)
|
511
|
+
> <EnableLiveStreamResponse> enable_live_stream(live_stream_id)
|
378
512
|
|
379
513
|
Enable a live stream
|
380
514
|
|
381
515
|
Enables a live stream, allowing it to accept an incoming RTMP stream.
|
382
516
|
|
383
|
-
###
|
517
|
+
### Examples
|
518
|
+
|
384
519
|
```ruby
|
385
|
-
|
520
|
+
require 'time'
|
386
521
|
require 'mux_ruby'
|
387
522
|
# setup authorization
|
388
523
|
MuxRuby.configure do |config|
|
@@ -395,19 +530,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
395
530
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
396
531
|
|
397
532
|
begin
|
398
|
-
#Enable a live stream
|
533
|
+
# Enable a live stream
|
399
534
|
result = api_instance.enable_live_stream(live_stream_id)
|
400
535
|
p result
|
401
536
|
rescue MuxRuby::ApiError => e
|
402
|
-
puts "
|
537
|
+
puts "Error when calling LiveStreamsApi->enable_live_stream: #{e}"
|
538
|
+
end
|
539
|
+
```
|
540
|
+
|
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}"
|
403
556
|
end
|
404
557
|
```
|
405
558
|
|
406
559
|
### Parameters
|
407
560
|
|
408
|
-
Name | Type | Description
|
409
|
-
|
410
|
-
**live_stream_id** | **String
|
561
|
+
| Name | Type | Description | Notes |
|
562
|
+
| ---- | ---- | ----------- | ----- |
|
563
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
411
564
|
|
412
565
|
### Return type
|
413
566
|
|
@@ -419,21 +572,22 @@ Name | Type | Description | Notes
|
|
419
572
|
|
420
573
|
### HTTP request headers
|
421
574
|
|
422
|
-
|
423
|
-
|
575
|
+
- **Content-Type**: Not defined
|
576
|
+
- **Accept**: application/json
|
424
577
|
|
425
578
|
|
579
|
+
## get_live_stream
|
426
580
|
|
427
|
-
|
428
|
-
> LiveStreamResponse get_live_stream(live_stream_id)
|
581
|
+
> <LiveStreamResponse> get_live_stream(live_stream_id)
|
429
582
|
|
430
583
|
Retrieve a live stream
|
431
584
|
|
432
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.
|
433
586
|
|
434
|
-
###
|
587
|
+
### Examples
|
588
|
+
|
435
589
|
```ruby
|
436
|
-
|
590
|
+
require 'time'
|
437
591
|
require 'mux_ruby'
|
438
592
|
# setup authorization
|
439
593
|
MuxRuby.configure do |config|
|
@@ -446,19 +600,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
446
600
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
447
601
|
|
448
602
|
begin
|
449
|
-
#Retrieve a live stream
|
603
|
+
# Retrieve a live stream
|
450
604
|
result = api_instance.get_live_stream(live_stream_id)
|
451
605
|
p result
|
452
606
|
rescue MuxRuby::ApiError => e
|
453
|
-
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}"
|
454
626
|
end
|
455
627
|
```
|
456
628
|
|
457
629
|
### Parameters
|
458
630
|
|
459
|
-
Name | Type | Description
|
460
|
-
|
461
|
-
**live_stream_id** | **String
|
631
|
+
| Name | Type | Description | Notes |
|
632
|
+
| ---- | ---- | ----------- | ----- |
|
633
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
462
634
|
|
463
635
|
### Return type
|
464
636
|
|
@@ -470,21 +642,22 @@ Name | Type | Description | Notes
|
|
470
642
|
|
471
643
|
### HTTP request headers
|
472
644
|
|
473
|
-
|
474
|
-
|
645
|
+
- **Content-Type**: Not defined
|
646
|
+
- **Accept**: application/json
|
475
647
|
|
476
648
|
|
649
|
+
## get_live_stream_simulcast_target
|
477
650
|
|
478
|
-
|
479
|
-
> 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)
|
480
652
|
|
481
653
|
Retrieve a Live Stream Simulcast Target
|
482
654
|
|
483
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.
|
484
656
|
|
485
|
-
###
|
657
|
+
### Examples
|
658
|
+
|
486
659
|
```ruby
|
487
|
-
|
660
|
+
require 'time'
|
488
661
|
require 'mux_ruby'
|
489
662
|
# setup authorization
|
490
663
|
MuxRuby.configure do |config|
|
@@ -498,20 +671,38 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
|
498
671
|
simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
|
499
672
|
|
500
673
|
begin
|
501
|
-
#Retrieve a Live Stream Simulcast Target
|
674
|
+
# Retrieve a Live Stream Simulcast Target
|
502
675
|
result = api_instance.get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
503
676
|
p result
|
504
677
|
rescue MuxRuby::ApiError => e
|
505
|
-
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}"
|
506
697
|
end
|
507
698
|
```
|
508
699
|
|
509
700
|
### Parameters
|
510
701
|
|
511
|
-
Name | Type | Description
|
512
|
-
|
513
|
-
**live_stream_id** | **String
|
514
|
-
**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. | |
|
515
706
|
|
516
707
|
### Return type
|
517
708
|
|
@@ -523,19 +714,20 @@ Name | Type | Description | Notes
|
|
523
714
|
|
524
715
|
### HTTP request headers
|
525
716
|
|
526
|
-
|
527
|
-
|
717
|
+
- **Content-Type**: Not defined
|
718
|
+
- **Accept**: application/json
|
528
719
|
|
529
720
|
|
721
|
+
## list_live_streams
|
530
722
|
|
531
|
-
|
532
|
-
> ListLiveStreamsResponse list_live_streams(opts)
|
723
|
+
> <ListLiveStreamsResponse> list_live_streams(opts)
|
533
724
|
|
534
725
|
List live streams
|
535
726
|
|
536
|
-
###
|
727
|
+
### Examples
|
728
|
+
|
537
729
|
```ruby
|
538
|
-
|
730
|
+
require 'time'
|
539
731
|
require 'mux_ruby'
|
540
732
|
# setup authorization
|
541
733
|
MuxRuby.configure do |config|
|
@@ -546,25 +738,45 @@ end
|
|
546
738
|
|
547
739
|
api_instance = MuxRuby::LiveStreamsApi.new
|
548
740
|
opts = {
|
549
|
-
limit:
|
550
|
-
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
|
551
744
|
}
|
552
745
|
|
553
746
|
begin
|
554
|
-
#List live streams
|
747
|
+
# List live streams
|
555
748
|
result = api_instance.list_live_streams(opts)
|
556
749
|
p result
|
557
750
|
rescue MuxRuby::ApiError => e
|
558
|
-
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}"
|
559
770
|
end
|
560
771
|
```
|
561
772
|
|
562
773
|
### Parameters
|
563
774
|
|
564
|
-
Name | Type | Description
|
565
|
-
|
566
|
-
**limit** | **Integer
|
567
|
-
**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] |
|
568
780
|
|
569
781
|
### Return type
|
570
782
|
|
@@ -576,21 +788,22 @@ Name | Type | Description | Notes
|
|
576
788
|
|
577
789
|
### HTTP request headers
|
578
790
|
|
579
|
-
|
580
|
-
|
791
|
+
- **Content-Type**: Not defined
|
792
|
+
- **Accept**: application/json
|
581
793
|
|
582
794
|
|
795
|
+
## reset_stream_key
|
583
796
|
|
584
|
-
|
585
|
-
> LiveStreamResponse reset_stream_key(live_stream_id)
|
797
|
+
> <LiveStreamResponse> reset_stream_key(live_stream_id)
|
586
798
|
|
587
799
|
Reset a live stream’s stream key
|
588
800
|
|
589
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.
|
590
802
|
|
591
|
-
###
|
803
|
+
### Examples
|
804
|
+
|
592
805
|
```ruby
|
593
|
-
|
806
|
+
require 'time'
|
594
807
|
require 'mux_ruby'
|
595
808
|
# setup authorization
|
596
809
|
MuxRuby.configure do |config|
|
@@ -603,19 +816,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
603
816
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
604
817
|
|
605
818
|
begin
|
606
|
-
#Reset a live stream’s stream key
|
819
|
+
# Reset a live stream’s stream key
|
607
820
|
result = api_instance.reset_stream_key(live_stream_id)
|
608
821
|
p result
|
609
822
|
rescue MuxRuby::ApiError => e
|
610
|
-
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}"
|
611
842
|
end
|
612
843
|
```
|
613
844
|
|
614
845
|
### Parameters
|
615
846
|
|
616
|
-
Name | Type | Description
|
617
|
-
|
618
|
-
**live_stream_id** | **String
|
847
|
+
| Name | Type | Description | Notes |
|
848
|
+
| ---- | ---- | ----------- | ----- |
|
849
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
619
850
|
|
620
851
|
### Return type
|
621
852
|
|
@@ -627,21 +858,22 @@ Name | Type | Description | Notes
|
|
627
858
|
|
628
859
|
### HTTP request headers
|
629
860
|
|
630
|
-
|
631
|
-
|
861
|
+
- **Content-Type**: Not defined
|
862
|
+
- **Accept**: application/json
|
632
863
|
|
633
864
|
|
865
|
+
## signal_live_stream_complete
|
634
866
|
|
635
|
-
|
636
|
-
> SignalLiveStreamCompleteResponse signal_live_stream_complete(live_stream_id)
|
867
|
+
> <SignalLiveStreamCompleteResponse> signal_live_stream_complete(live_stream_id)
|
637
868
|
|
638
869
|
Signal a live stream is finished
|
639
870
|
|
640
|
-
(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
|
641
874
|
|
642
|
-
### Example
|
643
875
|
```ruby
|
644
|
-
|
876
|
+
require 'time'
|
645
877
|
require 'mux_ruby'
|
646
878
|
# setup authorization
|
647
879
|
MuxRuby.configure do |config|
|
@@ -654,19 +886,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
|
|
654
886
|
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
655
887
|
|
656
888
|
begin
|
657
|
-
#Signal a live stream is finished
|
889
|
+
# Signal a live stream is finished
|
658
890
|
result = api_instance.signal_live_stream_complete(live_stream_id)
|
659
891
|
p result
|
660
892
|
rescue MuxRuby::ApiError => e
|
661
|
-
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}"
|
662
912
|
end
|
663
913
|
```
|
664
914
|
|
665
915
|
### Parameters
|
666
916
|
|
667
|
-
Name | Type | Description
|
668
|
-
|
669
|
-
**live_stream_id** | **String
|
917
|
+
| Name | Type | Description | Notes |
|
918
|
+
| ---- | ---- | ----------- | ----- |
|
919
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
670
920
|
|
671
921
|
### Return type
|
672
922
|
|
@@ -678,8 +928,6 @@ Name | Type | Description | Notes
|
|
678
928
|
|
679
929
|
### HTTP request headers
|
680
930
|
|
681
|
-
|
682
|
-
|
683
|
-
|
684
|
-
|
931
|
+
- **Content-Type**: Not defined
|
932
|
+
- **Accept**: application/json
|
685
933
|
|