Home Reference Source
import PlayheadPlugin from 'wavesurfer.js/src/plugin/playhead/index.js'
public class | source

PlayheadPlugin

Static Method Summary

Static Public Methods
public static

Playhead plugin definition factory

since 5.0.0

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

element: *

public
public
public

options: {}

public

params: *

public
public

style: *

public

unFuns: *[]

public

util: *

public
public

wrapper: *

Method Summary

Public Methods
public
public

init()

public

setPlayheadTime(time: *)

public

wavesurferOn(ev: *, fn: *): *

Static Public Methods

public static create(params: PlayheadPluginParams): PluginDefinition since 5.0.0 source

Playhead plugin definition factory

This function must be used to create a plugin definition which can be used by wavesurfer to correctly instantiate the plugin.

Params:

NameTypeAttributeDescription
params PlayheadPluginParams

parameters use to initialise the plugin

Return:

PluginDefinition

an object representing the plugin

Public Constructors

public constructor() source

Public Members

public element: * source

public markerHeight: number source

public markerWidth: number source

public options: {} source

public params: * source

public playheadTime: number source

public style: * source

public unFuns: *[] source

public util: * source

public wavesurfer: * source

public wrapper: * source

Public Methods

public destroy() source

public init() source

public setPlayheadTime(time: *) source

Params:

NameTypeAttributeDescription
time *

public wavesurferOn(ev: *, fn: *): * source

Params:

NameTypeAttributeDescription
ev *
fn *

Return:

*