Live Stream V1 API - Class Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings (v0.8.2)

Version 0.8.2

• 0.9.0 (latest)
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings.

H264 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 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 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 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. Minimum value is 10,000.

  • For SD resolution (< 720p), must be <= 3,000,000 (3 Mbps).
  • For HD resolution (<= 1080p), must be <= 15,000,000 (15 Mbps).

#bitrate_bps=

def bitrate_bps=(value) -> ::Integer

Parameter

• value (::Integer) —

  Required. The video bitrate in bits per second. Minimum value is 10,000.

  • For SD resolution (< 720p), must be <= 3,000,000 (3 Mbps).
  • For HD resolution (<= 1080p), must be <= 15,000,000 (15 Mbps).

Returns

• (::Integer) —

  Required. The video bitrate in bits per second. Minimum value is 10,000.

  • For SD resolution (< 720p), must be <= 3,000,000 (3 Mbps).
  • For HD resolution (<= 1080p), must be <= 15,000,000 (15 Mbps).

#entropy_coder

def entropy_coder() -> ::String

Returns

• (::String) —

  The entropy coder to use. The default is cabac.

  Supported entropy coders:

  • cavlc
  • cabac

#entropy_coder=

def entropy_coder=(value) -> ::String

Parameter

• value (::String) —

  The entropy coder to use. The default is cabac.

  Supported entropy coders:

  • cavlc
  • cabac

Returns

• (::String) —

  The entropy coder to use. The default is cabac.

  Supported entropy coders:

  • cavlc
  • cabac

#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 60. 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 60. 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 60. 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 2s. Note that gopDuration must be less than or equal to segment_duration, and segment_duration must be divisible by gopDuration. Valid range is [2s, 20s].

  All video streams in the same channel must have the same GOP size.

#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 2s. Note that gopDuration must be less than or equal to segment_duration, and segment_duration must be divisible by gopDuration. Valid range is [2s, 20s].

  All video streams in the same channel must have the same GOP size.

Returns

• (::Google::Protobuf::Duration) — Select the GOP size based on the specified duration. The default is 2s. Note that gopDuration must be less than or equal to segment_duration, and segment_duration must be divisible by gopDuration. Valid range is [2s, 20s].

  All video streams in the same channel must have the same GOP size.

#gop_frame_count

def gop_frame_count() -> ::Integer

Returns

• (::Integer) — Select the GOP size based on the specified frame count. If GOP frame count is set instead of GOP duration, GOP duration will be calculated by gopFrameCount/frameRate. The calculated GOP duration must satisfy the limitations on gopDuration as well. Valid range is [60, 600].

#gop_frame_count=

def gop_frame_count=(value) -> ::Integer

Parameter

• value (::Integer) — Select the GOP size based on the specified frame count. If GOP frame count is set instead of GOP duration, GOP duration will be calculated by gopFrameCount/frameRate. The calculated GOP duration must satisfy the limitations on gopDuration as well. Valid range is [60, 600].

Returns

• (::Integer) — Select the GOP size based on the specified frame count. If GOP frame count is set instead of GOP duration, GOP duration will be calculated by gopFrameCount/frameRate. The calculated GOP duration must satisfy the limitations on gopDuration as well. Valid range is [60, 600].

#height_pixels

def height_pixels() -> ::Integer

Returns

• (::Integer) — Required. The height of the video in pixels. Must be an even integer. Valid range is [180, 1080].

#height_pixels=

def height_pixels=(value) -> ::Integer

Parameter

• value (::Integer) — Required. The height of the video in pixels. Must be an even integer. Valid range is [180, 1080].

Returns

• (::Integer) — Required. The height of the video in pixels. Must be an even integer. Valid range is [180, 1080].

#profile

def profile() -> ::String

Returns

• (::String) — Enforces the specified codec profile. The following profiles are supported:
  • baseline
  • main (default)
  • high

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

#profile=

def profile=(value) -> ::String

Parameter

• value (::String) — Enforces the specified codec profile. The following profiles are supported:
  • baseline
  • main (default)
  • high

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

Returns

• (::String) — Enforces the specified codec profile. The following profiles are supported:
  • baseline
  • main (default)
  • high

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

#tune

def tune() -> ::String

Returns

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

#tune=

def tune=(value) -> ::String

Parameter

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

Returns

• (::String) — Enforces the specified codec tune. The available options are FFmpeg-compatible Encode Options Note that certain values for this field may cause the transcoder to override other fields you set in the H264CodecSettings 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 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 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 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 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 bitrate_bps.

Returns

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

#width_pixels

def width_pixels() -> ::Integer

Returns

• (::Integer) — Required. The width of the video in pixels. Must be an even integer. Valid range is [320, 1920].

#width_pixels=

def width_pixels=(value) -> ::Integer

Parameter

• value (::Integer) — Required. The width of the video in pixels. Must be an even integer. Valid range is [320, 1920].

Returns

• (::Integer) — Required. The width of the video in pixels. Must be an even integer. Valid range is [320, 1920].