← 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/OutputAudioQueue.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/OutputAudioQueue.xml
1
1
<Type Name="OutputAudioQueue" FullName="MonoMac.AudioToolbox.OutputAudioQueue">
2
2
  <TypeSignature Language="C#" Value="public class OutputAudioQueue : MonoMac.AudioToolbox.AudioQueue" />
3
 
  <TypeSignature Language="ILAsm" Value=".class public auto ansi OutputAudioQueue extends MonoMac.AudioToolbox.AudioQueue" />
 
3
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OutputAudioQueue extends MonoMac.AudioToolbox.AudioQueue" />
4
4
  <AssemblyInfo>
5
5
    <AssemblyName>MonoMac</AssemblyName>
6
6
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
20
20
See the StreamingAudio sample program in monotouch-samples for an example program.
21
21
</para>
22
22
    </remarks>
 
23
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=26d904c2-c44a-46f2-883a-a01bb5657309">StreamingAudio</related>
23
24
  </Docs>
24
25
  <Members>
25
26
    <Member MemberName=".ctor">
39
40
      </Docs>
40
41
    </Member>
41
42
    <Member MemberName=".ctor">
 
43
      <MemberSignature Language="C#" Value="public OutputAudioQueue (MonoMac.AudioToolbox.AudioStreamBasicDescription desc, MonoMac.CoreFoundation.CFRunLoop runLoop, MonoMac.CoreFoundation.CFString runMode);" />
 
44
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype MonoMac.AudioToolbox.AudioStreamBasicDescription desc, class MonoMac.CoreFoundation.CFRunLoop runLoop, class MonoMac.CoreFoundation.CFString runMode) cil managed" />
 
45
      <MemberType>Constructor</MemberType>
 
46
      <AssemblyInfo>
 
47
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
48
      </AssemblyInfo>
 
49
      <Parameters>
 
50
        <Parameter Name="desc" Type="MonoMac.AudioToolbox.AudioStreamBasicDescription" />
 
51
        <Parameter Name="runLoop" Type="MonoMac.CoreFoundation.CFRunLoop" />
 
52
        <Parameter Name="runMode" Type="MonoMac.CoreFoundation.CFString" />
 
53
      </Parameters>
 
54
      <Docs>
 
55
        <param name="desc">Stream description.</param>
 
56
        <param name="runLoop">The run loop in which the OnOutputCompleted method and the OutputCompleted event are raised, if you pass null, this uses an internal thread.</param>
 
57
        <param name="runMode">The run mode for the run loop.</param>
 
58
        <summary>Creates an OutputAudioQueue, specifying on which run loop events are delivered.</summary>
 
59
        <remarks>Usually the stream description is fetched from an AudioFile or an AudioStreamFile.</remarks>
 
60
      </Docs>
 
61
    </Member>
 
62
    <Member MemberName=".ctor">
42
63
      <MemberSignature Language="C#" Value="public OutputAudioQueue (MonoMac.AudioToolbox.AudioStreamBasicDescription desc, MonoMac.CoreFoundation.CFRunLoop runLoop, string runMode);" />
43
64
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype MonoMac.AudioToolbox.AudioStreamBasicDescription desc, class MonoMac.CoreFoundation.CFRunLoop runLoop, string runMode) cil managed" />
44
65
      <MemberType>Constructor</MemberType>
58
79
        <remarks>Usually the stream description is fetched from an AudioFile or an AudioStreamFile.</remarks>
59
80
      </Docs>
60
81
    </Member>
 
82
    <Member MemberName="DisableOfflineRender">
 
83
      <MemberSignature Language="C#" Value="public MonoMac.AudioToolbox.AudioQueueStatus DisableOfflineRender ();" />
 
84
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype MonoMac.AudioToolbox.AudioQueueStatus DisableOfflineRender() cil managed" />
 
85
      <MemberType>Method</MemberType>
 
86
      <AssemblyInfo>
 
87
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
88
      </AssemblyInfo>
 
89
      <ReturnValue>
 
90
        <ReturnType>MonoMac.AudioToolbox.AudioQueueStatus</ReturnType>
 
91
      </ReturnValue>
 
92
      <Parameters />
 
93
      <Docs>
 
