← 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/AudioSession.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/AudioSession.xml
11
11
  <Interfaces />
12
12
  <Docs>
13
13
    <summary>Interface to to control the audio context of your application</summary>
14
 
    <remarks>To be added.</remarks>
 
14
    <remarks>
 
15
      <para>
 
16
 
 
17
        You use the various AudioSession methods to control how the
 
18
        input and output are handled by the operating system,
 
19
        configure the recorder and speakers, control where the audio
 
20
        is played to, and where the audio is recorded from.
 
21
        AudioSession also provides a mechanism to start and stop using
 
22
        the audio system and to monitor changes to the audio system.
 
23
 
 
24
      </para>
 
25
      <para>
 
26
        Both the initialization sequence and the use of some
 
27
        properties on AudioSession can throw an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
28
      </para>
 
29
      <para>
 
30
 
 
31
        Your application can use the <see cref="M:MonoMac.AudioToolbox.AudioSession.AddListener(MonoMac.AudioToolbox.AudioSessionProperty, MonoMac.AudioToolbox.AudioSession.PropertyListener)" />
 
32
        method with the AudioInputAvailable value to monitor when the microphone becomes available. 
 
33
 
 
34
      </para>
 
35
    </remarks>
 
36
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=26d904c2-c44a-46f2-883a-a01bb5657309">StreamingAudio</related>
 
37
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=133bdad4-776a-454d-a265-889d009d0335">SysSound</related>
15
38
  </Docs>
16
39
  <Members>
17
40
    <Member MemberName="AddListener">
29
52
        <Parameter Name="listener" Type="MonoMac.AudioToolbox.AudioSession+PropertyListener" />
30
53
      </Parameters>
31
54
      <Docs>
32
 
        <param name="property">To be added.</param>
33
 
        <param name="listener">To be added.</param>
34
 
        <summary>To be added.</summary>
35
 
        <remarks>To be added.</remarks>
 
55
        <param name="property">The property to monitor.</param>
 
56
        <param name="listener">Callback to invoke when the property changes.</param>
 
57
        <summary>Registers a method to be invoked when an audio session property changes.</summary>
 
58
        <remarks>Use the RemoveListener method to stop receiving property change notifications.</remarks>
36
59
      </Docs>
37
60
    </Member>
38
61
    <Member MemberName="AudioInputAvailable">
46
69
        <ReturnType>System.Boolean</ReturnType>
47
70
      </ReturnValue>
48
71
      <Docs>
49
 
        <summary>To be added.</summary>
50
 
        <value>To be added.</value>
51
 
        <remarks>To be added.</remarks>
 
72
        <summary>Determines whether audio input is available.</summary>
 
73
        <value>
 
74
        </value>
 
75
        <remarks>
 
76
          <para>
 
77
 
 
78
            This property determines whether input is available.
 
79
            Phones always have input available, while iPod Touch
 
80
            devices only have input available if a microphone or a
 
81
            headset with a microphone is plugged.
 
82
 
 
83
          </para>
 
84
          <para>
 
85
            If there is an error reading or setting the property,
 
86
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
87
          </para>
 
88
        </remarks>
52
89
      </Docs>
53
90
    </Member>
54
91
    <Member MemberName="AudioRoute">
58
95
      <AssemblyInfo>
59
96
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
60
97
      </AssemblyInfo>
 
98
      <Attributes>
 
99
        <Attribute>
 
100
          <AttributeName>System.Obsolete("Use InputRoute or OutputRoute instead")</AttributeName>
 
101
        </Attribute>
 
102
      </Attributes>
61
103
      <ReturnValue>
62
104
        <ReturnType>System.String</ReturnType>
63
105
      </ReturnValue>
64
106
      <Docs>
65
 
        <summary>To be added.</summary>
66
 
        <value>To be added.</value>
67
 
        <remarks>To be added.</remarks>
 
107
        <summary>Obsolete method.</summary>
 
108
        <value>
 
109
        </value>
 
