@fishjam-cloud/react-native-client 0.28.3 → 0.29.0

package/dist/hooks/useCustomAudioSource.d.ts

@@ -0,0 +1,91 @@
+import { type CustomAudioTrack } from '@fishjam-cloud/react-native-webrtc';
+/**
+ * Settings for {@link useCustomAudioSource}, fixed for the lifetime of a
+ * streaming session (a `startStreaming`/`stopStreaming` pair).
+ */
+export interface UseCustomAudioSourceOptions {
+    /**
+     * Stable id identifying this custom source. Defaults to
+     * `"customAudioSource"`. Every hook instance that streams at the same time
+     * needs its own id — two instances sharing one silently replace each
+     * other's published track.
+     */
+    sourceId?: string;
+    /**
+     * Sample rate of the PCM you will push, in hertz. Must be a positive
+     * multiple of `100`. Push whatever your source produces natively — it is
+     * resampled downstream. Defaults to `48000`.
+     */
+    sampleRateHz?: number;
+    /**
+     * `1` for mono or `2` for interleaved stereo. Defaults to `1`.
+     */
+    channelCount?: 1 | 2;
+    /**
+     * How much pushed-but-not-yet-sent audio to hold, in milliseconds, before
+     * the oldest is dropped. The buffer drains in real time, so this is the
+     * furthest you can push ahead — for example a long text-to-speech utterance
+     * handed over in one call. Must be at least `10`. Defaults to `60000` (one
+     * minute).
+     */
+    maxBufferedDurationMs?: number;
+}
+export interface UseCustomAudioSourceResult {
+    /** Whether the custom audio track is currently published. */
+    isStreaming: boolean;
+    /**
+     * Push handle for the published track; `null` until streaming starts. Hand
+     * it to `pushAudioSamples` whenever your source produces audio. The handle
+     * is plain and worklet-serializable, so it can be shared into a worklet and
+     * pushed from there directly — no thread hop.
+     */
+    track: CustomAudioTrack | null;
+    /**
+     * Create the custom audio track and publish it. Once this resolves the
+     * track is registered — pushed samples are streamed to the room right away
+     * when the peer is connected, or automatically once it connects. No-op when
+     * already streaming.
+     */
+    startStreaming: () => Promise<void>;
+    /**
+     * Unpublish and release the custom audio track. No-op when not streaming.
+     */
+    stopStreaming: () => Promise<void>;
+    /** The error that failed the last `startStreaming` or `stopStreaming` call, if any. */
+    error: Error | null;
+}
+/**
+ * Publish your own audio to Fishjam.
+ *
+ * Creates a custom audio track, publishes it, and cleans it up — you supply
+ * the PCM from any source (a synthesizer, a decoder, an audio pipeline) via
+ * `pushAudioSamples`. The published track behaves like a live microphone:
+ * pauses in pushing are fine and play as silence. It is independent of
+ * {@link useMicrophone} and does not involve the device microphone in any way —
+ * publishing it does not trigger the recording permission.
+ *
+ * Remote peers receive the track with metadata type `"customAudio"`
+ * (`usePeers` exposes it under `customAudioTracks`).
+ *
+ * Push PCM with `pushAudioSamples` (from `@fishjam-cloud/react-native-client`)
+ * and the returned {@link UseCustomAudioSourceResult.track | track} handle —
+ * from the JS thread or from inside a worklet, with any chunk size. The track
+ * re-paces pushes into a continuous stream, filling gaps with silence like a
+ * live microphone. `Float32Array` samples are expected in `[-1, 1]`;
+ * `Int16Array` is taken as-is.
+ *
+ * ```tsx
+ * const { startStreaming, stopStreaming, track } = useCustomAudioSource();
+ *
+ * // e.g. from react-native-audio-api's AudioRecorder:
+ * recorder.onAudioReady({ sampleRate: 48000, bufferLength: 4800, channelCount: 1 },
+ *     ({ buffer }) => track && pushAudioSamples(track, buffer.getChannelData(0)));
+ * ```
+ *
+ * Requires the New Architecture; `startStreaming` reports an error on the old
+ * architecture.
+ *
+ * @group Hooks
+ */
+export declare function useCustomAudioSource(options?: UseCustomAudioSourceOptions): UseCustomAudioSourceResult;
+//# sourceMappingURL=useCustomAudioSource.d.ts.map

