Hiyve Components - v1.0.0
    Preparing search index...

    Function StreamingControls

    • StreamingControls provides UI for starting and stopping live streams.

      Parameters

      Returns ReactElement

      The rendered StreamingControls component

      The StreamingControls component offers both full and compact modes for different layout requirements. It includes an options dialog for configuring streaming settings like MP4 recording.

      Key Features:

      • Start/stop button: One-click streaming control with visual state changes
      • Loading state: Shows spinner while stream is starting
      • Options dialog: Configure MP4 recording before starting
      • Duration display: Shows elapsed streaming time when active
      • Compact mode: Icon-only display for space-constrained layouts
      • Full customization: Labels (i18n), icons, and styles

      Basic streaming controls:

      import { StreamingControls } from '@hiyve/react-capture';

      function LiveStreaming() {
      const { isStreaming, isStreamingStarting, startStreaming, stopStreaming, streamingDuration } = useStreaming();

      return (
      <StreamingControls
      isStreaming={isStreaming}
      isStreamingStarting={isStreamingStarting}
      onStreamingStart={startStreaming}
      onStreamingStop={stopStreaming}
      duration={streamingDuration}
      />
      );
      }