Skip to content

Commit ef762ab

Browse files
authored
v3.16.0 (#79)
1 parent 7285191 commit ef762ab

35 files changed

+1458
-32
lines changed

.openapi-generator/FILES

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,13 +164,17 @@ docs/UpdateAssetMasterAccessRequest.md
164164
docs/UpdateAssetRequest.md
165165
docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md
166166
docs/UpdateLiveStreamGeneratedSubtitlesRequest.md
167+
docs/UpdateLiveStreamNewAssetSettings.md
167168
docs/UpdateLiveStreamRequest.md
168169
docs/UpdateReferrerDomainRestrictionRequest.md
169170
docs/UpdateTranscriptionVocabularyRequest.md
171+
docs/UpdateUserAgentRestrictionRequest.md
170172
docs/UpdateWebInputUrlRequest.md
171173
docs/Upload.md
172174
docs/UploadError.md
173175
docs/UploadResponse.md
176+
docs/UserAgentRestrictionRequest.md
177+
docs/UserAgentRestrictionSettings.md
174178
docs/VideoView.md
175179
docs/VideoViewEvent.md
176180
docs/VideoViewResponse.md
@@ -349,13 +353,17 @@ mux_python/models/update_asset_mp4_support_request.py
349353
mux_python/models/update_asset_request.py
350354
mux_python/models/update_live_stream_embedded_subtitles_request.py
351355
mux_python/models/update_live_stream_generated_subtitles_request.py
356+
mux_python/models/update_live_stream_new_asset_settings.py
352357
mux_python/models/update_live_stream_request.py
353358
mux_python/models/update_referrer_domain_restriction_request.py
354359
mux_python/models/update_transcription_vocabulary_request.py
360+
mux_python/models/update_user_agent_restriction_request.py
355361
mux_python/models/update_web_input_url_request.py
356362
mux_python/models/upload.py
357363
mux_python/models/upload_error.py
358364
mux_python/models/upload_response.py
365+
mux_python/models/user_agent_restriction_request.py
366+
mux_python/models/user_agent_restriction_settings.py
359367
mux_python/models/video_view.py
360368
mux_python/models/video_view_event.py
361369
mux_python/models/video_view_response.py
@@ -367,4 +375,8 @@ setup.cfg
367375
setup.py
368376
test-requirements.txt
369377
test/__init__.py
378+
test/test_update_live_stream_new_asset_settings.py
379+
test/test_update_user_agent_restriction_request.py
380+
test/test_user_agent_restriction_request.py
381+
test/test_user_agent_restriction_settings.py
370382
tox.ini

docs/AbridgedVideoView.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
1616
**view_end** | **str** | | [optional]
1717
**viewer_experience_score** | **float** | | [optional]
1818
**watch_time** | **int** | | [optional]
19+
**playback_failure** | **bool** | | [optional]
1920

2021
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
2122

docs/CreatePlaybackRestrictionRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional]
7+
**user_agent** | [**UserAgentRestrictionRequest**](UserAgentRestrictionRequest.md) | | [optional]
78

89
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
910

docs/DeliveryReport.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
1111
**asset_state** | **str** | The state of the asset. | [optional]
1212
**asset_duration** | **float** | The duration of the asset in seconds. | [optional]
1313
**asset_resolution_tier** | **str** | The resolution tier that the asset was ingested at, affecting billing for ingest & storage | [optional]
14+
**asset_encoding_tier** | **str** | The encoding tier that the asset was ingested at. [See the encoding tiers guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional]
1415
**delivered_seconds** | **float** | Total number of delivered seconds during this time window. | [optional]
1516
**delivered_seconds_by_resolution** | [**DeliveryReportDeliveredSecondsByResolution**](DeliveryReportDeliveredSecondsByResolution.md) | | [optional]
1617

docs/GenerateTrackSubtitlesResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**data** | [**Track**](Track.md) | | [optional]
6+
**data** | [**list[Track]**](Track.md) | | [optional]
77

88
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
99

docs/PlaybackRestriction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
**created_at** | **str** | Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch). | [optional]
88
**updated_at** | **str** | Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch). | [optional]
99
**referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional]
10+
**user_agent** | [**UserAgentRestrictionSettings**](UserAgentRestrictionSettings.md) | | [optional]
1011

1112
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1213