110
        <remarks>
 
111
          <para>
 
112
            If there is an error reading or setting the property,
 
113
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
114
          </para>
 
115
        </remarks>
68
116
      </Docs>
69
117
    </Member>
70
118
    <Member MemberName="AudioShouldDuck">
78
126
        <ReturnType>System.Boolean</ReturnType>
79
127
      </ReturnValue>
80
128
      <Docs>
81
 
        <summary>To be added.</summary>
82
 
        <value>To be added.</value>
83
 
        <remarks>To be added.</remarks>
 
129
        <summary>Controls audio ducking for your application.</summary>
 
130
        <value>
 
131
        </value>
 
132
        <remarks>
 
133
          <para>
 
134
            When this property is set to true, if there is background
 
135
            music playing and you have configured this session to
 
136
            allow audio mixing, when your application produces sound,
 
137
            the background music volume is reduced.  After you play
 
138
            your sound, you should reset the value to false.
 
139
          </para>
 
140
          <para>
 
141
            By default, this property is set to false, and no audio ducking takes place.
 
142
          </para>
 
143
          <para>
 
144
            If there is an error reading or setting the property,
 
145
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
146
          </para>
 
147
        </remarks>
84
148
      </Docs>
85
149
    </Member>
86
150
    <Member MemberName="Category">
94
158
        <ReturnType>MonoMac.AudioToolbox.AudioSessionCategory</ReturnType>
95
159
      </ReturnValue>
96
160
      <Docs>
97
 
        <summary>To be added.</summary>
98
 
        <value>To be added.</value>
99
 
        <remarks>To be added.</remarks>
 
161
        <summary>Controls how the operating system treats the audio from your application.</summary>
 
162
        <value>
 
163
        </value>
 
164
        <remarks>
 
165
          <para>
 
166
 
 
167
            This property is used to control how the operating system
 
168
            treat your audio.  It can be used to control whether your
 
169
            application needs exclusive access to the microphones or
 
170
            speakers or to configure if the audio can be mixed with
 
171
            background music.
 
172
 
 
173
          </para>
 
174
          <para>
 
175
            If there is an error reading or setting the property,
 
176
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
177
          </para>
 
178
        </remarks>
100
179
      </Docs>
101
180
    </Member>
102
181
    <Member MemberName="CurrentHardwareInputLatency">
110
189
        <ReturnType>System.Single</ReturnType>
111
190
      </ReturnValue>
112
191
      <Docs>
113
 
        <summary>To be added.</summary>
114
 
        <value>To be added.</value>
115
 
        <remarks>To be added.</remarks>
 
192
        <summary>The current hardware input latency in seconds.</summary>
 
193
        <value>
 
194
        </value>
 
195
        <remarks>
 
196
          <para>
 
197
            If there is an error reading or setting the property,
 
198
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
199
          </para>
 
200
        </remarks>
116
201
      </Docs>
117
202
    </Member>
118
203
    <Member MemberName="CurrentHardwareInputNumberChannels">
126
211
        <ReturnType>System.Int32</ReturnType>
127
212
      </ReturnValue>
128
213
      <Docs>
129
 
        <summary>To be added.</summary>
130
 
        <value>To be added.</value>
131
 
        <remarks>To be added.</remarks>
 
214
        <summary>The number of hardware input channels.</summary>
 
215
        <value>
 
216
        </value>
 
217
        <remarks>
 
218
          <para>
 
219
            If there is an error reading or setting the property,
 
220
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
221
          </para>
 
222
        </remarks>
132
223
      </Docs>
133
224
    </Member>
134
225
    <Member MemberName="CurrentHardwareIOBufferDuration">
142
233
        <ReturnType>System.Single</ReturnType>
143
234
      </ReturnValue>
144
235
      <Docs>
145
 
        <summary>To be added.</summary>
146
 
        <value>To be added.</value>
147
 
        <remarks>To be added.</remarks>
 
236
        <summary>The size in seconds of the hardware input and output buffer.</summary>
 
