Class: Google::Apis::TranscoderV1::H264CodecSettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/transcoder_v1/classes.rb,
lib/google/apis/transcoder_v1/representations.rb,
lib/google/apis/transcoder_v1/representations.rb

Overview

H264 codec settings.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ H264CodecSettings

Returns a new instance of H264CodecSettings.



679
680
681
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 679

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_open_gop ⇒ Boolean Also known as: allow_open_gop?

Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false. Corresponds to the JSON property allowOpenGop

Returns:

  • (Boolean) 


541
542
543
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 541

def allow_open_gop
  @allow_open_gop
end

#aq_strength ⇒ 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. Corresponds to the JSON property aqStrength

Returns:

  • (Float) 


549
550
551
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 549

def aq_strength
  @aq_strength
end

#b_frame_count ⇒ Fixnum

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. Corresponds to the JSON property bFrameCount

Returns:

  • (Fixnum) 


555
556
557
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 555

def b_frame_count
  @b_frame_count
end

#b_pyramid ⇒ Boolean Also known as: b_pyramid?

Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false. Corresponds to the JSON property bPyramid

Returns:

  • (Boolean) 


561
562
563
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 561

def b_pyramid
  @b_pyramid
end

#bitrate_bps ⇒ Fixnum

Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000. Corresponds to the JSON property bitrateBps

Returns:

  • (Fixnum) 


568
569
570
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 568

def bitrate_bps
  @bitrate_bps
end

#crf_level ⇒ Fixnum

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. Corresponds to the JSON property crfLevel

Returns:

  • (Fixnum) 


574
575
576
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 574

def crf_level
  @crf_level
end

#enable_two_pass ⇒ Boolean Also known as: enable_two_pass?

Use two-pass encoding strategy to achieve better video quality. VideoStream. rate_control_mode must be vbr. The default is false. Corresponds to the JSON property enableTwoPass

Returns:

  • (Boolean) 


580
581
582
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 580

def enable_two_pass
  @enable_two_pass
end

#entropy_coder ⇒ String

The entropy coder to use. The default is cabac. Supported entropy coders: - cavlc - cabac Corresponds to the JSON property entropyCoder

Returns:

  • (String) 


587
588
589
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 587

def entropy_coder
  @entropy_coder
end

#frame_rate ⇒ 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. Corresponds to the JSON property frameRate

Returns:

  • (Float) 


597
598
599
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 597

def frame_rate
  @frame_rate
end

#gop_duration ⇒ String

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. Corresponds to the JSON property gopDuration

Returns:

  • (String) 


605
606
607
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 605

def gop_duration
  @gop_duration
end

#gop_frame_count ⇒ Fixnum

Select the GOP size based on the specified frame count. Must be greater than zero. Corresponds to the JSON property gopFrameCount

Returns:

  • (Fixnum) 


611
612
613
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 611

def gop_frame_count
  @gop_frame_count
end

#height_pixels ⇒ Fixnum

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. Corresponds to the JSON property heightPixels

Returns:

  • (Fixnum) 


618
619
620
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 618

def height_pixels
  @height_pixels
end

#pixel_format ⇒ 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 Corresponds to the JSON property pixelFormat

Returns:

  • (String) 


627
628
629
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 627

def pixel_format
  @pixel_format
end

#preset ⇒ 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 H264CodecSettings message. Corresponds to the JSON property preset

Returns:

  • (String) 


635
636
637
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 635

def preset
  @preset
end

#profile ⇒ String

Enforces the specified codec profile. The following profiles are supported: * baseline * main * high (default) 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 H264CodecSettings message. Corresponds to the JSON property profile

Returns:

  • (String) 


644
645
646
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 644

def profile
  @profile
end

#rate_control_mode ⇒ String

Specify the rate_control_mode. The default is vbr. Supported rate control modes: - vbr - variable bitrate - crf - constant rate factor Corresponds to the JSON property rateControlMode

Returns:

  • (String) 


650
651
652
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 650

def rate_control_mode
  @rate_control_mode
end

#tune ⇒ 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 H264CodecSettings message. Corresponds to the JSON property tune

Returns:

  • (String) 


658
659
660
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 658

def tune
  @tune
end

#vbv_fullness_bits ⇒ Fixnum

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. Corresponds to the JSON property vbvFullnessBits

Returns:

  • (Fixnum) 


664
665
666
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 664

def vbv_fullness_bits
  @vbv_fullness_bits
end

#vbv_size_bits ⇒ Fixnum

Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to VideoStream.bitrate_bps. Corresponds to the JSON property vbvSizeBits

Returns:

  • (Fixnum) 


670
671
672
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 670

def vbv_size_bits
  @vbv_size_bits
end

#width_pixels ⇒ Fixnum

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. Corresponds to the JSON property widthPixels

Returns:

  • (Fixnum) 


677
678
679
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 677

def width_pixels
  @width_pixels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 684

def update!(**args)
  @allow_open_gop = args[:allow_open_gop] if args.key?(:allow_open_gop)
  @aq_strength = args[:aq_strength] if args.key?(:aq_strength)
  @b_frame_count = args[:b_frame_count] if args.key?(:b_frame_count)
  @b_pyramid = args[:b_pyramid] if args.key?(:b_pyramid)
  @bitrate_bps = args[:bitrate_bps] if args.key?(:bitrate_bps)
  @crf_level = args[:crf_level] if args.key?(:crf_level)
  @enable_two_pass = args[:enable_two_pass] if args.key?(:enable_two_pass)
  @entropy_coder = args[:entropy_coder] if args.key?(:entropy_coder)
  @frame_rate = args[:frame_rate] if args.key?(:frame_rate)
  @gop_duration = args[:gop_duration] if args.key?(:gop_duration)
  @gop_frame_count = args[:gop_frame_count] if args.key?(:gop_frame_count)
  @height_pixels = args[:height_pixels] if args.key?(:height_pixels)
  @pixel_format = args[:pixel_format] if args.key?(:pixel_format)
  @preset = args[:preset] if args.key?(:preset)
  @profile = args[:profile] if args.key?(:profile)
  @rate_control_mode = args[:rate_control_mode] if args.key?(:rate_control_mode)
  @tune = args[:tune] if args.key?(:tune)
  @vbv_fullness_bits = args[:vbv_fullness_bits] if args.key?(:vbv_fullness_bits)
  @vbv_size_bits = args[:vbv_size_bits] if args.key?(:vbv_size_bits)
  @width_pixels = args[:width_pixels] if args.key?(:width_pixels)
end