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

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