237
        <value>
 
238
        </value>
 
239
        <remarks>
 
240
          <para>
 
241
            If there is an error reading or setting the property,
 
242
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
243
          </para>
 
244
        </remarks>
148
245
      </Docs>
149
246
    </Member>
150
247
    <Member MemberName="CurrentHardwareOutputLatency">
158
255
        <ReturnType>System.Single</ReturnType>
159
256
      </ReturnValue>
160
257
      <Docs>
161
 
        <summary>To be added.</summary>
162
 
        <value>To be added.</value>
163
 
        <remarks>To be added.</remarks>
 
258
        <summary>The current hardware output latency in seconds.</summary>
 
259
        <value>
 
260
        </value>
 
261
        <remarks>
 
262
          <para>
 
263
            If there is an error reading or setting the property,
 
264
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
265
          </para>
 
266
        </remarks>
164
267
      </Docs>
165
268
    </Member>
166
269
    <Member MemberName="CurrentHardwareOutputNumberChannels">
174
277
        <ReturnType>System.Int32</ReturnType>
175
278
      </ReturnValue>
176
279
      <Docs>
177
 
        <summary>To be added.</summary>
178
 
        <value>To be added.</value>
179
 
        <remarks>To be added.</remarks>
 
280
        <summary>Number of hardware output channels.</summary>
 
281
        <value>
 
282
        </value>
 
283
        <remarks>
 
284
          <para>
 
285
            If there is an error reading or setting the property,
 
286
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
287
          </para>
 
288
        </remarks>
180
289
      </Docs>
181
290
    </Member>
182
291
    <Member MemberName="CurrentHardwareOutputVolume">
190
299
        <ReturnType>System.Single</ReturnType>
191
300
      </ReturnValue>
192
301
      <Docs>
193
 
        <summary>To be added.</summary>
194
 
        <value>To be added.</value>
195
 
        <remarks>To be added.</remarks>
 
302
        <summary>Your application volume, from 0 to 1.</summary>
 
303
        <value>Floating point value between 0 and 1.</value>
 
304
        <remarks>
 
305
          <para>
 
306
            If there is an error reading or setting the property,
 
307
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
308
          </para>
 
309
        </remarks>
196
310
      </Docs>
197
311
    </Member>
198
312
    <Member MemberName="CurrentHardwareSampleRate">
206
320
        <ReturnType>System.Double</ReturnType>
207
321
      </ReturnValue>
208
322
      <Docs>
209
 
        <summary>To be added.</summary>
210
 
        <value>To be added.</value>
211
 
        <remarks>To be added.</remarks>
 
323
        <summary>The current hardware sample rate.</summary>
 
324
        <value>
 
325
        </value>
 
326
        <remarks>
 
327
          <para>
 
328
            If there is an error reading or setting the property,
 
329
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
330
          </para>
 
331
        </remarks>
212
332
      </Docs>
213
333
    </Member>
214
334
    <Member MemberName="Initialize">
223
343
      </ReturnValue>
224
344
      <Parameters />
225
345
      <Docs>
226
 
        <summary>To be added.</summary>
227
 
        <remarks>To be added.</remarks>
 
346
        <summary>Initializes the Audio Session.</summary>
 
347
        <remarks>
 
348
          <para>
 
349
 
 
350
            In addition to calling the Initialize method on
 
351
            AudioSession, you will want to set the <see cref="P:MonoMac.AudioToolbox.AudioSession.Category" />
 
352
            and the <see cref="P:MonoMac.AudioToolbox.AudioSession.Mode" />
 
353
            properties to control the priority of your audio and the
 
354
            rules for mixing your audio with other audio playing on
 
355
            the device.
 
356
 
 
357
          </para>
 
358
          <para>
 
359
 
 
360
            When you call this variation of Initialize, both the <see cref="E:MonoMac.AudioToolbox.AudioSession.Interrupted" />
 
361
            and <see cref="E:MonoMac.AudioToolbox.AudioSession.Resumed" />
 
