Class: Google::Cloud::Video::Transcoder::V1beta1::Overlay

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/transcoder/v1beta1/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::V1beta1::Overlay::Animation>

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

Returns:



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
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 412

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 jpeg image.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. URI of the JPEG image in Cloud Storage. For example,
  #     `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
  # @!attribute [rw] resolution
  #   @return [::Google::Cloud::Video::Transcoder::V1beta1::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::V1beta1::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::V1beta1::Overlay::FadeType]
  #     Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
  # @!attribute [rw] xy
  #   @return [::Google::Cloud::Video::Transcoder::V1beta1::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::V1beta1::Overlay::AnimationStatic]
  #     Display static overlay object.
  # @!attribute [rw] animation_fade
  #   @return [::Google::Cloud::Video::Transcoder::V1beta1::Overlay::AnimationFade]
  #     Display overlay object with fade animation.
  # @!attribute [rw] animation_end
  #   @return [::Google::Cloud::Video::Transcoder::V1beta1::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::V1beta1::Overlay::Image

Returns Image overlay.

Returns:



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
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 412

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 jpeg image.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. URI of the JPEG image in Cloud Storage. For example,
  #     `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
  # @!attribute [rw] resolution
  #   @return [::Google::Cloud::Video::Transcoder::V1beta1::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::V1beta1::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::V1beta1::Overlay::FadeType]
  #     Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
  # @!attribute [rw] xy
  #   @return [::Google::Cloud::Video::Transcoder::V1beta1::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::V1beta1::Overlay::AnimationStatic]
  #     Display static overlay object.
  # @!attribute [rw] animation_fade
  #   @return [::Google::Cloud::Video::Transcoder::V1beta1::Overlay::AnimationFade]
  #     Display overlay object with fade animation.
  # @!attribute [rw] animation_end
  #   @return [::Google::Cloud::Video::Transcoder::V1beta1::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