Open topic with navigation

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 Summary

    Modifier | Constructor and Description
    --- | ---
    `protected` | `Init()`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `T` | `autoPlay(java.lang.Boolean hasAutoPlay)` Initializes whether the media file starts playing as soon as it loads.
    `T` | `currentSource(java.lang.String currentSource)` Initializes the URL of the media file currently selected in the browser window.
    `T` | `currentSource(StringProperty currentSource)` Initializes the URL of the media file currently selected in the browser window.
    `T` | `duration(java.lang.Integer duration)` Initializes the length of the currently selected media file (in milliseconds).
    `T` | `muted(java.lang.Boolean isMuted)` Initializes whether the media volume is muted.
    `T` | `playbackControls(java.lang.Boolean hasPlaybackControls)` Initializes whether the media player should display playback controls.
    `T` | `playbackRate(java.lang.Double playbackRate)` Initializes the speed of the media playback.
    `T` | `playbackTime(java.lang.Integer playbackTime)` Initializes the current playback position in the media file (in milliseconds).
    `T` | `playing(java.lang.Boolean isPlaying)` Initializes whether the media is currently playing.
    `T` | `playInLoop(java.lang.Boolean isPlayInLoop)` Initializes whether the media file should start playing again from the beginning as soon as it finishes playing.
    `T` | `sources(java.lang.String[] sources)` Initializes the list of all media file source URLs.
    `T` | `volume(java.lang.Double volume)` Initializes the volume used when playing the media file.

    - ### Methods inherited from class com.hp.lft.sdk.web.WebElementDescription.Init

      `accessibilityName, accessibilityName, build, cssSelector, cssSelector, role, role, xpath, xpath`

    - ### Methods inherited from class com.hp.lft.sdk.web.WebBaseDescription.Init

      `absoluteLocation, absoluteLocation, absoluteLocation, attribute, attribute, attributes, className, className, id, id, innerHTML, innerHTML, innerText, innerText, location, location, location, name, name, outerHTML, outerHTML, outerText, outerText, size, size, size, style, style, styles, tagName, tagName, title, title, visible`

    - ### Methods inherited from class com.hp.lft.sdk.DescriptionBase.Init

      `index, self, vri, vri`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### Init

          protected Init()

  - ### Method Detail

    - #### autoPlay

          public T autoPlay(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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).