362
            events are raised on the main loop.  Use the <see cref="P:MonoMac.AudioToolbox.AudioSession.Initialize(MonoMac.CoreFoundation.CFRunLoop&#xA;            runLoop, System.String runMode)" /> if you want to specify
 
363
            a different runloop.
 
364
 
 
365
          </para>
 
366
          <para>
 
367
            If there is an error initializing the AudioSession, this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
368
          </para>
 
369
          <example>
 
370
            <code lang="c#">
 
371
//
 
372
// Initialize the audio session for audio playback
 
373
//
 
374
AudioSession.Initialize ();
 
375
AudioSession.Category = AudioSessionCategory.MediaPlayback;
 
376
</code>
 
377
          </example>
 
378
        </remarks>
228
379
      </Docs>
229
380
    </Member>
230
381
    <Member MemberName="Initialize">
242
393
        <Parameter Name="runMode" Type="System.String" />
243
394
      </Parameters>
244
395
      <Docs>
245
 
        <param name="runLoop">To be added.</param>
246
 
        <param name="runMode">To be added.</param>
247
 
        <summary>To be added.</summary>
 
396
        <param name="runLoop">The runloop to execute on.</param>
 
397
        <param name="runMode">Run loop mode (see NSRunLoop for the various modes).</param>
 
398
        <summary>Initializes the Audio Session.</summary>
 
399
        <remarks>
 
400
          <para>
 
401
 
 
402
            In addition to calling the Initialize method on
 
403
            AudioSession, you will want to set the <see cref="P:MonoMac.AudioToolbox.AudioSession.Category" />
 
404
            and the <see cref="P:MonoMac.AudioToolbox.AudioSession.Mode" />
 
405
            properties to control the priority of your audio and the
 
406
            rules for mixing your audio with other audio playing on
 
407
            the device.
 
408
 
 
409
          </para>
 
410
          <para>
 
411
 
 
412
            When you call this variation of Initialize, both the <see cref="E:MonoMac.AudioToolbox.AudioSession.Interrupted" />
 
413
            and <see cref="E:MonoMac.AudioToolbox.AudioSession.Resumed" />
 
414
            events are raised on the specified run loop with the
 
415
            specified run loop mode.  Use the <see cref="P:MonoMac.AudioToolbox.AudioSession.Initialize()" />
 
416
            if you want those events to be raised on the main thread.
 
417
 
 
418
          </para>
 
419
          <example>
 
420
            <code lang="c#">
 
421
//
 
422
// Initialize the audio session for audio playback
 
423
//
 
424
AudioSession.Initialize (myRunLoop, myRunMode);
 
425
AudioSession.Category = AudioSessionCategory.MediaPlayback;
 
426
</code>
 
427
          </example>
 
428
        </remarks>
 
429
      </Docs>
 
430
    </Member>
 
431
    <Member MemberName="InputGainAvailable">
 
432
      <MemberSignature Language="C#" Value="public static bool InputGainAvailable { get; }" />
 
433
      <MemberSignature Language="ILAsm" Value=".property bool InputGainAvailable" />
 
434
      <MemberType>Property</MemberType>
 
435
      <AssemblyInfo>
 
436
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
437
      </AssemblyInfo>
 
438
      <Attributes>
 
439
        <Attribute>
 
440
          <AttributeName>MonoMac.ObjCRuntime.Since(5, 0)</AttributeName>
 
441
        </Attribute>
 
442
      </Attributes>
 
443
      <ReturnValue>
 
444
        <ReturnType>System.Boolean</ReturnType>
 
445
      </ReturnValue>
 
446
      <Docs>
 
447
        <summary>To be added.</summary>
 
448
        <value>To be added.</value>
 
449
        <remarks>To be added.</remarks>
 
450
      </Docs>
 
451
    </Member>
 
452
    <Member MemberName="InputGainScalar">
 
453
      <MemberSignature Language="C#" Value="public static float InputGainScalar { get; set; }" />
 
