Class: Google::Cloud::Video::Transcoder::V1::Overlay

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

Overview

Overlay configuration.

Defined Under Namespace

Modules: FadeType Classes: Animation, AnimationEnd, AnimationFade, AnimationStatic, Image, NormalizedCoordinate

Instance Attribute Summary collapse

Instance Attribute Details

#animations ⇒ ::Array<::Google::Cloud::Video::Transcoder::V1::Overlay::Animation>

Returns List of Animations. The list should be chronological, without any time overlap.

Returns:



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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'proto_docs/google/cloud/video/transcoder/v1/resources.rb', line 507

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

  # 2D normalized coordinates. Default: `{0.0, 0.0}`
  # @!attribute [rw] x
  #   @return [::Float]
  #     Normalized x coordinate.
  # @!attribute [rw] y
  #   @return [::Float]
  #     Normalized y coordinate.
  class NormalizedCoordinate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overlaid image.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. URI of the image in Cloud Storage. For example,
  #     `gs://bucket/inputs/image.png`. Only PNG and JPEG images are supported.
  # @!attribute [rw] resolution
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::NormalizedCoordinate]
  #     Normalized image resolution, based on output video resolution. Valid
  #     values: `0.0`–`1.0`. To respect the original image aspect ratio, set
  #     either `x` or `y` to `0.0`. To use the original image resolution, set
  #     both `x` and `y` to `0.0`.
  # @!attribute [rw] alpha
  #   @return [::Float]
  #     Target image opacity. Valid values are from  `1.0` (solid, default) to
  #     `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
  class Image
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Display static overlay object.
  # @!attribute [rw] xy
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::NormalizedCoordinate]
  #     Normalized coordinates based on output video resolution. Valid
  #     values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay
  #     object. For example, use the x and y coordinates \\{0,0} to position the
  #     top-left corner of the overlay animation in the top-left corner of the
  #     output video.
  # @!attribute [rw] start_time_offset
  #   @return [::Google::Protobuf::Duration]
  #     The time to start displaying the overlay object, in seconds. Default: 0
  class AnimationStatic
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Display overlay object with fade animation.
  # @!attribute [rw] fade_type
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::FadeType]
  #     Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
  # @!attribute [rw] xy
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::NormalizedCoordinate]
  #     Normalized coordinates based on output video resolution. Valid
  #     values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay
  #     object. For example, use the x and y coordinates \\{0,0} to position the
  #     top-left corner of the overlay animation in the top-left corner of the
  #     output video.
  # @!attribute [rw] start_time_offset
  #   @return [::Google::Protobuf::Duration]
  #     The time to start the fade animation, in seconds. Default: 0
  # @!attribute [rw] end_time_offset
  #   @return [::Google::Protobuf::Duration]
  #     The time to end the fade animation, in seconds. Default:
  #     `start_time_offset` + 1s
  class AnimationFade
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # End previous overlay animation from the video. Without AnimationEnd, the
  # overlay object will keep the state of previous animation until the end of
  # the video.
  # @!attribute [rw] start_time_offset
  #   @return [::Google::Protobuf::Duration]
  #     The time to end overlay object, in seconds. Default: 0
  class AnimationEnd
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Animation types.
  # @!attribute [rw] animation_static
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::AnimationStatic]
  #     Display static overlay object.
  # @!attribute [rw] animation_fade
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::AnimationFade]
  #     Display overlay object with fade animation.
  # @!attribute [rw] animation_end
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::AnimationEnd]
  #     End previous animation.
  class Animation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Fade type for the overlay: `FADE_IN` or `FADE_OUT`.
  module FadeType
    # The fade type is not specified.
    FADE_TYPE_UNSPECIFIED = 0

    # Fade the overlay object into view.
    FADE_IN = 1

    # Fade the overlay object out of view.
    FADE_OUT = 2
  end
end

#image ⇒ ::Google::Cloud::Video::Transcoder::V1::Overlay::Image

Returns Image overlay.

Returns:



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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'proto_docs/google/cloud/video/transcoder/v1/resources.rb', line 507

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

  # 2D normalized coordinates. Default: `{0.0, 0.0}`
  # @!attribute [rw] x
  #   @return [::Float]
  #     Normalized x coordinate.
  # @!attribute [rw] y
  #   @return [::Float]
  #     Normalized y coordinate.
  class NormalizedCoordinate
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overlaid image.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. URI of the image in Cloud Storage. For example,
  #     `gs://bucket/inputs/image.png`. Only PNG and JPEG images are supported.
  # @!attribute [rw] resolution
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::NormalizedCoordinate]
  #     Normalized image resolution, based on output video resolution. Valid
  #     values: `0.0`–`1.0`. To respect the original image aspect ratio, set
  #     either `x` or `y` to `0.0`. To use the original image resolution, set
  #     both `x` and `y` to `0.0`.
  # @!attribute [rw] alpha
  #   @return [::Float]
  #     Target image opacity. Valid values are from  `1.0` (solid, default) to
  #     `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
  class Image
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Display static overlay object.
  # @!attribute [rw] xy
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::NormalizedCoordinate]
  #     Normalized coordinates based on output video resolution. Valid
  #     values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay
  #     object. For example, use the x and y coordinates \\{0,0} to position the
  #     top-left corner of the overlay animation in the top-left corner of the
  #     output video.
  # @!attribute [rw] start_time_offset
  #   @return [::Google::Protobuf::Duration]
  #     The time to start displaying the overlay object, in seconds. Default: 0
  class AnimationStatic
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Display overlay object with fade animation.
  # @!attribute [rw] fade_type
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::FadeType]
  #     Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
  # @!attribute [rw] xy
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::NormalizedCoordinate]
  #     Normalized coordinates based on output video resolution. Valid
  #     values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay
  #     object. For example, use the x and y coordinates \\{0,0} to position the
  #     top-left corner of the overlay animation in the top-left corner of the
  #     output video.
  # @!attribute [rw] start_time_offset
  #   @return [::Google::Protobuf::Duration]
  #     The time to start the fade animation, in seconds. Default: 0
  # @!attribute [rw] end_time_offset
  #   @return [::Google::Protobuf::Duration]
  #     The time to end the fade animation, in seconds. Default:
  #     `start_time_offset` + 1s
  class AnimationFade
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # End previous overlay animation from the video. Without AnimationEnd, the
  # overlay object will keep the state of previous animation until the end of
  # the video.
  # @!attribute [rw] start_time_offset
  #   @return [::Google::Protobuf::Duration]
  #     The time to end overlay object, in seconds. Default: 0
  class AnimationEnd
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Animation types.
  # @!attribute [rw] animation_static
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::AnimationStatic]
  #     Display static overlay object.
  # @!attribute [rw] animation_fade
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::AnimationFade]
  #     Display overlay object with fade animation.
  # @!attribute [rw] animation_end
  #   @return [::Google::Cloud::Video::Transcoder::V1::Overlay::AnimationEnd]
  #     End previous animation.
  class Animation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Fade type for the overlay: `FADE_IN` or `FADE_OUT`.
  module FadeType
    # The fade type is not specified.
    FADE_TYPE_UNSPECIFIED = 0

    # Fade the overlay object into view.
    FADE_IN = 1

    # Fade the overlay object out of view.
    FADE_OUT = 2
  end
end