Interface EventMap

interface EventMap {
    broke: (() => void);
    dataChange: ((data: CruisePluginTypes.PluginData, prevData?: CruisePluginTypes.PluginData) => void);
    dataLoaded: ((data: CruisePluginTypes.PluginData) => void);
    disable: ((options: {
        userAction: boolean;
    }) => void);
    dispose: (() => void);
    enable: ((options: {
        userAction: boolean;
    }) => void);
    end: (() => void);
    hide: ((options: {
        userAction: boolean;
    }) => void);
    pause: ((options: {
        userAction: boolean;
    }) => void);
    play: ((options: {
        userAction: boolean;
    }) => void);
    playIndexChange: ((index: number, keyframe: CruiseKeyframe) => void);
    playStateChange: ((playingState: "pause" | "playing", options: {
        userAction: boolean;
    }) => void);
    progressChange: ((progress: number) => void);
    show: ((options: {
        userAction: boolean;
    }) => void);
    speedChange: ((speed: number, options: {
        userAction: boolean;
    }) => void);
    stateChange: ((params: {
        prevState?: CruisePluginTypes.PluginState;
        state: CruisePluginTypes.PluginState;
        userAction: boolean;
    }) => void);
}

Hierarchy

Properties

broke dataChange dataLoaded disable dispose enable end hide pause play playIndexChange playStateChange progressChange show speedChange stateChange

Properties

broke

broke: (() => void)

播放被手势操作打断，同时会触发 ”pause“ 事件

dataChange

dataChange: ((data: CruisePluginTypes.PluginData, prevData?: CruisePluginTypes.PluginData) => void)

数据变更

dataLoaded

dataLoaded: ((data: CruisePluginTypes.PluginData) => void)

数据加载完成

disable

disable: ((options: {
    userAction: boolean;
}) => void)

关闭

dispose

dispose: (() => void)

插件被销毁

enable

enable: ((options: {
    userAction: boolean;
}) => void)

开启

end

end: (() => void)

播放结束

hide

hide: ((options: {
    userAction: boolean;
}) => void)

隐藏

pause

pause: ((options: {
    userAction: boolean;
}) => void)

暂停播放，相当于 playStateChange: ('pause') => void

play

play: ((options: {
    userAction: boolean;
}) => void)

开始播放，相当于 playStateChange: ('playing') => void

playIndexChange

playIndexChange: ((index: number, keyframe: CruiseKeyframe) => void)

播放的帧改变，index表示开始播放第{index}个帧

playStateChange

playStateChange: ((playingState: "pause" | "playing", options: {
    userAction: boolean;
}) => void)

播放状态改变，playingState: playing 表示播放；pause 表示暂停

progressChange

progressChange: ((progress: number) => void)

MovePlugin 自定义路线漫游时，progress 更新时触发，范围 0~1

show

show: ((options: {
    userAction: boolean;
}) => void)

展示

speedChange

speedChange: ((speed: number, options: {
    userAction: boolean;
}) => void)

播放速度改变，speed表示播放速度

stateChange

stateChange: ((params: {
    prevState?: CruisePluginTypes.PluginState;
    state: CruisePluginTypes.PluginState;
    userAction: boolean;
}) => void)

插件状态变化

Settings

Member Visibility

On This Page

Properties