Class: Azure::MediaServices::Mgmt::V2018_07_01::Models::Image

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

Overview

Describes the basic properties for generating thumbnails from the input video

Direct Known Subclasses

JpgImage, PngImage

Instance Attribute Summary collapse

Attributes inherited from Video

#key_frame_interval, #stretch_mode

Attributes inherited from Codec

#label

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Image

Returns a new instance of Image.



17
18
19
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/image.rb', line 17

def initialize
  @odatatype = "#Microsoft.Media.Image"
end

Instance Attribute Details

#odatatype ⇒ Object

Returns the value of attribute odatatype.



21
22
23
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/image.rb', line 21

def odatatype
  @odatatype
end

#range ⇒ String

generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%).

Returns:

  • (String) —

    The position in the input video at which to stop



42
43
44
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/image.rb', line 42

def range
  @range
end

#start ⇒ String

generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a relative value (For example, 1%). Also supports a macro Best, which tells the encoder to select the best thumbnail from the first few seconds of the video.

Returns:

  • (String) —

    The position in the input video from where to start



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

def start
  @start
end

#step ⇒ String

value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every 30 frames), or a relative value (For example, 1%).

Returns:

  • (String) —

    The intervals at which thumbnails are generated. The



35
36
37
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/image.rb', line 35

def step
  @step
end

Class Method Details

.mapper ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/image.rb', line 49

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: '#Microsoft.Media.Image',
    type: {
      name: 'Composite',
      class_name: 'Image',
      model_properties: {
        label: {
          client_side_validation: true,
          required: false,
          serialized_name: 'label',
          type: {
            name: 'String'
          }
        },
        odatatype: {
          client_side_validation: true,
          required: true,
          serialized_name: '@odata\\.type',
          type: {
            name: 'String'
          }
        },
        key_frame_interval: {
          client_side_validation: true,
          required: false,
          serialized_name: 'keyFrameInterval',
          type: {
            name: 'TimeSpan'
          }
        },
        stretch_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'stretchMode',
          type: {
            name: 'String'
          }
        },
        start: {
          client_side_validation: true,
          required: true,
          serialized_name: 'start',
          type: {
            name: 'String'
          }
        },
        step: {
          client_side_validation: true,
          required: false,
          serialized_name: 'step',
          type: {
            name: 'String'
          }
        },
        range: {
          client_side_validation: true,
          required: false,
          serialized_name: 'range',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end