/
JpgImage.xml
225 lines (225 loc) · 14.9 KB
/
JpgImage.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<Type Name="JpgImage" FullName="Microsoft.Azure.Management.Media.Models.JpgImage">
<TypeSignature Language="C#" Value="public class JpgImage : Microsoft.Azure.Management.Media.Models.Image" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JpgImage extends Microsoft.Azure.Management.Media.Models.Image" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.Media.Models.JpgImage" />
<TypeSignature Language="VB.NET" Value="Public Class JpgImage
Inherits Image" />
<TypeSignature Language="F#" Value="type JpgImage = class
 inherit Image" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>3.0.4.0</AssemblyVersion>
<AssemblyVersion>3.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Management.Media.Models.Image</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonObject("#Microsoft.Media.JpgImage")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("#Microsoft.Media.JpgImage")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Describes the properties for producing a series of JPEG images from the
input video.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JpgImage ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Media.Models.JpgImage.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the JpgImage class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JpgImage (string start, string label = default, TimeSpan? keyFrameInterval = default, Microsoft.Azure.Management.Media.Models.StretchMode? stretchMode = default, Microsoft.Azure.Management.Media.Models.VideoSyncMode? syncMode = default, string step = default, string range = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Media.Models.JpgLayer> layers = default, int? spriteColumn = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string start, string label, valuetype System.Nullable`1<valuetype System.TimeSpan> keyFrameInterval, valuetype System.Nullable`1<valuetype Microsoft.Azure.Management.Media.Models.StretchMode> stretchMode, valuetype System.Nullable`1<valuetype Microsoft.Azure.Management.Media.Models.VideoSyncMode> syncMode, string step, string range, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.Media.Models.JpgLayer> layers, valuetype System.Nullable`1<int32> spriteColumn) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Media.Models.JpgImage.#ctor(System.String,System.String,System.Nullable{System.TimeSpan},System.Nullable{Microsoft.Azure.Management.Media.Models.StretchMode},System.Nullable{Microsoft.Azure.Management.Media.Models.VideoSyncMode},System.String,System.String,System.Collections.Generic.IList{Microsoft.Azure.Management.Media.Models.JpgLayer},System.Nullable{System.Int32})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (start As String, Optional label As String = Nothing, Optional keyFrameInterval As Nullable(Of TimeSpan) = Nothing, Optional stretchMode As Nullable(Of StretchMode) = Nothing, Optional syncMode As Nullable(Of VideoSyncMode) = Nothing, Optional step As String = Nothing, Optional range As String = Nothing, Optional layers As IList(Of JpgLayer) = Nothing, Optional spriteColumn As Nullable(Of Integer) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.Media.Models.JpgImage : string * string * Nullable<TimeSpan> * Nullable<Microsoft.Azure.Management.Media.Models.StretchMode> * Nullable<Microsoft.Azure.Management.Media.Models.VideoSyncMode> * string * string * System.Collections.Generic.IList<Microsoft.Azure.Management.Media.Models.JpgLayer> * Nullable<int> -> Microsoft.Azure.Management.Media.Models.JpgImage" Usage="new Microsoft.Azure.Management.Media.Models.JpgImage (start, label, keyFrameInterval, stretchMode, syncMode, step, range, layers, spriteColumn)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="start" Type="System.String" />
<Parameter Name="label" Type="System.String" />
<Parameter Name="keyFrameInterval" Type="System.Nullable<System.TimeSpan>" />
<Parameter Name="stretchMode" Type="System.Nullable<Microsoft.Azure.Management.Media.Models.StretchMode>" />
<Parameter Name="syncMode" Type="System.Nullable<Microsoft.Azure.Management.Media.Models.VideoSyncMode>" />
<Parameter Name="step" Type="System.String" />
<Parameter Name="range" Type="System.String" />
<Parameter Name="layers" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.Media.Models.JpgLayer>" />
<Parameter Name="spriteColumn" Type="System.Nullable<System.Int32>" />
</Parameters>
<Docs>
<param name="start">The position in the input video from where to
start generating thumbnails. The value can be in ISO 8601 format
(For example, PT05S to start at 5 seconds), or a frame count (For
example, 10 to start at the 10th frame), or a relative value to
stream duration (For example, 10% to start at 10% of stream
duration). Also supports a macro {Best}, which tells the encoder to
select the best thumbnail from the first few seconds of the video
and will only produce one thumbnail, no matter what other settings
are for Step and Range. The default value is macro {Best}.</param>
<param name="label">An optional label for the codec. The label can
be used to control muxing behavior.</param>
<param name="keyFrameInterval">The distance between two key frames.
The value should be non-zero in the range [0.5, 20] seconds,
specified in ISO 8601 format. The default is 2 seconds(PT2S). Note
that this setting is ignored if VideoSyncMode.Passthrough is set,
where the KeyFrameInterval value will follow the input source
setting.</param>
<param name="stretchMode">The resizing mode - how the input video
will be resized to fit the desired output resolution(s). Default is
AutoSize. Possible values include: 'None', 'AutoSize',
'AutoFit'</param>
<param name="syncMode">The Video Sync Mode. Possible values
include: 'Auto', 'Passthrough', 'Cfr', 'Vfr'</param>
<param name="step">The intervals at which thumbnails are generated.
The value can be in ISO 8601 format (For example, PT05S for one
image every 5 seconds), or a frame count (For example, 30 for one
image every 30 frames), or a relative value to stream duration (For
example, 10% for one image every 10% of stream duration). Note:
Step value will affect the first generated thumbnail, which may not
be exactly the one specified at transform preset start time. This
is due to the encoder, which tries to select the best thumbnail
between start time and Step position from start time as the first
output. As the default value is 10%, it means if stream has long
duration, the first generated thumbnail might be far away from the
one specified at start time. Try to select reasonable value for
Step if the first thumbnail is expected close to start time, or set
Range value at 1 if only one thumbnail is needed at start
time.</param>
<param name="range">The position relative to transform preset start
time in the input video at which to stop generating thumbnails. The
value can be in ISO 8601 format (For example, PT5M30S to stop at 5
minutes and 30 seconds from start time), or a frame count (For
example, 300 to stop at the 300th frame from the frame at start
time. If this value is 1, it means only producing one thumbnail at
start time), or a relative value to the stream duration (For
example, 50% to stop at half of stream duration from start time).
The default value is 100%, which means to stop at the end of the
stream.</param>
<param name="layers">A collection of output JPEG image layers to be
produced by the encoder.</param>
<param name="spriteColumn">Sets the number of columns used in
thumbnail sprite image. The number of rows are automatically
calculated and a VTT file is generated with the coordinate mappings
for each thumbnail in the sprite. Note: this value should be a
positive integer and a proper value is recommended so that the
output image resolution will not go beyond JPEG maximum pixel
resolution limit 65535x65535.</param>
<summary>
Initializes a new instance of the JpgImage class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Layers">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.Media.Models.JpgLayer> Layers { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.Media.Models.JpgLayer> Layers" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.JpgImage.Layers" />
<MemberSignature Language="VB.NET" Value="Public Property Layers As IList(Of JpgLayer)" />
<MemberSignature Language="F#" Value="member this.Layers : System.Collections.Generic.IList<Microsoft.Azure.Management.Media.Models.JpgLayer> with get, set" Usage="Microsoft.Azure.Management.Media.Models.JpgImage.Layers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="layers")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="layers")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.Media.Models.JpgLayer></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a collection of output JPEG image layers to be
produced by the encoder.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SpriteColumn">
<MemberSignature Language="C#" Value="public int? SpriteColumn { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> SpriteColumn" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.JpgImage.SpriteColumn" />
<MemberSignature Language="VB.NET" Value="Public Property SpriteColumn As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.SpriteColumn : Nullable<int> with get, set" Usage="Microsoft.Azure.Management.Media.Models.JpgImage.SpriteColumn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="spriteColumn")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="spriteColumn")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets sets the number of columns used in thumbnail sprite
image. The number of rows are automatically calculated and a VTT
file is generated with the coordinate mappings for each thumbnail
in the sprite. Note: this value should be a positive integer and a
proper value is recommended so that the output image resolution
will not go beyond JPEG maximum pixel resolution limit 65535x65535.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public override void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Media.Models.JpgImage.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="jpgImage.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>