Package com.google.cloud.video.transcoder.v1

Class VideoStream.Vp9CodecSettings.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<VideoStream.Vp9CodecSettings.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<VideoStream.Vp9CodecSettings.Builder>

      • getDefaultInstanceForType

        public VideoStream.Vp9CodecSettings getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public VideoStream.Vp9CodecSettings build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public VideoStream.Vp9CodecSettings buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<VideoStream.Vp9CodecSettings.Builder>

      • mergeFrom

        public VideoStream.Vp9CodecSettings.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<VideoStream.Vp9CodecSettings.Builder>
        Throws:
        IOException

      • getWidthPixels

        public int getWidthPixels()
         The width of the video in pixels. Must be an even integer.
 When not specified, the width is adjusted to match the specified height
 and input aspect ratio. If both are omitted, the input width is used.

 For portrait videos that contain horizontal ASR and rotation metadata,
 provide the width, in pixels, per the horizontal ASR. The API calculates
 the height per the horizontal ASR. The API detects any rotation metadata
 and swaps the requested height and width for the output.
        int32 width_pixels = 1;
        Specified by:
        getWidthPixels in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The widthPixels.

      • setWidthPixels

        public VideoStream.Vp9CodecSettings.Builder setWidthPixels​(int value)
         The width of the video in pixels. Must be an even integer.
 When not specified, the width is adjusted to match the specified height
 and input aspect ratio. If both are omitted, the input width is used.

 For portrait videos that contain horizontal ASR and rotation metadata,
 provide the width, in pixels, per the horizontal ASR. The API calculates
 the height per the horizontal ASR. The API detects any rotation metadata
 and swaps the requested height and width for the output.
        int32 width_pixels = 1;
        Parameters:
        value - The widthPixels to set.
        Returns:
        This builder for chaining.

      • clearWidthPixels

        public VideoStream.Vp9CodecSettings.Builder clearWidthPixels()
         The width of the video in pixels. Must be an even integer.
 When not specified, the width is adjusted to match the specified height
 and input aspect ratio. If both are omitted, the input width is used.

 For portrait videos that contain horizontal ASR and rotation metadata,
 provide the width, in pixels, per the horizontal ASR. The API calculates
 the height per the horizontal ASR. The API detects any rotation metadata
 and swaps the requested height and width for the output.
        int32 width_pixels = 1;
        Returns:
        This builder for chaining.

      • getHeightPixels

        public int getHeightPixels()
         The height of the video in pixels. Must be an even integer.
 When not specified, the height is adjusted to match the specified width
 and input aspect ratio. If both are omitted, the input height is used.

 For portrait videos that contain horizontal ASR and rotation metadata,
 provide the height, in pixels, per the horizontal ASR. The API calculates
 the width per the horizontal ASR. The API detects any rotation metadata
 and swaps the requested height and width for the output.
        int32 height_pixels = 2;
        Specified by:
        getHeightPixels in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The heightPixels.

      • setHeightPixels

        public VideoStream.Vp9CodecSettings.Builder setHeightPixels​(int value)
         The height of the video in pixels. Must be an even integer.
 When not specified, the height is adjusted to match the specified width
 and input aspect ratio. If both are omitted, the input height is used.

 For portrait videos that contain horizontal ASR and rotation metadata,
 provide the height, in pixels, per the horizontal ASR. The API calculates
 the width per the horizontal ASR. The API detects any rotation metadata
 and swaps the requested height and width for the output.
        int32 height_pixels = 2;
        Parameters:
        value - The heightPixels to set.
        Returns:
        This builder for chaining.

      • clearHeightPixels

        public VideoStream.Vp9CodecSettings.Builder clearHeightPixels()
         The height of the video in pixels. Must be an even integer.
 When not specified, the height is adjusted to match the specified width
 and input aspect ratio. If both are omitted, the input height is used.

 For portrait videos that contain horizontal ASR and rotation metadata,
 provide the height, in pixels, per the horizontal ASR. The API calculates
 the width per the horizontal ASR. The API detects any rotation metadata
 and swaps the requested height and width for the output.
        int32 height_pixels = 2;
        Returns:
        This builder for chaining.

      • getFrameRate

        public double getFrameRate()
         Required. The target video frame rate in frames per second (FPS). Must be
 less than or equal to 120. Will default to the input frame rate if larger
 than the input frame rate. The API will generate an output FPS that is
 divisible by the input FPS, and smaller or equal to the target FPS. See
 [Calculating frame
 rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for
 more information.
        double frame_rate = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFrameRate in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The frameRate.

      • setFrameRate

        public VideoStream.Vp9CodecSettings.Builder setFrameRate​(double value)
         Required. The target video frame rate in frames per second (FPS). Must be
 less than or equal to 120. Will default to the input frame rate if larger
 than the input frame rate. The API will generate an output FPS that is
 divisible by the input FPS, and smaller or equal to the target FPS. See
 [Calculating frame
 rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for
 more information.
        double frame_rate = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The frameRate to set.
        Returns:
        This builder for chaining.

      • clearFrameRate

        public VideoStream.Vp9CodecSettings.Builder clearFrameRate()
         Required. The target video frame rate in frames per second (FPS). Must be
 less than or equal to 120. Will default to the input frame rate if larger
 than the input frame rate. The API will generate an output FPS that is
 divisible by the input FPS, and smaller or equal to the target FPS. See
 [Calculating frame
 rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for
 more information.
        double frame_rate = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • getBitrateBps

        public int getBitrateBps()
         Required. The video bitrate in bits per second. The minimum value is
 1,000. The maximum value is 480,000,000.
        int32 bitrate_bps = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBitrateBps in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The bitrateBps.

      • setBitrateBps

        public VideoStream.Vp9CodecSettings.Builder setBitrateBps​(int value)
         Required. The video bitrate in bits per second. The minimum value is
 1,000. The maximum value is 480,000,000.
        int32 bitrate_bps = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bitrateBps to set.
        Returns:
        This builder for chaining.

      • clearBitrateBps

        public VideoStream.Vp9CodecSettings.Builder clearBitrateBps()
         Required. The video bitrate in bits per second. The minimum value is
 1,000. The maximum value is 480,000,000.
        int32 bitrate_bps = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • getPixelFormat

        public String getPixelFormat()
         Pixel format to use. The default is `yuv420p`.

 Supported pixel formats:

 - `yuv420p` pixel format
 - `yuv422p` pixel format
 - `yuv444p` pixel format
 - `yuv420p10` 10-bit HDR pixel format
 - `yuv422p10` 10-bit HDR pixel format
 - `yuv444p10` 10-bit HDR pixel format
 - `yuv420p12` 12-bit HDR pixel format
 - `yuv422p12` 12-bit HDR pixel format
 - `yuv444p12` 12-bit HDR pixel format
        string pixel_format = 5;
        Specified by:
        getPixelFormat in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The pixelFormat.

      • getPixelFormatBytes

        public com.google.protobuf.ByteString getPixelFormatBytes()
         Pixel format to use. The default is `yuv420p`.

 Supported pixel formats:

 - `yuv420p` pixel format
 - `yuv422p` pixel format
 - `yuv444p` pixel format
 - `yuv420p10` 10-bit HDR pixel format
 - `yuv422p10` 10-bit HDR pixel format
 - `yuv444p10` 10-bit HDR pixel format
 - `yuv420p12` 12-bit HDR pixel format
 - `yuv422p12` 12-bit HDR pixel format
 - `yuv444p12` 12-bit HDR pixel format
        string pixel_format = 5;
        Specified by:
        getPixelFormatBytes in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The bytes for pixelFormat.

      • setPixelFormat

        public VideoStream.Vp9CodecSettings.Builder setPixelFormat​(String value)
         Pixel format to use. The default is `yuv420p`.

 Supported pixel formats:

 - `yuv420p` pixel format
 - `yuv422p` pixel format
 - `yuv444p` pixel format
 - `yuv420p10` 10-bit HDR pixel format
 - `yuv422p10` 10-bit HDR pixel format
 - `yuv444p10` 10-bit HDR pixel format
 - `yuv420p12` 12-bit HDR pixel format
 - `yuv422p12` 12-bit HDR pixel format
 - `yuv444p12` 12-bit HDR pixel format
        string pixel_format = 5;
        Parameters:
        value - The pixelFormat to set.
        Returns:
        This builder for chaining.

      • clearPixelFormat

        public VideoStream.Vp9CodecSettings.Builder clearPixelFormat()
         Pixel format to use. The default is `yuv420p`.

 Supported pixel formats:

 - `yuv420p` pixel format
 - `yuv422p` pixel format
 - `yuv444p` pixel format
 - `yuv420p10` 10-bit HDR pixel format
 - `yuv422p10` 10-bit HDR pixel format
 - `yuv444p10` 10-bit HDR pixel format
 - `yuv420p12` 12-bit HDR pixel format
 - `yuv422p12` 12-bit HDR pixel format
 - `yuv444p12` 12-bit HDR pixel format
        string pixel_format = 5;
        Returns:
        This builder for chaining.

      • setPixelFormatBytes

        public VideoStream.Vp9CodecSettings.Builder setPixelFormatBytes​(com.google.protobuf.ByteString value)
         Pixel format to use. The default is `yuv420p`.

 Supported pixel formats:

 - `yuv420p` pixel format
 - `yuv422p` pixel format
 - `yuv444p` pixel format
 - `yuv420p10` 10-bit HDR pixel format
 - `yuv422p10` 10-bit HDR pixel format
 - `yuv444p10` 10-bit HDR pixel format
 - `yuv420p12` 12-bit HDR pixel format
 - `yuv422p12` 12-bit HDR pixel format
 - `yuv444p12` 12-bit HDR pixel format
        string pixel_format = 5;
        Parameters:
        value - The bytes for pixelFormat to set.
        Returns:
        This builder for chaining.

      • getRateControlMode

        public String getRateControlMode()
         Specify the `rate_control_mode`. The default is `vbr`.

 Supported rate control modes:

 - `vbr` - variable bitrate
        string rate_control_mode = 6;
        Specified by:
        getRateControlMode in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The rateControlMode.

      • getRateControlModeBytes

        public com.google.protobuf.ByteString getRateControlModeBytes()
         Specify the `rate_control_mode`. The default is `vbr`.

 Supported rate control modes:

 - `vbr` - variable bitrate
        string rate_control_mode = 6;
        Specified by:
        getRateControlModeBytes in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The bytes for rateControlMode.

      • setRateControlMode

        public VideoStream.Vp9CodecSettings.Builder setRateControlMode​(String value)
         Specify the `rate_control_mode`. The default is `vbr`.

 Supported rate control modes:

 - `vbr` - variable bitrate
        string rate_control_mode = 6;
        Parameters:
        value - The rateControlMode to set.
        Returns:
        This builder for chaining.

      • clearRateControlMode

        public VideoStream.Vp9CodecSettings.Builder clearRateControlMode()
         Specify the `rate_control_mode`. The default is `vbr`.

 Supported rate control modes:

 - `vbr` - variable bitrate
        string rate_control_mode = 6;
        Returns:
        This builder for chaining.

      • setRateControlModeBytes

        public VideoStream.Vp9CodecSettings.Builder setRateControlModeBytes​(com.google.protobuf.ByteString value)
         Specify the `rate_control_mode`. The default is `vbr`.

 Supported rate control modes:

 - `vbr` - variable bitrate
        string rate_control_mode = 6;
        Parameters:
        value - The bytes for rateControlMode to set.
        Returns:
        This builder for chaining.

      • getCrfLevel

        public int getCrfLevel()
         Target CRF level. Must be between 10 and 36, where 10 is the highest
 quality and 36 is the most efficient compression. The default is 21.

 **Note:** This field is not supported.
        int32 crf_level = 7;
        Specified by:
        getCrfLevel in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The crfLevel.

      • setCrfLevel

        public VideoStream.Vp9CodecSettings.Builder setCrfLevel​(int value)
         Target CRF level. Must be between 10 and 36, where 10 is the highest
 quality and 36 is the most efficient compression. The default is 21.

 **Note:** This field is not supported.
        int32 crf_level = 7;
        Parameters:
        value - The crfLevel to set.
        Returns:
        This builder for chaining.

      • clearCrfLevel

        public VideoStream.Vp9CodecSettings.Builder clearCrfLevel()
         Target CRF level. Must be between 10 and 36, where 10 is the highest
 quality and 36 is the most efficient compression. The default is 21.

 **Note:** This field is not supported.
        int32 crf_level = 7;
        Returns:
        This builder for chaining.

      • hasGopFrameCount

        public boolean hasGopFrameCount()
         Select the GOP size based on the specified frame count. Must be greater
 than zero.
        int32 gop_frame_count = 8;
        Specified by:
        hasGopFrameCount in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        Whether the gopFrameCount field is set.

      • getGopFrameCount

        public int getGopFrameCount()
         Select the GOP size based on the specified frame count. Must be greater
 than zero.
        int32 gop_frame_count = 8;
        Specified by:
        getGopFrameCount in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The gopFrameCount.

      • setGopFrameCount

        public VideoStream.Vp9CodecSettings.Builder setGopFrameCount​(int value)
         Select the GOP size based on the specified frame count. Must be greater
 than zero.
        int32 gop_frame_count = 8;
        Parameters:
        value - The gopFrameCount to set.
        Returns:
        This builder for chaining.

      • clearGopFrameCount

        public VideoStream.Vp9CodecSettings.Builder clearGopFrameCount()
         Select the GOP size based on the specified frame count. Must be greater
 than zero.
        int32 gop_frame_count = 8;
        Returns:
        This builder for chaining.

      • hasGopDuration

        public boolean hasGopDuration()
         Select the GOP size based on the specified duration. The default is
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
        .google.protobuf.Duration gop_duration = 9;
        Specified by:
        hasGopDuration in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        Whether the gopDuration field is set.

      • getGopDuration

        public com.google.protobuf.Duration getGopDuration()
         Select the GOP size based on the specified duration. The default is
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
        .google.protobuf.Duration gop_duration = 9;
        Specified by:
        getGopDuration in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The gopDuration.

      • setGopDuration

        public VideoStream.Vp9CodecSettings.Builder setGopDuration​(com.google.protobuf.Duration value)
         Select the GOP size based on the specified duration. The default is
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
        .google.protobuf.Duration gop_duration = 9;

      • setGopDuration

        public VideoStream.Vp9CodecSettings.Builder setGopDuration​(com.google.protobuf.Duration.Builder builderForValue)
         Select the GOP size based on the specified duration. The default is
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
        .google.protobuf.Duration gop_duration = 9;

      • mergeGopDuration

        public VideoStream.Vp9CodecSettings.Builder mergeGopDuration​(com.google.protobuf.Duration value)
         Select the GOP size based on the specified duration. The default is
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
        .google.protobuf.Duration gop_duration = 9;

      • clearGopDuration

        public VideoStream.Vp9CodecSettings.Builder clearGopDuration()
         Select the GOP size based on the specified duration. The default is
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
        .google.protobuf.Duration gop_duration = 9;

      • getGopDurationBuilder

        public com.google.protobuf.Duration.Builder getGopDurationBuilder()
         Select the GOP size based on the specified duration. The default is
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
        .google.protobuf.Duration gop_duration = 9;

      • getGopDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getGopDurationOrBuilder()
         Select the GOP size based on the specified duration. The default is
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
        .google.protobuf.Duration gop_duration = 9;
        Specified by:
        getGopDurationOrBuilder in interface VideoStream.Vp9CodecSettingsOrBuilder

      • getProfile

        public String getProfile()
         Enforces the specified codec profile. The following profiles are
 supported:

 *   `profile0` (default)
 *   `profile1`
 *   `profile2`
 *   `profile3`

 The available options are
 [WebM-compatible](https://www.webmproject.org/vp9/profiles/).
 Note that certain values for this field may cause the
 transcoder to override other fields you set in the `Vp9CodecSettings`
 message.
        string profile = 10;
        Specified by:
        getProfile in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The profile.

      • getProfileBytes

        public com.google.protobuf.ByteString getProfileBytes()
         Enforces the specified codec profile. The following profiles are
 supported:

 *   `profile0` (default)
 *   `profile1`
 *   `profile2`
 *   `profile3`

 The available options are
 [WebM-compatible](https://www.webmproject.org/vp9/profiles/).
 Note that certain values for this field may cause the
 transcoder to override other fields you set in the `Vp9CodecSettings`
 message.
        string profile = 10;
        Specified by:
        getProfileBytes in interface VideoStream.Vp9CodecSettingsOrBuilder
        Returns:
        The bytes for profile.

      • setProfile

        public VideoStream.Vp9CodecSettings.Builder setProfile​(String value)
         Enforces the specified codec profile. The following profiles are
 supported:

 *   `profile0` (default)
 *   `profile1`
 *   `profile2`
 *   `profile3`

 The available options are
 [WebM-compatible](https://www.webmproject.org/vp9/profiles/).
 Note that certain values for this field may cause the
 transcoder to override other fields you set in the `Vp9CodecSettings`
 message.
        string profile = 10;
        Parameters:
        value - The profile to set.
        Returns:
        This builder for chaining.

      • clearProfile

        public VideoStream.Vp9CodecSettings.Builder clearProfile()
         Enforces the specified codec profile. The following profiles are
 supported:

 *   `profile0` (default)
 *   `profile1`
 *   `profile2`
 *   `profile3`

 The available options are
 [WebM-compatible](https://www.webmproject.org/vp9/profiles/).
 Note that certain values for this field may cause the
 transcoder to override other fields you set in the `Vp9CodecSettings`
 message.
        string profile = 10;
        Returns:
        This builder for chaining.

      • setProfileBytes

        public VideoStream.Vp9CodecSettings.Builder setProfileBytes​(com.google.protobuf.ByteString value)
         Enforces the specified codec profile. The following profiles are
 supported:

 *   `profile0` (default)
 *   `profile1`
 *   `profile2`
 *   `profile3`

 The available options are
 [WebM-compatible](https://www.webmproject.org/vp9/profiles/).
 Note that certain values for this field may cause the
 transcoder to override other fields you set in the `Vp9CodecSettings`
 message.
        string profile = 10;
        Parameters:
        value - The bytes for profile to set.
        Returns:
        This builder for chaining.