@tiny-codes/react-easy 1.4.6 → 1.4.8

package/es/hooks/useUserMedia.d.ts

@@ -0,0 +1,104 @@
+export interface UseUserMediaProps {
+    /**
+     * - **EN:** The media constraints for the audio and video stream.
+     * - **CN:** 媒体流的媒体约束。
+     */
+    media: Pick<MediaStreamConstraints, 'audio' | 'video'>;
+    /**
+     * - **EN:** Whether to enable PCM output, only effective when recording audio. Please use
+     *   `onPcmStreamChunk` callback to get PCM data. Default is `false`.
+     * - **CN:** 是否启用 PCM 输出，仅在录制音频时有效。请使用 `onPcmStreamChunk` 回调获取 PCM 数据。默认`false`
+     */
+    pcmAudioOptions?: {
+        /**
+         * - **EN:** The audio context options for the PCM output.
+         * - **CN:** PCM 输出的音频上下文选项。
+         */
+        audioContext?: AudioContextOptions;
+        /**
+         * - **EN:** The worklet options for the PCM output.
+         * - **CN:** PCM 输出的工作线程选项。
+         */
+        workletOptions?: AudioWorkletNodeOptions;
+    };
+    /**
+     * - **EN:** Callback function that is triggered when the recording starts, providing the media
+     *   stream.
+     * - **CN:** 开始录制时触发的回调函数，提供媒体流。
+     *
+     * @param {MediaStream} stream - The media stream.
+     */
+    onStartRecording?: (stream: MediaStream) => void;
+    /**
+     * - **EN:** Callback function that is triggered when the recording stops.
+     * - **CN:** 停止录制时触发的回调函数。
+     */
+    onStopRecording?: () => void;
+    /**
+     * - **EN:** Callback function that is triggered when a new chunk of media data is available.
+     * - **CN:** 当录制媒体流时，每个时间分片会触发一次 `onStreamChunk` 回调，提供媒体数据块。
+     *
+     * > 注意音频流编码格式为：audio/webm;codecs=opus。如果希望获取 PCM 数据，请使用 `onPcmData` 回调。
+     *
+     * @param {Blob} chunk - The media data chunk (MIME: audio/webm;codecs=opus) | 媒体数据块 (MIME:
+     *   audio/webm;codecs=opus)
+     */
+    onStreamChunk?: (chunk: Blob) => void;
+    /**
+     * - **EN:** Callback for raw PCM float data (per render quantum)
+     * - **CN:** 获取原始 PCM 浮点数据的回调（每个渲染量子）
+     *
+     * @param data Monophonic or polyphonic spliced data | 单声道或多声道拼接数据
+     * @param sampleRate Sample rate | 采样率
+     */
+    onPcmStreamChunk?: (channels: Float32Array[], sampleRate: number) => void;
+    /**
+     * - **EN:** Whether to disable this hook.
+     * - **CN:** 是否禁用此工具
+     */
+    disabled?: boolean;
+    /**
+     * - **EN:** The slicing time period (milliseconds) for each fragment of the audio and video stream,
+     *   each time slice will trigger the `onStreamChunk` callback. Default is `500`.
+     * - **CN:** 媒体流每个分片的切片时间段（毫秒），每个时间分片会触发一次 `onStreamChunk` 回调，默认值为 `500`。
+     */
+    streamSliceMs?: number;
+    /**
+     * - **EN:** The silence detection threshold (0-1) for the audio stream, below which the audio is
+     *   considered silent. Default is `0`.
+     * - **CN:** 音频流的静音检测阈值（0-1），低于该值音频被视为静音。默认值为 `0`。
+     */
+    soundDetectionThreshold?: number;
+    /**
+     * - **EN:** The timeout duration (milliseconds) for detecting sound input. If no sound is detected
+     *   within this period, the user will be prompted to re-select the audio device. Default is
+     *   `3000`.
+     * - **CN:** 检测是否有声音输入的超时时间（毫秒），如果在该时间段内没有检测到声音，则会提示用户重新选择音频设备。默认值为 `3000`。
+     */
+    soundDetectionTimeout?: number;
+}
+declare const useUserMedia: (props: UseUserMediaProps) => UseUserMediaResult;
+export interface UseUserMediaResult {
+    /**
+     * - **EN** Whether the media stream is currently being recorded
+     * - **CN** 是否正在录制媒体流
+     */
+    isRecording: boolean;
+    /**
+     * - **EN** Start recording the media stream
+     * - **CN** 开始录制媒体流
+     */
+    startRecording: () => Promise<MediaRecorder>;
+    /**
+     * - **EN** Stop recording the media stream
+     * - **CN** 停止录制媒体流
+     */
+    stopRecording: () => void;
+    /**
+     * - **EN** Get the media stream being recorded, returns the stream if recording, otherwise returns
+     *   `undefined`
+     * - **CN** 获取正在录制的媒体流，如果正在录制则返回该流，否则返回 `undefined`
+     */
+    mediaStream?: MediaStream;
+}
+export default useUserMedia;