Class: Google::Cloud::Video::LiveStream::V1::VideoStream

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/livestream/v1/outputs.rb

Overview

Video stream resource.

Defined Under Namespace

Classes: H264CodecSettings, H265CodecSettings

Instance Attribute Summary collapse

Instance Attribute Details

#h264 ⇒ ::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings 



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 397

class VideoStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # H264 codec settings.
  # @!attribute [rw] width_pixels
  #   @return [::Integer]
  #     Required. The width of the video in pixels. Must be an even integer.
  #     Valid range is [320, 4096].
  # @!attribute [rw] height_pixels
  #   @return [::Integer]
  #     Required. The height of the video in pixels. Must be an even integer.
  #     Valid range is [180, 2160].
  # @!attribute [rw] frame_rate
  #   @return [::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](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for
  #     more information.
  # @!attribute [rw] bitrate_bps
  #   @return [::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).
  #     - For UHD resolution (<= 2160p), must be <= 25,000,000 (25 Mbps).
  # @!attribute [rw] allow_open_gop
  #   @return [::Boolean]
  #     Specifies whether an open Group of Pictures (GOP) structure should be
  #     allowed or not. The default is `false`.
  # @!attribute [rw] gop_frame_count
  #   @return [::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].
  #
  #     Note: The following fields are mutually exclusive: `gop_frame_count`, `gop_duration`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] gop_duration
  #   @return [::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
  #     {::Google::Cloud::Video::LiveStream::V1::SegmentSettings#segment_duration segment_duration},
  #     and
  #     {::Google::Cloud::Video::LiveStream::V1::SegmentSettings#segment_duration 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.
  #
  #     Note: The following fields are mutually exclusive: `gop_duration`, `gop_frame_count`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] vbv_size_bits
  #   @return [::Integer]
  #     Size of the Video Buffering Verifier (VBV) buffer in bits. Must be
  #     greater than zero. The default is equal to
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings#bitrate_bps bitrate_bps}.
  # @!attribute [rw] vbv_fullness_bits
  #   @return [::Integer]
  #     Initial fullness of the Video Buffering Verifier (VBV) buffer in bits.
  #     Must be greater than zero. The default is equal to 90% of
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings#vbv_size_bits vbv_size_bits}.
  # @!attribute [rw] entropy_coder
  #   @return [::String]
  #     The entropy coder to use. The default is `cabac`.
  #
  #     Supported entropy coders:
  #
  #     - `cavlc`
  #     - `cabac`
  # @!attribute [rw] b_pyramid
  #   @return [::Boolean]
  #     Allow B-pyramid for reference frame selection. This may not be supported
  #     on all decoders. The default is `false`.
  # @!attribute [rw] b_frame_count
  #   @return [::Integer]
  #     The number of consecutive B-frames. Must be greater than or equal to
  #     zero. Must be less than
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings#gop_frame_count gop_frame_count}
  #     if set. The default is 0.
  # @!attribute [rw] aq_strength
  #   @return [::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.
  # @!attribute [rw] profile
  #   @return [::String]
  #     Enforces the specified codec profile. The following profiles are
  #     supported:
  #
  #     *   `baseline`
  #     *   `main` (default)
  #     *   `high`
  #
  #     The available options are [FFmpeg-compatible Profile
  #     Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Profile).
  #     Note that certain values for this field may cause the
  #     transcoder to override other fields you set in the
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings H264CodecSettings}
  #     message.
  # @!attribute [rw] tune
  #   @return [::String]
  #     Enforces the specified codec tune. The available options are
  #     [FFmpeg-compatible Encode
  #     Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune)
  #     Note that certain values for this field may cause the transcoder to
  #     override other fields you set in the
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings H264CodecSettings}
  #     message.
  class H264CodecSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # H265 codec settings.
  # @!attribute [rw] width_pixels
  #   @return [::Integer]
  #     Optional. 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.
  #     Valid range is [320, 4096].
  # @!attribute [rw] height_pixels
  #   @return [::Integer]
  #     Optional. 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.
  #     Valid range is [180, 2160].
  # @!attribute [rw] frame_rate
  #   @return [::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](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for
  #     more information.
  # @!attribute [rw] bitrate_bps
  #   @return [::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).
  #     - For UHD resolution (<= 2160p), must be <= 25,000,000 (25 Mbps).
  # @!attribute [rw] gop_frame_count
  #   @return [::Integer]
  #     Optional. 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].
  #
  #     Note: The following fields are mutually exclusive: `gop_frame_count`, `gop_duration`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] gop_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Select the GOP size based on the specified duration. The
  #     default is `2s`. Note that `gopDuration` must be less than or equal to
  #     {::Google::Cloud::Video::LiveStream::V1::SegmentSettings#segment_duration segment_duration},
  #     and
  #     {::Google::Cloud::Video::LiveStream::V1::SegmentSettings#segment_duration 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.
  #
  #     Note: The following fields are mutually exclusive: `gop_duration`, `gop_frame_count`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] vbv_size_bits
  #   @return [::Integer]
  #     Optional. Size of the Video Buffering Verifier (VBV) buffer in bits. Must
  #     be greater than zero. The default is equal to
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H265CodecSettings#bitrate_bps bitrate_bps}.
  # @!attribute [rw] vbv_fullness_bits
  #   @return [::Integer]
  #     Optional. Initial fullness of the Video Buffering Verifier (VBV) buffer
  #     in bits. Must be greater than zero. The default is equal to 90% of
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H265CodecSettings#vbv_size_bits vbv_size_bits}.
  # @!attribute [rw] b_pyramid
  #   @return [::Boolean]
  #     Optional. Allow B-pyramid for reference frame selection. This may not be
  #     supported on all decoders. The default is `false`.
  # @!attribute [rw] b_frame_count
  #   @return [::Integer]
  #     Optional. The number of consecutive B-frames. Must be greater than or
  #     equal to zero. Must be less than
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H265CodecSettings#gop_frame_count gop_frame_count}
  #     if set. The default is 0.
  # @!attribute [rw] aq_strength
  #   @return [::Float]
  #     Optional. 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.
  class H265CodecSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#h265 ⇒ ::Google::Cloud::Video::LiveStream::V1::VideoStream::H265CodecSettings 



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 397

class VideoStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # H264 codec settings.
  # @!attribute [rw] width_pixels
  #   @return [::Integer]
  #     Required. The width of the video in pixels. Must be an even integer.
  #     Valid range is [320, 4096].
  # @!attribute [rw] height_pixels
  #   @return [::Integer]
  #     Required. The height of the video in pixels. Must be an even integer.
  #     Valid range is [180, 2160].
  # @!attribute [rw] frame_rate
  #   @return [::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](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for
  #     more information.
  # @!attribute [rw] bitrate_bps
  #   @return [::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).
  #     - For UHD resolution (<= 2160p), must be <= 25,000,000 (25 Mbps).
  # @!attribute [rw] allow_open_gop
  #   @return [::Boolean]
  #     Specifies whether an open Group of Pictures (GOP) structure should be
  #     allowed or not. The default is `false`.
  # @!attribute [rw] gop_frame_count
  #   @return [::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].
  #
  #     Note: The following fields are mutually exclusive: `gop_frame_count`, `gop_duration`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] gop_duration
  #   @return [::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
  #     {::Google::Cloud::Video::LiveStream::V1::SegmentSettings#segment_duration segment_duration},
  #     and
  #     {::Google::Cloud::Video::LiveStream::V1::SegmentSettings#segment_duration 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.
  #
  #     Note: The following fields are mutually exclusive: `gop_duration`, `gop_frame_count`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] vbv_size_bits
  #   @return [::Integer]
  #     Size of the Video Buffering Verifier (VBV) buffer in bits. Must be
  #     greater than zero. The default is equal to
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings#bitrate_bps bitrate_bps}.
  # @!attribute [rw] vbv_fullness_bits
  #   @return [::Integer]
  #     Initial fullness of the Video Buffering Verifier (VBV) buffer in bits.
  #     Must be greater than zero. The default is equal to 90% of
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings#vbv_size_bits vbv_size_bits}.
  # @!attribute [rw] entropy_coder
  #   @return [::String]
  #     The entropy coder to use. The default is `cabac`.
  #
  #     Supported entropy coders:
  #
  #     - `cavlc`
  #     - `cabac`
  # @!attribute [rw] b_pyramid
  #   @return [::Boolean]
  #     Allow B-pyramid for reference frame selection. This may not be supported
  #     on all decoders. The default is `false`.
  # @!attribute [rw] b_frame_count
  #   @return [::Integer]
  #     The number of consecutive B-frames. Must be greater than or equal to
  #     zero. Must be less than
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings#gop_frame_count gop_frame_count}
  #     if set. The default is 0.
  # @!attribute [rw] aq_strength
  #   @return [::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.
  # @!attribute [rw] profile
  #   @return [::String]
  #     Enforces the specified codec profile. The following profiles are
  #     supported:
  #
  #     *   `baseline`
  #     *   `main` (default)
  #     *   `high`
  #
  #     The available options are [FFmpeg-compatible Profile
  #     Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Profile).
  #     Note that certain values for this field may cause the
  #     transcoder to override other fields you set in the
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings H264CodecSettings}
  #     message.
  # @!attribute [rw] tune
  #   @return [::String]
  #     Enforces the specified codec tune. The available options are
  #     [FFmpeg-compatible Encode
  #     Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune)
  #     Note that certain values for this field may cause the transcoder to
  #     override other fields you set in the
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H264CodecSettings H264CodecSettings}
  #     message.
  class H264CodecSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # H265 codec settings.
  # @!attribute [rw] width_pixels
  #   @return [::Integer]
  #     Optional. 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.
  #     Valid range is [320, 4096].
  # @!attribute [rw] height_pixels
  #   @return [::Integer]
  #     Optional. 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.
  #     Valid range is [180, 2160].
  # @!attribute [rw] frame_rate
  #   @return [::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](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for
  #     more information.
  # @!attribute [rw] bitrate_bps
  #   @return [::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).
  #     - For UHD resolution (<= 2160p), must be <= 25,000,000 (25 Mbps).
  # @!attribute [rw] gop_frame_count
  #   @return [::Integer]
  #     Optional. 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].
  #
  #     Note: The following fields are mutually exclusive: `gop_frame_count`, `gop_duration`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] gop_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Select the GOP size based on the specified duration. The
  #     default is `2s`. Note that `gopDuration` must be less than or equal to
  #     {::Google::Cloud::Video::LiveStream::V1::SegmentSettings#segment_duration segment_duration},
  #     and
  #     {::Google::Cloud::Video::LiveStream::V1::SegmentSettings#segment_duration 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.
  #
  #     Note: The following fields are mutually exclusive: `gop_duration`, `gop_frame_count`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] vbv_size_bits
  #   @return [::Integer]
  #     Optional. Size of the Video Buffering Verifier (VBV) buffer in bits. Must
  #     be greater than zero. The default is equal to
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H265CodecSettings#bitrate_bps bitrate_bps}.
  # @!attribute [rw] vbv_fullness_bits
  #   @return [::Integer]
  #     Optional. Initial fullness of the Video Buffering Verifier (VBV) buffer
  #     in bits. Must be greater than zero. The default is equal to 90% of
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H265CodecSettings#vbv_size_bits vbv_size_bits}.
  # @!attribute [rw] b_pyramid
  #   @return [::Boolean]
  #     Optional. Allow B-pyramid for reference frame selection. This may not be
  #     supported on all decoders. The default is `false`.
  # @!attribute [rw] b_frame_count
  #   @return [::Integer]
  #     Optional. The number of consecutive B-frames. Must be greater than or
  #     equal to zero. Must be less than
  #     {::Google::Cloud::Video::LiveStream::V1::VideoStream::H265CodecSettings#gop_frame_count gop_frame_count}
  #     if set. The default is 0.
  # @!attribute [rw] aq_strength
  #   @return [::Float]
  #     Optional. 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.
  class H265CodecSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end