Transcoder V1 API - Class Google::Cloud::Video::Transcoder::V1::VideoStream::H265CodecSettings (v0.10.0)

Version 0.10.0

• 1.0.1 (latest)
• 1.0.0
• 0.13.0
• 0.12.2
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.2

Reference documentation and code samples for the Transcoder V1 API class Google::Cloud::Video::Transcoder::V1::VideoStream::H265CodecSettings.

H265 codec settings.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#allow_open_gop

def allow_open_gop() -> ::Boolean

Returns

• (::Boolean) — Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.

#allow_open_gop=

def allow_open_gop=(value) -> ::Boolean

Parameter

• value (::Boolean) — Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.

Returns

• (::Boolean) — Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.

#aq_strength

def aq_strength() -> ::Float

Returns

• (::Float) — Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.

#aq_strength=

def aq_strength=(value) -> ::Float

Parameter

• value (::Float) — Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.

Returns

• (::Float) — Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.

#b_frame_count

def b_frame_count() -> ::Integer

Returns

• (::Integer) — The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than VideoStream.gop_frame_count if set. The default is 0.

#b_frame_count=

def b_frame_count=(value) -> ::Integer

Parameter

• value (::Integer) — The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than VideoStream.gop_frame_count if set. The default is 0.

Returns

• (::Integer) — The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than VideoStream.gop_frame_count if set. The default is 0.

#b_pyramid

def b_pyramid() -> ::Boolean

Returns

• (::Boolean) — Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false.

#b_pyramid=

def b_pyramid=(value) -> ::Boolean

Parameter

• value (::Boolean) — Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false.

Returns

• (::Boolean) — Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false.

#bitrate_bps

def bitrate_bps() -> ::Integer

Returns

• (::Integer) — Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.

#bitrate_bps=

def bitrate_bps=(value) -> ::Integer

Parameter

• value (::Integer) — Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.

Returns

• (::Integer) — Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.

#crf_level

def crf_level() -> ::Integer

Returns

• (::Integer) — 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.

#crf_level=

def crf_level=(value) -> ::Integer

Parameter

• value (::Integer) — 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.

Returns

• (::Integer) — 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.

#enable_two_pass

def enable_two_pass() -> ::Boolean

Returns

• (::Boolean) — Use two-pass encoding strategy to achieve better video quality. VideoStream.rate_control_mode must be vbr. The default is false.

#enable_two_pass=

def enable_two_pass=(value) -> ::Boolean

Parameter

• value (::Boolean) — Use two-pass encoding strategy to achieve better video quality. VideoStream.rate_control_mode must be vbr. The default is false.

Returns

• (::Boolean) — Use two-pass encoding strategy to achieve better video quality. VideoStream.rate_control_mode must be vbr. The default is false.

#frame_rate

def frame_rate() -> ::Float

Returns

• (::Float) — 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 for more information.

#frame_rate=

def frame_rate=(value) -> ::Float

Parameter

• value (::Float) — 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 for more information.

Returns

• (::Float) — 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 for more information.

#gop_duration

def gop_duration() -> ::Google::Protobuf::Duration

Returns

• (::Google::Protobuf::Duration) — Select the GOP size based on the specified duration. The default is 3s. Note that gopDuration must be less than or equal to segmentDuration, and segmentDuration must be divisible by gopDuration.

#gop_duration=

def gop_duration=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — Select the GOP size based on the specified duration. The default is 3s. Note that gopDuration must be less than or equal to segmentDuration, and segmentDuration must be divisible by gopDuration.

Returns

• (::Google::Protobuf::Duration) — Select the GOP size based on the specified duration. The default is 3s. Note that gopDuration must be less than or equal to segmentDuration, and segmentDuration must be divisible by gopDuration.

#gop_frame_count

def gop_frame_count() -> ::Integer

Returns

• (::Integer) — Select the GOP size based on the specified frame count. Must be greater than zero.

#gop_frame_count=

def gop_frame_count=(value) -> ::Integer

Parameter

• value (::Integer) — Select the GOP size based on the specified frame count. Must be greater than zero.

Returns

• (::Integer) — Select the GOP size based on the specified frame count. Must be greater than zero.

#height_pixels

