From 617fda2864298e2f28c8422e94bfaab85b1bf43c Mon Sep 17 00:00:00 2001 From: makaveli10 Date: Thu, 10 Oct 2024 08:43:21 -0400 Subject: [PATCH] Update Readme Signed-off-by: makaveli10 --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f98b9b..19bb230 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,9 @@ If you don't want this, set `--no_single_model`. - `use_vad`: Whether to use `Voice Activity Detection` on the server. - `save_output_recording`: Set to True to save the microphone input as a `.wav` file during live transcription. This option is helpful for recording sessions for later playback or analysis. Defaults to `False`. - `output_recording_filename`: Specifies the `.wav` file path where the microphone input will be saved if `save_output_recording` is set to `True`. + - `max_clients`: Specifies the maximum number of clients the server should allow. Defaults to 4. + - `max_connection_time`: Maximum connection time for each client in seconds. Defaults to 600. + ```python from whisper_live.client import TranscriptionClient client = TranscriptionClient( @@ -87,7 +90,9 @@ client = TranscriptionClient( model="small", use_vad=False, save_output_recording=True, # Only used for microphone input, False by Default - output_recording_filename="./output_recording.wav" # Only used for microphone input + output_recording_filename="./output_recording.wav", # Only used for microphone input + max_clients=4, + max_connection_time=600 ) ``` It connects to the server running on localhost at port 9090. Using a multilingual model, language for the transcription will be automatically detected. You can also use the language option to specify the target language for the transcription, in this case, English ("en"). The translate option should be set to `True` if we want to translate from the source language to English and `False` if we want to transcribe in the source language.