Class VideoEncoderBase

  • Direct Known Subclasses:
    VideoEncoderH264

    public class VideoEncoderBase
    extends Object
    Base type for all video encoding presets, which define the recipe or instructions on how the input video should be processed.
    • Constructor Detail

      • VideoEncoderBase

        public VideoEncoderBase()
    • Method Detail

      • bitrateKbps

        public String bitrateKbps()
        Get the bitrateKbps property: The maximum bitrate, in kilobits per second or Kbps, at which video should be encoded. If omitted, encoder sets it automatically to try and match the quality of the input video.
        Returns:
        the bitrateKbps value.
      • withBitrateKbps

        public VideoEncoderBase withBitrateKbps​(String bitrateKbps)
        Set the bitrateKbps property: The maximum bitrate, in kilobits per second or Kbps, at which video should be encoded. If omitted, encoder sets it automatically to try and match the quality of the input video.
        Parameters:
        bitrateKbps - the bitrateKbps value to set.
        Returns:
        the VideoEncoderBase object itself.
      • frameRate

        public String frameRate()
        Get the frameRate property: The frame rate (in frames per second) of the encoded video. The value must be greater than zero, and less than or equal to 300. If omitted, the encoder uses the average frame rate of the input video.
        Returns:
        the frameRate value.
      • withFrameRate

        public VideoEncoderBase withFrameRate​(String frameRate)
        Set the frameRate property: The frame rate (in frames per second) of the encoded video. The value must be greater than zero, and less than or equal to 300. If omitted, the encoder uses the average frame rate of the input video.
        Parameters:
        frameRate - the frameRate value to set.
        Returns:
        the VideoEncoderBase object itself.
      • scale

        public VideoScale scale()
        Get the scale property: Describes the resolution of the encoded video. If omitted, the encoder uses the resolution of the input video.
        Returns:
        the scale value.
      • withScale

        public VideoEncoderBase withScale​(VideoScale scale)
        Set the scale property: Describes the resolution of the encoded video. If omitted, the encoder uses the resolution of the input video.
        Parameters:
        scale - the scale value to set.
        Returns:
        the VideoEncoderBase object itself.
      • validate

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