Skip to content

Commit 7c159dc

Browse files
committed
[release] 2.0.0
1 parent 7b1edfa commit 7c159dc

File tree

142 files changed

+1611
-237
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+1611
-237
lines changed

.openapi-generator/FILES

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ docs/DisableLiveStreamResponse.md
2929
docs/EnableLiveStreamResponse.md
3030
docs/Error.md
3131
docs/ErrorsApi.md
32+
docs/ExportDate.md
33+
docs/ExportFile.md
3234
docs/ExportsApi.md
3335
docs/FilterValue.md
3436
docs/FiltersApi.md
@@ -75,6 +77,7 @@ docs/ListRealTimeMetricsResponse.md
7577
docs/ListRelatedIncidentsResponse.md
7678
docs/ListSigningKeysResponse.md
7779
docs/ListUploadsResponse.md
80+
docs/ListVideoViewExportsResponse.md
7881
docs/ListVideoViewsResponse.md
7982
docs/LiveStream.md
8083
docs/LiveStreamResponse.md
@@ -152,6 +155,8 @@ mux_python/models/dimension_value.py
152155
mux_python/models/disable_live_stream_response.py
153156
mux_python/models/enable_live_stream_response.py
154157
mux_python/models/error.py
158+
mux_python/models/export_date.py
159+
mux_python/models/export_file.py
155160
mux_python/models/filter_value.py
156161
mux_python/models/get_asset_input_info_response.py
157162
mux_python/models/get_asset_or_live_stream_id_response.py
@@ -195,6 +200,7 @@ mux_python/models/list_real_time_metrics_response.py
195200
mux_python/models/list_related_incidents_response.py
196201
mux_python/models/list_signing_keys_response.py
197202
mux_python/models/list_uploads_response.py
203+
mux_python/models/list_video_view_exports_response.py
198204
mux_python/models/list_video_views_response.py
199205
mux_python/models/live_stream.py
200206
mux_python/models/live_stream_response.py
@@ -229,4 +235,7 @@ setup.cfg
229235
setup.py
230236
test-requirements.txt
231237
test/__init__.py
238+
test/test_export_date.py
239+
test/test_export_file.py
240+
test/test_list_video_view_exports_response.py
232241
tox.ini

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Its up to you to manage your token and secret. In our examples, we read them fro
5454
### Example Usage
5555
Below is a quick example of using mux-python to list the Video assets stored in your Mux account.
5656

57-
Be sure to also checkout the [examples directory](examples/):
57+
Be sure to also checkout the [exmples directory](examples/):
5858
* [List Assets, Live Streams, Signing Keys, and Uploads.](examples/video/list-everything.py)
5959
* [Create an Asset, wait for it to become availiable, and print its playback URL](examples/video/ingest.py)
6060
* [Create a new Live Stream and retrieve its Stream key.](examples/video/create-live-stream.py)

docs/Asset.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ Name | Type | Description | Notes
66
**id** | **str** | Unique identifier for the Asset. Max 255 characters. | [optional]
77
**created_at** | **str** | Time the Asset was created, defined as a Unix timestamp (seconds since epoch). | [optional]
88
**status** | **str** | The status of the asset. | [optional]
9-
**duration** | **float** | The duration of the asset in seconds (max duration for a single asset is 24 hours). | [optional]
9+
**duration** | **float** | The duration of the asset in seconds (max duration for a single asset is 12 hours). | [optional]
1010
**max_stored_resolution** | **str** | The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional]
11-
**max_stored_frame_rate** | **float** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. | [optional]
11+
**max_stored_frame_rate** | **float** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. | [optional]
1212
**aspect_ratio** | **str** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional]
1313
**playback_ids** | [**list[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]
1414
**tracks** | [**list[Track]**](Track.md) | The individual media tracks that make up an asset. | [optional]
1515
**errors** | [**AssetErrors**](AssetErrors.md) | | [optional]
1616
**per_title_encode** | **bool** | | [optional]
17+
**upload_id** | **str** | Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload. | [optional]
1718
**is_live** | **bool** | Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state. | [optional]
1819
**passthrough** | **str** | Arbitrary metadata set for the asset. Max 255 characters. | [optional]
1920
**live_stream_id** | **str** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional]

docs/AssetsApi.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Method | HTTP request | Description
2323
2424
Create an asset
2525

26-
Create a new Mux Video asset.
26+
Create a new Mux Video asset.
2727

2828
### Example
2929

@@ -242,7 +242,7 @@ Name | Type | Description | Notes
242242
243243
Delete an asset
244244

245-
Deletes a video asset and all its data
245+
Deletes a video asset and all its data.
246246

247247
### Example
248248

