← Back to branch summary

~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.AVFoundation/AVAssetWriterInputPixelBufferAdaptor.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/monomac/docs/en/MonoMac.AVFoundation/AVAssetWriterInputPixelBufferAdaptor.xml
 
1
<Type Name="AVAssetWriterInputPixelBufferAdaptor" FullName="MonoMac.AVFoundation.AVAssetWriterInputPixelBufferAdaptor">
 
2
  <TypeSignature Language="C#" Value="public class AVAssetWriterInputPixelBufferAdaptor : MonoMac.Foundation.NSObject" />
 
3
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AVAssetWriterInputPixelBufferAdaptor extends MonoMac.Foundation.NSObject" />
 
4
  <AssemblyInfo>
 
5
    <AssemblyName>MonoMac</AssemblyName>
 
6
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
7
  </AssemblyInfo>
 
8
  <Base>
 
9
    <BaseTypeName>MonoMac.Foundation.NSObject</BaseTypeName>
 
10
  </Base>
 
11
  <Interfaces />
 
12
  <Attributes>
 
13
    <Attribute>
 
14
      <AttributeName>MonoMac.Foundation.Register("AVAssetWriterInputPixelBufferAdaptor", true)</AttributeName>
 
15
    </Attribute>
 
16
  </Attributes>
 
17
  <Docs>
 
18
    <summary>To be added.</summary>
 
19
    <remarks>To be added.</remarks>
 
20
  </Docs>
 
21
  <Members>
 
22
    <Member MemberName=".ctor">
 
23
      <MemberSignature Language="C#" Value="public AVAssetWriterInputPixelBufferAdaptor (MonoMac.Foundation.NSCoder coder);" />
 
24
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class MonoMac.Foundation.NSCoder coder) cil managed" />
 
25
      <MemberType>Constructor</MemberType>
 
26
      <AssemblyInfo>
 
27
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
28
      </AssemblyInfo>
 
29
      <Attributes>
 
30
        <Attribute>
 
31
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
 
32
        </Attribute>
 
33
        <Attribute>
 
34
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
35
        </Attribute>
 
36
      </Attributes>
 
37
      <Parameters>
 
38
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
 
39
      </Parameters>
 
40
      <Docs>
 
41
        <param name="coder">The unarchiver object.</param>
 
42
        <summary>A constructor that initializes the object from the data stored in the unarchiver object.</summary>
 
43
        <remarks>This constructor is provided to allow the class to be initialized from an unarchiver (for example, during NIB deserialization).</remarks>
 
44
      </Docs>
 
45
    </Member>
 
46
    <Member MemberName=".ctor">
 
47
      <MemberSignature Language="C#" Value="public AVAssetWriterInputPixelBufferAdaptor (MonoMac.Foundation.NSObjectFlag t);" />
 
48
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class MonoMac.Foundation.NSObjectFlag t) cil managed" />
 
49
      <MemberType>Constructor</MemberType>
 
50
      <AssemblyInfo>
 
51
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
52
      </AssemblyInfo>
 
53
      <Attributes>
 
54
        <Attribute>
 
55
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
56
        </Attribute>
 
57
      </Attributes>
 
58
      <Parameters>
 
59
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
 
60
      </Parameters>
 
61
      <Docs>
 
62
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
 
63
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
 
64
        <remarks>
 
65
          <para>This constructor should be called by derived classes when they are initialized using an [Export] attribute. The argument value is ignore, typically the chaining would look like this:</para>
 
66
          <example>
 
67
            <code lang="C#">
 