454
      <MemberSignature Language="ILAsm" Value=".property float32 InputGainScalar" />
 
455
      <MemberType>Property</MemberType>
 
456
      <AssemblyInfo>
 
457
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
458
      </AssemblyInfo>
 
459
      <Attributes>
 
460
        <Attribute>
 
461
          <AttributeName>MonoMac.ObjCRuntime.Since(5, 0)</AttributeName>
 
462
        </Attribute>
 
463
      </Attributes>
 
464
      <ReturnValue>
 
465
        <ReturnType>System.Single</ReturnType>
 
466
      </ReturnValue>
 
467
      <Docs>
 
468
        <summary>To be added.</summary>
 
469
        <value>To be added.</value>
248
470
        <remarks>To be added.</remarks>
249
471
      </Docs>
250
472
    </Member>
255
477
      <AssemblyInfo>
256
478
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
257
479
      </AssemblyInfo>
 
480
      <Attributes>
 
481
        <Attribute>
 
482
          <AttributeName>MonoMac.ObjCRuntime.Since(5, 0)</AttributeName>
 
483
        </Attribute>
 
484
      </Attributes>
258
485
      <ReturnValue>
259
486
        <ReturnType>MonoMac.AudioToolbox.AudioSessionInputRouteKind</ReturnType>
260
487
      </ReturnValue>
261
488
      <Docs>
 
489
        <summary>Controls the source for audio input.</summary>
 
490
        <value>
 
491
        </value>
 
492
        <remarks>
 
493
        </remarks>
 
494
      </Docs>
 
495
    </Member>
 
496
    <Member MemberName="InputSources">
 
497
      <MemberSignature Language="C#" Value="public static MonoMac.AudioToolbox.AccessoryInfo[] InputSources { get; }" />
 
498
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.AudioToolbox.AccessoryInfo[] InputSources" />
 
499
      <MemberType>Property</MemberType>
 
500
      <AssemblyInfo>
 
501
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
502
      </AssemblyInfo>
 
503
      <Attributes>
 
504
        <Attribute>
 
505
          <AttributeName>MonoMac.ObjCRuntime.Since(5, 0)</AttributeName>
 
506
        </Attribute>
 
507
      </Attributes>
 
508
      <ReturnValue>
 
509
        <ReturnType>MonoMac.AudioToolbox.AccessoryInfo[]</ReturnType>
 
510
      </ReturnValue>
 
511
      <Docs>
262
512
        <summary>To be added.</summary>
263
513
        <value>To be added.</value>
264
514
        <remarks>To be added.</remarks>
275
525
        <ReturnType>System.EventHandler</ReturnType>
276
526
      </ReturnValue>
277
527
      <Docs>
278
 
        <summary>To be added.</summary>
279
 
        <remarks>To be added.</remarks>
 
528
        <summary>Event raised when the audio session has been interrupted.</summary>
 
529
        <remarks>
 
530
          <para>
 
531
 
 
532
            You can use the <see cref="P:MonoMac.AudioToolbox.AudioSession.InterruptionType" /> property to determine the cause of the interruption.
 
533
 
 
534
          </para>
 
535
          <para>
 
536
            In addition, the Resumed event is raised when the audio session is resumed.
 
537
          </para>
 
538
        </remarks>
280
539
      </Docs>
281
540
    </Member>
282
541
    <Member MemberName="InterruptionType">
295
554
        <ReturnType>MonoMac.AudioToolbox.AudioSessionInterruptionType</ReturnType>
296
555
      </ReturnValue>
297
556
      <Docs>
298
 
        <summary>To be added.</summary>
299
 
        <value>To be added.</value>
300
 
        <remarks>To be added.</remarks>
 
557
        <summary>The type of interruption, used to determine the appropriate course of action when the AudioSession is interrupted.</summary>
 
558
        <value>
 
559
        </value>
 
560
        <remarks>
 
