Skip to content

3.21.0 #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ docs/AssetNonStandardInputReasons.md
docs/AssetRecordingTimes.md
docs/AssetResponse.md
docs/AssetStaticRenditions.md
docs/AssetStaticRenditionsFiles.md
docs/AssetsApi.md
docs/BreakdownValue.md
docs/Broadcast.md
Expand All @@ -26,6 +25,8 @@ docs/CreatePlaybackIDResponse.md
docs/CreatePlaybackRestrictionRequest.md
docs/CreateSimulcastTargetRequest.md
docs/CreateSpaceRequest.md
docs/CreateStaticRenditionRequest.md
docs/CreateStaticRenditionResponse.md
docs/CreateTrackRequest.md
docs/CreateTrackResponse.md
docs/CreateTranscriptionVocabularyRequest.md
Expand Down Expand Up @@ -157,6 +158,7 @@ docs/SpaceStatus.md
docs/SpaceType.md
docs/SpacesApi.md
docs/StartSpaceBroadcastResponse.md
docs/StaticRendition.md
docs/StopSpaceBroadcastResponse.md
docs/Track.md
docs/TranscriptionVocabulariesApi.md
Expand All @@ -169,6 +171,7 @@ docs/UpdateAssetRequest.md
docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md
docs/UpdateLiveStreamGeneratedSubtitlesRequest.md
docs/UpdateLiveStreamNewAssetSettings.md
docs/UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest.md
docs/UpdateLiveStreamRequest.md
docs/UpdateReferrerDomainRestrictionRequest.md
docs/UpdateTranscriptionVocabularyRequest.md
Expand Down Expand Up @@ -222,7 +225,6 @@ mux_python/models/asset_non_standard_input_reasons.py
mux_python/models/asset_recording_times.py
mux_python/models/asset_response.py
mux_python/models/asset_static_renditions.py
mux_python/models/asset_static_renditions_files.py
mux_python/models/breakdown_value.py
mux_python/models/broadcast.py
mux_python/models/broadcast_layout.py
Expand All @@ -237,6 +239,8 @@ mux_python/models/create_playback_id_response.py
mux_python/models/create_playback_restriction_request.py
mux_python/models/create_simulcast_target_request.py
mux_python/models/create_space_request.py
mux_python/models/create_static_rendition_request.py
mux_python/models/create_static_rendition_response.py
mux_python/models/create_track_request.py
mux_python/models/create_track_response.py
mux_python/models/create_transcription_vocabulary_request.py
Expand Down Expand Up @@ -352,6 +356,7 @@ mux_python/models/space_response.py
mux_python/models/space_status.py
mux_python/models/space_type.py
mux_python/models/start_space_broadcast_response.py
mux_python/models/static_rendition.py
mux_python/models/stop_space_broadcast_response.py
mux_python/models/track.py
mux_python/models/transcription_vocabulary.py
Expand All @@ -362,6 +367,7 @@ mux_python/models/update_asset_request.py
mux_python/models/update_live_stream_embedded_subtitles_request.py
mux_python/models/update_live_stream_generated_subtitles_request.py
mux_python/models/update_live_stream_new_asset_settings.py
mux_python/models/update_live_stream_new_asset_settings_static_renditions_request.py
mux_python/models/update_live_stream_request.py
mux_python/models/update_referrer_domain_restriction_request.py
mux_python/models/update_transcription_vocabulary_request.py
Expand Down
4 changes: 2 additions & 2 deletions docs/AssetStaticRenditions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ An object containing the current status of any static renditions (mp4s). The obj
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **str** | Indicates the status of downloadable MP4 versions of this asset. | [optional] [default to 'disabled']
**files** | [**list[AssetStaticRenditionsFiles]**](AssetStaticRenditionsFiles.md) | Array of file objects. | [optional]
**status** | **str** | Indicates the status of downloadable MP4 versions of this asset. This field is only valid when `mp4_support` is enabled | [optional] [default to 'disabled']
**files** | [**list[StaticRendition]**](StaticRendition.md) | Array of file objects. | [optional]

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

Expand Down
15 changes: 0 additions & 15 deletions docs/AssetStaticRenditionsFiles.md

This file was deleted.

