react-native-nitro-screen-recorder/lib/hooks/useGlobalRecording.d.ts

A library to capture screen recordings with react-native powered by NitroModules.

import { ScreenRecordingFile } from '../types';
/**
 * Configuration options for the global recording hook.
 */
type GlobalRecordingHookInput = {
    /**
     * Callback invoked when a global screen recording begins.
     * Use this to update your UI to indicate recording is in progress.
     */
    onRecordingStarted?: () => void;
    /**
     * Callback invoked when a global screen recording finishes.
     * Receives the recorded file (if successfully retrieved) or undefined if retrieval failed.
     *
     * @param file The screen recording file, or undefined if retrieval failed
     */
    onRecordingFinished?: (file?: ScreenRecordingFile) => void;
    /**
     * A callback for iOS when the broadcast modal shows, in case you want to
     * perform some analytics or tasks. Is a no-op on android.
     */
    onBroadcastModalShown?: () => void;
    onBroadcastModalDismissed?: () => void;
    /**
     * Time in milliseconds to wait after recording ends before attempting to retrieve the file.
     * This allows the system time to finish writing the recording to disk.
     *
     * @default 500
     */
    settledTimeMs?: number;
};
/**
 * Return value from the global recording hook.
 */
type GlobalRecordingHookOutput = {
    /**
     * Whether a global screen recording is currently active.
     * Updates automatically as recordings start and stop.
     */
    isRecording: boolean;
};
/**
 * React hook for monitoring and responding to global screen recording events.
 *
 * This hook automatically tracks the state of global screen recordings (recordings
 * that capture the entire device screen, not just your app) and provides callbacks
 * for when recordings start and finish. It also manages the timing of file retrieval
 * to ensure the recording file is fully written before attempting to access it.
 *
 * **Key Features:**
 * - Automatically tracks global recording state
 * - Provides lifecycle callbacks for recording start/finish events
 * - Handles timing delays for safe file retrieval
 * - Filters out within-app recordings (only responds to global recordings)
 *
 * **Use Cases:**
 * - Show recording indicators in your UI
 * - Automatically upload or process completed recordings
 * - Trigger analytics events for recording usage
 * - Update app state based on recording activity
 *
 * @param props Configuration options for the hook
 * @returns Object containing the current recording state
 *
 * @example
 * ```tsx
 *   const { isRecording } = useGlobalRecording({
 *     onRecordingStarted: () => {
 *       analytics.track('recording_started');
 *     },
 *     onBroadcastModalShown: () => {
 *       console.log("User tried to initiate recording")
 *     },
 *     onBroadcastModalDismissed: () => {
 *       redirectToAnotherApp()
 *     },
 *     onRecordingFinished: async (file) => {
 *       if (file) {
 *         try {
 *           await uploadRecording(file);
 *           showSuccessToast('Recording uploaded successfully!');
 *         } catch (error) {
 *           showErrorToast('Failed to upload recording');
 *         }
 *       }
 *     },
 *   });
 * ```
 */
export declare const useGlobalRecording: (props?: GlobalRecordingHookInput) => GlobalRecordingHookOutput;
export {};
//# sourceMappingURL=useGlobalRecording.d.ts.map