561
          The value of this property is only valid when called from the <see cref="E:MonoMac.AudioToolbox.AudioSession.Interrupted" /> event handler.
 
562
        </remarks>
301
563
      </Docs>
302
564
    </Member>
303
565
    <Member MemberName="Mode">
307
569
      <AssemblyInfo>
308
570
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
309
571
      </AssemblyInfo>
 
572
      <Attributes>
 
573
        <Attribute>
 
574
          <AttributeName>MonoMac.ObjCRuntime.Since(5, 0)</AttributeName>
 
575
        </Attribute>
 
576
      </Attributes>
310
577
      <ReturnValue>
311
578
        <ReturnType>MonoMac.AudioToolbox.AudioSessionMode</ReturnType>
312
579
      </ReturnValue>
341
608
        <ReturnType>System.Boolean</ReturnType>
342
609
      </ReturnValue>
343
610
      <Docs>
 
611
        <summary>Whether another application is currently playing back audio.</summary>
 
612
        <value>
 
613
        </value>
 
614
        <remarks>
 
615
        </remarks>
 
616
      </Docs>
 
617
    </Member>
 
618
    <Member MemberName="OutputDestinations">
 
619
      <MemberSignature Language="C#" Value="public static MonoMac.AudioToolbox.AccessoryInfo[] OutputDestinations { get; }" />
 
620
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.AudioToolbox.AccessoryInfo[] OutputDestinations" />
 
621
      <MemberType>Property</MemberType>
 
622
      <AssemblyInfo>
 
623
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
624
      </AssemblyInfo>
 
625
      <Attributes>
 
626
        <Attribute>
 
627
          <AttributeName>MonoMac.ObjCRuntime.Since(5, 0)</AttributeName>
 
628
        </Attribute>
 
629
      </Attributes>
 
630
      <ReturnValue>
 
631
        <ReturnType>MonoMac.AudioToolbox.AccessoryInfo[]</ReturnType>
 
632
      </ReturnValue>
 
633
      <Docs>
344
634
        <summary>To be added.</summary>
345
635
        <value>To be added.</value>
346
636
        <remarks>To be added.</remarks>
353
643
      <AssemblyInfo>
354
644
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
355
645
      </AssemblyInfo>
 
646
      <Attributes>
 
647
        <Attribute>
 
648
          <AttributeName>MonoMac.ObjCRuntime.Since(5, 0)</AttributeName>
 
649
        </Attribute>
 
650
      </Attributes>
356
651
      <ReturnValue>
357
652
        <ReturnType>MonoMac.AudioToolbox.AudioSessionOutputRouteKind[]</ReturnType>
358
653
      </ReturnValue>
359
654
      <Docs>
360
 
        <summary>To be added.</summary>
361
 
        <value>To be added.</value>
362
 
        <remarks>To be added.</remarks>
 
655
        <summary>Retrives information about the available audio output routes.</summary>
 
656
        <value>
 
657
        </value>
 
658
        <remarks>
 
659
          <para>
 
660
            If there is an error reading or setting the property,
 
661
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
662
          </para>
 
663
        </remarks>
363
664
      </Docs>
364
665
    </Member>
365
666
    <Member MemberName="OverrideCategoryDefaultToSpeaker">
375
676
      <Docs>
376
677
        <summary>To be added.</summary>
377
678
        <value>To be added.</value>
378
 
        <remarks>To be added.</remarks>
 
679
        <remarks>
 
680
          <para>
 
681
            If there is an error reading or setting the property,
 
682
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
683
          </para>
 
684
        </remarks>
379
685
      </Docs>
380
686
    </Member>
381
687
    <Member MemberName="OverrideCategoryEnableBluetoothInput">
390
696
      </ReturnValue>
391
697
      <Docs>
392
698
        <summary>If input is coming from a bluetooth headset, it routes the audio output to the headset.</summary>
393
 
        <value>To be added.</value>
394
 
        <remarks>To be added.</remarks>
 
699
        <value>
 
700
        </value>
 
701
        <remarks>
 
