Interface EventMap

Hierarchy

EventMap<State>
- EventMap

Index

Properties

click disable dispose enable exposure hide loadVideoFirstFrame playStateChange show stateChange

Properties

click

click: ((params) => void)

Type declaration

- (params): void
- Parameters
  - params: Object
  Returns void

disable

disable: ((options) => void)

Type declaration

- (options): void
- Parameters
  - options: {
    userAction: boolean;
    }
    - userAction: boolean
  Returns void

dispose

dispose: (() => void)

Type declaration

- (): void
- 插件被销毁
  
  Returns void

enable

enable: ((options) => void)

Type declaration

- (options): void
- Parameters
  - options: {
    userAction: boolean;
    }
    - userAction: boolean
  Returns void

exposure

exposure: ((params) => void)

Type declaration

- (params): void
- Parameters
  - params: {
    id: TagId;
    type: "end" | "start";
    }
    - id: TagId
    - type: "end" | "start"
  Returns void

hide

hide: ((options) => void)

Type declaration

- (options): void
- Parameters
  - options: {
    userAction: boolean;
    withAnimation: boolean;
    }
    - userAction: boolean
    - withAnimation: boolean
  Returns void

loadVideoFirstFrame

loadVideoFirstFrame: (() => void)

Type declaration

- (): void
- Returns void

playStateChange

playStateChange: ((params) => void)

Type declaration

- (params): void
- Parameters
  - params: {
        event: Event;
        mediaInstance: HTMLMediaElement;
        state: "playing" | "paused";
        tag: TagInstance;
    }
    - event: Event
    - mediaInstance: HTMLMediaElement
    - state: "playing" | "paused"
    - tag: TagInstance
  Returns void

show

show: ((options) => void)

Type declaration

- (options): void
- Parameters
  - options: {
    userAction: boolean;
    withAnimation: boolean;
    }
    - userAction: boolean
    - withAnimation: boolean
  Returns void

stateChange

stateChange: ((params) => void)

Type declaration

- (params): void
- 插件状态变化
  Parameters
  - params: {
        prevState?: State;
        state: State;
        userAction: boolean;
    }
    - Optional prevState?: State
      
      上一个State
    - state: State
      
      最新的State
    - userAction: boolean
      
      是否是用户触发
  Returns void