Package com.hp.lft.sdk.web

Class MediaControlDescription.Init<T extends MediaControlDescription.Init<T>>

java.lang.Object
com.hp.lft.sdk.DescriptionBase.Init<T>
com.hp.lft.sdk.web.WebBaseDescription.Init<T>
com.hp.lft.sdk.web.WebElementDescription.Init<T>
com.hp.lft.sdk.web.MediaControlDescription.Init<T>
Direct Known Subclasses:
AudioControlDescription.Init, VideoControlDescription.Init
Enclosing class:
MediaControlDescription
protected abstract static class MediaControlDescription.Init<T extends MediaControlDescription.Init<T>> extends WebElementDescription.Init<T>
Helper class for derived Builder classes.

  • Constructor Details

    • Init

      protected Init()

  • Method Details

    • autoPlay

      public T autoPlay(Boolean hasAutoPlay)
      Initializes whether the media file starts playing as soon as it loads.
      Parameters:
      hasAutoPlay - true, if the media file starts playing as soon as it loads.
      Returns:
      the description instance with the update state (builder pattern).

    • playbackControls

      public T playbackControls(Boolean hasPlaybackControls)
      Initializes whether the media player should display playback controls.
      Parameters:
      hasPlaybackControls - true, if the media player should display playback controls.
      Returns:
      the description instance with the update state (builder pattern).

    • currentSource

      public T currentSource(String currentSource)
      Initializes the URL of the media file currently selected in the browser window.
      Parameters:
      currentSource - the URL of the media file currently selected in the browser window.
      Returns:
      the description instance with the update state (builder pattern).

    • currentSource

      public T currentSource(StringProperty currentSource)
      Initializes the URL of the media file currently selected in the browser window.
      Parameters:
      currentSource - a StringProperty(or RegExpProperty) representing the URL of the media file currently selected in the browser window.
      Returns:
      the description instance with the update state (builder pattern).

    • playInLoop

      public T playInLoop(Boolean isPlayInLoop)
      Initializes whether the media file should start playing again from the beginning as soon as it finishes playing.
      Parameters:
      isPlayInLoop - true, if the media file should start playing again from the beginning as soon as it finishes playing.
      Returns:
      the description instance with the update state (builder pattern).

    • muted

      public T muted(Boolean isMuted)
      Initializes whether the media volume is muted.
      Parameters:
      isMuted - true, if the media volume is muted.
      Returns:
      the description instance with the update state (builder pattern).

    • playbackRate

      public T playbackRate(Double playbackRate)
      Initializes the speed of the media playback. Valid values are numbers with up to two decimal places. For example, 0.51 or 1.00.
      Parameters:
      playbackRate - the speed of the media playback. Valid values are numbers with up to two decimal places. For example, 0.51 or 1.00.
      Returns:
      the description instance with the update state (builder pattern).

    • playing

      public T playing(Boolean isPlaying)
      Initializes whether the media is currently playing.
      Parameters:
      isPlaying - true, if the media is currently playing.
      Returns:
      the description instance with the update state (builder pattern).

    • volume

      public T volume(Double volume)
      Initializes the volume used when playing the media file. Valid values are numbers with up to two decimal places. For example, 0.51 or 1.00.
      Parameters:
      volume - the volume used when playing the media file. Valid values are numbers with up to two decimal places. For example, 0.51 or 1.00.
      Returns:
      the description instance with the update state (builder pattern).

    • duration

      public T duration(Integer duration)
      Initializes the length of the currently selected media file (in milliseconds).
      Parameters:
      duration - the length of the currently selected media file (in milliseconds).
      Returns:
      the description instance with the update state (builder pattern).

    • playbackTime

      public T playbackTime(Integer playbackTime)
      Initializes the current playback position in the media file (in milliseconds).
      Parameters:
      playbackTime - the current playback position in the media file (in milliseconds).
      Returns:
      the description instance with the update state (builder pattern).

    • sources

      public T sources(String[] sources)
      Initializes the list of all media file source URLs.
      Parameters:
      sources - the list of all media file source URLs.
      Returns:
      the description instance with the update state (builder pattern).