@vtx/player 0.0.7 → 0.0.10

package/dist/index.d.ts

@@ -0,0 +1,221 @@
+/// <reference types="react" />
+import moment from 'moment';
+import { CloudControlPanelProps } from '@/components/controls';
+import { VideoType as VideoType$1 } from '@/components/player';
+import * as react from 'react';
+import { GetHistoryUrlParams, LoadVideoInfoParams } from '@/api/types';
+
+/** 视频流格式 */
+declare type VideoType = 'flv' | 'hls' | 'hk_ws';
+interface ConstructorParams {
+    url: string;
+    /** 渲染容器 */
+    container: HTMLDivElement;
+    /** 是否直播，flv.js需要 */
+    live?: boolean;
+    /** 视频流格式 */
+    type?: VideoType;
+    /** 开始时间，历史回放需要 */
+    startTime?: moment.MomentInput;
+    /** 结束时间，历史回放需要 */
+    endTime?: moment.MomentInput;
+}
+/**
+ * 视频播放核心类
+ */
+declare class Player {
+    /** 视频地址 */
+    url: string;
+    /** 视频流格式 */
+    type: VideoType;
+    private player;
+    private video;
+    /** 开始时间，历史回放需要 */
+    private startTime?;
+    /** 结束时间，历史回放需要 */
+    private endTime?;
+    /** 跳转时间，用于处理进度条位置 */
+    private seekTime?;
+    /** 之前的视频播放速度，用于处理海康音量控制 */
+    private preSpeed;
+    constructor(params: ConstructorParams);
+    /** 播放 */
+    play(): Promise<void>;
+    /** 回放 */
+    playBack(): Promise<void>;
+    /** 销毁 */
+    destroy(): void;
+    /** 截图 */
+    capture(captureName?: string, time?: boolean): void;
+    /** 尺寸重置 */
+    resize(): void;
+    /**
+     * 设置音量
+     * @param value
+     */
+    setVolume(value: number): void;
+    /**
+     * 设置播放速度
+     * @param speed
+     */
+    setSpeed(speed: 0.5 | 1 | 2 | 4 | 8): void;
+    /**
+     * 时间更新事件
+     * @param callback 回调函数
+     */
+    onTimeUpdate(callback: (currentTime: number, speed: number) => void): void;
+    /** 跳转到 */
+    seekTo(time: number): Promise<void>;
+    /**
+     * 暂停播放
+     * @param callback 回调函数
+     */
+    pause(callback?: () => void): void;
+    /**
+     * 恢复播放
+     * @param callback 回调函数
+     */
+    resume(callback?: () => void): void;
+    /**
+     * 开始对讲
+     * @param url 对讲地址
+     */
+    startTalk(url: string): Promise<void>;
+    /**
+     * 开始对讲
+     * @param state 状态
+     */
+    stopTalk(): Promise<void>;
+}
+
+interface VtxPlayerProps$1 {
+    /** 视频流地址 */
+    url: string;
+    /** 宽度 */
+    width?: number;
+    /** 高度 */
+    height?: number;
+    /** 视频流格式，如果为空则根据url自行判断 */
+    type?: VideoType$1;
+    /** 截图文件名 */
+    captureName?: string;
+    /** 对讲地址 */
+    talkUrl?: string;
+    /** 云台控制 */
+    cloudParams?: CloudControlPanelProps;
+}
+declare const LivePlayer: (props: VtxPlayerProps$1) => JSX.Element;
+
+declare type HistoryPlayerHandle = {
+    /**
+     * 跳转，目前仅支持海康视频跳转
+     */
+    seekTo: (time: string) => Promise<void>;
+};
+interface VtxPlayerProps {
+    /** 视频流地址 */
+    url: string;
+    /** 视频流格式，如果为空则根据url自行判断 */
+    type?: VideoType$1;
+    /** 开始时间，格式为：YYYY-MM-DD HH:mm:ss */
+    startTime: string;
+    /** 结束时间，格式为：YYYY-MM-DD HH:mm:ss  */
+    endTime: string;
+    /** 宽度 */
+    width?: number;
+    /** 高度 */
+    height?: number;
+    /** 截图文件名 */
+    captureName?: string;
+    /** 控制条bottom */
+    controlBottom?: number;
+    /** 播放器进度回调，time:YYYY-MM-DD HH:mm:ss speed:播放速率 */
+    onTimeChange?: (time: string, speed: number) => void;
+}
+declare const HistoryPlayer: react.ForwardRefExoticComponent<VtxPlayerProps & react.RefAttributes<HistoryPlayerHandle>>;
+
+declare type LiveControlHandle = {
+    /** 加载视频 */
+    load: (channel: ChannelType) => void;
+    /** 卸载视频，参数为通道编号 */
+    unLoad: (channelNum: string) => void;
+    /** 一次加载多个视频，适用于初始化 */
+    multiLoad: (channels: ChannelType[]) => void;
+};
+interface LiveControlProps {
+    /** 展开/收缩按钮回调 */
+    onExpandChange?: (expand: boolean) => void;
+    /** 视频关闭回调，参数为通道编号数组 */
+    onChannelChange?: (channelSNum: string[]) => void;
+    /** 宽度 */
+    width?: number | string;
+    /** 高度 */
+    height?: number | string;
+    /** 轮询频率 */
+    polling?: number | undefined;
+}
+declare type ChannelType = {
+    /** 通道号 */
+    channelNum: string;
+    /** 设备ID */
+    deviceId?: string;
+    /** 协议 */
+    protocol?: string;
+};
+/**
+ * 实时分屏组件
+ */
+declare const LiveControl: react.ForwardRefExoticComponent<LiveControlProps & react.RefAttributes<LiveControlHandle>>;
+
+declare type HistoryControlHandle = {
+    load: (channel: GetHistoryUrlParams) => void;
+};
+interface HistoryControlProps {
+    /** 宽度 */
+    width?: number;
+    /** 高度 */
+    height?: number;
+    /** 展开/收缩按钮回调 */
+    onExpandChange?: (expand: boolean) => void;
+    /** 播放器进度回调，time:YYYY-MM-DD HH:mm:ss */
+    onTimeChange?: (time: string) => void;
+}
+/**
+ * 历史视频控制器
+ */
+declare const HistoryControl: react.ForwardRefExoticComponent<HistoryControlProps & react.RefAttributes<HistoryControlHandle>>;
+
+interface BillPlayerProps {
+    /** 参数 */
+    params: LoadVideoInfoParams;
+    /** 宽度 */
+    width?: string | number;
+    /** 高度 */
+    height?: string | number;
+    /** 是否显示实时视频，默认为true */
+    live?: boolean;
+    /** 是否显示历史视频，默认为true */
+    history?: boolean;
+    /** 实时默认播放 */
+    defaultLivePlay?: boolean;
+    /** 历史默认播放 */
+    defaultHistoryPlay?: boolean;
+}
+declare const BillPlayer: (props: BillPlayerProps) => JSX.Element;
+
+interface LiveChannelPlayerProps {
+    /** 通道ID */
+    channelId: string;
+    /** 宽度 */
+    width?: number;
+    /** 高度 */
+    height?: number;
+}
+/**
+ * 基于通道ID的实时播放器
+ * @param props
+ * @returns
+ */
+declare const LiveChannelPlayer: (props: LiveChannelPlayerProps) => JSX.Element | undefined;
+
+export { BillPlayer, HistoryControl, HistoryPlayer, LiveChannelPlayer, LiveControl, LivePlayer, Player };