Files
rrweb/packages/rrweb-player/typings/index.d.ts

74 lines
1.7 KiB
TypeScript

import { eventWithTime, playerConfig } from 'rrweb/typings/types';
import { Replayer, mirror } from 'rrweb';
import { SvelteComponent } from 'svelte';
export type RRwebPlayerOptions = {
target: HTMLElement;
props: {
/**
* The events to replay.
* @default `[]`
*/
events: eventWithTime[];
/**
* The width of the replayer
* @defaultValue `1024`
*/
width?: number;
/**
* The height of the replayer
* @defaultValue `576`
*/
height?: number;
/**
* The maximum scale of the replayer (1 = 100%). Set to 0 for unlimited
* @defaultValue `1`
*/
maxScale?: number;
/**
* Whether to autoplay
* @defaultValue `true`
*/
autoPlay?: boolean;
/**
* The default speed to play at
* @defaultValue `1`
*/
speed?: number;
/**
* Speed options in UI
* @defaultValue `[1, 2, 4, 8]`
*/
speedOption?: number[];
/**
* Whether to show the controller UI
* @defaultValue `true`
*/
showController?: boolean;
/**
* Customize the custom events style with a key-value map
* @defaultValue `{}`
*/
tags?: Record<string, string>;
} & Partial<playerConfig>;
};
export default class rrwebPlayer extends SvelteComponent {
constructor(options: RRwebPlayerOptions);
addEventListener(event: string, handler: (params: any) => unknown): void;
addEvent(event: eventWithTime): void;
getMetaData: Replayer['getMetaData'];
getReplayer: () => Replayer;
getMirror: () => typeof mirror;
toggle: () => void;
setSpeed: (speed: number) => void;
toggleSkipInactive: () => void;
triggerResize: () => void;
play: () => void;
pause: () => void;
goto: (timeOffset: number, play?: boolean) => void;
}