package/dist/hooks/useCustomAudioSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCustomAudioSource.d.ts","sourceRoot":"","sources":["../../src/hooks/useCustomAudioSource.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,gBAAgB,EAGtB,MAAM,oCAAoC,CAAC;AAU5C;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACrB;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,0BAA0B;IACzC,6DAA6D;IAC7D,WAAW,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,KAAK,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC/B;;;;;OAKG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC;;OAEG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,uFAAuF;IACvF,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;CACrB;AAyBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,CAAC,EAAE,2BAA2B,GAAG,0BAA0B,CAyGtG"}

package/dist/hooks/useCustomAudioSource.js

@@ -0,0 +1,151 @@
+import { createCustomAudioTrack, } from '@fishjam-cloud/react-native-webrtc';
+import { useCallback, useEffect, useRef, useState } from 'react';
+import { useCustomSource } from '../overrides/hooks';
+const DEFAULT_SOURCE_ID = 'customAudioSource';
+const DEFAULT_SAMPLE_RATE_HZ = 48000;
+const DEFAULT_CHANNEL_COUNT = 1;
+const DEFAULT_MAX_BUFFERED_DURATION_MS = 60_000;
+function stopStreamTracks(stream) {
+    try {
+        stream.getTracks().forEach((track) => track.stop());
+    }
+    catch (cause) {
+        console.warn('useCustomAudioSource: stopping tracks failed', cause);
+    }
+}
+function toError(cause) {
+    return cause instanceof Error ? cause : new Error(String(cause));
+}
+/**
+ * Publish your own audio to Fishjam.
+ *
+ * Creates a custom audio track, publishes it, and cleans it up — you supply
+ * the PCM from any source (a synthesizer, a decoder, an audio pipeline) via
+ * `pushAudioSamples`. The published track behaves like a live microphone:
+ * pauses in pushing are fine and play as silence. It is independent of
+ * {@link useMicrophone} and does not involve the device microphone in any way —
+ * publishing it does not trigger the recording permission.
+ *
+ * Remote peers receive the track with metadata type `"customAudio"`
+ * (`usePeers` exposes it under `customAudioTracks`).
+ *
+ * Push PCM with `pushAudioSamples` (from `@fishjam-cloud/react-native-client`)
+ * and the returned {@link UseCustomAudioSourceResult.track | track} handle —
+ * from the JS thread or from inside a worklet, with any chunk size. The track
+ * re-paces pushes into a continuous stream, filling gaps with silence like a
+ * live microphone. `Float32Array` samples are expected in `[-1, 1]`;
+ * `Int16Array` is taken as-is.
+ *
+ * ```tsx
+ * const { startStreaming, stopStreaming, track } = useCustomAudioSource();
+ *
+ * // e.g. from react-native-audio-api's AudioRecorder:
+ * recorder.onAudioReady({ sampleRate: 48000, bufferLength: 4800, channelCount: 1 },
+ *     ({ buffer }) => track && pushAudioSamples(track, buffer.getChannelData(0)));
+ * ```
+ *
+ * Requires the New Architecture; `startStreaming` reports an error on the old
+ * architecture.
+ *
+ * @group Hooks
+ */
+export function useCustomAudioSource(options) {
+    const sourceId = options?.sourceId ?? DEFAULT_SOURCE_ID;
+    const sampleRateHz = options?.sampleRateHz ?? DEFAULT_SAMPLE_RATE_HZ;
+    const channelCount = options?.channelCount ?? DEFAULT_CHANNEL_COUNT;
+    const maxBufferedDurationMs = options?.maxBufferedDurationMs ?? DEFAULT_MAX_BUFFERED_DURATION_MS;
+    const { setStream } = useCustomSource(sourceId);
+    // Read through a ref so startStreaming picks up the latest setStream without
+    // retriggering its memoization when the provider re-renders. Each session
+    // captures the function it started with, so stop/unmount tear down the
+    // sourceId that was actually published even if the option changed since.
+    const setStreamRef = useRef(setStream);
+    useEffect(() => {
+        setStreamRef.current = setStream;
+    });
+    const sessionRef = useRef(null);
+    const [track, setTrack] = useState(null);
+    const [error, setError] = useState(null);
+    const startStreaming = useCallback(async () => {
+        if (sessionRef.current) {
+            return;
+        }
+        const session = { created: null, cancelled: false, setStream: setStreamRef.current };
+        sessionRef.current = session;
+        setError(null);
+        try {
+            const created = await createCustomAudioTrack({
+                sampleRateHz,
+                channelCount,
+                maxBufferedDurationMs,
+            });
+            if (session.cancelled) {
+                // Stopped (or unmounted) while creating — discard the just-built track.
+                stopStreamTracks(created.stream);
+                return;
+            }
+            session.created = created;
+            await session.setStream(created.stream);
+            if (session.cancelled) {
+                // stopStreaming already unpublished and released the track.
+                return;
+            }
+            setTrack(created.track);
+        }
+        catch (cause) {
+            if (session.created) {
+                stopStreamTracks(session.created.stream);
+            }
+            if (!session.cancelled) {
+                sessionRef.current = null;
+                setError(toError(cause));
+            }
+        }
+    }, [sampleRateHz, channelCount, maxBufferedDurationMs]);
+    const stopStreaming = useCallback(async () => {
+        const session = sessionRef.current;
+        if (!session) {
+            return;
+        }
+        session.cancelled = true;
+        sessionRef.current = null;
+        setTrack(null);
+        if (session.created) {
+            try {
+                await session.setStream(null);
+            }
+            catch (cause) {
+                setError(toError(cause));
+            }
+            finally {
+                stopStreamTracks(session.created.stream);
+            }
+        }
+    }, []);
+    useEffect(() => () => {
+        const session = sessionRef.current;
+        if (!session) {
+            return;
+        }
+        session.cancelled = true;
+        sessionRef.current = null;
+        const created = session.created;
+        if (created) {
+            // Unpublish before stopping the tracks, so a publish call still queued
+            // behind other custom sources never runs on an already-stopped track.
+            // Failures are ignored — the provider may be unmounting too and there
+            // is no surface left to report to.
+            session
+                .setStream(null)
+                .catch(() => { })
+                .finally(() => stopStreamTracks(created.stream));
+        }
+    }, []);
+    return {
+        isStreaming: track !== null,
+        track,
+        startStreaming,
+        stopStreaming,
+        error,
+    };
+}

