← 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.AVFoundation/AVAudioPlayerSettings.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.AVFoundation/AVAudioPlayerSettings.xml
 
1
<Type Name="AVAudioPlayerSettings" FullName="MonoMac.AVFoundation.AVAudioPlayerSettings">
 
2
  <TypeSignature Language="C#" Value="public class AVAudioPlayerSettings" />
 
3
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AVAudioPlayerSettings extends System.Object" />
 
4
  <AssemblyInfo>
 
5
    <AssemblyName>MonoMac</AssemblyName>
 
6
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
7
  </AssemblyInfo>
 
8
  <Base>
 
9
    <BaseTypeName>System.Object</BaseTypeName>
 
10
  </Base>
 
11
  <Interfaces />
 
12
  <Docs>
 
13
    <summary>Describes the audio playback state from an AVAudioPlayer.</summary>
 
14
    <remarks>
 
15
      <para>
 
16
        This class contains the description of the audio being
 
17
        played back by AVAudioPlayer and is returned by the <see cref="P:MonoMac.AVFoundation.AVPlayer.Settings" /> property on
 
18
        the AVAudioPlayer instance.
 
19
      </para>
 
20
      <para>
 
21
 
 
22
        The various properties in this class describe the properties
 
23
        of the audio associated with the player.
 
24
 
 
25
      </para>
 
26
    </remarks>
 
27
  </Docs>
 
28
  <Members>
 
29
    <Member MemberName="AudioChannelLayout">
 
30
      <MemberSignature Language="C#" Value="public MonoMac.AudioToolbox.AudioChannelLayout AudioChannelLayout { get; }" />
 
31
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.AudioToolbox.AudioChannelLayout AudioChannelLayout" />
 
32
      <MemberType>Property</MemberType>
 
33
      <AssemblyInfo>
 
34
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
35
      </AssemblyInfo>
 
36
      <ReturnValue>
 
37
        <ReturnType>MonoMac.AudioToolbox.AudioChannelLayout</ReturnType>
 
38
      </ReturnValue>
 
39
      <Docs>
 
40
        <summary>Describes the channel layout for the sound associated with this player.</summary>
 
41
        <value>
 
42
        </value>
 
43
        <remarks>
 
44
        </remarks>
 
45
      </Docs>
 
46
    </Member>
 
47
    <Member MemberName="AudioFormat">
 
48
      <MemberSignature Language="C#" Value="public MonoMac.AudioToolbox.AudioFormatType AudioFormat { get; }" />
 
49
      <MemberSignature Language="ILAsm" Value=".property instance valuetype MonoMac.AudioToolbox.AudioFormatType AudioFormat" />
 
50
      <MemberType>Property</MemberType>
 
51
      <AssemblyInfo>
 
52
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
53
      </AssemblyInfo>
 
54
      <ReturnValue>
 
55
        <ReturnType>MonoMac.AudioToolbox.AudioFormatType</ReturnType>
 
56
      </ReturnValue>
 
57
      <Docs>
 
58
        <summary>The audio data format.</summary>
 
59
        <value>
 
60
        </value>
 
61
        <remarks>
 
62
        </remarks>
 
63
      </Docs>
 
64
    </Member>
 
65
    <Member MemberName="EncoderBitRateKey">
 
66
      <MemberSignature Language="C#" Value="public int EncoderBitRateKey { get; }" />
 
67
      <MemberSignature Language="ILAsm" Value=".property instance int32 EncoderBitRateKey" />
 
68
      <MemberType>Property</MemberType>
 
69
      <AssemblyInfo>
 
70
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
71
      </AssemblyInfo>
 
72
      <ReturnValue>
 
73
        <ReturnType>System.Int32</ReturnType>
 
74
      </ReturnValue>
 
75
      <Docs>
 
76
        <summary>The bit rate at which the audio was encoded.</summary>
 
77
        <value>
 
78
        </value>
 
79
        <remarks>
 
80
        </remarks>
 
81
      </Docs>
 
82
    </Member>
 
83
    <Member MemberName="NumberChannels">
 
84
      <MemberSignature Language="C#" Value="public int NumberChannels { get; }" />
 
85
      <MemberSignature Language="ILAsm" Value=".property instance int32 NumberChannels" />
 
86
      <MemberType>Property</MemberType>
 
87
      <AssemblyInfo>
 
88
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
89
      </AssemblyInfo>
 
90
      <ReturnValue>
 
91
        <ReturnType>System.Int32</ReturnType>
 
92
      </ReturnValue>
 
93
      <Docs>
 
94
        <summary>The number of audio channels on the audio</summary>
 
95
        <value>
 
96
        </value>
 
97
        <remarks>
 
98
        </remarks>
 
99
      </Docs>
 
100
    </Member>
 
101
    <Member MemberName="op_Implicit">
 
102
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSDictionary op_Implicit (MonoMac.AVFoundation.AVAudioPlayerSettings settings);" />
 
103
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class MonoMac.Foundation.NSDictionary op_Implicit(class MonoMac.AVFoundation.AVAudioPlayerSettings settings) cil managed" />
 
104
      <MemberType>Method</MemberType>
 
105
      <AssemblyInfo>
 
106
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
107
      </AssemblyInfo>
 
108
      <ReturnValue>
 
109
        <ReturnType>MonoMac.Foundation.NSDictionary</ReturnType>
 
110
      </ReturnValue>
 
111
      <Parameters>
 
112
        <Parameter Name="settings" Type="MonoMac.AVFoundation.AVAudioPlayerSettings" />
 
113
      </Parameters>
 
114
      <Docs>
 
115
        <param name="settings">The source AVAudioPLayeSettings</param>
 
116
        <summary>Implicit operator that Converts an AVAudioPlayerSettings to an NSDictionary</summary>
 
117
        <returns>
 
118
        </returns>
 
119
        <remarks>This is used for source-code compatibility with older versions of the API that merely exposed an NSDictionary as the return value for the <see cref="P:MonoMac.AVFoundation.AVPlayer.Settings" /> property.</remarks>
 
120
      </Docs>
 
121
    </Member>
 
122
    <Member MemberName="SampleRate">
 
123
      <MemberSignature Language="C#" Value="public float SampleRate { get; }" />
 
124
      <MemberSignature Language="ILAsm" Value=".property instance float32 SampleRate" />
 
125
      <MemberType>Property</MemberType>
 
126
      <AssemblyInfo>
 
127
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
128
      </AssemblyInfo>
 
129
      <ReturnValue>
 
130
        <ReturnType>System.Single</ReturnType>
 
131
      </ReturnValue>
 
132
      <Docs>
 
133
        <summary>The sample rate.</summary>
 
134
        <value>
 
135
        </value>
 
136
        <remarks>
 
137
        </remarks>
 
138
      </Docs>
 
139
    </Member>
 
140
  </Members>
 
141
</Type>