def height_pixels() -> ::Integer

Returns

• (::Integer) — 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.

#height_pixels=

def height_pixels=(value) -> ::Integer

Parameter

• value (::Integer) — 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.

Returns

• (::Integer) — 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.

#pixel_format

def pixel_format() -> ::String

Returns

• (::String) —

  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

#pixel_format=

def pixel_format=(value) -> ::String

Parameter

• value (::String) —

  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

Returns

• (::String) —

  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

#preset

def preset() -> ::String

Returns

• (::String) — Enforces the specified codec preset. The default is veryfast. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

#preset=

def preset=(value) -> ::String

Parameter

• value (::String) — Enforces the specified codec preset. The default is veryfast. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

Returns

• (::String) — Enforces the specified codec preset. The default is veryfast. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

#profile

def profile() -> ::String

Returns

• (::String) — Enforces the specified codec profile. The following profiles are supported:
  • 8-bit profiles
    • main (default)
    • main-intra
    • mainstillpicture
  • 10-bit profiles
    • main10 (default)
    • main10-intra
    • main422-10
    • main422-10-intra
    • main444-10
    • main444-10-intra
  • 12-bit profiles
    • main12 (default)
    • main12-intra
    • main422-12
    • main422-12-intra
    • main444-12
    • main444-12-intra

  The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

#profile=

def profile=(value) -> ::String

Parameter

• value (::String) — Enforces the specified codec profile. The following profiles are supported:
  • 8-bit profiles
    • main (default)
    • main-intra
    • mainstillpicture
  • 10-bit profiles
    • main10 (default)
    • main10-intra
    • main422-10
    • main422-10-intra
    • main444-10
    • main444-10-intra
  • 12-bit profiles
    • main12 (default)
    • main12-intra
    • main422-12
    • main422-12-intra
    • main444-12
    • main444-12-intra

  The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

Returns

• (::String) — Enforces the specified codec profile. The following profiles are supported:
  • 8-bit profiles
    • main (default)
    • main-intra
    • mainstillpicture
  • 10-bit profiles
    • main10 (default)
    • main10-intra
    • main422-10
    • main422-10-intra
    • main444-10
    • main444-10-intra
  • 12-bit profiles
    • main12 (default)
    • main12-intra
    • main422-12
    • main422-12-intra
    • main444-12
    • main444-12-intra

  The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

#rate_control_mode

def rate_control_mode() -> ::String

Returns

• (::String) —

  Specify the rate_control_mode. The default is vbr.

  Supported rate control modes:

  • vbr - variable bitrate
  • crf - constant rate factor

#rate_control_mode=

def rate_control_mode=(value) -> ::String

Parameter

• value (::String) —

  Specify the rate_control_mode. The default is vbr.

  Supported rate control modes:

  • vbr - variable bitrate
  • crf - constant rate factor

Returns

• (::String) —

  Specify the rate_control_mode. The default is vbr.

  Supported rate control modes:

  • vbr - variable bitrate
  • crf - constant rate factor

#tune

def tune() -> ::String

Returns

• (::String) — Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

#tune=

def tune=(value) -> ::String

Parameter

• value (::String) — Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

Returns

• (::String) — Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

#vbv_fullness_bits

def vbv_fullness_bits() -> ::Integer

Returns

• (::Integer) — Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of VideoStream.vbv_size_bits.

#vbv_fullness_bits=

def vbv_fullness_bits=(value) -> ::Integer

Parameter

• value (::Integer) — Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of VideoStream.vbv_size_bits.

Returns

• (::Integer) — Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of VideoStream.vbv_size_bits.

#vbv_size_bits

def vbv_size_bits() -> ::Integer

Returns

• (::Integer) — Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to VideoStream.bitrate_bps.

#vbv_size_bits=

def vbv_size_bits=(value) -> ::Integer

Parameter

• value (::Integer) — Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to VideoStream.bitrate_bps.

Returns

• (::Integer) — Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to VideoStream.bitrate_bps.

#width_pixels

def width_pixels() -> ::Integer

Returns

• (::Integer) — 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.

#width_pixels=

def width_pixels=(value) -> ::Integer

Parameter

• value (::Integer) — 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.

Returns

• (::Integer) — 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.