← 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/SystemSound.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/SystemSound.xml
37
37
        <remarks>The system sounds are limited to 30 seconds or less.   If there is an error, this constructor will throw an exception.   If you want to avoid exceptions, and instead get a null on error, call the FromFile methods.</remarks>
38
38
      </Docs>
39
39
    </Member>
 
40
    <Member MemberName="AddSystemSoundCompletion">
 
41
      <MemberSignature Language="C#" Value="public MonoMac.AudioToolbox.AudioServicesError AddSystemSoundCompletion (Action routine, MonoMac.CoreFoundation.CFRunLoop runLoop = null);" />
 
42
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype MonoMac.AudioToolbox.AudioServicesError AddSystemSoundCompletion(class System.Action routine, class MonoMac.CoreFoundation.CFRunLoop runLoop) cil managed" />
 
43
      <MemberType>Method</MemberType>
 
44
      <AssemblyInfo>
 
45
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
46
      </AssemblyInfo>
 
47
      <ReturnValue>
 
48
        <ReturnType>MonoMac.AudioToolbox.AudioServicesError</ReturnType>
 
49
      </ReturnValue>
 
50
      <Parameters>
 
51
        <Parameter Name="routine" Type="System.Action" />
 
52
        <Parameter Name="runLoop" Type="MonoMac.CoreFoundation.CFRunLoop" />
 
53
      </Parameters>
 
54
      <Docs>
 
55
        <param name="routine">To be added.</param>
 
56
        <param name="runLoop">To be added.</param>
 
57
        <summary>To be added.</summary>
 
58
        <returns>To be added.</returns>
 
59
        <remarks>To be added.</remarks>
 
60
      </Docs>
 
61
    </Member>
40
62
    <Member MemberName="Close">
41
63
      <MemberSignature Language="C#" Value="public void Close ();" />
42
64
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Close() cil managed" />
53
75
        <remarks />
54
76
      </Docs>
55
77
    </Member>
 
78
    <Member MemberName="CompletePlaybackIfAppDies">
 
79
      <MemberSignature Language="C#" Value="public bool CompletePlaybackIfAppDies { get; set; }" />
 
80
      <MemberSignature Language="ILAsm" Value=".property instance bool CompletePlaybackIfAppDies" />
 
81
      <MemberType>Property</MemberType>
 
82
      <AssemblyInfo>
 
83
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
84
      </AssemblyInfo>
 
85
      <ReturnValue>
 
86
        <ReturnType>System.Boolean</ReturnType>
 
87
      </ReturnValue>
 
88
      <Docs>
 
89
        <summary>To be added.</summary>
 
90
        <value>To be added.</value>
 
91
        <remarks>To be added.</remarks>
 
92
      </Docs>
 
93
    </Member>
56
94
    <Member MemberName="Dispose">
57
95
      <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
58
96
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
70
108
        <param name="disposing">
71
109
          <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>
72
110
        </param>
73
 
        <summary>Releases the resourced used by the SystemSound object.</summary>
 
111
        <summary>Releases the resources used by the SystemSound object.</summary>
74
112
        <remarks>
75
113
          <para>This Dispose method releases the resources used by the SystemSound class.</para>
76
114
          <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>
152
190
        <remarks>This IntPtr is a handle to the underlying unmanaged representation for this object.</remarks>
153
191
      </Docs>
154
192
    </Member>
 
193
    <Member MemberName="IsUISound">
 
194
      <MemberSignature Language="C#" Value="public bool IsUISound { get; set; }" />
 
195
      <MemberSignature Language="ILAsm" Value=".property instance bool IsUISound" />
 
196
      <MemberType>Property</MemberType>
 
197
      <AssemblyInfo>
 
198
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
199
      </AssemblyInfo>
 
200
      <ReturnValue>
 
201
        <ReturnType>System.Boolean</ReturnType>
 
202
      </ReturnValue>
 
203
      <Docs>
 
204
        <summary>To be added.</summary>
 
205
        <value>To be added.</value>
 
206
        <remarks>To be added.</remarks>
 
207
      </Docs>
 
208
    </Member>
155
209
    <Member MemberName="PlayAlertSound">
156
210
      <MemberSignature Language="C#" Value="public void PlayAlertSound ();" />
157
211
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void PlayAlertSound() cil managed" />
184
238
        <remarks>The system sound is played asynchronously, but it is also limited to 30 seconds or less.</remarks>
185
239
      </Docs>
186
240
    </Member>
 
241
    <Member MemberName="RemoveSystemSoundCompletion">
 
242
      <MemberSignature Language="C#" Value="public void RemoveSystemSoundCompletion ();" />
 
243
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveSystemSoundCompletion() cil managed" />
 
244
      <MemberType>Method</MemberType>
 
245
      <AssemblyInfo>
 
246
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
247
      </AssemblyInfo>
 
248
      <ReturnValue>
 
249
        <ReturnType>System.Void</ReturnType>
 
250
      </ReturnValue>
 
251
      <Parameters />
 
252
      <Docs>
 
253
        <summary>To be added.</summary>
 
254
        <remarks>To be added.</remarks>
 
255
      </Docs>
 
256
    </Member>
187
257
    <Member MemberName="System.IDisposable.Dispose">
188
258
      <MemberSignature Language="C#" Value="void IDisposable.Dispose ();" />
189
259
      <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.IDisposable.Dispose() cil managed" />
196
266
      </ReturnValue>
197
267
      <Parameters />
198
268
      <Docs>
199
 
        <summary>Releases the resourced used by the SystemSound object.</summary>
 
269
        <summary>Releases the resources used by the SystemSound object.</summary>
200
270
        <remarks>
201
271
          <para>The Dispose method releases the resources used by the SystemSound class.</para>
202
272
          <para>Calling the Dispose method when you are finished using the SystemSound 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>
203
273
        </remarks>
204
274
      </Docs>
205
275
    </Member>
206
 
    <Member MemberName="Vibrate">
207
 
      <MemberSignature Language="C#" Value="public static readonly MonoMac.AudioToolbox.SystemSound Vibrate;" />
208
 
      <MemberSignature Language="ILAsm" Value=".field public static initonly class MonoMac.AudioToolbox.SystemSound Vibrate" />
209
 
      <MemberType>Field</MemberType>
210
 
      <AssemblyInfo>
211
 
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
212
 
      </AssemblyInfo>
213
 
      <ReturnValue>
214
 
        <ReturnType>MonoMac.AudioToolbox.SystemSound</ReturnType>
215
 
      </ReturnValue>
216
 
      <Docs>
217
 
        <summary>A special system sound that can be used to make the device vibrate.</summary>
218
 
        <remarks>This system sound does nothing on iPod touches.</remarks>
219
 
      </Docs>
220
 
    </Member>
221
276
  </Members>
222
277
</Type>