94
        <summary>Disables the offline renderer.</summary>
 
95
        <returns>AudioQueueStatus.Ok on success, otherwise the error. </returns>
 
96
        <remarks>
 
97
        </remarks>
 
98
      </Docs>
 
99
    </Member>
61
100
    <Member MemberName="OnOutputCompleted">
62
101
      <MemberSignature Language="C#" Value="protected virtual void OnOutputCompleted (IntPtr audioQueueBuffer);" />
63
102
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnOutputCompleted(native int audioQueueBuffer) cil managed" />
105
144
        </remarks>
106
145
      </Docs>
107
146
    </Member>
 
147
    <Member MemberName="RenderOffline">
 
148
      <MemberSignature Language="C#" Value="public MonoMac.AudioToolbox.AudioQueueStatus RenderOffline (double timeStamp, MonoMac.AudioToolbox.AudioQueueBuffer* audioQueueBuffer, int frameCount);" />
 
149
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype MonoMac.AudioToolbox.AudioQueueStatus RenderOffline(float64 timeStamp, valuetype MonoMac.AudioToolbox.AudioQueueBuffer* audioQueueBuffer, int32 frameCount) cil managed" />
 
150
      <MemberType>Method</MemberType>
 
151
      <AssemblyInfo>
 
152
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
153
      </AssemblyInfo>
 
154
      <ReturnValue>
 
155
        <ReturnType>MonoMac.AudioToolbox.AudioQueueStatus</ReturnType>
 
156
      </ReturnValue>
 
157
      <Parameters>
 
158
        <Parameter Name="timeStamp" Type="System.Double" />
 
159
        <Parameter Name="audioQueueBuffer" Type="MonoMac.AudioToolbox.AudioQueueBuffer*" />
 
160
        <Parameter Name="frameCount" Type="System.Int32" />
 
161
      </Parameters>
 
162
      <Docs>
 
163
        <param name="timeStamp">The timestamp of the first frame to render.</param>
 
164
        <param name="audioQueueBuffer">The audio queue buffer to render to.</param>
 
165
        <param name="frameCount">The number of frames to render.</param>
 
166
        <summary>Writes audio data to an audio buffer, instead of to a device.</summary>
 
167
        <returns>AudioQueueStatus.Ok on success, otherwise the error. </returns>
 
168
        <remarks>
 
169
        </remarks>
 
170
      </Docs>
 
171
    </Member>
 
172
    <Member MemberName="SetOfflineRenderFormat">
 
173
      <MemberSignature Language="C#" Value="public MonoMac.AudioToolbox.AudioQueueStatus SetOfflineRenderFormat (MonoMac.AudioToolbox.AudioStreamBasicDescription desc, MonoMac.AudioToolbox.AudioChannelLayout layout);" />
 
174
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype MonoMac.AudioToolbox.AudioQueueStatus SetOfflineRenderFormat(valuetype MonoMac.AudioToolbox.AudioStreamBasicDescription desc, class MonoMac.AudioToolbox.AudioChannelLayout layout) cil managed" />
 
175
      <MemberType>Method</MemberType>
 
176
      <AssemblyInfo>
 
177
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
178
      </AssemblyInfo>
 
179
      <ReturnValue>
 
180
        <ReturnType>MonoMac.AudioToolbox.AudioQueueStatus</ReturnType>
 
181
      </ReturnValue>
 
182
      <Parameters>
 
183
        <Parameter Name="desc" Type="MonoMac.AudioToolbox.AudioStreamBasicDescription" />
 
184
        <Parameter Name="layout" Type="MonoMac.AudioToolbox.AudioChannelLayout" />
 
185
      </Parameters>
 
186
      <Docs>
 
187
        <param name="desc">The audio format to use for offline rendering.</param>
 
188
        <param name="layout">The channel layout to use for offline rendering. Optional.</param>
 
189
        <summary>Enables offline rendering by setting the audio format and optionally the channel layout to use when rendering.</summary>
 
190
        <returns>AudioQueueStatus.Ok on success, otherwise the error. </returns>
 
191
        <remarks>
 
192
        </remarks>
 
193
      </Docs>
 
194
    </Member>
108
195
  </Members>
109
196
</Type>