You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Asset.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,15 @@ Name | Type | Description | Notes
6
6
**id** | **str** | Unique identifier for the Asset. Max 255 characters. | [optional]
7
7
**created_at** | **str** | Time the Asset was created, defined as a Unix timestamp (seconds since epoch). | [optional]
8
8
**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]
10
10
**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]
12
12
**aspect_ratio** | **str** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional]
13
13
**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]
14
14
**tracks** | [**list[Track]**](Track.md) | The individual media tracks that make up an asset. | [optional]
**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]
17
18
**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]
18
19
**passthrough** | **str** | Arbitrary metadata set for the asset. Max 255 characters. | [optional]
19
20
**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]
@@ -242,7 +242,7 @@ Name | Type | Description | Notes
242
242
243
243
Delete an asset
244
244
245
-
Deletes a video asset and all its data
245
+
Deletes a video asset and all its data.
246
246
247
247
### Example
248
248
@@ -673,11 +673,11 @@ Name | Type | Description | Notes
673
673
[[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)
**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]
9
9
**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]
10
11
**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]
11
12
**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]
Copy file name to clipboardExpand all lines: docs/CreateTrackRequest.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
**type** | **str** | |
8
8
**text_type** | **str** | |
9
9
**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]
11
11
**closed_captions** | **bool** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional]
12
12
**passthrough** | **str** | Arbitrary metadata set for the track either when creating the asset or track. | [optional]
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.
16
16
17
17
### Example
18
18
@@ -47,7 +47,7 @@ with mux_python.ApiClient(configuration) as api_client:
47
47
page =1# int | Offset by this many pages, of the size of `limit` (optional) (default to 1)
48
48
limit =100# int | Number of items to include in the response (optional) (default to 100)
49
49
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)
51
51
52
52
try:
53
53
# List Usage
@@ -64,7 +64,7 @@ Name | Type | Description | Notes
64
64
**page** | **int**| Offset by this many pages, of the size of `limit` | [optional][default to 1]
65
65
**limit** | **int**| Number of items to include in the response | [optional][default to 100]
66
66
**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]
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
0 commit comments