media-stream-player/dist/WsRtspVideo.d.ts

Player built on top of media-stream-library

import React from 'react';
import { Rtcp, Sdp } from 'media-stream-library';
import { VideoProperties } from './PlaybackArea';
import { MetadataHandler } from './metadata';
/**
 * WebSocket + RTSP playback component.
 */
interface WsRtspVideoProps {
    readonly forwardedRef?: React.Ref<HTMLVideoElement>;
    /**
     * The _intended_ playback state.
     */
    readonly play?: boolean;
    /**
     * The source URI for the WebSocket server.
     */
    readonly ws?: string;
    /**
     * The RTSP URI.
     */
    readonly rtsp?: string;
    /**
     * Activate automatic playback.
     */
    readonly autoPlay?: boolean;
    /**
     * Default mute state.
     */
    readonly muted?: boolean;
    /**
     * Callback to signal video is playing.
     */
    readonly onPlaying?: (videoProperties: VideoProperties) => void;
    /**
     * Callback to signal video ended.
     */
    readonly onEnded?: () => void;
    /**
     * Callback when SDP data is received.
     */
    readonly onSdp?: (msg: Sdp) => void;
    /**
     * Callback when RTCP data is received.
     */
    readonly onRtcp?: (msg: Rtcp) => void;
    readonly metadataHandler?: MetadataHandler;
    /**
     * Start playing from a specific offset (in seconds)
     */
    readonly offset?: number;
    /**
     * Activate automatic retries on RTSP errors.
     */
    readonly autoRetry?: boolean;
}
export declare const WsRtspVideo: React.FC<WsRtspVideoProps>;
export {};