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

Player built on top of media-stream-library

import React from 'react';
import { Sdp } from 'media-stream-library';
import { PlayerNativeElement, VapixParameters } from './PlaybackArea';
import { MetadataHandler } from './metadata';
import { Format } from './types';
interface PlayerProps {
    readonly hostname: string;
    readonly vapixParams?: VapixParameters;
    readonly initialFormat?: Format;
    readonly autoPlay?: boolean;
    readonly onSdp?: (msg: Sdp) => void;
    readonly metadataHandler?: MetadataHandler;
    /**
     * Set to true if the camera requires a secure
     * connection, "https" and "wss" protocols.
     */
    readonly secure?: boolean;
    readonly aspectRatio?: number;
    readonly className?: string;
    /**
     * When playing a recording, the time the video started
     * (used for labeling with an absolute time) formatted
     * as an ISO time, e.g.: 2021-02-03T12:21:57.465715Z
     */
    readonly startTime?: string;
    /**
     * When playing a recording, the total duration of the video
     * if known by the user (and not reported from backend) in
     * seconds.
     */
    readonly duration?: number;
    /**
     * Activate automatic retries on RTSP errors.
     */
    readonly autoRetry?: boolean;
}
export declare const Player: React.ForwardRefExoticComponent<PlayerProps & React.RefAttributes<PlayerNativeElement>>;
export {};