68
public class MyClass : BaseClass {
 
69
    [Export ("initWithFoo:")]
 
70
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
71
    {
 
72
        ...
 
73
    }
 
74
</code>
 
75
          </example>
 
76
        </remarks>
 
77
      </Docs>
 
78
    </Member>
 
79
    <Member MemberName=".ctor">
 
80
      <MemberSignature Language="C#" Value="public AVAssetWriterInputPixelBufferAdaptor (IntPtr handle);" />
 
81
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
 
82
      <MemberType>Constructor</MemberType>
 
83
      <AssemblyInfo>
 
84
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
85
      </AssemblyInfo>
 
86
      <Attributes>
 
87
        <Attribute>
 
88
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
89
        </Attribute>
 
90
      </Attributes>
 
91
      <Parameters>
 
92
        <Parameter Name="handle" Type="System.IntPtr" />
 
93
      </Parameters>
 
94
      <Docs>
 
95
        <param name="handle">Pointer (handle) to the unmanaged object.</param>
 
96
        <summary>A constructor used when creating managed representations of unmanaged objects;  Called by the runtime.</summary>
 
97
        <remarks>
 
98
          <para>This constructor is invoked by the runtime infrastructure (<see cref="M:MonoMac.ObjCRuntime.GetNSObject (System.IntPtr)" />) to create a new managed representation for a pointer to an unmanaged Objective-C object.    You should not invoke this method directly, instead you should call the GetNSObject method as it will prevent two instances of a managed object to point to the same native object.</para>
 
99
        </remarks>
 
100
      </Docs>
 
101
    </Member>
 
102
    <Member MemberName=".ctor">
 
103
      <MemberSignature Language="C#" Value="public AVAssetWriterInputPixelBufferAdaptor (MonoMac.AVFoundation.AVAssetWriterInput input, MonoMac.CoreVideo.CVPixelBufferAttributes attributes);" />
 
104
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class MonoMac.AVFoundation.AVAssetWriterInput input, class MonoMac.CoreVideo.CVPixelBufferAttributes attributes) cil managed" />
 
105
      <MemberType>Constructor</MemberType>
 
106
      <AssemblyInfo>
 
107
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
108
      </AssemblyInfo>
 
109
      <Parameters>
 
110
        <Parameter Name="input" Type="MonoMac.AVFoundation.AVAssetWriterInput" />
 
111
        <Parameter Name="attributes" Type="MonoMac.CoreVideo.CVPixelBufferAttributes" />
 
112
      </Parameters>
 
113
      <Docs>
 
114
        <param name="input">To be added.</param>
 
115
        <param name="attributes">To be added.</param>
 
116
        <summary>To be added.</summary>
 
117
        <remarks>To be added.</remarks>
 
118
      </Docs>
 
119
    </Member>
 
120
    <Member MemberName=".ctor">
 
121
      <MemberSignature Language="C#" Value="public AVAssetWriterInputPixelBufferAdaptor (MonoMac.AVFoundation.AVAssetWriterInput input, MonoMac.Foundation.NSDictionary sourcePixelBufferAttributes);" />
 
122
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class MonoMac.AVFoundation.AVAssetWriterInput input, class MonoMac.Foundation.NSDictionary sourcePixelBufferAttributes) cil managed" />
 
123
      <MemberType>Constructor</MemberType>
 
124
      <AssemblyInfo>
 
125
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
126
      </AssemblyInfo>
 
127
      <Attributes>
 
128
        <Attribute>
 
129
          <AttributeName>MonoMac.Foundation.Export("initWithAssetWriterInput:sourcePixelBufferAttributes:")</AttributeName>
 
130
        </Attribute>
 
131
      </Attributes>
 
132
      <Parameters>
 
133
        <Parameter Name="input" Type="MonoMac.AVFoundation.AVAssetWriterInput" />
 
134
        <Parameter Name="sourcePixelBufferAttributes" Type="MonoMac.Foundation.NSDictionary" />
 
135
      </Parameters>
 
136
      <Docs>
 
137
        <param name="input">To be added.</param>
 
138
        <param name="sourcePixelBufferAttributes">
 
139
          <para>The dictionary should contain configuration
 
140
          information using keys from the <see cref="MonoMac.CoreVideo&gt;CVPixelBuffer" /> class.</para>
 
141
          <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
 
142
        </param>
 
143
        <summary>To be added.</summary>
 
144
        <remarks>To be added.</remarks>
 
145
      </Docs>
 
146
    </Member>
 
147
    <Member MemberName="AppendPixelBufferWithPresentationTime">
 
