Class: Azure::MediaServices::Mgmt::V2018_07_01::Models::Overlay

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-07-01/generated/azure_mgmt_media_services/models/overlay.rb

Overview

Base type for all overlays - image, audio or video.

Direct Known Subclasses

AudioOverlay, VideoOverlay

Constant Summary collapse

@@discriminatorMap = 
Hash.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Overlay

Returns a new instance of Overlay.



19
20
21
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/overlay.rb', line 19

def initialize
  @odatatype = "Overlay"
end

Instance Attribute Details

#audio_gain_level ⇒ Float

should be in the range [0, 1.0]. The default is 1.0.

Returns:

  • (Float) —

    The gain level of audio in the overlay. The value



60
61
62
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/overlay.rb', line 60

def audio_gain_level
  @audio_gain_level
end

#end_property ⇒ Duration

ends. The value should be in ISO 8601 duration format. For example, PT30S to end the overlay at 30 seconds in to the input video. If not specified the overlay will be applied until the end of the input video if inputLoop is true. Else, if inputLoop is false, then overlay will last as long as the duration of the overlay media.

Returns:

  • (Duration) —

    The position in the input video at which the overlay



45
46
47
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/overlay.rb', line 45

def end_property
  @end_property
end

#fade_in_duration ⇒ Duration

the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S).

Returns:

  • (Duration) —

    The duration over which the overlay fades in onto



51
52
53
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/overlay.rb', line 51

def fade_in_duration
  @fade_in_duration
end

#fade_out_duration ⇒ Duration

input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S).

Returns:

  • (Duration) —

    The duration over which the overlay fades out of the



56
57
58
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/overlay.rb', line 56

def fade_out_duration
  @fade_out_duration
end

#input_label ⇒ String

overlay. The Input must specify exactly one file. You can specify an image file in JPG or PNG formats, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See aka.ms/mesformats for the complete list of supported audio and video file formats.

Returns:

  • (String) —

    The label of the job input which is to be used as an



30
31
32
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/overlay.rb', line 30

def input_label
  @input_label
end

#odatatype ⇒ Object

Returns the value of attribute odatatype.



23
24
25
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/overlay.rb', line 23

def odatatype
  @odatatype
end

#start ⇒ Duration

video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds in to the input video. If not specified the overlay starts from the beginning of the input video.

Returns:

  • (Duration) —

    The start position, with reference to the input



37
38
39
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/overlay.rb', line 37

def start
  @start
end

Class Method Details

.mapper ⇒ Object

Mapper for Overlay class as Ruby Hash. This will be used for serialization/deserialization.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/overlay.rb', line 67

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Overlay',
    type: {
      name: 'Composite',
      polymorphic_discriminator: '@odata.type',
      uber_parent: 'Overlay',
      class_name: 'Overlay',
      model_properties: {
        input_label: {
          client_side_validation: true,
          required: true,
          serialized_name: 'inputLabel',
          type: {
            name: 'String'
          }
        },
        start: {
          client_side_validation: true,
          required: false,
          serialized_name: 'start',
          type: {
            name: 'TimeSpan'
          }
        },
        end_property: {
          client_side_validation: true,
          required: false,
          serialized_name: 'end',
          type: {
            name: 'TimeSpan'
          }
        },
        fade_in_duration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'fadeInDuration',
          type: {
            name: 'TimeSpan'
          }
        },
        fade_out_duration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'fadeOutDuration',
          type: {
            name: 'TimeSpan'
          }
        },
        audio_gain_level: {
          client_side_validation: true,
          required: false,
          serialized_name: 'audioGainLevel',
          type: {
            name: 'Double'
          }
        }
      }
    }
  }
end