151 changes: 151 additions & 0 deletions docs/AssetsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**create_asset**](AssetsApi.md#create_asset) | **POST** /video/v1/assets | Create an asset
[**create_asset_playback_id**](AssetsApi.md#create_asset_playback_id) | **POST** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID
[**create_asset_static_rendition**](AssetsApi.md#create_asset_static_rendition) | **POST** /video/v1/assets/{ASSET_ID}/static-renditions | Create a static rendition for an asset
[**create_asset_track**](AssetsApi.md#create_asset_track) | **POST** /video/v1/assets/{ASSET_ID}/tracks | Create an asset track
[**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset
[**delete_asset_playback_id**](AssetsApi.md#delete_asset_playback_id) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID
[**delete_asset_static_rendition**](AssetsApi.md#delete_asset_static_rendition) | **DELETE** /video/v1/assets/{ASSET_ID}/static-renditions/{STATIC_RENDITION_ID} | Delete a single static rendition for an asset
[**delete_asset_track**](AssetsApi.md#delete_asset_track) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track
[**generate_asset_track_subtitles**](AssetsApi.md#generate_asset_track_subtitles) | **POST** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles | Generate track subtitles
[**get_asset**](AssetsApi.md#get_asset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset
Expand Down Expand Up @@ -168,6 +170,81 @@ Name | Type | Description | Notes

[[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)

# **create_asset_static_rendition**
> CreateStaticRenditionResponse create_asset_static_rendition(asset_id, create_static_rendition_request)

Create a static rendition for an asset

Creates a static rendition (i.e. MP4) for an asset

### Example

* Basic Authentication (accessToken):
```python
from __future__ import print_function
import time
import mux_python
from mux_python.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mux.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mux_python.Configuration(
host = "https://api.mux.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: accessToken
configuration = mux_python.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with mux_python.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mux_python.AssetsApi(api_client)
asset_id = 'asset_id_example' # str | The asset ID.
create_static_rendition_request = {"resolution":"highest"} # CreateStaticRenditionRequest |

try:
# Create a static rendition for an asset
api_response = api_instance.create_asset_static_rendition(asset_id, create_static_rendition_request)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssetsApi->create_asset_static_rendition: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**asset_id** | **str**| The asset ID. |
**create_static_rendition_request** | [**CreateStaticRenditionRequest**](CreateStaticRenditionRequest.md)| |

### Return type

[**CreateStaticRenditionResponse**](CreateStaticRenditionResponse.md)

### Authorization

[accessToken](../README.md#accessToken)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Created | - |

[[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)

# **create_asset_track**
> CreateTrackResponse create_asset_track(asset_id, create_track_request)

Expand Down Expand Up @@ -389,6 +466,80 @@ void (empty response body)

[[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)

# **delete_asset_static_rendition**
> delete_asset_static_rendition(asset_id, static_rendition_id)

Delete a single static rendition for an asset

Deletes a single static rendition for an asset

### Example

* Basic Authentication (accessToken):
```python
from __future__ import print_function
import time
import mux_python
from mux_python.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mux.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mux_python.Configuration(
host = "https://api.mux.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: accessToken
configuration = mux_python.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with mux_python.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mux_python.AssetsApi(api_client)
asset_id = 'asset_id_example' # str | The asset ID.
static_rendition_id = 'static_rendition_id_example' # str | The static rendition ID.

try:
# Delete a single static rendition for an asset
api_instance.delete_asset_static_rendition(asset_id, static_rendition_id)
except ApiException as e:
print("Exception when calling AssetsApi->delete_asset_static_rendition: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**asset_id** | **str**| The asset ID. |
**static_rendition_id** | **str**| The static rendition ID. |

### Return type

void (empty response body)

### Authorization

[accessToken](../README.md#accessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |

[[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)

# **delete_asset_track**
> delete_asset_track(asset_id, track_id)

Expand Down
3 changes: 2 additions & 1 deletion docs/CreateAssetRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ Name | Type | Description | Notes
**advanced_playback_policies** | [**list[CreatePlaybackIDRequest]**](CreatePlaybackIDRequest.md) | An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policy` when creating a DRM playback ID. | [optional]
**per_title_encode** | **bool** | | [optional]
**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional]
**mp4_support** | **str** | Specify what level of support for mp4 playback. * 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). MP4 files are not produced for `none` (default). In most cases you should use our default HLS-based streaming playback (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional]
**mp4_support** | **str** | Specify what level of support for mp4 playback. You may not enable both `mp4_support` and `static_renditions`. * 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). MP4 files are not produced for `none` (default). In most cases you should use our default HLS-based streaming playback (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional]
**normalize_audio** | **bool** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to False]
**master_access** | **str** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional]
**test** | **bool** | Marks the asset as a test asset when the value is set to true. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs. | [optional]
**max_resolution_tier** | **str** | Max resolution tier can be used to control the maximum `resolution_tier` your asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`. | [optional]
**encoding_tier** | **str** | This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. The default encoding tier for an account can be set in the Mux Dashboard. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) | [optional]
**video_quality** | **str** | The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) | [optional]
**static_renditions** | [**list[CreateStaticRenditionRequest]**](CreateStaticRenditionRequest.md) | An array of static renditions to create for this asset. You may not enable both `static_renditions` and `mp4_support` | [optional]

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

Expand Down
11 changes: 11 additions & 0 deletions docs/CreateStaticRenditionRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CreateStaticRenditionRequest

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**resolution** | **str** | | [optional]
**passthrough** | **str** | Arbitrary user-supplied metadata set for the static rendition. Max 255 characters. | [optional]

[[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 changes: 10 additions & 0 deletions docs/CreateStaticRenditionResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CreateStaticRenditionResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**StaticRendition**](StaticRendition.md) | | [optional]

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


Loading