package/dist/index.d.ts

@@ -7,10 +7,11 @@ import './webrtc-polyfill';
 import React from 'react';
 import { type FishjamProviderProps as ReactClientFishjamProviderProps } from '@fishjam-cloud/react-client';
 export { RTCView, RTCPIPView, type RTCVideoViewProps, type RTCPIPViewProps } from './overrides/RTCView';
-export { ScreenCapturePickerView, startPIP, stopPIP, AudioDeviceType, useAudioOutput, } from '@fishjam-cloud/react-native-webrtc';
-export type { CallKitAction, CallKitConfig, MediaStream, MediaStreamTrack, AudioDevice, AudioOutputChangedInfo, UseAudioOutputResult, } from '@fishjam-cloud/react-native-webrtc';
+export { ScreenCapturePickerView, startPIP, stopPIP, AudioDeviceType, useAudioOutput, pushAudioSamples, } from '@fishjam-cloud/react-native-webrtc';
+export type { CallKitAction, CallKitConfig, CustomAudioSink, CustomAudioTrack, MediaStream, MediaStreamTrack, AudioDevice, AudioOutputChangedInfo, UseAudioOutputResult, } from '@fishjam-cloud/react-native-webrtc';
 export { useForegroundService, type ForegroundServiceConfig } from './useForegroundService';
 export { useCameraPermissions, useMicrophonePermissions, type PermissionStatus } from './hooks/usePermissions';
