Package com.azure.media.videoanalyzer.edge.models

Class RateControl

  • public final class RateControl
extends Object
    Class representing the video's rate control.

    • Constructor Detail

      • RateControl

        public RateControl()

    • Method Detail

      • getBitRateLimit

        public Float getBitRateLimit()
        Get the bitRateLimit property: the maximum output bitrate in kbps.
        Returns:
        the bitRateLimit value.

      • setBitRateLimit

        public RateControl setBitRateLimit​(Float bitRateLimit)
        Set the bitRateLimit property: the maximum output bitrate in kbps.
        Parameters:
        bitRateLimit - the bitRateLimit value to set.
        Returns:
        the RateControl object itself.

      • getEncodingInterval

        public Float getEncodingInterval()
        Get the encodingInterval property: Interval at which images are encoded and transmitted.
        Returns:
        the encodingInterval value.

      • setEncodingInterval

        public RateControl setEncodingInterval​(Float encodingInterval)
        Set the encodingInterval property: Interval at which images are encoded and transmitted.
        Parameters:
        encodingInterval - the encodingInterval value to set.
        Returns:
        the RateControl object itself.

      • getFrameRateLimit

        public Float getFrameRateLimit()
        Get the frameRateLimit property: Maximum output framerate in fps.
        Returns:
        the frameRateLimit value.

      • setFrameRateLimit

        public RateControl setFrameRateLimit​(Float frameRateLimit)
        Set the frameRateLimit property: Maximum output framerate in fps.
        Parameters:
        frameRateLimit - the frameRateLimit value to set.
        Returns:
        the RateControl object itself.

      • isGuaranteedFrameRate

        public Boolean isGuaranteedFrameRate()
        Get the guaranteedFrameRate property: A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate.
        Returns:
        the guaranteedFrameRate value.

      • setGuaranteedFrameRate

        public RateControl setGuaranteedFrameRate​(Boolean guaranteedFrameRate)
        Set the guaranteedFrameRate property: A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate.
        Parameters:
        guaranteedFrameRate - the guaranteedFrameRate value to set.
        Returns:
        the RateControl object itself.