Class VideoScale


  • public final class VideoScale
    extends Object
    The video scaling information.
    • Constructor Detail

      • VideoScale

        public VideoScale()
    • Method Detail

      • height

        public String height()
        Get the height property: The desired output video height.
        Returns:
        the height value.
      • withHeight

        public VideoScale withHeight​(String height)
        Set the height property: The desired output video height.
        Parameters:
        height - the height value to set.
        Returns:
        the VideoScale object itself.
      • width

        public String width()
        Get the width property: The desired output video width.
        Returns:
        the width value.
      • withWidth

        public VideoScale withWidth​(String width)
        Set the width property: The desired output video width.
        Parameters:
        width - the width value to set.
        Returns:
        the VideoScale object itself.
      • mode

        public VideoScaleMode mode()
        Get the mode property: Describes the video scaling mode to be applied. Default mode is 'Pad'. If the mode is 'Pad' or 'Stretch' then both width and height must be specified. Else if the mode is 'PreserveAspectRatio' then only one of width or height need be provided.
        Returns:
        the mode value.
      • withMode

        public VideoScale withMode​(VideoScaleMode mode)
        Set the mode property: Describes the video scaling mode to be applied. Default mode is 'Pad'. If the mode is 'Pad' or 'Stretch' then both width and height must be specified. Else if the mode is 'PreserveAspectRatio' then only one of width or height need be provided.
        Parameters:
        mode - the mode value to set.
        Returns:
        the VideoScale object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.