import MediaSessionPlugin from 'wavesurfer.js/src/plugin/mediasession/index.js'

public class | source

MediaSessionPlugin

Extends:

Observer → MediaSessionPlugin

Implements:

PluginClass

Visualize MediaSession information for a wavesurfer instance.

Example:

// es6
import MediaSessionPlugin from 'wavesurfer.mediasession.js';

// commonjs
var MediaSessionPlugin = require('wavesurfer.mediasession.js');

// if you are using <script> tags
var MediaSessionPlugin = window.WaveSurfer.mediasession;

// ... initialising wavesurfer with the plugin
var wavesurfer = WaveSurfer.create({
  // wavesurfer options ...
  plugins: [
    MediaSessionPlugin.create({
      // plugin options ...
    })
  ]
});

Static Method Summary

Static Public Methods
public static	create(params: MediaSessionPluginParams): PluginDefinition MediaSession plugin definition factory

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	metadata: *
public	params: *
public	wavesurfer: *

Method Summary

Public Methods
public	destroy()
public	init()
public	update()

Inherited Summary

From class Observer
public	handlers: *
public	fireEvent(event: string, args: ...any) Manually fire an event
public	on(event: string, fn: function): ListenerDescriptor Attach a handler function for an event.
public	once(event: string, handler: function): ListenerDescriptor Attach a handler to an event.
public	setDisabledEventEmissions(eventNames: string[]) Disable firing a list of events by name.	since 4.0.0
public	un(event: string, fn: function) Remove an event handler.
public	unAll() Remove all event handlers.

Static Public Methods

public static create(params: MediaSessionPluginParams): PluginDefinition source

MediaSession 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:

Name	Type	Attribute	Description
params	MediaSessionPluginParams		parameters use to initialise the plugin

MediaSessionPlugin

Extends:

Implements:

Example:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static create(params: MediaSessionPluginParams): PluginDefinition source

Params:

Return:

Public Constructors

public constructor() source

Override:

Public Members

public metadata: * source

public params: * source

public wavesurfer: * source

Public Methods

public destroy() source

public init() source

public update() source