702
          <para>
 
703
            If there is an error reading or setting the property,
 
704
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
705
          </para>
 
706
        </remarks>
395
707
      </Docs>
396
708
    </Member>
397
709
    <Member MemberName="OverrideCategoryMixWithOthers">
405
717
        <ReturnType>System.Boolean</ReturnType>
406
718
      </ReturnValue>
407
719
      <Docs>
408
 
        <summary>To be added.</summary>
409
 
        <value>To be added.</value>
410
 
        <remarks>To be added.</remarks>
 
720
        <summary>Mixes the background audio with the audio generated by the application, regardless of the default <see cref="P:MonoMac.AudioToolbox.AudioSession.Category" /> setting.</summary>
 
721
        <value>
 
722
        </value>
 
723
        <remarks>
 
724
          <para>
 
725
            This setting can be used when the <see cref="P:MonoMac.AudioToolbox.AudioSession.Category" /> session is set to either MediaPlayback or PlayAndRecord.
 
726
          </para>
 
727
          <para>
 
728
            If there is an error reading or setting the property,
 
729
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
730
          </para>
 
731
        </remarks>
411
732
      </Docs>
412
733
    </Member>
413
734
    <Member MemberName="PreferredHardwareIOBufferDuration">
421
742
        <ReturnType>System.Single</ReturnType>
422
743
      </ReturnValue>
423
744
      <Docs>
424
 
        <summary>To be added.</summary>
425
 
        <value>To be added.</value>
426
 
        <remarks>To be added.</remarks>
 
745
        <summary>Your application desired buffer size in seconds. </summary>
 
746
        <value>
 
747
        </value>
 
748
        <remarks>
 
749
          <para>
 
750
            There is no guarantee that you will get the number of requested seconds, you can determine the actual number of seconds by reading the <see cref="P:MonoMac.AudioToolbox.AudioSession.CurrentHardwareIOBufferDuration" /> property.
 
751
          </para>
 
752
          <para>
 
753
            If there is an error reading or setting the property,
 
754
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
755
          </para>
 
756
        </remarks>
427
757
      </Docs>
428
758
    </Member>
429
759
    <Member MemberName="PreferredHardwareSampleRate">
437
767
        <ReturnType>System.Double</ReturnType>
438
768
      </ReturnValue>
439
769
      <Docs>
440
 
        <summary>To be added.</summary>
441
 
        <value>To be added.</value>
442
 
        <remarks>To be added.</remarks>
 
770
        <summary>Your desired audio sample rate.</summary>
 
771
        <value>
 
772
        </value>
 
773
        <remarks>
 
774
          <para>
 
775
            There is no guarantee that you will get the requested sample rate, you can determine the actual number by reading the <see cref="P:MonoMac.AudioToolbox.AudioSession.CurrentHardwareSampleRate" /> property.
 
776
          </para>
 
777
          <para>
 
778
            If there is an error reading or setting the property,
 
779
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
780
          </para>
 
781
        </remarks>
443
782
      </Docs>
444
783
    </Member>
445
784
    <Member MemberName="RemoveListener">
457
796
        <Parameter Name="listener" Type="MonoMac.AudioToolbox.AudioSession+PropertyListener" />
458
797
      </Parameters>
459
798
      <Docs>
460
 
        <param name="property">To be added.</param>
461
 
        <param name="listener">To be added.</param>
462
 
        <summary>To be added.</summary>
463
 
        <remarks>To be added.</remarks>
 
799
        <param name="property">The monitored property.</param>
 
800
        <param name="listener">The Callback that was specified in the call to AddListener.</param>
 
801
        <summary>Removes the specified listener from the list of monitored audio session properties.</summary>
 
802
        <remarks>Properties to monitor are registered with the AddListener method.</remarks>
464
803
      </Docs>
465
804
    </Member>
466
805
    <Member MemberName="Resumed">
474
813
        <ReturnType>System.EventHandler</ReturnType>
475
814
      </ReturnValue>
