← 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.CoreMedia/CMSampleBuffer.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.CoreMedia/CMSampleBuffer.xml
24
24
  <Docs>
25
25
    <summary>To be added.</summary>
26
26
    <remarks>To be added.</remarks>
 
27
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=9fa28988-64fe-4365-b2b7-95542daf4f9b">avcaptureframes</related>
27
28
  </Docs>
28
29
  <Members>
 
30
    <Member MemberName="CreateForImageBuffer">
 
31
      <MemberSignature Language="C#" Value="public static MonoMac.CoreMedia.CMSampleBuffer CreateForImageBuffer (MonoMac.CoreVideo.CVImageBuffer imageBuffer, bool dataReady, MonoMac.CoreMedia.CMVideoFormatDescription formatDescription, MonoMac.CoreMedia.CMSampleTimingInfo sampleTiming, out MonoMac.CoreMedia.CMSampleBufferError error);" />
 
32
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.CoreMedia.CMSampleBuffer CreateForImageBuffer(class MonoMac.CoreVideo.CVImageBuffer imageBuffer, bool dataReady, class MonoMac.CoreMedia.CMVideoFormatDescription formatDescription, valuetype MonoMac.CoreMedia.CMSampleTimingInfo sampleTiming, valuetype MonoMac.CoreMedia.CMSampleBufferError error) cil managed" />
 
33
      <MemberType>Method</MemberType>
 
34
      <AssemblyInfo>
 
35
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
36
      </AssemblyInfo>
 
37
      <ReturnValue>
 
38
        <ReturnType>MonoMac.CoreMedia.CMSampleBuffer</ReturnType>
 
39
      </ReturnValue>
 
40
      <Parameters>
 
41
        <Parameter Name="imageBuffer" Type="MonoMac.CoreVideo.CVImageBuffer" />
 
42
        <Parameter Name="dataReady" Type="System.Boolean" />
 
43
        <Parameter Name="formatDescription" Type="MonoMac.CoreMedia.CMVideoFormatDescription" />
 
44
        <Parameter Name="sampleTiming" Type="MonoMac.CoreMedia.CMSampleTimingInfo" />
 
45
        <Parameter Name="error" Type="MonoMac.CoreMedia.CMSampleBufferError&amp;" RefType="out" />
 
46
      </Parameters>
 
47
      <Docs>
 
48
        <param name="imageBuffer">To be added.</param>
 
49
        <param name="dataReady">To be added.</param>
 
50
        <param name="formatDescription">To be added.</param>
 
51
        <param name="sampleTiming">To be added.</param>
 
52
        <param name="error">To be added.</param>
 
53
        <summary>To be added.</summary>
 
54
        <returns>To be added.</returns>
 
55
        <remarks>To be added.</remarks>
 
56
      </Docs>
 
57
    </Member>
 
58
    <Member MemberName="CreateWithPacketDescriptions">
 
59
      <MemberSignature Language="C#" Value="public static MonoMac.CoreMedia.CMSampleBuffer CreateWithPacketDescriptions (MonoMac.CoreMedia.CMBlockBuffer dataBuffer, MonoMac.CoreMedia.CMFormatDescription formatDescription, int samplesCount, MonoMac.CoreMedia.CMTime sampleTimestamp, MonoMac.AudioToolbox.AudioStreamPacketDescription[] packetDescriptions, out MonoMac.CoreMedia.CMSampleBufferError error);" />
 
60
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.CoreMedia.CMSampleBuffer CreateWithPacketDescriptions(class MonoMac.CoreMedia.CMBlockBuffer dataBuffer, class MonoMac.CoreMedia.CMFormatDescription formatDescription, int32 samplesCount, valuetype MonoMac.CoreMedia.CMTime sampleTimestamp, valuetype MonoMac.AudioToolbox.AudioStreamPacketDescription[] packetDescriptions, valuetype MonoMac.CoreMedia.CMSampleBufferError error) cil managed" />
 
61
      <MemberType>Method</MemberType>
 
62
      <AssemblyInfo>
 
63
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
64
      </AssemblyInfo>
 
65
      <ReturnValue>
 
66
        <ReturnType>MonoMac.CoreMedia.CMSampleBuffer</ReturnType>
 
67
      </ReturnValue>
 
68
      <Parameters>
 
69
        <Parameter Name="dataBuffer" Type="MonoMac.CoreMedia.CMBlockBuffer" />
 
70
        <Parameter Name="formatDescription" Type="MonoMac.CoreMedia.CMFormatDescription" />
 
71
        <Parameter Name="samplesCount" Type="System.Int32" />
 
72
        <Parameter Name="sampleTimestamp" Type="MonoMac.CoreMedia.CMTime" />
 
73
        <Parameter Name="packetDescriptions" Type="MonoMac.AudioToolbox.AudioStreamPacketDescription[]" />
 
74
        <Parameter Name="error" Type="MonoMac.CoreMedia.CMSampleBufferError&amp;" RefType="out" />
 
75
      </Parameters>
 
76
      <Docs>
 
77
        <param name="dataBuffer">To be added.</param>
 
78
        <param name="formatDescription">To be added.</param>
 
79
        <param name="samplesCount">To be added.</param>
 
80
        <param name="sampleTimestamp">To be added.</param>
 
81
        <param name="packetDescriptions">To be added.</param>
 
82
        <param name="error">To be added.</param>
 
83
        <summary>To be added.</summary>
 
84
        <returns>To be added.</returns>
 
85
        <remarks>To be added.</remarks>
 
86
      </Docs>
 
87
    </Member>
29
88
    <Member MemberName="DataIsReady">
