Skip to content

Commit b7b42b2

Browse files
eroppleeropple
committed
[minor] release transcription vocabularies
1 parent cee2c8b commit b7b42b2

Some content is hidden

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

47 files changed

+3459
-25
lines changed

‎.openapi-generator/FILES

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ docs/CreateSimulcastTargetRequest.md
2727
docs/CreateSpaceRequest.md
2828
docs/CreateTrackRequest.md
2929
docs/CreateTrackResponse.md
30+
docs/CreateTranscriptionVocabularyRequest.md
3031
docs/CreateUploadRequest.md
3132
docs/DeliveryReport.md
3233
docs/DeliveryUsageApi.md
@@ -87,11 +88,13 @@ docs/ListRealTimeMetricsResponse.md
8788
docs/ListRelatedIncidentsResponse.md
8889
docs/ListSigningKeysResponse.md
8990
docs/ListSpacesResponse.md
91+
docs/ListTranscriptionVocabulariesResponse.md
9092
docs/ListUploadsResponse.md
9193
docs/ListVideoViewExportsResponse.md
9294
docs/ListVideoViewsResponse.md
9395
docs/LiveStream.md
9496
docs/LiveStreamEmbeddedSubtitleSettings.md
97+
docs/LiveStreamGeneratedSubtitleSettings.md
9598
docs/LiveStreamResponse.md
9699
docs/LiveStreamStatus.md
97100
docs/LiveStreamsApi.md
@@ -126,13 +129,18 @@ docs/SpacesApi.md
126129
docs/StartSpaceBroadcastResponse.md
127130
docs/StopSpaceBroadcastResponse.md
128131
docs/Track.md
132+
docs/TranscriptionVocabulariesApi.md
133+
docs/TranscriptionVocabulary.md
134+
docs/TranscriptionVocabularyResponse.md
129135
docs/URLSigningKeysApi.md
130136
docs/UpdateAssetMP4SupportRequest.md
131137
docs/UpdateAssetMasterAccessRequest.md
132138
docs/UpdateAssetRequest.md
133139
docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md
140+
docs/UpdateLiveStreamGeneratedSubtitlesRequest.md
134141
docs/UpdateLiveStreamRequest.md
135142
docs/UpdateReferrerDomainRestrictionRequest.md
143+
docs/UpdateTranscriptionVocabularyRequest.md
136144
docs/Upload.md
137145
docs/UploadError.md
138146
docs/UploadResponse.md
@@ -156,6 +164,7 @@ mux_python/api/playback_id_api.py
156164
mux_python/api/playback_restrictions_api.py
157165
mux_python/api/real_time_api.py
158166
mux_python/api/spaces_api.py
167+
mux_python/api/transcription_vocabularies_api.py
159168
mux_python/api/url_signing_keys_api.py
160169
mux_python/api/video_views_api.py
161170
mux_python/api_client.py
@@ -187,6 +196,7 @@ mux_python/models/create_simulcast_target_request.py
187196
mux_python/models/create_space_request.py
188197
mux_python/models/create_track_request.py
189198
mux_python/models/create_track_response.py
199+
mux_python/models/create_transcription_vocabulary_request.py
190200
mux_python/models/create_upload_request.py
191201
mux_python/models/delivery_report.py
192202
mux_python/models/dimension_value.py
@@ -240,11 +250,13 @@ mux_python/models/list_real_time_metrics_response.py
240250
mux_python/models/list_related_incidents_response.py
241251
mux_python/models/list_signing_keys_response.py
242252
mux_python/models/list_spaces_response.py
253+
mux_python/models/list_transcription_vocabularies_response.py
243254
mux_python/models/list_uploads_response.py
244255
mux_python/models/list_video_view_exports_response.py
245256
mux_python/models/list_video_views_response.py
246257
mux_python/models/live_stream.py
247258
mux_python/models/live_stream_embedded_subtitle_settings.py
259+
mux_python/models/live_stream_generated_subtitle_settings.py
248260
mux_python/models/live_stream_response.py
249261
mux_python/models/live_stream_status.py
250262
mux_python/models/metric.py
@@ -273,12 +285,16 @@ mux_python/models/space_type.py
273285
mux_python/models/start_space_broadcast_response.py
274286
mux_python/models/stop_space_broadcast_response.py
275287
mux_python/models/track.py
288+
mux_python/models/transcription_vocabulary.py
289+
mux_python/models/transcription_vocabulary_response.py
276290
mux_python/models/update_asset_master_access_request.py
277291
mux_python/models/update_asset_mp4_support_request.py
278292
mux_python/models/update_asset_request.py
279293
mux_python/models/update_live_stream_embedded_subtitles_request.py
294+
mux_python/models/update_live_stream_generated_subtitles_request.py
280295
mux_python/models/update_live_stream_request.py
281296
mux_python/models/update_referrer_domain_restriction_request.py
297+
mux_python/models/update_transcription_vocabulary_request.py
282298
mux_python/models/upload.py
283299
mux_python/models/upload_error.py
284300
mux_python/models/upload_response.py
@@ -291,4 +307,12 @@ setup.cfg
291307
setup.py
292308
test-requirements.txt
293309
test/__init__.py
310+
test/test_create_transcription_vocabulary_request.py
311+
test/test_list_transcription_vocabularies_response.py
312+
test/test_live_stream_generated_subtitle_settings.py
313+
test/test_transcription_vocabularies_api.py
314+
test/test_transcription_vocabulary.py
315+
test/test_transcription_vocabulary_response.py
316+
test/test_update_live_stream_generated_subtitles_request.py
317+
test/test_update_transcription_vocabulary_request.py
294318
tox.ini

