Class Player

Hierarchy (View Summary)

Player
- MPlayer

Index

Constructors

Methods

bindElement getPlayState getPlayStateChangeListeners pause play removePlayStateChangeListener setPlayStateChangeListener stop unbindElement stopAll

Constructors

constructor

new Player(
doc: MDocument,
playStateChangeListener?: PlayStateChangeListener,
): Player
Create new music player.
Parameters
- doc: MDocument
  Music document to play.
- OptionalplayStateChangeListener: PlayStateChangeListener
  Play state change listener.
Returns Player

Methods

bindElement

bindElement(elem: string | HTMLElement): boolean
Bind this player to custom HTML element.

Note (since 6.3.3): bindElement() no longer throws if bind fails, it returns false instead.
Parameters
- elem: string | HTMLElement
  HTML element id or element.
Returns boolean
- Boolean wheter bind was succesfull.

getPlayState

getPlayState(): PlayState
Get play state.

Returns PlayState
- Play state.

getPlayStateChangeListeners

getPlayStateChangeListeners(): PlayStateChangeListener[]
Get play state change listeners.

Returns PlayStateChangeListener[]

pause

pause(): Player
Pause playback of attached document.

Returns Player
- This player instance.

play

play(): Player
Playe attached document.

Returns Player
- This player instance.

removePlayStateChangeListener

removePlayStateChangeListener(
playStateChangeListener: PlayStateChangeListener,
): void
Remove play state change listener.
Parameters
- playStateChangeListener: PlayStateChangeListener
  Play state change listener.
Returns void

setPlayStateChangeListener

setPlayStateChangeListener(
playStateChangeListener: PlayStateChangeListener,
): void
Set play state change listener.
Parameters
- playStateChangeListener: PlayStateChangeListener
  Play state change listener.
Returns void

stop

stop(): Player
Stop playback of attached document.

Returns Player
- This player instance.

unbindElement

unbindElement(elem: string | HTMLElement): boolean
Unbind this player from custom HTML element.

Note (since 6.3.3): unbindElement() no longer throws if bind fails, it returns false instead.
Parameters
- elem: string | HTMLElement
  HTML element id or element.
Returns boolean
- Boolean wheter unbind was succesfull.

`Static`stopAll

stopAll(): void
Stop all playing.

Returns void