Class: Google::Apis::TranscoderV1beta1::VideoStream

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

Overview

Video stream resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VideoStream

Returns a new instance of VideoStream.



1788
1789
1790
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1788

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) 


1640
1641
1642
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1640

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) 


1648
1649
1650
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1648

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) 


1654
1655
1656
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1654

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) 


1660
1661
1662
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1660

def b_pyramid
  @b_pyramid
end

#bitrate_bps ⇒ Fixnum

Required. The video bitrate in bits per second. Must be between 1 and 1,000, 000,000. Corresponds to the JSON property bitrateBps

Returns:

  • (Fixnum) 


1667
1668
1669
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1667

def bitrate_bps
  @bitrate_bps
end

#codec ⇒ String

Codec type. The following codecs are supported: * h264 (default) * h265 * vp9 Corresponds to the JSON property codec

Returns:

  • (String) 


1673
1674
1675
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1673

def codec
  @codec
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) 


1679
1680
1681
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1679

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) 


1685
1686
1687
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1685

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) 


1692
1693
1694
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1692

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. The following table shows the computed video FPS given the target FPS (in parenthesis) and input FPS (in the first column): | | (30) | (60) | (25) | (50) | |--------|--------|----- ---|------|------| | 240 | Fail | Fail | Fail | Fail | | 120 | 30 | 60 | 20 | 30 | | 100 | 25 | 50 | 20 | 30 | | 50 | 25 | 50 | 20 | 30 | | 60 | 30 | 60 | 20 | 30 | | 59.94 | 29.97 | 59.94 | 20 | 30 | | 48 | 24 | 48 | 20 | 30 | | 30 | 30 | 30 | 20 | 30 | | 25 | 25 | 25 | 20 | 30 | | 24 | 24 | 24 | 20 | 30 | | 23.976 | 23.976 | 23.976 | 20 | 30 | | 15 | 15 | 15 | 20 | 30 | | 12 | 12 | 12 | 20 | 30 | | 10 | 10 | 10 | 20 | 30 | Corresponds to the JSON property frameRate

Returns:

  • (Float) 


1708
1709
1710
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1708

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) 


1716
1717
1718
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1716

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) 


1722
1723
1724
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1722

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) 


1729
1730
1731
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1729

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) 


1738
1739
1740
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1738

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

Returns:

  • (String) 


1746
1747
1748
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1746

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 VideoStream message. Corresponds to the JSON property profile

Returns:

  • (String) 


1754
1755
1756
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1754

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) 


1760
1761
1762
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1760

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

Returns:

  • (String) 


1767
1768
1769
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1767

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) 


1773
1774
1775
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1773

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) 


1779
1780
1781
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1779

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) 


1786
1787
1788
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1786

def width_pixels
  @width_pixels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1793

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)
  @codec = args[:codec] if args.key?(:codec)
  @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