148
      <MemberSignature Language="C#" Value="public virtual bool AppendPixelBufferWithPresentationTime (MonoMac.CoreVideo.CVPixelBuffer pixelBuffer, MonoMac.CoreMedia.CMTime presentationTime);" />
 
149
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool AppendPixelBufferWithPresentationTime(class MonoMac.CoreVideo.CVPixelBuffer pixelBuffer, valuetype MonoMac.CoreMedia.CMTime presentationTime) cil managed" />
 
150
      <MemberType>Method</MemberType>
 
151
      <AssemblyInfo>
 
152
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
153
      </AssemblyInfo>
 
154
      <Attributes>
 
155
        <Attribute>
 
156
          <AttributeName>MonoMac.Foundation.Export("appendPixelBuffer:withPresentationTime:")</AttributeName>
 
157
        </Attribute>
 
158
      </Attributes>
 
159
      <ReturnValue>
 
160
        <ReturnType>System.Boolean</ReturnType>
 
161
      </ReturnValue>
 
162
      <Parameters>
 
163
        <Parameter Name="pixelBuffer" Type="MonoMac.CoreVideo.CVPixelBuffer" />
 
164
        <Parameter Name="presentationTime" Type="MonoMac.CoreMedia.CMTime" />
 
165
      </Parameters>
 
166
      <Docs>
 
167
        <param name="pixelBuffer">To be added.</param>
 
168
        <param name="presentationTime">To be added.</param>
 
169
        <summary>To be added.</summary>
 
170
        <returns>To be added.</returns>
 
171
        <remarks>To be added.</remarks>
 
172
      </Docs>
 
173
    </Member>
 
174
    <Member MemberName="AssetWriterInput">
 
175
      <MemberSignature Language="C#" Value="public virtual MonoMac.AVFoundation.AVAssetWriterInput AssetWriterInput { get; }" />
 
176
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.AVFoundation.AVAssetWriterInput AssetWriterInput" />
 
177
      <MemberType>Property</MemberType>
 
178
      <AssemblyInfo>
 
179
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
180
      </AssemblyInfo>
 
181
      <Attributes>
 
182
        <Attribute>
 
183
          <AttributeName>get: MonoMac.Foundation.Export("assetWriterInput")</AttributeName>
 
184
        </Attribute>
 
185
      </Attributes>
 
186
      <ReturnValue>
 
187
        <ReturnType>MonoMac.AVFoundation.AVAssetWriterInput</ReturnType>
 
188
      </ReturnValue>
 
189
      <Docs>
 
190
        <summary>To be added.</summary>
 
191
        <value>To be added.</value>
 
192
        <remarks>To be added.</remarks>
 
193
      </Docs>
 
194
    </Member>
 
195
    <Member MemberName="Attributes">
 
196
      <MemberSignature Language="C#" Value="public MonoMac.CoreVideo.CVPixelBufferAttributes Attributes { get; }" />
 
197
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.CoreVideo.CVPixelBufferAttributes Attributes" />
 
198
      <MemberType>Property</MemberType>
 
199
      <AssemblyInfo>
 
200
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
201
      </AssemblyInfo>
 
202
      <ReturnValue>
 
203
        <ReturnType>MonoMac.CoreVideo.CVPixelBufferAttributes</ReturnType>
 
204
      </ReturnValue>
 
205
      <Docs>
 
206
        <summary>To be added.</summary>
 
207
        <value>To be added.</value>
 
208
        <remarks>To be added.</remarks>
 
209
      </Docs>
 
210
    </Member>
 
211
    <Member MemberName="ClassHandle">
 
212
      <MemberSignature Language="C#" Value="public override IntPtr ClassHandle { get; }" />
 
213
      <MemberSignature Language="ILAsm" Value=".property instance native int ClassHandle" />
 
214
      <MemberType>Property</MemberType>
 
215
      <AssemblyInfo>
 
216
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
217
      </AssemblyInfo>
 
218
      <ReturnValue>
 
219
        <ReturnType>System.IntPtr</ReturnType>
 
220
      </ReturnValue>
 
221
      <Docs>
 