+export { useCustomAudioSource, type UseCustomAudioSourceOptions, type UseCustomAudioSourceResult, } from './hooks/useCustomAudioSource';
 export { InitializeDevicesSettings, useConnection, useDataChannel, useSandbox, useUpdatePeerMetadata, useVAD, Variant, } from '@fishjam-cloud/react-client';
 export { useCamera, useInitializeDevices, useMicrophone, useScreenShare, useCustomSource, useLivestreamStreamer, useLivestreamViewer, usePeers, useCallKit, useCallKitEvent, useCallKitService, } from './overrides/hooks';
 export type { StreamerInputs, ConnectStreamerConfig, UseLivestreamStreamerResult, UseLivestreamViewerResult, UseCameraResult, UseMicrophoneResult, UseScreenShareResult, UseCustomSourceResult, UseInitializeDevicesReturn, Track, RemoteTrack, CustomSource, InitializeDevicesResult, PeerWithTracks, TrackFields, MiddlewareResult, TrackMiddleware, TracksMiddleware, TracksMiddlewareResult, } from './overrides/types';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,OAAO,mBAAmB,CAAC;AAC3B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAEL,KAAK,oBAAoB,IAAI,+BAA+B,EAC7D,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACxG,OAAO,EACL,uBAAuB,EACvB,QAAQ,EACR,OAAO,EACP,eAAe,EACf,cAAc,GACf,MAAM,oCAAoC,CAAC;AAE5C,YAAY,EACV,aAAa,EACb,aAAa,EACb,WAAW,EACX,gBAAgB,EAChB,WAAW,EACX,sBAAsB,EACtB,oBAAoB,GACrB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,oBAAoB,EAAE,KAAK,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAC5F,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/G,OAAO,EACL,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,UAAU,EACV,qBAAqB,EACrB,MAAM,EACN,OAAO,GACR,MAAM,6BAA6B,CAAC;AAErC,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,QAAQ,EACR,UAAU,EACV,eAAe,EACf,iBAAiB,GAClB,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,2BAA2B,EAC3B,yBAAyB,EACzB,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,0BAA0B,EAC1B,KAAK,EACL,WAAW,EACX,YAAY,EACZ,uBAAuB,EACvB,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EACV,0BAA0B,EAC1B,cAAc,EACd,mBAAmB,EACnB,QAAQ,EACR,eAAe,EACf,eAAe,EACf,KAAK,EACL,WAAW,EACX,UAAU,EACV,uBAAuB,EACvB,MAAM,EACN,UAAU,EACV,yBAAyB,EACzB,wBAAwB,EACxB,YAAY,EACZ,OAAO,EACP,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,YAAY,EACZ,kBAAkB,EAClB,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,mBAAmB,GACpB,MAAM,6BAA6B,CAAC;AAGrC,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,+BAA+B,EAAE,mBAAmB,GAAG,eAAe,CAAC,CAAC;AAChH,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB,mEAO1D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,OAAO,mBAAmB,CAAC;AAC3B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAEL,KAAK,oBAAoB,IAAI,+BAA+B,EAC7D,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACxG,OAAO,EACL,uBAAuB,EACvB,QAAQ,EACR,OAAO,EACP,eAAe,EACf,cAAc,EACd,gBAAgB,GACjB,MAAM,oCAAoC,CAAC;AAE5C,YAAY,EACV,aAAa,EACb,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,gBAAgB,EAChB,WAAW,EACX,sBAAsB,EACtB,oBAAoB,GACrB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,oBAAoB,EAAE,KAAK,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAC5F,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC/G,OAAO,EACL,oBAAoB,EACpB,KAAK,2BAA2B,EAChC,KAAK,0BAA0B,GAChC,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EACL,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,UAAU,EACV,qBAAqB,EACrB,MAAM,EACN,OAAO,GACR,MAAM,6BAA6B,CAAC;AAErC,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,QAAQ,EACR,UAAU,EACV,eAAe,EACf,iBAAiB,GAClB,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,2BAA2B,EAC3B,yBAAyB,EACzB,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,0BAA0B,EAC1B,KAAK,EACL,WAAW,EACX,YAAY,EACZ,uBAAuB,EACvB,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EACV,0BAA0B,EAC1B,cAAc,EACd,mBAAmB,EACnB,QAAQ,EACR,eAAe,EACf,eAAe,EACf,KAAK,EACL,WAAW,EACX,UAAU,EACV,uBAAuB,EACvB,MAAM,EACN,UAAU,EACV,yBAAyB,EACzB,wBAAwB,EACxB,YAAY,EACZ,OAAO,EACP,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,YAAY,EACZ,kBAAkB,EAClB,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,mBAAmB,GACpB,MAAM,6BAA6B,CAAC;AAGrC,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,+BAA+B,EAAE,mBAAmB,GAAG,eAAe,CAAC,CAAC;AAChH,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB,mEAO1D"}

