Package org.zkoss.zkmax.zul

Class Video

    • Constructor Detail

      • Video

        public Video()

      • Video

        public Video​(java.lang.String src)

    • Method Detail

      • isAutoplay

        public boolean isAutoplay()
        Returns whether to auto start playing the video.

        Default: false.

        Returns:
        true if video enable autoplay function.

      • setAutoplay

        public void setAutoplay​(boolean autoplay)
        Sets whether to auto start playing the video.
        Parameters:
        autoplay - whether to enable autoplay function.

      • isControls

        public boolean isControls()
        Returns whether to display the video controls.

        Default: false.

        Returns:
        true if video display the controls.

      • setControls

        public void setControls​(boolean controls)
        Sets whether to display the video controls.
        Parameters:
        controls - whether to display the video controls.

      • isLoop

        public boolean isLoop()
        Returns whether to play the video repeatedly.

        Default: false.

        Returns:
        true if video enable loop function.

      • setLoop

        public void setLoop​(boolean loop)
        Sets whether to play the video repeatedly.
        Parameters:
        loop - whether to enable loop function.

      • isDimBackground

        public boolean isDimBackground()
        Returns whether to turn whole page to be covered by translucent black except the Video, also called theater mode. When theater mode is enabled, user can click anywhere on the page except the Video to disable theater mode.

        Default: false.

        Returns:
        true if theater mode is enabled.

      • setDimBackground

        public void setDimBackground​(boolean dimBackground)
        Sets whether to turn whole page to be covered by translucent black except Video, also called theater mode. When theater mode is enabled, user can click anywhere on the page except the Video to disable theater mode.
        Parameters:
        dimBackground - whether to enable theater mode.

      • getPreload

        public java.lang.String getPreload()
        Returns "none" or "metadata" or "auto" or null

        Default: null.

        Returns:
        whether and how the video should be loaded.

      • setPreload

        public void setPreload​(java.lang.String preload)
        Sets whether and how the video should be loaded, which could be one of "none", "metadata", "auto". Refer to Preload Attribute Description for details.
        Parameters:
        preload - which could be one of "none", "metadata", "auto".

      • getPoster

        public java.lang.String getPoster()
        Returns the image source, if didn't set the image, return null.

        Default: null.

        Returns:
        the image source.

      • setPoster

        public void setPoster​(java.lang.String poster)
        Sets an image to be shown while the video is downloading, or until the user hits the play button.
        Parameters:
        poster - the image source.

      • getSrc

        public java.util.List<java.lang.String> getSrc()
        Returns the video source as List.

        Default: [].

        Returns:
        the video source.

      • setSrcList

        public void setSrcList​(java.util.List<java.lang.String> src)
        Sets the source list, be invoked by the setSrc(String).
        Parameters:
        src - the source list.

      • getCrossorigin

        public java.lang.String getCrossorigin()
        Returns the crossorigin of this video tag, could be "anonymous", "use-credentials" or null.

        Default: null.

        Returns:
        the crossorigin of this video tag.

      • setCrossorigin

        public void setCrossorigin​(java.lang.String crossorigin)

        Could be "anonymous" or "use-credentials", an invalid string and an empty string will be handled as the "anonymous". Notice that this attribute refers to the corresponding attribute of the HTML5 specification. Hence, it would still be rendered to client-side as a DOM attribute even if the browser doesn’t support it.

        Parameters:
        crossorigin - the crossorigin of this video tag.

      • isPlaysinline

        public boolean isPlaysinline()
        Returns the playsinline of this video tag.

        Default: false.

        Returns:
        true if the video enable playsinline function.

      • setPlaysinline

        public void setPlaysinline​(boolean playsinline)

        Sets the playsinline of this video tag. Notice that this attribute refers to the corresponding attribute of the HTML5 specification. Hence, it would still be rendered to client-side as a DOM attribute even if the browser doesn’t support it.

        Parameters:
        playsinline - whether to enable the playsinline function.

      • getPlaybackRate

        public double getPlaybackRate()
        Returns the video play speed.

        Default: 1.0.

        Returns:
        video play speed.

      • setPlaybackRate

        public void setPlaybackRate​(double playbackRate)
        Sets the video play speed, type of value is in double, valid value is depending on browser.
        Parameters:
        playbackRate - video play speed.

      • isClipToFit

        public boolean isClipToFit()
        Return whether to clip video when the source size doesn't fit the tag size setting, for example: if video source is 1280 * 720, but the video tag is 
        <video width="1000px" height="720px" />
        , it will cut off the sides of the video, preserving the aspect ratio, and also filling in the space.

        Default: false.

        Returns:
        whether to clip video when the source size doesn't fit the tag size setting.

      • setClipToFit

        public void setClipToFit​(boolean clipToFit)
        Set whether to clip video when the source size doesn't fit the tag size setting, for example: if video source is 1280 * 720, but the video tag is 
        <video width="1000px" height="720px" />
        , it will cut off the sides of the video, preserving the aspect ratio, and also filling in the space.
        Parameters:
        clipToFit - whether to clip video when the source size doesn't fit the tag size setting.

      • isMuted

        public boolean isMuted()
        Returns whether the video is muted.
        Returns:
        whether the video is muted.

      • setMuted

        public void setMuted​(boolean muted)
        Sets whether to mute the video.
        Parameters:
        muted - whether to mute the video.

      • setPlaying

        public void setPlaying​(boolean playing)
        Ture to indicate the same as play() False to indicate the same as pause()

      • setCurrentTime

        public void setCurrentTime​(double currentTime)
        Sets which part of video to play.
        Parameters:
        currentTime - which part of video to play, the value is in seconds.

      • getVolume

        public double getVolume()
        Returns the volume of video. Default: 1.0
        Returns:
        the volume of video, type of value is in double, valid value is between 0.0 and 1.0.

      • setVolume

        public void setVolume​(double volume)
        Sets the volume of video.
        Parameters:
        volume - the volume of video, type of value is in double, valid value is between 0.0 and 1.0.

      • play

        public void play()
        Play the video at the client.

      • pause

        public void pause()
        Pause the video at the client.

      • stop

        public void stop()
        Stop the video at the client.

      • isPlaying

        public boolean isPlaying()
        Return whether the video is playing.
        Returns:
        true if video is playing;

      • isPaused

        public boolean isPaused()
        Return whether the video is paused.
        Returns:
        true if video is paused;

      • isStopped

        public boolean isStopped()
        Return whether the video is stopped. While the video is ended, also means it is stopped.
        Returns:
        true if video is stopped or ended;

      • isEnded

        public boolean isEnded()
        Return whether the video is ended.
        Returns:
        true if video is ended;
        Since:
        9.6.0

      • updateByClient

        protected void updateByClient​(java.lang.String name,
                              java.lang.Object value)
        Description copied from class: AbstractComponent
        Called when the widget running at the client asks the server to update a value. The update is caused by an AU request named setAttr (by invoking zk.Widget's smartUpdate at client).

        By default, it does nothing but log a warning message, since it is not safe to allow the client to update a field arbitrary.

        However, if you'd like to allow the update for a particular component you could do one of the following

        1. For component developers: override this method to update the field directly. For example,
          protected void updateByClient(String name, Object value) {
        if ("disabled".equals(name))
                setDisabled(name, ((Boolean)value).booleanValue());
        else
                super.updateByClient(name, value);
        2. For application developers: set an attribute called org.zkoss.zk.ui.updateByClient to be true. Then, this method will use reflection to find out the setter to update the value. Nothing happens if the method is not found.

          3. Notice: this method will invoke AbstractComponent.disableClientUpdate(boolean) to disable any update to the client, when calling the setter.

          If you want to enable the client update for all instances of a given component (though not recommended for the security reason), you could refer to here.

          See also zk.Widget.smartUpdate().

        Overrides:
        updateByClient in class AbstractComponent