222
        <summary>The handle for this class.</summary>
 
223
        <value>The pointer to the Objective-C class.</value>
 
224
        <remarks>Each MonoMac class mirrors an unmanaged Objective-C class.   This value contains the pointer to the Objective-C class, it is similar to calling objc_getClass with the object name.</remarks>
 
225
      </Docs>
 
226
    </Member>
 
227
    <Member MemberName="Create">
 
228
      <MemberSignature Language="C#" Value="public static MonoMac.AVFoundation.AVAssetWriterInputPixelBufferAdaptor Create (MonoMac.AVFoundation.AVAssetWriterInput input, MonoMac.CoreVideo.CVPixelBufferAttributes attributes);" />
 
229
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.AVFoundation.AVAssetWriterInputPixelBufferAdaptor Create(class MonoMac.AVFoundation.AVAssetWriterInput input, class MonoMac.CoreVideo.CVPixelBufferAttributes attributes) cil managed" />
 
230
      <MemberType>Method</MemberType>
 
231
      <AssemblyInfo>
 
232
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
233
      </AssemblyInfo>
 
234
      <ReturnValue>
 
235
        <ReturnType>MonoMac.AVFoundation.AVAssetWriterInputPixelBufferAdaptor</ReturnType>
 
236
      </ReturnValue>
 
237
      <Parameters>
 
238
        <Parameter Name="input" Type="MonoMac.AVFoundation.AVAssetWriterInput" />
 
239
        <Parameter Name="attributes" Type="MonoMac.CoreVideo.CVPixelBufferAttributes" />
 
240
      </Parameters>
 
241
      <Docs>
 
242
        <param name="input">To be added.</param>
 
243
        <param name="attributes">To be added.</param>
 
244
        <summary>To be added.</summary>
 
245
        <returns>To be added.</returns>
 
246
        <remarks>To be added.</remarks>
 
247
      </Docs>
 
248
    </Member>
 
249
    <Member MemberName="Dispose">
 
250
      <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
 
251
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
 
252
      <MemberType>Method</MemberType>
 
253
      <AssemblyInfo>
 
254
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
255
      </AssemblyInfo>
 
256
      <ReturnValue>
 
257
        <ReturnType>System.Void</ReturnType>
 
258
      </ReturnValue>
 
259
      <Parameters>
 
260
        <Parameter Name="disposing" Type="System.Boolean" />
 
261
      </Parameters>
 
262
      <Docs>
 
263
        <param name="disposing">
 
264
          <para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources;   If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>
 
265
        </param>
 
266
        <summary>Releases the resources used by the AVAssetWriterInputPixelBufferAdaptor object.</summary>
 
267
        <remarks>
 
268
          <para>This Dispose method releases the resources used by the AVAssetWriterInputPixelBufferAdaptor class.</para>
 
269
          <para>This method is called by both the Dispose() method and the object finalizer (Finalize).    When invoked by the Dispose method, the parameter disposting <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released;  when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>
 
270
          <para>Calling the Dispose method when you are finished using the AVAssetWriterInputPixelBufferAdaptor ensures that all external resources used by this managed object are released as soon as possible.  Once you have invoked the Dispose method, the object is no longer useful and you should no longer make any calls to it.</para>
 
271
          <para>  For more information on how to override this method and on the Dispose/IDisposable pattern, read the ``Implementing a Dispose Method'' document at http://msdn.microsoft.com/en-us/library/fs2xkftw.aspx</para>
 
272
        </remarks>
 
273
      </Docs>
 
274
    </Member>
 
275
    <Member MemberName="FromInput">
 
276
      <MemberSignature Language="C#" Value="public static MonoMac.AVFoundation.AVAssetWriterInputPixelBufferAdaptor FromInput (MonoMac.AVFoundation.AVAssetWriterInput input, MonoMac.Foundation.NSDictionary sourcePixelBufferAttributes);" />
 
277
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.AVFoundation.AVAssetWriterInputPixelBufferAdaptor FromInput(class MonoMac.AVFoundation.AVAssetWriterInput input, class MonoMac.Foundation.NSDictionary sourcePixelBufferAttributes) cil managed" />
 
