Skip to content

Commit 772b3c2

Browse files
eroppleeropple
committed
[minor] release for real-time
1 parent 408e4cc commit 772b3c2

Some content is hidden

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

57 files changed

+5402
-11
lines changed

‎.openapi-generator/FILES

+45
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,19 @@ docs/AssetStaticRenditions.md
1212
docs/AssetStaticRenditionsFiles.md
1313
docs/AssetsApi.md
1414
docs/BreakdownValue.md
15+
docs/Broadcast.md
16+
docs/BroadcastLayout.md
17+
docs/BroadcastResolution.md
18+
docs/BroadcastResponse.md
19+
docs/BroadcastStatus.md
1520
docs/CreateAssetRequest.md
21+
docs/CreateBroadcastRequest.md
1622
docs/CreateLiveStreamRequest.md
1723
docs/CreatePlaybackIDRequest.md
1824
docs/CreatePlaybackIDResponse.md
1925
docs/CreatePlaybackRestrictionRequest.md
2026
docs/CreateSimulcastTargetRequest.md
27+
docs/CreateSpaceRequest.md
2128
docs/CreateTrackRequest.md
2229
docs/CreateTrackResponse.md
2330
docs/CreateUploadRequest.md
@@ -79,6 +86,7 @@ docs/ListRealTimeDimensionsResponseData.md
7986
docs/ListRealTimeMetricsResponse.md
8087
docs/ListRelatedIncidentsResponse.md
8188
docs/ListSigningKeysResponse.md
89+
docs/ListSpacesResponse.md
8290
docs/ListUploadsResponse.md
8391
docs/ListVideoViewExportsResponse.md
8492
docs/ListVideoViewsResponse.md
@@ -110,6 +118,13 @@ docs/SigningKey.md
110118
docs/SigningKeyResponse.md
111119
docs/SimulcastTarget.md
112120
docs/SimulcastTargetResponse.md
121+
docs/Space.md
122+
docs/SpaceResponse.md
123+
docs/SpaceStatus.md
124+
docs/SpaceType.md
125+
docs/SpacesApi.md
126+
docs/StartSpaceBroadcastResponse.md
127+
docs/StopSpaceBroadcastResponse.md
113128
docs/Track.md
114129
docs/URLSigningKeysApi.md
115130
docs/UpdateAssetMP4SupportRequest.md
@@ -140,6 +155,7 @@ mux_python/api/metrics_api.py
140155
mux_python/api/playback_id_api.py
141156
mux_python/api/playback_restrictions_api.py
142157
mux_python/api/real_time_api.py
158+
mux_python/api/spaces_api.py
143159
mux_python/api/url_signing_keys_api.py
144160
mux_python/api/video_views_api.py
145161
mux_python/api_client.py
@@ -156,12 +172,19 @@ mux_python/models/asset_response.py
156172
mux_python/models/asset_static_renditions.py
157173
mux_python/models/asset_static_renditions_files.py
158174
mux_python/models/breakdown_value.py
175+
mux_python/models/broadcast.py
176+
mux_python/models/broadcast_layout.py
177+
mux_python/models/broadcast_resolution.py
178+
mux_python/models/broadcast_response.py
179+
mux_python/models/broadcast_status.py
159180
mux_python/models/create_asset_request.py
181+
mux_python/models/create_broadcast_request.py
160182
mux_python/models/create_live_stream_request.py
161183
mux_python/models/create_playback_id_request.py
162184
mux_python/models/create_playback_id_response.py
163185
mux_python/models/create_playback_restriction_request.py
164186
mux_python/models/create_simulcast_target_request.py
187+
mux_python/models/create_space_request.py
165188
mux_python/models/create_track_request.py
166189
mux_python/models/create_track_response.py
167190
mux_python/models/create_upload_request.py
@@ -216,6 +239,7 @@ mux_python/models/list_real_time_dimensions_response_data.py
216239
mux_python/models/list_real_time_metrics_response.py
217240
mux_python/models/list_related_incidents_response.py
218241
mux_python/models/list_signing_keys_response.py
242+
mux_python/models/list_spaces_response.py
219243
mux_python/models/list_uploads_response.py
220244
mux_python/models/list_video_view_exports_response.py
221245
mux_python/models/list_video_views_response.py
@@ -242,6 +266,12 @@ mux_python/models/signing_key.py
242266
mux_python/models/signing_key_response.py
243267
mux_python/models/simulcast_target.py
244268
mux_python/models/simulcast_target_response.py
269+
mux_python/models/space.py
270+
mux_python/models/space_response.py
271+
mux_python/models/space_status.py
272+
mux_python/models/space_type.py
273+
mux_python/models/start_space_broadcast_response.py
274+
mux_python/models/stop_space_broadcast_response.py
245275
mux_python/models/track.py
246276
mux_python/models/update_asset_master_access_request.py
247277
mux_python/models/update_asset_mp4_support_request.py
@@ -261,4 +291,19 @@ setup.cfg
261291
setup.py
262292
test-requirements.txt
263293
test/__init__.py
294+
test/test_broadcast.py
295+
test/test_broadcast_layout.py
296+
test/test_broadcast_resolution.py
297+
test/test_broadcast_response.py
298+
test/test_broadcast_status.py
299+
test/test_create_broadcast_request.py
300+
test/test_create_space_request.py
301+
test/test_list_spaces_response.py
302+
test/test_space.py
303+
test/test_space_response.py
304+
test/test_space_status.py
305+
test/test_space_type.py
306+
test/test_spaces_api.py
307+
test/test_start_space_broadcast_response.py
308+
test/test_stop_space_broadcast_response.py
264309
tox.ini

