← 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.AudioToolbox/AudioFileStream.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.AudioToolbox/AudioFileStream.xml
23
23
This can be used to parse audio files when you are streaming audio from the network for example.
24
24
</para>
25
25
    </remarks>
 
26
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=26d904c2-c44a-46f2-883a-a01bb5657309">StreamingAudio</related>
26
27
  </Docs>
27
28
  <Members>
28
29
    <Member MemberName=".ctor">
52
53
        <ReturnType>System.Double</ReturnType>
53
54
      </ReturnValue>
54
55
      <Docs>
55
 
        <summary>To be added.</summary>
56
 
        <value>To be added.</value>
57
 
        <remarks>To be added.</remarks>
 
56
        <summary>Average bytes per packet.   This value is precise for audio files with constant bit rates or audio files that have a packet index, otherwise it is a computed average.</summary>
 
57
        <value>
 
58
        </value>
 
59
        <remarks>
 
60
        </remarks>
58
61
      </Docs>
59
62
    </Member>
60
63
    <Member MemberName="BitRate">
189
192
      </ReturnValue>
190
193
      <Parameters />
191
194
      <Docs>
192
 
        <summary>Releases the resourced used by the AudioFileStream object.</summary>
 
195
        <summary>Releases the resources used by the AudioFileStream object.</summary>
193
196
        <remarks>
194
197
          <para>The Dispose method releases the resources used by the AudioFileStream class.</para>
195
198
          <para>Calling the Dispose method when you are finished using the AudioFileStream 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>
213
216
        <param name="disposing">
214
217
          <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>
215
218
        </param>
216
 
        <summary>Releases the resourced used by the AudioFileStream object.</summary>
 
219
        <summary>Releases the resources used by the AudioFileStream object.</summary>
217
220
        <remarks>
218
221
          <para>This Dispose method releases the resources used by the AudioFileStream class.</para>
219
222
          <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>
251
254
      <Parameters />
252
255
      <Docs>
253
256
        <summary>Finalizer for the AudioFileStream object</summary>
254
 
        <remarks></remarks>
 
257
        <remarks>
 
258
        </remarks>
255
259
      </Docs>
256
260
    </Member>
257
261
    <Member MemberName="FrameToPacket">
269
273
        <Parameter Name="frameOffsetInPacket" Type="System.Int32&amp;" RefType="out" />
270
274
      </Parameters>
271
275
      <Docs>
272
 
        <param name="frame">To be added.</param>
273
 
        <param name="frameOffsetInPacket">To be added.</param>
274
 
        <summary>To be added.</summary>
275
 
        <returns>To be added.</returns>
276
 
        <remarks>To be added.</remarks>
 
276
        <param name="frame">The audio frame number.</param>
 
277
        <param name="frameOffsetInPacket">The frame offset in the packet.</param>
 
278
        <summary>Returns the packet number and the frame offset in the packet (on the out parameter) corresponding to the requested audio frame.</summary>
 
279
        <returns>The packet number that corresponds to the specified frame.</returns>
 
280
        <remarks>
 
281
        </remarks>
277
282
      </Docs>
278
283
    </Member>
279
284
    <Member MemberName="GetProperty">