278
      <MemberType>Method</MemberType>
 
279
      <AssemblyInfo>
 
280
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
281
      </AssemblyInfo>
 
282
      <Attributes>
 
283
        <Attribute>
 
284
          <AttributeName>MonoMac.Foundation.Export("assetWriterInputPixelBufferAdaptorWithAssetWriterInput:sourcePixelBufferAttributes:")</AttributeName>
 
285
        </Attribute>
 
286
        <Attribute>
 
287
          <AttributeName>System.Obsolete("Use Create method", false)</AttributeName>
 
288
        </Attribute>
 
289
      </Attributes>
 
290
      <ReturnValue>
 
291
        <ReturnType>MonoMac.AVFoundation.AVAssetWriterInputPixelBufferAdaptor</ReturnType>
 
292
      </ReturnValue>
 
293
      <Parameters>
 
294
        <Parameter Name="input" Type="MonoMac.AVFoundation.AVAssetWriterInput" />
 
295
        <Parameter Name="sourcePixelBufferAttributes" Type="MonoMac.Foundation.NSDictionary" />
 
296
      </Parameters>
 
297
      <Docs>
 
298
        <param name="input">To be added.</param>
 
299
        <param name="sourcePixelBufferAttributes">
 
300
          <para>The dictionary should contain configuration
 
301
          information using keys from the <see cref="MonoMac.CoreVideo&gt;CVPixelBuffer" /> class.</para>
 
302
          <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
 
303
        </param>
 
304
        <summary>To be added.</summary>
 
305
        <returns>To be added.</returns>
 
306
        <remarks>To be added.</remarks>
 
307
      </Docs>
 
308
    </Member>
 
309
    <Member MemberName="PixelBufferPool">
 
310
      <MemberSignature Language="C#" Value="public virtual MonoMac.CoreVideo.CVPixelBufferPool PixelBufferPool { get; }" />
 
311
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.CoreVideo.CVPixelBufferPool PixelBufferPool" />
 
312
      <MemberType>Property</MemberType>
 
313
      <AssemblyInfo>
 
314
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
315
      </AssemblyInfo>
 
316
      <Attributes>
 
317
        <Attribute>
 
318
          <AttributeName>get: MonoMac.Foundation.Export("pixelBufferPool")</AttributeName>
 
319
        </Attribute>
 
320
      </Attributes>
 
321
      <ReturnValue>
 
322
        <ReturnType>MonoMac.CoreVideo.CVPixelBufferPool</ReturnType>
 
323
      </ReturnValue>
 
324
      <Docs>
 
325
        <summary>To be added.</summary>
 
326
        <value>To be added.</value>
 
327
        <remarks>To be added.</remarks>
 
328
      </Docs>
 
329
    </Member>
 
330
    <Member MemberName="SourcePixelBufferAttributes">
 
331
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSDictionary SourcePixelBufferAttributes { get; }" />
 
332
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.Foundation.NSDictionary SourcePixelBufferAttributes" />
 
333
      <MemberType>Property</MemberType>
 
334
      <AssemblyInfo>
 
335
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
336
      </AssemblyInfo>
 
337
      <Attributes>
 
338
        <Attribute>
 
339
          <AttributeName>get: MonoMac.Foundation.Export("sourcePixelBufferAttributes")</AttributeName>
 
340
        </Attribute>
 
341
      </Attributes>
 
342
      <ReturnValue>
 
343
        <ReturnType>MonoMac.Foundation.NSDictionary</ReturnType>
 
344
      </ReturnValue>
 
345
      <Docs>
 
346
        <summary>To be added.</summary>
 
347
        <value>
 
348
          <para>The dictionary contains configuration
 
349
          information using keys from the <see cref="MonoMac.CoreVideo&gt;CVPixelBuffer" /> class.</para>
 
350
        </value>
 
351
        <remarks>To be added.</remarks>
 
352
      </Docs>
 
353
    </Member>
 
354
  </Members>
 
355
</Type>