@@ -673,11 +673,11 @@ Name | Type | Description | Notes
673673
[[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)
674674

675675
# **list_assets**
676-
> ListAssetsResponse list_assets(limit=limit, page=page)
676+
> ListAssetsResponse list_assets(limit=limit, page=page, live_stream_id=live_stream_id, upload_id=upload_id)
677677
678678
List assets
679679

680-
List all Mux assets.
680+
List all Mux assets.
681681

682682
### Example
683683

@@ -711,10 +711,12 @@ with mux_python.ApiClient(configuration) as api_client:
711711
api_instance = mux_python.AssetsApi(api_client)
712712
limit = 25 # int | Number of items to include in the response (optional) (default to 25)
713713
page = 1 # int | Offset by this many pages, of the size of `limit` (optional) (default to 1)
714+
live_stream_id = 'live_stream_id_example' # str | Filter response to return all the assets for this live stream only (optional)
715+
upload_id = 'upload_id_example' # str | Filter response to return an asset created from this direct upload only (optional)
714716

715717
try:
716718
# List assets
717-
api_response = api_instance.list_assets(limit=limit, page=page)
719+
api_response = api_instance.list_assets(limit=limit, page=page, live_stream_id=live_stream_id, upload_id=upload_id)
718720
pprint(api_response)
719721
except ApiException as e:
720722
print("Exception when calling AssetsApi->list_assets: %s\n" % e)
@@ -726,6 +728,8 @@ Name | Type | Description | Notes
726728
------------- | ------------- | ------------- | -------------
727729
**limit** | **int**| Number of items to include in the response | [optional] [default to 25]
728730
**page** | **int**| Offset by this many pages, of the size of `limit` | [optional] [default to 1]
731+
**live_stream_id** | **str**| Filter response to return all the assets for this live stream only | [optional]
732+
**upload_id** | **str**| Filter response to return an asset created from this direct upload only | [optional]
729733

730734
### Return type
731735

docs/CreateLiveStreamRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional]
88
**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. Defaults to 60 seconds on the API if not specified. | [optional]
99
**passthrough** | **str** | | [optional]
10+
**audio_only** | **bool** | Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted. | [optional]
1011
**reduced_latency** | **bool** | 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. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional]
1112
**test** | **bool** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams 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]
1213
**simulcast_targets** | [**list[CreateSimulcastTargetRequest]**](CreateSimulcastTargetRequest.md) | | [optional]

docs/CreateTrackRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**type** | **str** | |
88
**text_type** | **str** | |
99
**language_code** | **str** | The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English. |
10-
**name** | **str** | The name of the track containing a human-readable description. This value must be unqiue across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional]
10+
**name** | **str** | The name of the track containing a human-readable description. This value must be unique across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional]
1111
**closed_captions** | **bool** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional]
1212
**passthrough** | **str** | Arbitrary metadata set for the track either when creating the asset or track. | [optional]
1313

docs/DeliveryUsageApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212
1313
List Usage
1414

15-
Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs.
15+
Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs.
1616

1717
### Example
1818

@@ -47,7 +47,7 @@ with mux_python.ApiClient(configuration) as api_client:
4747
page = 1 # int | Offset by this many pages, of the size of `limit` (optional) (default to 1)
4848
limit = 100 # int | Number of items to include in the response (optional) (default to 100)
4949
asset_id = 'asset_id_example' # str | Filter response to return delivery usage for this asset only. (optional)
50-
timeframe = ['timeframe_example'] # list[str] | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. (optional)
50+
timeframe = ['timeframe_example'] # list[str] | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. (optional)
5151

5252
try:
5353
# List Usage
@@ -64,7 +64,7 @@ Name | Type | Description | Notes
6464
**page** | **int**| Offset by this many pages, of the size of `limit` | [optional] [default to 1]
6565
**limit** | **int**| Number of items to include in the response | [optional] [default to 100]
6666
**asset_id** | **str**| Filter response to return delivery usage for this asset only. | [optional]
67-
**timeframe** | [**list[str]**](str.md)| Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. | [optional]
67+
**timeframe** | [**list[str]**](str.md)| Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. | [optional]
6868

6969
### Return type
7070

docs/ErrorsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212
1313
List Errors
1414

15-
Returns a list of errors
15+
Returns a list of errors.
1616

1717
### Example
1818

docs/ExportDate.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ExportDate
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**export_date** | **date** | | [optional]
7+
**files** | [**list[ExportFile]**](ExportFile.md) | | [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/ExportFile.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ExportFile
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**version** | **int** | | [optional]
7+
**type** | **str** | | [optional]
8+
**path** | **str** | | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

0 commit comments

Comments
 (0)