package/dist/index.js

@@ -13,9 +13,10 @@ import React from 'react';
 import { FishjamProvider as ReactClientFishjamProvider, } from '@fishjam-cloud/react-client';
 import { FishjamClient } from '@fishjam-cloud/ts-client';
 export { RTCView, RTCPIPView } from './overrides/RTCView';
-export { ScreenCapturePickerView, startPIP, stopPIP, AudioDeviceType, useAudioOutput, } from '@fishjam-cloud/react-native-webrtc';
+export { ScreenCapturePickerView, startPIP, stopPIP, AudioDeviceType, useAudioOutput, pushAudioSamples, } from '@fishjam-cloud/react-native-webrtc';
 export { useForegroundService } from './useForegroundService';
 export { useCameraPermissions, useMicrophonePermissions } from './hooks/usePermissions';
+export { useCustomAudioSource, } from './hooks/useCustomAudioSource';
 export { useConnection, useDataChannel, useSandbox, useUpdatePeerMetadata, useVAD, Variant, } from '@fishjam-cloud/react-client';
 export { useCamera, useInitializeDevices, useMicrophone, useScreenShare, useCustomSource, useLivestreamStreamer, useLivestreamViewer, usePeers, useCallKit, useCallKitEvent, useCallKitService, } from './overrides/hooks';
 export function FishjamProvider(props) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishjam-cloud/react-native-client",
-  "version": "0.28.3",
+  "version": "0.29.0",
   "description": "React Native client library for Fishjam",
   "license": "Apache-2.0",
   "author": "Fishjam Team",
@@ -42,15 +42,15 @@
     ]
   },
   "peerDependencies": {
-    "@fishjam-cloud/react-native-webrtc": "0.28.0",
+    "@fishjam-cloud/react-native-webrtc": "0.29.0",
     "expo": "*",
     "react": "*",
     "react-native": "*",
     "react-native-get-random-values": "1.11.0"
   },
   "dependencies": {
-    "@fishjam-cloud/react-client": "0.28.3",
-    "@fishjam-cloud/react-native-webrtc": "0.28.0",
+    "@fishjam-cloud/react-client": "0.29.0",
+    "@fishjam-cloud/react-native-webrtc": "0.29.0",
     "fast-text-encoding": "1.0.6",
     "react-native-get-random-values": "1.11.0",
     "react-native-url-polyfill": "3.0.0"