media-stream-player/dist/WsRtspCanvas.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';
interface WsRtspCanvasProps {
    readonly forwardedRef?: React.Ref<HTMLCanvasElement>;
    /**
     * The _intended_ playback state.
     */
    readonly play?: boolean;
    /**
     * The source URI for the WebSocket server.
     */
    readonly ws?: string;
    /**
     * The RTSP URI.
     */
    readonly rtsp?: string;
    /**
     * Callback to signal video is playing.
     */
    readonly onPlaying: (props: 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;
    /**
     * Start playing from a specific offset (in seconds)
     */
    readonly offset?: number;
    /**
     * Activate automatic retries on RTSP errors.
     */
    readonly autoRetry?: boolean;
}
/**
 * Properties:
 *
 * play: indicated the _intended_ playback state
 * ws/rtsp: src URIs for WebSocket/RTP server
 *
 * Internal state:
 * canplay: there is enough data on the video element to play
 * playing: the video element playback is progressing
 */
export declare const WsRtspCanvas: React.FC<WsRtspCanvasProps>;
export {};