Skip to content

Commit dcbf3c6

Browse files
committed
clarify streaming behavior and recording return values
1 parent 26a7ae0 commit dcbf3c6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

sdk/python/packages/flet-audio-recorder/src/flet_audio_recorder/audio_recorder.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ async def start_recording(
6262
provided on platforms other than web.
6363
6464
When streaming, use :attr:`~flet_audio_recorder.AudioEncoder.PCM16BITS` as
65-
encoder, in which case, then emitted or uploaded
65+
the encoder. In that case, emitted or uploaded
6666
:attr:`~flet_audio_recorder.AudioRecorderStreamEvent.chunk`s contain raw PCM16
67-
data. In some usecases, these chunks could be wrapped in a container such as
67+
data. In some use cases, these chunks can be wrapped in a container such as
6868
WAV if the output must be directly playable as an audio file.
6969
7070
Args:
@@ -117,11 +117,11 @@ async def is_recording(self) -> bool:
117117

118118
async def stop_recording(self) -> Optional[str]:
119119
"""
120-
Stops the audio recording and optionally returns the path to the saved file.
120+
Stops the audio recording and optionally returns the recording location.
121121
122122
Returns:
123-
The file path where the audio was saved or `None` when
124-
streaming (i.e. when `upload` or :attr:`on_stream` is set).
123+
The local file path where the audio was saved, a Blob URL on web, or
124+
`None` when streaming (i.e. when `upload` or :attr:`on_stream` is set).
125125
"""
126126
return await self._invoke_method("stop_recording")
127127

0 commit comments

Comments
 (0)