476
815
      <Docs>
477
 
        <summary>To be added.</summary>
478
 
        <remarks>To be added.</remarks>
 
816
        <summary>Event raised when the audio session has resumed.</summary>
 
817
        <remarks>In addition, the Interrupted event is raised when the audio session is interrupted.</remarks>
479
818
      </Docs>
480
819
    </Member>
481
820
    <Member MemberName="RoutingOverride">
489
828
        <ReturnType>MonoMac.AudioToolbox.AudioSessionRoutingOverride</ReturnType>
490
829
      </ReturnValue>
491
830
      <Docs>
492
 
        <summary>To be added.</summary>
493
 
        <value>To be added.</value>
494
 
        <remarks>To be added.</remarks>
 
831
        <summary>Controls the output route, overriding the default set by the <see cref="P:MonoMac.AudioToolbox.AudioSession.Category" />.</summary>
 
832
        <value>
 
833
        </value>
 
834
        <remarks>
 
835
          <para>
 
836
            This property is only valid if the Category is set to PlayAndRecord.
 
837
          </para>
 
838
          <para>
 
839
            If this property is set to Speaker when a headset is
 
840
            plugged, this will also switch the input to use the system
 
841
            microphone, and not the one on the headset.
 
842
          </para>
 
843
          <para>
 
844
            The setting of this variable is reset when a headset are plugged or unplugged.
 
845
          </para>
 
846
          <para>
 
847
            If there is an error reading or setting the property,
 
848
            this will raise an <see cref="T:MonoMac.AudioToolbox.AudioSessionException" />.
 
849
          </para>
 
850
        </remarks>
495
851
      </Docs>
496
852
    </Member>
497
853
    <Member MemberName="SetActive">
508
864
        <Parameter Name="active" Type="System.Boolean" />
509
865
      </Parameters>
510
866
      <Docs>
 
867
        <param name="active">Whether to enable the audio session.</param>
 
868
        <summary>Enables or Disables the audio session.</summary>
 
869
        <remarks>
 
870
          <para>
 
871
            This method is used to enable and disable the audio session.
 
872
          </para>
 
873
          <para>
 
874
            This method can throw an AudioSessionException if another
 
875
            application is currently using the AudioSession in the
 
876
            foreground and does not support audio mixing.
 
877
          </para>
 
878
        </remarks>
 
879
      </Docs>
 
880
    </Member>
 
881
    <Member MemberName="SetActive">
 
882
      <MemberSignature Language="C#" Value="public static MonoMac.AudioToolbox.AudioSessionErrors SetActive (bool active, MonoMac.AudioToolbox.AudioSessionActiveFlags flags);" />
 
883
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype MonoMac.AudioToolbox.AudioSessionErrors SetActive(bool active, valuetype MonoMac.AudioToolbox.AudioSessionActiveFlags flags) cil managed" />
 
884
      <MemberType>Method</MemberType>
 
885
      <AssemblyInfo>
 
886
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
887
      </AssemblyInfo>
 
888
      <Attributes>
 
889
        <Attribute>
 
890
          <AttributeName>MonoMac.ObjCRuntime.Since(4, 0)</AttributeName>
 
891
        </Attribute>
 
892
      </Attributes>
 
893
      <ReturnValue>
 
894
        <ReturnType>MonoMac.AudioToolbox.AudioSessionErrors</ReturnType>
 
895
      </ReturnValue>
 
896
      <Parameters>
 
897
        <Parameter Name="active" Type="System.Boolean" />
 
898
        <Parameter Name="flags" Type="MonoMac.AudioToolbox.AudioSessionActiveFlags" />
 
899
      </Parameters>
 
900
      <Docs>
511
901
        <param name="active">To be added.</param>
 
902
        <param name="flags">To be added.</param>
512
903
        <summary>To be added.</summary>
 
904
        <returns>To be added.</returns>
513
905
        <remarks>To be added.</remarks>
514
906
      </Docs>
515
907
    </Member>