docs/PlaybackRestrictionsApi.md

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Method | HTTP request | Description
99
[**get_playback_restriction**](PlaybackRestrictionsApi.md#get_playback_restriction) | **GET** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Retrieve a Playback Restriction
1010
[**list_playback_restrictions**](PlaybackRestrictionsApi.md#list_playback_restrictions) | **GET** /video/v1/playback-restrictions | List Playback Restrictions
1111
[**update_referrer_domain_restriction**](PlaybackRestrictionsApi.md#update_referrer_domain_restriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer | Update the Referrer Playback Restriction
12+
[**update_user_agent_restriction**](PlaybackRestrictionsApi.md#update_user_agent_restriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/user_agent | Update the User Agent Restriction
1213

1314

1415
# **create_playback_restriction**
@@ -48,7 +49,7 @@ configuration = mux_python.Configuration(
4849
with mux_python.ApiClient(configuration) as api_client:
4950
# Create an instance of the API class
5051
api_instance = mux_python.PlaybackRestrictionsApi(api_client)
51-
create_playback_restriction_request = {"referrer":{"allowed_domains":["*.example.com"],"allow_no_referrer":true}} # CreatePlaybackRestrictionRequest |
52+
create_playback_restriction_request = {"referrer":{"allowed_domains":["*.example.com"],"allow_no_referrer":true},"user_agent":{"allow_no_user_agent":false,"allow_high_risk_user_agent":false}} # CreatePlaybackRestrictionRequest |
5253

5354
try:
5455
# Create a Playback Restriction
@@ -379,3 +380,78 @@ Name | Type | Description | Notes
379380

380381
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
381382

383+
# **update_user_agent_restriction**
384+
> PlaybackRestrictionResponse update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request)
385+
386+
Update the User Agent Restriction
387+
388+
Allows you to modify how Mux validates playback requests with different user agents. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.
389+
390+
### Example
391+
392+
* Basic Authentication (accessToken):
393+
```python
394+
from __future__ import print_function
395+
import time
396+
import mux_python
397+
from mux_python.rest import ApiException
398+
from pprint import pprint
399+
# Defining the host is optional and defaults to https://api.mux.com
400+
# See configuration.py for a list of all supported configuration parameters.
401+
configuration = mux_python.Configuration(
402+
host = "https://api.mux.com"
403+
)
404+
405+
# The client must configure the authentication and authorization parameters
406+
# in accordance with the API server security policy.
407+
# Examples for each auth method are provided below, use the example that
408+
# satisfies your auth use case.
409+
410+
# Configure HTTP basic authorization: accessToken
411+
configuration = mux_python.Configuration(
412+
username = 'YOUR_USERNAME',
413+
password = 'YOUR_PASSWORD'
414+
)
415+
416+
# Enter a context with an instance of the API client
417+
with mux_python.ApiClient(configuration) as api_client:
418+
# Create an instance of the API class
419+
api_instance = mux_python.PlaybackRestrictionsApi(api_client)
420+
playback_restriction_id = 'playback_restriction_id_example' # str | ID of the Playback Restriction.
421+
update_user_agent_restriction_request = {"allow_no_user_agent":false,"allow_high_risk_user_agent":false} # UpdateUserAgentRestrictionRequest |
422+
423+
try:
424+
# Update the User Agent Restriction
425+
api_response = api_instance.update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request)
426+
pprint(api_response)
427+
except ApiException as e:
428+
print("Exception when calling PlaybackRestrictionsApi->update_user_agent_restriction: %s\n" % e)
429+
```
430+
431+
### Parameters
432+
433+
Name | Type | Description | Notes
434+
------------- | ------------- | ------------- | -------------
435+
**playback_restriction_id** | **str**| ID of the Playback Restriction. |
436+
**update_user_agent_restriction_request** | [**UpdateUserAgentRestrictionRequest**](UpdateUserAgentRestrictionRequest.md)| |
437+
438+
### Return type
439+
440+
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
441+
442+
### Authorization
443+
444+
[accessToken](../README.md#accessToken)
445+
446+
### HTTP request headers
447+
448+
- **Content-Type**: application/json
449+
- **Accept**: application/json
450+
451+
### HTTP response details
452+
| Status code | Description | Response headers |
453+
|-------------|-------------|------------------|
454+
**200** | OK | - |
455+
456+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
457+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# UpdateLiveStreamNewAssetSettings
2+
3+
Updates the new asset settings to use to generate a new asset for this live stream. Only the `mp4_support` setting may be updated.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**mp4_support** | **str** | Specify what level of support for mp4 playback should be added to new assets generated from this live stream. * The `none` option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. * The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

docs/UpdateLiveStreamRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**use_slate_for_standard_latency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to False]
1010
**reconnect_slate_url** | **str** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used. | [optional]
1111
**max_continuous_duration** | **int** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional] [default to 43200]
12+
**new_asset_settings** | [**UpdateLiveStreamNewAssetSettings**](UpdateLiveStreamNewAssetSettings.md) | | [optional]
1213

1314
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1415

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# UpdateUserAgentRestrictionRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**allow_no_user_agent** | **bool** | Whether or not to allow views without a `User-Agent` HTTP request header. | [optional] [default to True]
7+
**allow_high_risk_user_agent** | **bool** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional] [default to True]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

0 commit comments

Comments
 (0)