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

<para>Calling the Dispose method when you are finished using the AudioFile 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>

294

310

295

311

<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>

296

312

</param>

297

<summary>Releases the resourced used by the AudioFile object.</summary>

313

<summary>Releases the resources used by the AudioFile object.</summary>

298

314

299

315

<para>This Dispose method releases the resources used by the AudioFile class.</para>

300

316

<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>

898

914

899

915

</Parameters>

900

916

<Docs>

901

<param name="inStartingPacket">To be added.</param>

902

<param name="nPackets">To be added.</param>

903

<param name="buffer">To be added.</param>

904

<summary>To be added.</summary>

905

<returns>To be added.</returns>

906

<remarks>To be added.</remarks>

917

<param name="inStartingPacket">The index of the first packet to read.</param>

918

<param name="nPackets">The number of packets to read.</param>

919

<param name="buffer">The output buffer where packets are written.</param>

920

<summary>Reads packets of audio data from an audio file.</summary>

921

<returns>Array of packet descriptors for the packets that were read.</returns>

922

923

</remarks>

924

</Docs>

925

</Member>

926

927

928

929

<MemberType>Method</MemberType>

930

931

932

</AssemblyInfo>

933

934

<ReturnType>MonoMac.AudioToolbox.AudioStreamPacketDescription[]</ReturnType>

935

</ReturnValue>

936

937

938

939

940

941

942

</Parameters>

943

<Docs>

944

<param name="useCache">If the data should be cached.</param>

945

<param name="inStartingPacket">The index of the first packet to read.</param>

946

<param name="nPackets">The number of packets to read.</param>

947

<param name="buffer">The output buffer where packets are written.</param>

948

<param name="count">On input the size of the output buffer (in bytes), upon return the actual number of bytes read.</param>

949

<summary>Reads packets of audio data from an audio file.</summary>

950

<returns>Array of packet descriptors for the packets that were read.</returns>

951

952

</remarks>

907

953

</Docs>

908

954

</Member>

909

955

925

971

926

972

</Parameters>

927

973

<Docs>

928

<param name="useCache">To be added.</param>

929

<param name="inStartingPacket">To be added.</param>

930

<param name="nPackets">To be added.</param>

931

<param name="buffer">To be added.</param>

932

<param name="offset">To be added.</param>

933

<param name="count">To be added.</param>

934

<summary>To be added.</summary>

935

<returns>To be added.</returns>

936

<remarks>To be added.</remarks>

974

<param name="useCache">If the data should be cached.</param>

975

<param name="inStartingPacket">The index of the first packet to read.</param>

976

<param name="nPackets">The number of packets to read.</param>

977

<param name="buffer">The output buffer where packets are written.</param>

978

<param name="offset">The offset in the output buffer where to start writing packets to.</param>

979

<param name="count">The size of the output buffer (in bytes).</param>

980

<summary>Reads packets of audio data from an audio file.</summary>

981

<returns>Array of packet descriptors for the packets that were read.</returns>

982

983

</remarks>

984

</Docs>

985

</Member>

986

987

988

989

<MemberType>Method</MemberType>

990

991

992

</AssemblyInfo>

993

994

<ReturnType>MonoMac.AudioToolbox.AudioStreamPacketDescription[]</ReturnType>

995

</ReturnValue>

996

997

998

999

1000

1001

1002

1003

</Parameters>

1004

<Docs>

1005

<param name="useCache">If the data should be cached.</param>

1006

<param name="inStartingPacket">The index of the first packet to read.</param>

1007

<param name="nPackets">On input the number of packets to read, upon return the number of packets actually read.</param>

1008

<param name="buffer">The output buffer where packets are written.</param>

1009

<param name="offset">The offset in the output buffer where to start writing packets to.</param>

1010

<param name="count">On input the size of the output buffer (in bytes), upon return the actual number of bytes read.</param>

1011

<summary>Reads packets of audio data from an audio file.</summary>

1012

<returns>Array of packet descriptors for the packets that were read.</returns>

1013

1014

</remarks>

937

1015

</Docs>

938

1016

</Member>

939

1017

Older »