30
89
      <MemberSignature Language="C#" Value="public bool DataIsReady { get; }" />
31
90
      <MemberSignature Language="ILAsm" Value=".property instance bool DataIsReady" />
70
129
      </ReturnValue>
71
130
      <Parameters />
72
131
      <Docs>
73
 
        <summary>Releases the resourced used by the CMSampleBuffer object.</summary>
 
132
        <summary>Releases the resources used by the CMSampleBuffer object.</summary>
74
133
        <remarks>
75
134
          <para>The Dispose method releases the resources used by the CMSampleBuffer class.</para>
76
135
          <para>Calling the Dispose method when you are finished using the CMSampleBuffer 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.  For more information on releasing resources see ``Cleaning up Unmananaged Resources'' at http://msdn.microsoft.com/en-us/library/498928w2.aspx</para>
94
153
        <param name="disposing">
95
154
          <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>
96
155
        </param>
97
 
        <summary>Releases the resourced used by the CMSampleBuffer object.</summary>
 
156
        <summary>Releases the resources used by the CMSampleBuffer object.</summary>
98
157
        <remarks>
99
158
          <para>This Dispose method releases the resources used by the CMSampleBuffer class.</para>
100
159
          <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>
136
195
        </remarks>
137
196
      </Docs>
138
197
    </Member>
 
198
    <Member MemberName="GetAudioFormatDescription">
 
199
      <MemberSignature Language="C#" Value="public MonoMac.CoreMedia.CMAudioFormatDescription GetAudioFormatDescription ();" />
 
200
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class MonoMac.CoreMedia.CMAudioFormatDescription GetAudioFormatDescription() cil managed" />
 
201
      <MemberType>Method</MemberType>
 
202
      <AssemblyInfo>
 
203
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
204
      </AssemblyInfo>
 
205
      <ReturnValue>
 
206
        <ReturnType>MonoMac.CoreMedia.CMAudioFormatDescription</ReturnType>
 
207
      </ReturnValue>
 
208
      <Parameters />
 
209
      <Docs>
 
210
        <summary>To be added.</summary>
 
211
        <returns>To be added.</returns>
 
212
        <remarks>To be added.</remarks>
 
213
      </Docs>
 
214
    </Member>
139
215
    <Member MemberName="GetDataBuffer">
140
216
      <MemberSignature Language="C#" Value="public MonoMac.CoreMedia.CMBlockBuffer GetDataBuffer ();" />
141
217
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class MonoMac.CoreMedia.CMBlockBuffer GetDataBuffer() cil managed" />
160
236
      <AssemblyInfo>
161
237
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
162
238
      </AssemblyInfo>
 
239
      <Attributes>
 
240
        <Attribute>
 
241
          <AttributeName>System.Obsolete("Use GetAudioFormatDescription or GetVideoFormatDescription")</AttributeName>
 
242
        </Attribute>
 
243
      </Attributes>
163
244
      <ReturnValue>
164
245
        <ReturnType>MonoMac.CoreMedia.CMFormatDescription</ReturnType>
165
246
      </ReturnValue>
188
269
      </Docs>
189
270
    </Member>
190
271
    <Member MemberName="GetSampleAttachments">
191
 
      <MemberSignature Language="C#" Value="public MonoMac.Foundation.NSMutableDictionary[] GetSampleAttachments (bool createIfNecessary);" />
192
 
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class MonoMac.Foundation.NSMutableDictionary[] GetSampleAttachments(bool createIfNecessary) cil managed" />
 
272
      <MemberSignature Language="C#" Value="public MonoMac.CoreMedia.CMSampleBufferAttachmentSettings[] GetSampleAttachments (bool createIfNecessary);" />
 
273
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class MonoMac.CoreMedia.CMSampleBufferAttachmentSettings[] GetSampleAttachments(bool createIfNecessary) cil managed" />
193
274
      <MemberType>Method</MemberType>
194
275
      <AssemblyInfo>
195
276
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
196
277
      </AssemblyInfo>
197
278
      <ReturnValue>
198
 
        <ReturnType>MonoMac.Foundation.NSMutableDictionary[]</ReturnType>
 
279
        <ReturnType>MonoMac.CoreMedia.CMSampleBufferAttachmentSettings[]</ReturnType>
199
280
      </ReturnValue>
200
281
      <Parameters>
201
282
        <Parameter Name="createIfNecessary" Type="System.Boolean" />
244
325
        <remarks>To be added.</remarks>
245
326
      </Docs>
246
327
    </Member>
 
328
    <Member MemberName="GetVideoFormatDescription">
 
329
      <MemberSignature Language="C#" Value="public MonoMac.CoreMedia.CMVideoFormatDescription GetVideoFormatDescription ();" />
 
330
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class MonoMac.CoreMedia.CMVideoFormatDescription GetVideoFormatDescription() cil managed" />
 
331
      <MemberType>Method</MemberType>
 
332
      <AssemblyInfo>
 
333
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
334
      </AssemblyInfo>
 
335
      <ReturnValue>
 
336
        <ReturnType>MonoMac.CoreMedia.CMVideoFormatDescription</ReturnType>
 
337
      </ReturnValue>
 
338
      <Parameters />
 
339
      <Docs>
 
340
        <summary>To be added.</summary>
 
341
        <returns>To be added.</returns>
 
342
        <remarks>To be added.</remarks>
 
343
      </Docs>
 
344
    </Member>
247
345
    <Member MemberName="Handle">
248
346
      <MemberSignature Language="C#" Value="public IntPtr Handle { get; }" />
249
347
      <MemberSignature Language="ILAsm" Value=".property instance native int Handle" />