Package org.zkoss.stateless.sul

Interface IAudio

All Superinterfaces:
IAnyGroup<IAudio>, IChildable<IAudio,ITrack>, IComponent<IAudio>, IHtmlBasedComponent<IAudio>, IXulElement<IAudio>
public interface IAudio extends IXulElement<IAudio>, IAnyGroup<IAudio>, IChildable<IAudio,ITrack>
Immutable Audio component

An audio clip.

Support @Action

Name Action Type
onStateChange ActionData: StateChangeData
Notifies when invoking play(), stop(), pause() or the audio is played to the end.
Author:
katherine
See Also:
  • Audio

  • Field Details

    • DEFAULT

      static final IAudio DEFAULT
      Constant for default attributes of this immutable component.

  • Method Details

    • getWidgetClass

      default String getWidgetClass()
      Returns the client widget class.

      Default: "zul.med.Audio"

      Specified by:
      getWidgetClass in interface IComponent<IAudio>

    • getSrc

      List<String> getSrc()
      Returns the src.

      Default: [].

    • withSrc

      IAudio withSrc(Iterable<String> src)
      Returns a copy of this immutable component with the specified placeholder.

      Sets the src of the audio. Note: If calling this with withContent(org.zkoss.sound.Audio), the withContent(org.zkoss.sound.Audio) has higher priority

      Parameters:
      src - The src of the component

      Default: [].

      Returns:
      A modified copy of the this object

    • withSrc

      default IAudio withSrc(String src)
      Returns a copy of this immutable component with the specified placeholder.

      Sets the src of the audio.

      Note: If calling this with withContent(org.zkoss.sound.Audio), the withContent(org.zkoss.sound.Audio) has higher priority

      Parameters:
      src - The src of the component

      Default: [].

      Returns:
      A modified copy of the this object

    • getPreload

      @Nullable String getPreload()
      Returns whether and how the audio should be loaded. "none", "metadata", "auto" or null

      Default: null.

    • withPreload

      IAudio withPreload(@Nullable String preload)
      Returns a copy of this immutable component with the specified preload.

      Sets whether and how the audio should be loaded. Refer to Preload Attribute Description for details.

      Parameters:
      preload - Whether and how the audio should be loaded. ("none", "metadata", "auto" or null)

      Default: null.

      Returns:
      A modified copy of the this object

    • getContent

      @Nullable org.zkoss.sound.Audio getContent()
      Returns the content set by withContent(org.zkoss.sound.Audio).

      Note: it won't fetch what is set thru by withSrc(java.lang.Iterable<java.lang.String>). It simply returns what is passed to withContent(org.zkoss.sound.Audio).

      Default: null

    • withContent

      IAudio withContent(@Nullable org.zkoss.sound.Audio audio)
      Returns a copy of this immutable component with the specified audio.

      Sets the content of the audio

      Note: If calling this with withSrc(java.lang.Iterable<java.lang.String>), the withContent(org.zkoss.sound.Audio) has higher priority

      Parameters:
      audio - The content of the audio.

      Default: null.

      Returns:
      A modified copy of the this object

    • isAutoplay

      default boolean isAutoplay()
      Returns whether to auto start playing the audio.

      Default: false.

    • withAutoplay

      IAudio withAutoplay(boolean autoplay)
      Returns a copy of this immutable component with the specified autoplay.

      Sets whether to auto start playing the audio.

      Parameters:
      autoplay - Whether to auto start playing the audio.

      Default: false.

      Returns:
      A modified copy of the this object

    • isControls

      default boolean isControls()
      Returns whether to display the audio controls.

      Default: false.

    • withControls

      IAudio withControls(boolean controls)
      Returns a copy of this immutable component with the specified controls.

      Sets whether to display the audio controls.

      Parameters:
      controls - Whether to display the audio controls.

      Default: false.

      Returns:
      A modified copy of the this object

    • isLoop

      default boolean isLoop()
      Returns whether to play the audio repeatedly.

      Default: false.

    • withLoop

      IAudio withLoop(boolean loop)
      Returns a copy of this immutable component with the specified loop.

      Sets whether to play the audio repeatedly.

      Parameters:
      loop - Whether to play the audio repeatedly.

      Default: false.

      Returns:
      A modified copy of the this object

    • isMuted

      default boolean isMuted()
      Returns whether to mute the audio.

      Default: false.

    • withMuted

      IAudio withMuted(boolean muted)
      Returns a copy of this immutable component with the specified muted.

      Sets whether to mute the audio.

      Parameters:
      muted - Whether to mute the audio.

      Default: false.

      Returns:
      A modified copy of the this object

    • of

      static IAudio of(String src)
      Returns the instance with the given src.
      Parameters:
      src - The URI of the audio source.

    • of

      static IAudio of(Iterable<ITrack> children)
      Returns the instance with the given ITrack children.
      Parameters:
      children - The children of ITrack

    • of

      static IAudio of(ITrack... children)
      Returns the instance with the given ITrack children.
      Parameters:
      children - The children of ITrack

    • ofId

      static IAudio ofId(String id)
      Returns the instance with the given id.
      Parameters:
      id - The id to identify this component