mcs/class/System/Documentation/en/System.Media/SoundPlayer.xml

   1 <Type Name="SoundPlayer" FullName="System.Media.SoundPlayer">
   2   <TypeSignature Language="C#" Value="public class SoundPlayer : System.ComponentModel.Component, System.Runtime.Serialization.ISerializable" />
   3   <AssemblyInfo>
   4     <AssemblyName>System</AssemblyName>
   5     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   6   </AssemblyInfo>
   7   <Base>
   8     <BaseTypeName>System.ComponentModel.Component</BaseTypeName>
   9   </Base>
  10   <Interfaces>
  11     <Interface>
  12       <InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>
  13     </Interface>
  14   </Interfaces>
  15   <Attributes>
  16     <Attribute>
  17       <AttributeName>System.ComponentModel.ToolboxItem(false)</AttributeName>
  18     </Attribute>
  19   </Attributes>
  20   <Docs>
  21     <summary>To be added.</summary>
  22     <remarks>To be added.</remarks>
  23   </Docs>
  24   <Members>
  25     <Member MemberName=".ctor">
  26       <MemberSignature Language="C#" Value="public SoundPlayer ();" />
  27       <MemberType>Constructor</MemberType>
  28       <AssemblyInfo>
  29         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  30       </AssemblyInfo>
  31       <Parameters />
  32       <Docs>
  33         <summary>To be added.</summary>
  34         <remarks>To be added.</remarks>
  35       </Docs>
  36     </Member>
  37     <Member MemberName=".ctor">
  38       <MemberSignature Language="C#" Value="public SoundPlayer (System.IO.Stream stream);" />
  39       <MemberType>Constructor</MemberType>
  40       <AssemblyInfo>
  41         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  42       </AssemblyInfo>
  43       <Parameters>
  44         <Parameter Name="stream" Type="System.IO.Stream" />
  45       </Parameters>
  46       <Docs>
  47         <param name="stream">To be added.</param>
  48         <summary>To be added.</summary>
  49         <remarks>To be added.</remarks>
  50       </Docs>
  51     </Member>
  52     <Member MemberName=".ctor">
  53       <MemberSignature Language="C#" Value="public SoundPlayer (string soundLocation);" />
  54       <MemberType>Constructor</MemberType>
  55       <AssemblyInfo>
  56         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  57       </AssemblyInfo>
  58       <Parameters>
  59         <Parameter Name="soundLocation" Type="System.String" />
  60       </Parameters>
  61       <Docs>
  62         <param name="soundLocation">To be added.</param>
  63         <summary>To be added.</summary>
  64         <remarks>To be added.</remarks>
  65       </Docs>
  66     </Member>
  67     <Member MemberName=".ctor">
  68       <MemberSignature Language="C#" Value="protected SoundPlayer (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext context);" />
  69       <MemberType>Constructor</MemberType>
  70       <AssemblyInfo>
  71         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  72       </AssemblyInfo>
  73       <Parameters>
  74         <Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
  75         <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
  76       </Parameters>
  77       <Docs>
  78         <param name="serializationInfo">To be added.</param>
  79         <param name="context">To be added.</param>
  80         <summary>To be added.</summary>
  81         <remarks>To be added.</remarks>
  82       </Docs>
  83     </Member>
  84     <Member MemberName="IsLoadCompleted">
  85       <MemberSignature Language="C#" Value="public bool IsLoadCompleted { get; }" />
  86       <MemberType>Property</MemberType>
  87       <AssemblyInfo>
  88         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  89       </AssemblyInfo>
  90       <ReturnValue>
  91         <ReturnType>System.Boolean</ReturnType>
  92       </ReturnValue>
  93       <Docs>
  94         <summary>To be added.</summary>
  95         <value>To be added.</value>
  96         <remarks>To be added.</remarks>
  97       </Docs>
  98     </Member>
  99     <Member MemberName="Load">
 100       <MemberSignature Language="C#" Value="public void Load ();" />
 101       <MemberType>Method</MemberType>
 102       <AssemblyInfo>
 103         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 104       </AssemblyInfo>
 105       <ReturnValue>
 106         <ReturnType>System.Void</ReturnType>
 107       </ReturnValue>
 108       <Parameters />
 109       <Docs>
 110         <summary>To be added.</summary>
 111         <remarks>To be added.</remarks>
 112       </Docs>
 113     </Member>
 114     <Member MemberName="LoadAsync">
 115       <MemberSignature Language="C#" Value="public void LoadAsync ();" />
 116       <MemberType>Method</MemberType>
 117       <AssemblyInfo>
 118         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 119       </AssemblyInfo>
 120       <ReturnValue>
 121         <ReturnType>System.Void</ReturnType>
 122       </ReturnValue>
 123       <Parameters />
 124       <Docs>
 125         <summary>To be added.</summary>
 126         <remarks>To be added.</remarks>
 127       </Docs>
 128     </Member>
 129     <Member MemberName="LoadCompleted">
 130       <MemberSignature Language="C#" Value="public event System.ComponentModel.AsyncCompletedEventHandler LoadCompleted;" />
 131       <MemberType>Event</MemberType>
 132       <AssemblyInfo>
 133         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 134       </AssemblyInfo>
 135       <ReturnValue>
 136         <ReturnType>System.ComponentModel.AsyncCompletedEventHandler</ReturnType>
 137       </ReturnValue>
 138       <Docs>
 139         <summary>To be added.</summary>
 140         <remarks>To be added.</remarks>
 141       </Docs>
 142     </Member>
 143     <Member MemberName="LoadTimeout">
 144       <MemberSignature Language="C#" Value="public int LoadTimeout { set; get; }" />
 145       <MemberType>Property</MemberType>
 146       <AssemblyInfo>
 147         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 148       </AssemblyInfo>
 149       <ReturnValue>
 150         <ReturnType>System.Int32</ReturnType>
 151       </ReturnValue>
 152       <Docs>
 153         <summary>To be added.</summary>
 154         <value>To be added.</value>
 155         <remarks>To be added.</remarks>
 156       </Docs>
 157     </Member>
 158     <Member MemberName="OnLoadCompleted">
 159       <MemberSignature Language="C#" Value="protected virtual void OnLoadCompleted (System.ComponentModel.AsyncCompletedEventArgs e);" />
 160       <MemberType>Method</MemberType>
 161       <AssemblyInfo>
 162         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 163       </AssemblyInfo>
 164       <ReturnValue>
 165         <ReturnType>System.Void</ReturnType>
 166       </ReturnValue>
 167       <Parameters>
 168         <Parameter Name="e" Type="System.ComponentModel.AsyncCompletedEventArgs" />
 169       </Parameters>
 170       <Docs>
 171         <param name="e">To be added.</param>
 172         <summary>To be added.</summary>
 173         <remarks>To be added.</remarks>
 174       </Docs>
 175     </Member>
 176     <Member MemberName="OnSoundLocationChanged">
 177       <MemberSignature Language="C#" Value="protected virtual void OnSoundLocationChanged (EventArgs e);" />
 178       <MemberType>Method</MemberType>
 179       <AssemblyInfo>
 180         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 181       </AssemblyInfo>
 182       <ReturnValue>
 183         <ReturnType>System.Void</ReturnType>
 184       </ReturnValue>
 185       <Parameters>
 186         <Parameter Name="e" Type="System.EventArgs" />
 187       </Parameters>
 188       <Docs>
 189         <param name="e">To be added.</param>
 190         <summary>To be added.</summary>
 191         <remarks>To be added.</remarks>
 192       </Docs>
 193     </Member>
 194     <Member MemberName="OnStreamChanged">
 195       <MemberSignature Language="C#" Value="protected virtual void OnStreamChanged (EventArgs e);" />
 196       <MemberType>Method</MemberType>
 197       <AssemblyInfo>
 198         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 199       </AssemblyInfo>
 200       <ReturnValue>
 201         <ReturnType>System.Void</ReturnType>
 202       </ReturnValue>
 203       <Parameters>
 204         <Parameter Name="e" Type="System.EventArgs" />
 205       </Parameters>
 206       <Docs>
 207         <param name="e">To be added.</param>
 208         <summary>To be added.</summary>
 209         <remarks>To be added.</remarks>
 210       </Docs>
 211     </Member>
 212     <Member MemberName="Play">
 213       <MemberSignature Language="C#" Value="public void Play ();" />
 214       <MemberType>Method</MemberType>
 215       <AssemblyInfo>
 216         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 217       </AssemblyInfo>
 218       <ReturnValue>
 219         <ReturnType>System.Void</ReturnType>
 220       </ReturnValue>
 221       <Parameters />
 222       <Docs>
 223         <summary>To be added.</summary>
 224         <remarks>To be added.</remarks>
 225       </Docs>
 226     </Member>
 227     <Member MemberName="PlayLooping">
 228       <MemberSignature Language="C#" Value="public void PlayLooping ();" />
 229       <MemberType>Method</MemberType>
 230       <AssemblyInfo>
 231         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 232       </AssemblyInfo>
 233       <ReturnValue>
 234         <ReturnType>System.Void</ReturnType>
 235       </ReturnValue>
 236       <Parameters />
 237       <Docs>
 238         <summary>To be added.</summary>
 239         <remarks>To be added.</remarks>
 240       </Docs>
 241     </Member>
 242     <Member MemberName="PlaySync">
 243       <MemberSignature Language="C#" Value="public void PlaySync ();" />
 244       <MemberType>Method</MemberType>
 245       <AssemblyInfo>
 246         <AssemblyVersion>2.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>
 257     <Member MemberName="SoundLocation">
 258       <MemberSignature Language="C#" Value="public string SoundLocation { set; get; }" />
 259       <MemberType>Property</MemberType>
 260       <AssemblyInfo>
 261         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 262       </AssemblyInfo>
 263       <ReturnValue>
 264         <ReturnType>System.String</ReturnType>
 265       </ReturnValue>
 266       <Docs>
 267         <summary>To be added.</summary>
 268         <value>To be added.</value>
 269         <remarks>To be added.</remarks>
 270       </Docs>
 271     </Member>
 272     <Member MemberName="SoundLocationChanged">
 273       <MemberSignature Language="C#" Value="public event EventHandler SoundLocationChanged;" />
 274       <MemberType>Event</MemberType>
 275       <AssemblyInfo>
 276         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 277       </AssemblyInfo>
 278       <ReturnValue>
 279         <ReturnType>System.EventHandler</ReturnType>
 280       </ReturnValue>
 281       <Docs>
 282         <summary>To be added.</summary>
 283         <remarks>To be added.</remarks>
 284       </Docs>
 285     </Member>
 286     <Member MemberName="Stop">
 287       <MemberSignature Language="C#" Value="public void Stop ();" />
 288       <MemberType>Method</MemberType>
 289       <AssemblyInfo>
 290         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 291       </AssemblyInfo>
 292       <ReturnValue>
 293         <ReturnType>System.Void</ReturnType>
 294       </ReturnValue>
 295       <Parameters />
 296       <Docs>
 297         <summary>To be added.</summary>
 298         <remarks>To be added.</remarks>
 299       </Docs>
 300     </Member>
 301     <Member MemberName="Stream">
 302       <MemberSignature Language="C#" Value="public System.IO.Stream Stream { set; get; }" />
 303       <MemberType>Property</MemberType>
 304       <AssemblyInfo>
 305         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 306       </AssemblyInfo>
 307       <ReturnValue>
 308         <ReturnType>System.IO.Stream</ReturnType>
 309       </ReturnValue>
 310       <Docs>
 311         <summary>To be added.</summary>
 312         <value>To be added.</value>
 313         <remarks>To be added.</remarks>
 314       </Docs>
 315     </Member>
 316     <Member MemberName="StreamChanged">
 317       <MemberSignature Language="C#" Value="public event EventHandler StreamChanged;" />
 318       <MemberType>Event</MemberType>
 319       <AssemblyInfo>
 320         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 321       </AssemblyInfo>
 322       <ReturnValue>
 323         <ReturnType>System.EventHandler</ReturnType>
 324       </ReturnValue>
 325       <Docs>
 326         <summary>To be added.</summary>
 327         <remarks>To be added.</remarks>
 328       </Docs>
 329     </Member>
 330     <Member MemberName="System.Runtime.Serialization.ISerializable.GetObjectData">
 331       <MemberSignature Language="C#" Value="void ISerializable.GetObjectData (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
 332       <MemberType>Method</MemberType>
 333       <AssemblyInfo>
 334         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 335       </AssemblyInfo>
 336       <ReturnValue>
 337         <ReturnType>System.Void</ReturnType>
 338       </ReturnValue>
 339       <Parameters>
 340         <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
 341         <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
 342       </Parameters>
 343       <Docs>
 344         <param name="info">To be added.</param>
 345         <param name="context">To be added.</param>
 346         <summary>To be added.</summary>
 347         <remarks>To be added.</remarks>
 348       </Docs>
 349     </Member>
 350     <Member MemberName="Tag">
 351       <MemberSignature Language="C#" Value="public object Tag { set; get; }" />
 352       <MemberType>Property</MemberType>
 353       <AssemblyInfo>
 354         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 355       </AssemblyInfo>
 356       <ReturnValue>
 357         <ReturnType>System.Object</ReturnType>
 358       </ReturnValue>
 359       <Docs>
 360         <summary>To be added.</summary>
 361         <value>To be added.</value>
 362         <remarks>To be added.</remarks>
 363       </Docs>
 364     </Member>
 365   </Members>
 366 </Type>