‎docs/Asset.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
1515
**errors** | [**AssetErrors**](AssetErrors.md) | | [optional]
1616
**per_title_encode** | **bool** | | [optional]
1717
**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]
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+
**is_live** | **bool** | Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream. | [optional]
1919
**passthrough** | **str** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional]
2020
**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]
2121
**master** | [**AssetMaster**](AssetMaster.md) | | [optional]

‎docs/Broadcast.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Broadcast
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **str** | Unique identifier for the broadcast. Max 255 characters. |
7+
**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional]
8+
**live_stream_id** | **str** | The ID of the live stream that the broadcast will be sent to. |
9+
**status** | [**BroadcastStatus**](BroadcastStatus.md) | |
10+
**layout** | [**BroadcastLayout**](BroadcastLayout.md) | |
11+
**background** | **str** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional]
12+
**resolution** | [**BroadcastResolution**](BroadcastResolution.md) | |
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
16+

‎docs/BroadcastLayout.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# BroadcastLayout
2+
3+
The layout used when broadcasting the space. Defaults to `gallery` if not set.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/BroadcastResolution.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# BroadcastResolution
2+
3+
The resolution of the composited video sent to the live stream. Defaults to `1920x1080` if not set.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/BroadcastResponse.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# BroadcastResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**data** | [**Broadcast**](Broadcast.md) | |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/BroadcastStatus.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# BroadcastStatus
2+
3+
The status of the broadcast. You can start and stop broadcasts with the `start` and `stop` APIs.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/CreateBroadcastRequest.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# CreateBroadcastRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional]
7+
**live_stream_id** | **str** | The ID of the live stream that you want to broadcast to. |
8+
**layout** | [**BroadcastLayout**](BroadcastLayout.md) | | [optional]
9+
**background** | **str** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional]
10+
**resolution** | [**BroadcastResolution**](BroadcastResolution.md) | | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

‎docs/CreateSimulcastTargetRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**passthrough** | **str** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional]
77
**stream_key** | **str** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional]
8-
**url** | **str** | RTMP hostname including application name for the third party live streaming service. Example: 'rtmp://live.example.com/app'. |
8+
**url** | **str** | RTMP hostname including application name for the third party live streaming service. Example: `rtmp://live.example.com/app`. |
99

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

‎docs/CreateSpaceRequest.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CreateSpaceRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**type** | [**SpaceType**](SpaceType.md) | | [optional]
7+
**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional]
8+
**broadcasts** | [**list[CreateBroadcastRequest]**](CreateBroadcastRequest.md) | An array of broadcast destinations you want to stream the space to. **Note:** By default only a single broadcast destination can be specified. Contact Mux support if you need more. | [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+

‎docs/ListSpacesResponse.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ListSpacesResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**data** | [**list[Space]**](Space.md) | |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/Space.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Space
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **str** | Unique identifier for the space. Max 255 characters. |
7+
**created_at** | **str** | Time the space was created, defined as a Unix timestamp (seconds since epoch). |
8+
**type** | [**SpaceType**](SpaceType.md) | |
9+
**status** | [**SpaceStatus**](SpaceStatus.md) | |
10+
**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional]
11+
**broadcasts** | [**list[Broadcast]**](Broadcast.md) | An array of broadcast destinations. | [optional]
12+
**active_session_id** | **str** | Unique identifier for the current lifecycle of the space. Only set when the space is `active` and is set to a new value each time the space transitions from `idle` to `active`. This value is useful for logging and debugging issues. Max 255 characters. | [optional]
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
16+

‎docs/SpaceResponse.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# SpaceResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**data** | [**Space**](Space.md) | |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/SpaceStatus.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# SpaceStatus
2+
3+
The status of the space. Spaces are `idle` when there are no participants connected, and `active` when there are participants connected.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/SpaceType.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# SpaceType
2+
3+
Specify the network architecture of the space. In `server` spaces, all video travels through Mux's video infrastructure. Defaults to `server` if not set.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

0 commit comments

Comments
 (0)