Artifacts/bin/public/Tizen.Multimedia.Radio.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Tizen.Multimedia.Radio</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Tizen.Multimedia.Radio">
   8             <summary>
   9             Provides a means for using the radio feature.
  10             </summary>
  11         </member>
  12         <member name="M:Tizen.Multimedia.Radio.#ctor">
  13             <summary>
  14             Initialize a new instance of the Radio class.
  15             </summary>
  16             <exception cref="T:System.NotSupportedException">Radio feature is not supported</exception>
  17         </member>
  18         <member name="E:Tizen.Multimedia.Radio.ScanUpdated">
  19             <summary>
  20             Occurs when radio scan information is updated.
  21             </summary>
  22         </member>
  23         <member name="E:Tizen.Multimedia.Radio.ScanStopped">
  24             <summary>
  25             Occurs when radio scanning stops.
  26             </summary>
  27         </member>
  28         <member name="E:Tizen.Multimedia.Radio.ScanCompleted">
  29             <summary>
  30             Occurs when radio scan is completed.
  31             </summary>
  32         </member>
  33         <member name="E:Tizen.Multimedia.Radio.Interrupted">
  34             <summary>
  35             Occurs when radio is interrupted
  36             </summary>
  37         </member>
  38         <member name="P:Tizen.Multimedia.Radio.State">
  39             <summary>
  40             Gets the current state of the radio.
  41             </summary>
  42         </member>
  43         <member name="P:Tizen.Multimedia.Radio.Frequency">
  44             <summary>
  45             Gets or sets the radio frequency, in [87500 ~ 108000] (kHz).
  46             </summary>
  47             <exception cref="T:System.ArgumentOutOfRangeException">
  48                 <paramref name="value"/> is less than <see cref="P:Tizen.Multimedia.Range.Min"/> of <see cref="P:Tizen.Multimedia.Radio.FrequencyRange"/>.\n
  49                 - or - \n
  50                 <paramref name="value"/> is greater than <see cref="P:Tizen.Multimedia.Range.Max"/> of <see cref="P:Tizen.Multimedia.Radio.FrequencyRange"/>.\n
  51             </exception>
  52         </member>
  53         <member name="P:Tizen.Multimedia.Radio.SignalStrength">
  54             <summary>
  55             Gets the current signal strength, in [-128 ~ 128] (dBm).
  56             </summary>
  57         </member>
  58         <member name="P:Tizen.Multimedia.Radio.IsMuted">
  59             <summary>
  60             Gets the value indicating if radio is muted.
  61             </summary>
  62             <value>
  63             true if the radio is muted; otherwise, false.
  64             The default is false.
  65             </value>
  66         </member>
  67         <member name="P:Tizen.Multimedia.Radio.ChannelSpacing">
  68             <summary>
  69             Gets the channel spacing for current region.
  70             </summary>
  71         </member>
  72         <member name="P:Tizen.Multimedia.Radio.Volume">
  73             <summary>
  74             Gets or sets the radio volume level.
  75             </summary>
  76             <remarks>Valid volume range is from 0 to 1.0(100%), inclusive.</remarks>
  77             <value>The default is 1.0.</value>
  78             <exception cref="T:System.ArgumentOutOfRangeException">
  79                 <paramref name="value"/> is less than zero.\n
  80                 - or -\n
  81                 <paramref name="value"/> is greater than 1.0.
  82             </exception>
  83         </member>
  84         <member name="P:Tizen.Multimedia.Radio.FrequencyRange">
  85             <summary>
  86             Gets the frequency for the region, in [87500 ~ 108000] (kHz).
  87             </summary>
  88         </member>
  89         <member name="M:Tizen.Multimedia.Radio.Start">
  90             <summary>
  91             Starts the radio.
  92             </summary>
  93             <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Ready"/> state.</remarks>
  94             <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
  95         </member>
  96         <member name="M:Tizen.Multimedia.Radio.Stop">
  97             <summary>
  98             Stops the radio.
  99             </summary>
 100             <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>
 101             <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
 102         </member>
 103         <member name="M:Tizen.Multimedia.Radio.StartScan">
 104             <summary>
 105             Starts radio scan, will trigger ScanInformationUpdated event, when scan information is updated
 106             </summary>
 107             <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Ready"/> or <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>
 108             <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
 109             <seealso cref="E:Tizen.Multimedia.Radio.ScanUpdated"/>
 110             <seealso cref="E:Tizen.Multimedia.Radio.ScanCompleted"/>
 111         </member>
 112         <member name="M:Tizen.Multimedia.Radio.StopScan">
 113             <summary>
 114             Stops radio scan.
 115             </summary>
 116             <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Scanning"/> state.</remarks>
 117             <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
 118             <seealso cref="E:Tizen.Multimedia.Radio.ScanStopped"/>
 119         </member>
 120         <member name="M:Tizen.Multimedia.Radio.SeekUpAsync">
 121             <summary>
 122             Seeks up the effective frequency of the radio.
 123             </summary>
 124             <returns>
 125             A task that represents the asynchronous seeking operation.
 126             The result value is the current frequency, in range [87500 ~ 108000] (kHz).
 127             It can be -1 if the seeking operation has failed.
 128             </returns>
 129             <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>
 130             <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
 131         </member>
 132         <member name="M:Tizen.Multimedia.Radio.SeekDownAsync">
 133             <summary>
 134             Seeks down the effective frequency of the radio.
 135             </summary>
 136             <returns>
 137             A task that represents the asynchronous seeking operation.
 138             The result value is the current frequency, in range [87500 ~ 108000] (kHz).
 139             It can be -1 if the seeking operation has failed.
 140             </returns>
 141             <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>
 142             <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
 143         </member>
 144         <member name="M:Tizen.Multimedia.Radio.Dispose(System.Boolean)">
 145             <summary>
 146             Releases the resources used by the Radio.
 147             </summary>
 148             <param name="disposing">
 149             true to release both managed and unmanaged resources; false to release only unmanaged resources.
 150             </param>
 151         </member>
 152         <member name="M:Tizen.Multimedia.Radio.Dispose">
 153             <summary>
 154             Releases all resources used by the <see cref="T:Tizen.Multimedia.Radio"/> object.
 155             </summary>
 156         </member>
 157         <member name="T:Tizen.Multimedia.RadioInterruptedEventArgs">
 158             <summary>
 159             Provides data for the <see cref="E:Tizen.Multimedia.Radio.Interrupted"/> event.
 160             </summary>
 161         </member>
 162         <member name="P:Tizen.Multimedia.RadioInterruptedEventArgs.Reason">
 163             <summary>
 164             Gets the reason.
 165             </summary>
 166             <value>The reason for interruption.</value>
 167         </member>
 168         <member name="M:Tizen.Multimedia.RadioInterruptedEventArgs.ToString">
 169             <summary>
 170             Returns a string that represents the current object.
 171             </summary>
 172             <returns>A string that represents the current object.</returns>
 173         </member>
 174         <member name="T:Tizen.Multimedia.RadioInterruptedReason">
 175             <summary>
 176             Specifies <see cref="T:Tizen.Multimedia.Radio"/> interrupted reasons.
 177             </summary>
 178         </member>
 179         <member name="F:Tizen.Multimedia.RadioInterruptedReason.ResourceConflict">
 180             <summary>
 181             By a resource conflict.
 182             </summary>
 183         </member>
 184         <member name="T:Tizen.Multimedia.RadioState">
 185             <summary>
 186             Specifies states of the <see cref="T:Tizen.Multimedia.Radio"/>.
 187             </summary>
 188         </member>
 189         <member name="F:Tizen.Multimedia.RadioState.Ready">
 190             <summary>
 191             Ready to play or scan.
 192             </summary>
 193         </member>
 194         <member name="F:Tizen.Multimedia.RadioState.Playing">
 195             <summary>
 196             Playing audio from the tuner.
 197             </summary>
 198         </member>
 199         <member name="F:Tizen.Multimedia.RadioState.Scanning">
 200             <summary>
 201             Scanning; searching for the next station for signal.
 202             </summary>
 203         </member>
 204         <member name="T:Tizen.Multimedia.ScanUpdatedEventArgs">
 205             <summary>
 206             Provides data for the <see cref="E:Tizen.Multimedia.Radio.ScanUpdated"/> event.
 207             </summary>
 208         </member>
 209         <member name="P:Tizen.Multimedia.ScanUpdatedEventArgs.Frequency">
 210             <summary>
 211             Gets the tuned radio frequency that is scanned, in range [87500 ~ 108000] (kHz).
 212             </summary>
 213         </member>
 214         <member name="M:Tizen.Multimedia.ScanUpdatedEventArgs.ToString">
 215             <summary>
 216             Returns a string that represents the current object.
 217             </summary>
 218             <returns>A string that represents the current object.</returns>
 219         </member>
 220     </members>
 221 </doc>