‎docs/CreateLiveStreamRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**passthrough** | **str** | | [optional]
1010
**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]
1111
**embedded_subtitles** | [**list[LiveStreamEmbeddedSubtitleSettings]**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional]
12+
**generated_subtitles** | [**list[LiveStreamGeneratedSubtitleSettings]**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with `generated_subtitles` configured will automatically receive two text tracks. The first of these will have a `text_source` value of `generated_live`, and will be available with `ready` status as soon as the stream is live. The second text track will have a `text_source` value of `generated_live_final` and will contain subtitles with improved accuracy, timing, and formatting. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional]
1213
**reduced_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it 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]
1314
**low_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional]
1415
**latency_mode** | **str** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Note: Reconnect windows are incompatible with Reduced Latency and Low Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional]

‎docs/CreateTranscriptionVocabularyRequest.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CreateTranscriptionVocabularyRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | The user-supplied name of the Transcription Vocabulary. | [optional]
7+
**phrases** | **list[str]** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles`, the probability of successful speech recognition for these words or phrases is boosted. |
8+
**passthrough** | **str** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [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/ListTranscriptionVocabulariesResponse.md

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Name | Type | Description | Notes
1414
**passthrough** | **str** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional]
1515
**audio_only** | **bool** | The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted. | [optional]
1616
**embedded_subtitles** | [**list[LiveStreamEmbeddedSubtitleSettings]**](LiveStreamEmbeddedSubtitleSettings.md) | Describes the embedded closed caption configuration of the incoming live stream. | [optional]
17-
**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. **Min**: 0.1s. **Max**: 300s (5 minutes). | [optional] [default to 60]
17+
**generated_subtitles** | [**list[LiveStreamGeneratedSubtitleSettings]**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with `generated_subtitles` configured will automatically receive two text tracks. The first of these will have a `text_source` value of `generated_live`, and will be available with `ready` status as soon as the stream is live. The second text track will have a `text_source` value of `generated_live_final` and will contain subtitles with improved accuracy, timing, and formatting. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional]
18+
**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. **Min**: 0.1s. **Max**: 1800s (30 minutes). | [optional] [default to 60]
1819
**reduced_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it 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. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional]
1920
**low_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional]
2021
**simulcast_targets** | [**list[SimulcastTarget]**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). | [optional]

‎docs/LiveStreamGeneratedSubtitleSettings.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# LiveStreamGeneratedSubtitleSettings
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | A name for this live stream subtitle track. | [optional]
7+
**passthrough** | **str** | Arbitrary metadata set for the live stream subtitle track. Max 255 characters. | [optional]
8+
**language_code** | **str** | The language to generate subtitles in. | [optional] [default to 'en']
9+
**transcription_vocabulary_ids** | **list[str]** | Unique identifiers for existing Transcription Vocabularies to use while generating subtitles for the live stream. If the Transcription Vocabularies provided collectively have more than 1000 phrases, only the first 1000 phrases will be included. | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/LiveStreamsApi.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Method | HTTP request | Description
2020
[**signal_live_stream_complete**](LiveStreamsApi.md#signal_live_stream_complete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished
2121
[**update_live_stream**](LiveStreamsApi.md#update_live_stream) | **PATCH** /video/v1/live-streams/{LIVE_STREAM_ID} | Update a live stream
2222
[**update_live_stream_embedded_subtitles**](LiveStreamsApi.md#update_live_stream_embedded_subtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles | Update a live stream's embedded subtitles
23+
[**update_live_stream_generated_subtitles**](LiveStreamsApi.md#update_live_stream_generated_subtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/generated-subtitles | Update a live stream's generated subtitles
2324

2425

2526
# **create_live_stream**
@@ -1209,3 +1210,78 @@ Name | Type | Description | Notes
12091210

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

1213+
# **update_live_stream_generated_subtitles**
1214+
> LiveStreamResponse update_live_stream_generated_subtitles(live_stream_id, update_live_stream_generated_subtitles_request)
1215+
1216+
Update a live stream's generated subtitles
1217+
1218+
Updates a live stream's automatic-speech-recognition-generated subtitle configuration. Automatic speech recognition subtitles can be removed by sending an empty array in the request payload.
1219+
1220+
### Example
1221+
1222+
* Basic Authentication (accessToken):
1223+
```python
1224+
from __future__ import print_function
1225+
import time
1226+
import mux_python
1227+
from mux_python.rest import ApiException
1228+
from pprint import pprint
1229+
# Defining the host is optional and defaults to https://api.mux.com
1230+
# See configuration.py for a list of all supported configuration parameters.
1231+
configuration = mux_python.Configuration(
1232+
host = "https://api.mux.com"
1233+
)
1234+
1235+
# The client must configure the authentication and authorization parameters
1236+
# in accordance with the API server security policy.
1237+
# Examples for each auth method are provided below, use the example that
1238+
# satisfies your auth use case.
1239+
1240+
# Configure HTTP basic authorization: accessToken
1241+
configuration = mux_python.Configuration(
1242+
username = 'YOUR_USERNAME',
1243+
password = 'YOUR_PASSWORD'
1244+
)
1245+
1246+
# Enter a context with an instance of the API client
1247+
with mux_python.ApiClient(configuration) as api_client:
1248+
# Create an instance of the API class
1249+
api_instance = mux_python.LiveStreamsApi(api_client)
1250+
live_stream_id = 'live_stream_id_example' # str | The live stream ID
1251+
update_live_stream_generated_subtitles_request = {"generated_subtitles":[{"name":"English CC (ASR)","language":"en","passthrough":"Example"}]} # UpdateLiveStreamGeneratedSubtitlesRequest |
1252+
1253+
try:
1254+
# Update a live stream's generated subtitles
1255+
api_response = api_instance.update_live_stream_generated_subtitles(live_stream_id, update_live_stream_generated_subtitles_request)
1256+
pprint(api_response)
1257+
except ApiException as e:
1258+
print("Exception when calling LiveStreamsApi->update_live_stream_generated_subtitles: %s\n" % e)
1259+
```
1260+
1261+
### Parameters
1262+
1263+
Name | Type | Description | Notes
1264+
------------- | ------------- | ------------- | -------------
1265+
**live_stream_id** | **str**| The live stream ID |
1266+
**update_live_stream_generated_subtitles_request** | [**UpdateLiveStreamGeneratedSubtitlesRequest**](UpdateLiveStreamGeneratedSubtitlesRequest.md)| |
1267+
1268+
### Return type
1269+
1270+
[**LiveStreamResponse**](LiveStreamResponse.md)
1271+
1272+
### Authorization
1273+
1274+
[accessToken](../README.md#accessToken)
1275+
1276+
### HTTP request headers
1277+
1278+
- **Content-Type**: application/json
1279+
- **Accept**: application/json
1280+
1281+
### HTTP response details
1282+
| Status code | Description | Response headers |
1283+
|-------------|-------------|------------------|
1284+
**200** | OK | - |
1285+
1286+
[[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)
1287+

0 commit comments

Comments
 (0)