Module one.jpro.platform.media
Package one.jpro.platform.media.player.impl

Class WebMediaPlayer

java.lang.Object
one.jpro.platform.media.player.impl.WebMediaPlayer
All Implemented Interfaces:
javafx.event.EventTarget, MediaEngine, MediaPlayer, WebMediaEngine
public final class WebMediaPlayer extends Object implements WebMediaEngine
MediaPlayer implementation for the web.
Author:
Besmir Beqiri

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.BooleanProperty
    autoPlay
    Whether playing should start as soon as possible.
    javafx.beans.property.ReadOnlyIntegerProperty
    currentCount
    The number of completed playback cycles.
    javafx.beans.property.ReadOnlyDoubleProperty
    currentRate
    The current rate of playback regardless of settings.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>
    currentTime
    The current media playback time.
    javafx.beans.property.IntegerProperty
    cycleCount
    The number of times the media will be played.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>
    cycleDuration
    The amount of time between the startTime and stopTime of this player.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>
    duration
    The total duration of play time if allowed to play until finished.
    final javafx.beans.property.ReadOnlyObjectProperty<MediaPlayerException>
    error
    Observable property set to a MediaPlayerException if an error occurs.
    final javafx.beans.property.ReadOnlyObjectProperty<MediaSource>
    mediaSource
    The media source for the current player.
    javafx.beans.property.BooleanProperty
    mute
    Whether the player audio is muted.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onEndOfMedia
    Event handler invoked when the end of media is reached naturally.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onError
    Event handler invoked when an error occurs.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onPaused
    Event handler invoked when the status changes to PAUSED.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onPlaying
    Event handler invoked when the status changes to PLAYING.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onReady
    Event handler invoked when the status changes to READY.
    javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onRepeat
    Event handler invoked when the player currentTime reaches stopTime and will be repeating.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onStalled
    Event handler invoked when the status changes to STALLED.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onStopped
    Event handler invoked when the status changes to STOPPED.
    javafx.beans.property.DoubleProperty
    rate
    The rate at which the media should be played.
    javafx.beans.property.ReadOnlyObjectProperty<WebReadyState>
    readyState
     
    javafx.beans.property.ObjectProperty<javafx.util.Duration>
    startTime
    The time offset where media should start playing, or restart from when repeating.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.media.MediaPlayer.Status>
    status
    The current status of this media player.
    javafx.beans.property.ObjectProperty<javafx.util.Duration>
    stopTime
    The time offset where media should stop playing or restart when repeating.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>
    totalDuration
    The total amount of play time if allowed to play until finished.
    javafx.beans.property.DoubleProperty
    volume
     

  • Field Summary

    Fields inherited from interface one.jpro.platform.media.player.MediaPlayer

    INDEFINITE

  • Constructor Summary

    Constructors
    Constructor
    Description
    WebMediaPlayer(com.jpro.webapi.WebAPI webAPI, MediaSource mediaSource)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    javafx.beans.property.BooleanProperty
    autoPlayProperty()
    Whether playing should start as soon as possible.
    javafx.event.EventDispatchChain
    buildEventDispatchChain(javafx.event.EventDispatchChain tail)
     
    javafx.beans.property.ReadOnlyIntegerProperty
    currentCountProperty()
    The number of completed playback cycles.
    javafx.beans.property.ReadOnlyDoubleProperty
    currentRateProperty()
    The current rate of playback regardless of settings.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>
    currentTimeProperty()
    The current media playback time.
    javafx.beans.property.IntegerProperty
    cycleCountProperty()
    The number of times the media will be played.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>
    cycleDurationProperty()
    The amount of time between the startTime and stopTime of this player.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>
    durationProperty()
    The total duration of play time if allowed to play until finished.
    final javafx.beans.property.ReadOnlyObjectProperty<MediaPlayerException>
    errorProperty()
    Observable property set to a MediaPlayerException if an error occurs.
    final int
    getCurrentCount()
    Retrieves the index of the current cycle.
    double
    getCurrentRate()
    Gets the value of the currentRate property.
    javafx.util.Duration
    getCurrentTime()
    Retrieves the current media time.
    int
    getCycleCount()
    Retrieves the cycle count.
    javafx.util.Duration
    getCycleDuration()
    Retrieves the cycle duration in seconds.
    javafx.util.Duration
    getDuration()
    Gets the duration for the given media source.
    final MediaPlayerException
    getError()
    Retrieve the value of the error property or null if there is no error.
    final MediaSource
    getMediaSource()
    Retrieves the current media source.
    final javafx.event.EventHandler<MediaPlayerEvent>
    getOnEndOfMedia()
    Retrievers the event handler invoked when the end of media is reached naturally.
    final javafx.event.EventHandler<MediaPlayerEvent>
    getOnError()
    Retrieves the event handler for errors.
    final javafx.event.EventHandler<MediaPlayerEvent>
    getOnPaused()
    Retrieves the MediaPlayer.Status.PAUSED event handler.
    final javafx.event.EventHandler<MediaPlayerEvent>
    getOnPlaying()
    Retrieves the MediaPlayer.Status.PLAYING event handler.
    final javafx.event.EventHandler<MediaPlayerEvent>
    getOnReady()
    Retrieves the MediaPlayer.Status.READY event handler.
    final javafx.event.EventHandler<MediaPlayerEvent>
    getOnRepeat()
    Retrieves the repeat event handler.
    final javafx.event.EventHandler<MediaPlayerEvent>
    getOnStalled()
    Retrieves the MediaPlayer.Status.STALLED event handler.
    final javafx.event.EventHandler<MediaPlayerEvent>
    getOnStopped()
    Retrieves the MediaPlayer.Status.STOPPED event handler.
    double
    getRate()
    Gets the value of the rate property.
    WebReadyState
    getReadyState()
    Gets the value of the readyState property.
    javafx.util.Duration
    getStartTime()
    Gets the value of the startTime property.
    javafx.scene.media.MediaPlayer.Status
    getStatus()
    Retrieves the current player status.
    javafx.util.Duration
    getStopTime()
    Gets the value of the stopTime property.
    javafx.util.Duration
    getTotalDuration()
    Retrieves the total playback duration including all cycles (repetitions).
    com.jpro.webapi.JSVariable
    getVideoElement()
    Returns the video element used to both play and record media on the browser.
    double
    getVolume()
    Gets the value of the volume property.
    com.jpro.webapi.WebAPI
    getWebAPI()
    Returns the WebAPI instance.
    boolean
    isAutoPlay()
    Retrieves the autoPlay property value.
    boolean
    isMute()
    Gets the value of the mute property.
    final javafx.beans.property.ReadOnlyObjectProperty<MediaSource>
    mediaSourceProperty()
    The media source for the current player.
    javafx.beans.property.BooleanProperty
    muteProperty()
    Whether the player audio is muted.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onEndOfMediaProperty()
    Event handler invoked when the end of media is reached naturally.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onErrorProperty()
    Event handler invoked when an error occurs.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onPausedProperty()
    Event handler invoked when the status changes to PAUSED.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onPlayingProperty()
    Event handler invoked when the status changes to PLAYING.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onReadyProperty()
    Event handler invoked when the status changes to READY.
    javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onRepeatProperty()
    Event handler invoked when the player currentTime reaches stopTime and will be repeating.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onStalledProperty()
    Event handler invoked when the status changes to STALLED.
    final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<MediaPlayerEvent>>
    onStoppedProperty()
    Event handler invoked when the status changes to STOPPED.
    void
    pause()
    Pauses the player.
    void
    play()
    Starts playing the media.
    javafx.beans.property.DoubleProperty
    rateProperty()
    The rate at which the media should be played.
    javafx.beans.property.ReadOnlyObjectProperty<WebReadyState>
    readyStateProperty()
     
    void
    seek(javafx.util.Duration seekTime)
    Seeks the player to a new playback time.
    void
    setAutoPlay(boolean value)
    Sets the autoPlay property value.
    void
    setCycleCount(int value)
    Sets the cycle count.
    void
    setMute(boolean value)
    Sets the value of the mute property.
    final void
    setOnEndOfMedia(javafx.event.EventHandler<MediaPlayerEvent> value)
    Sets the event handler invoked when the end of media is reached naturally.
    final void
    setOnError(javafx.event.EventHandler<MediaPlayerEvent> value)
    Sets the event handler to be called when an error occurs.
    final void
    setOnPaused(javafx.event.EventHandler<MediaPlayerEvent> value)
    Sets the MediaPlayer.Status.PAUSED event handler.
    final void
    setOnPlaying(javafx.event.EventHandler<MediaPlayerEvent> value)
    Sets the MediaPlayer.Status.PLAYING event handler.
    final void
    setOnReady(javafx.event.EventHandler<MediaPlayerEvent> value)
    Sets the MediaPlayer.Status.READY event handler.
    final void
    setOnRepeat(javafx.event.EventHandler<MediaPlayerEvent> value)
    Sets the repeat event handler.
    final void
    setOnStalled(javafx.event.EventHandler<MediaPlayerEvent> value)
    Sets the MediaPlayer.Status.STALLED event handler.
    final void
    setOnStopped(javafx.event.EventHandler<MediaPlayerEvent> value)
    Sets the MediaPlayer.Status.STOPPED event handler.
    void
    setRate(double value)
    Sets the value of the rate property.
    void
    setStartTime(javafx.util.Duration value)
    Sets the value of the startTime property.
    void
    setStopTime(javafx.util.Duration value)
    Sets the value of the stopTime property.
    void
    setVolume(double value)
    Sets the value of the volume property.
    javafx.beans.property.ObjectProperty<javafx.util.Duration>
    startTimeProperty()
    The time offset where media should start playing, or restart from when repeating.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.media.MediaPlayer.Status>
    statusProperty()
    The current status of this media player.
    void
    stop()
    Stops playing the media.
    javafx.beans.property.ObjectProperty<javafx.util.Duration>
    stopTimeProperty()
    The time offset where media should stop playing or restart when repeating.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.util.Duration>
    totalDurationProperty()
    The total amount of play time if allowed to play until finished.
    javafx.beans.property.DoubleProperty
    volumeProperty()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait