Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Multimedia.Radio.xml
index d02a8e7..961a17e 100644 (file)
-<?xml version="1.0"?>
-<doc>
-    <assembly>
-        <name>Tizen.Multimedia.Radio</name>
-    </assembly>
-    <members>
-        <member name="T:Tizen.Multimedia.Radio">
-            <summary>
-            Provides a means for using the radio feature.
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.Radio.#ctor">
-            <summary>
-            Initialize a new instance of the Radio class.
-            </summary>
-            <exception cref="T:System.NotSupportedException">Radio feature is not supported</exception>
-        </member>
-        <member name="E:Tizen.Multimedia.Radio.ScanUpdated">
-            <summary>
-            Occurs when radio scan information is updated.
-            </summary>
-        </member>
-        <member name="E:Tizen.Multimedia.Radio.ScanStopped">
-            <summary>
-            Occurs when radio scanning stops.
-            </summary>
-        </member>
-        <member name="E:Tizen.Multimedia.Radio.ScanCompleted">
-            <summary>
-            Occurs when radio scan is completed.
-            </summary>
-        </member>
-        <member name="E:Tizen.Multimedia.Radio.Interrupted">
-            <summary>
-            Occurs when radio is interrupted
-            </summary>
-        </member>
-        <member name="P:Tizen.Multimedia.Radio.State">
-            <summary>
-            Gets the current state of the radio.
-            </summary>
-        </member>
-        <member name="P:Tizen.Multimedia.Radio.Frequency">
-            <summary>
-            Gets or sets the radio frequency, in [87500 ~ 108000] (kHz).
-            </summary>
-            <exception cref="T:System.ArgumentOutOfRangeException">
-                <paramref name="value"/> is less than <see cref="P:Tizen.Multimedia.Range.Min"/> of <see cref="P:Tizen.Multimedia.Radio.FrequencyRange"/>.\n
-                - or - \n
-                <paramref name="value"/> is greater than <see cref="P:Tizen.Multimedia.Range.Max"/> of <see cref="P:Tizen.Multimedia.Radio.FrequencyRange"/>.\n
-            </exception>
-        </member>
-        <member name="P:Tizen.Multimedia.Radio.SignalStrength">
-            <summary>
-            Gets the current signal strength, in [-128 ~ 128] (dBm).
-            </summary>
-        </member>
-        <member name="P:Tizen.Multimedia.Radio.IsMuted">
-            <summary>
-            Gets the value indicating if radio is muted.
-            </summary>
-            <value>
-            true if the radio is muted; otherwise, false.
-            The default is false.
-            </value>
-        </member>
-        <member name="P:Tizen.Multimedia.Radio.ChannelSpacing">
-            <summary>
-            Gets the channel spacing for current region.
-            </summary>
-        </member>
-        <member name="P:Tizen.Multimedia.Radio.Volume">
-            <summary>
-            Gets or sets the radio volume level.
-            </summary>
-            <remarks>Valid volume range is from 0 to 1.0(100%), inclusive.</remarks>
-            <value>The default is 1.0.</value>
-            <exception cref="T:System.ArgumentOutOfRangeException">
-                <paramref name="value"/> is less than zero.\n
-                - or -\n
-                <paramref name="value"/> is greater than 1.0.
-            </exception>
-        </member>
-        <member name="P:Tizen.Multimedia.Radio.FrequencyRange">
-            <summary>
-            Gets the frequency for the region, in [87500 ~ 108000] (kHz).
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.Radio.Start">
-            <summary>
-            Starts the radio.
-            </summary>
-            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Ready"/> state.</remarks>
-            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
-        </member>
-        <member name="M:Tizen.Multimedia.Radio.Stop">
-            <summary>
-            Stops the radio.
-            </summary>
-            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>
-            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
-        </member>
-        <member name="M:Tizen.Multimedia.Radio.StartScan">
-            <summary>
-            Starts radio scan, will trigger ScanInformationUpdated event, when scan information is updated
-            </summary>
-            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Ready"/> or <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>
-            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
-            <seealso cref="E:Tizen.Multimedia.Radio.ScanUpdated"/>
-            <seealso cref="E:Tizen.Multimedia.Radio.ScanCompleted"/>
-        </member>
-        <member name="M:Tizen.Multimedia.Radio.StopScan">
-            <summary>
-            Stops radio scan.
-            </summary>
-            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Scanning"/> state.</remarks>
-            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
-            <seealso cref="E:Tizen.Multimedia.Radio.ScanStopped"/>
-        </member>
-        <member name="M:Tizen.Multimedia.Radio.SeekUpAsync">
-            <summary>
-            Seeks up the effective frequency of the radio.
-            </summary>
-            <returns>
-            A task that represents the asynchronous seeking operation.
-            The result value is the current frequency, in range [87500 ~ 108000] (kHz).
-            It can be -1 if the seeking operation has failed.
-            </returns>
-            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>
-            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
-        </member>
-        <member name="M:Tizen.Multimedia.Radio.SeekDownAsync">
-            <summary>
-            Seeks down the effective frequency of the radio.
-            </summary>
-            <returns>
-            A task that represents the asynchronous seeking operation.
-            The result value is the current frequency, in range [87500 ~ 108000] (kHz).
-            It can be -1 if the seeking operation has failed.
-            </returns>
-            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>
-            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>
-        </member>
-        <member name="M:Tizen.Multimedia.Radio.Dispose(System.Boolean)">
-            <summary>
-            Releases the resources used by the Radio.
-            </summary>
-            <param name="disposing">
-            true to release both managed and unmanaged resources; false to release only unmanaged resources.
-            </param>
-        </member>
-        <member name="M:Tizen.Multimedia.Radio.Dispose">
-            <summary>
-            Releases all resources used by the <see cref="T:Tizen.Multimedia.Radio"/> object.
-            </summary>
-        </member>
-        <member name="T:Tizen.Multimedia.RadioInterruptedEventArgs">
-            <summary>
-            Provides data for the <see cref="E:Tizen.Multimedia.Radio.Interrupted"/> event.
-            </summary>
-        </member>
-        <member name="P:Tizen.Multimedia.RadioInterruptedEventArgs.Reason">
-            <summary>
-            Gets the reason.
-            </summary>
-            <value>The reason for interruption.</value>
-        </member>
-        <member name="M:Tizen.Multimedia.RadioInterruptedEventArgs.ToString">
-            <summary>
-            Returns a string that represents the current object.
-            </summary>
-            <returns>A string that represents the current object.</returns>
-        </member>
-        <member name="T:Tizen.Multimedia.RadioInterruptedReason">
-            <summary>
-            Specifies <see cref="T:Tizen.Multimedia.Radio"/> interrupted reasons.
-            </summary>
-        </member>
-        <member name="F:Tizen.Multimedia.RadioInterruptedReason.ResourceConflict">
-            <summary>
-            By a resource conflict.
-            </summary>
-        </member>
-        <member name="T:Tizen.Multimedia.RadioState">
-            <summary>
-            Specifies states of the <see cref="T:Tizen.Multimedia.Radio"/>.
-            </summary>
-        </member>
-        <member name="F:Tizen.Multimedia.RadioState.Ready">
-            <summary>
-            Ready to play or scan.
-            </summary>
-        </member>
-        <member name="F:Tizen.Multimedia.RadioState.Playing">
-            <summary>
-            Playing audio from the tuner.
-            </summary>
-        </member>
-        <member name="F:Tizen.Multimedia.RadioState.Scanning">
-            <summary>
-            Scanning; searching for the next station for signal.
-            </summary>
-        </member>
-        <member name="T:Tizen.Multimedia.ScanUpdatedEventArgs">
-            <summary>
-            Provides data for the <see cref="E:Tizen.Multimedia.Radio.ScanUpdated"/> event.
-            </summary>
-        </member>
-        <member name="P:Tizen.Multimedia.ScanUpdatedEventArgs.Frequency">
-            <summary>
-            Gets the tuned radio frequency that is scanned, in range [87500 ~ 108000] (kHz).
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.ScanUpdatedEventArgs.ToString">
-            <summary>
-            Returns a string that represents the current object.
-            </summary>
-            <returns>A string that represents the current object.</returns>
-        </member>
-    </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+    <assembly>\r
+        <name>Tizen.Multimedia.Radio</name>\r
+    </assembly>\r
+    <members>\r
+        <member name="T:Tizen.Multimedia.Radio">\r
+            <summary>\r
+            Provides a means for using the radio feature.\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.Radio.#ctor">\r
+            <summary>\r
+            Initializes a new instance of the Radio class.\r
+            </summary>\r
+            <exception cref="T:System.NotSupportedException">The radio feature is not supported.</exception>\r
+        </member>\r
+        <member name="E:Tizen.Multimedia.Radio.ScanUpdated">\r
+            <summary>\r
+            Occurs when the radio scanning information is updated.\r
+            </summary>\r
+        </member>\r
+        <member name="E:Tizen.Multimedia.Radio.ScanStopped">\r
+            <summary>\r
+            Occurs when the radio scanning stops.\r
+            </summary>\r
+        </member>\r
+        <member name="E:Tizen.Multimedia.Radio.ScanCompleted">\r
+            <summary>\r
+            Occurs when the radio scanning is completed.\r
+            </summary>\r
+        </member>\r
+        <member name="E:Tizen.Multimedia.Radio.Interrupted">\r
+            <summary>\r
+            Occurs when the radio is interrupted.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.Radio.State">\r
+            <summary>\r
+            Gets the current state of the radio.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.Radio.Frequency">\r
+            <summary>\r
+            Gets or sets the radio frequency in the range of 87500 ~ 108000 kHz.\r
+            </summary>\r
+            <exception cref="T:System.ArgumentOutOfRangeException">\r
+                <paramref name="value"/> is less than <see cref="P:Tizen.Multimedia.Range.Min"/> of <see cref="P:Tizen.Multimedia.Radio.FrequencyRange"/>.\n\r
+                - or - \n\r
+                <paramref name="value"/> is greater than <see cref="P:Tizen.Multimedia.Range.Max"/> of <see cref="P:Tizen.Multimedia.Radio.FrequencyRange"/>.\n\r
+            </exception>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.Radio.SignalStrength">\r
+            <summary>\r
+            Gets the current signal strength in the range of -128 ~ 128 dBm.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.Radio.IsMuted">\r
+            <summary>\r
+            Gets the value indicating if the radio is muted.\r
+            </summary>\r
+            <value>\r
+            true if the radio is muted; otherwise, false.\r
+            The default is false.\r
+            </value>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.Radio.ChannelSpacing">\r
+            <summary>\r
+            Gets the channel spacing for the current region.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.Radio.Volume">\r
+            <summary>\r
+            Gets or sets the radio volume level.\r
+            </summary>\r
+            <remarks>Valid volume range is from 0 to 1.0(100%), inclusive.</remarks>\r
+            <value>The default is 1.0.</value>\r
+            <exception cref="T:System.ArgumentOutOfRangeException">\r
+                <paramref name="value"/> is less than zero.\n\r
+                - or -\n\r
+                <paramref name="value"/> is greater than 1.0.\r
+            </exception>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.Radio.FrequencyRange">\r
+            <summary>\r
+            Gets the frequency for the region in the range of 87500 ~ 108000 kHz.\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.Radio.Start">\r
+            <summary>\r
+            Starts the radio.\r
+            </summary>\r
+            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Ready"/> state.</remarks>\r
+            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.Radio.Stop">\r
+            <summary>\r
+            Stops the radio.\r
+            </summary>\r
+            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>\r
+            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.Radio.StartScan">\r
+            <summary>\r
+            Starts the radio scanning and triggers the ScanInformationUpdated event when the scan information is updated.\r
+            </summary>\r
+            <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
+            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>\r
+            <seealso cref="E:Tizen.Multimedia.Radio.ScanUpdated"/>\r
+            <seealso cref="E:Tizen.Multimedia.Radio.ScanCompleted"/>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.Radio.StopScan">\r
+            <summary>\r
+            Stops the radio scanning.\r
+            </summary>\r
+            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Scanning"/> state.</remarks>\r
+            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>\r
+            <seealso cref="E:Tizen.Multimedia.Radio.ScanStopped"/>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.Radio.SeekUpAsync">\r
+            <summary>\r
+            Seeks up the effective frequency of the radio.\r
+            </summary>\r
+            <returns>\r
+            A task that represents the asynchronous seeking operation.\r
+            The result value is the current frequency in the range of 87500 ~ 108000 kHz.\r
+            It can be -1 if the seeking operation has failed.\r
+            </returns>\r
+            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>\r
+            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.Radio.SeekDownAsync">\r
+            <summary>\r
+            Seeks down the effective frequency of the radio.\r
+            </summary>\r
+            <returns>\r
+            A task that represents the asynchronous seeking operation.\r
+            The result value is the current frequency in the range of 87500 ~ 108000 kHz.\r
+            It can be -1 if the seeking operation has failed.\r
+            </returns>\r
+            <remarks>The radio must be in the <see cref="F:Tizen.Multimedia.RadioState.Playing"/> state.</remarks>\r
+            <exception cref="T:System.InvalidOperationException">The radio is not in the valid state.</exception>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.Radio.Dispose(System.Boolean)">\r
+            <summary>\r
+            Releases the resources used by the Radio.\r
+            </summary>\r
+            <param name="disposing">\r
+            true to release both managed and unmanaged resources; false to release only unmanaged resources.\r
+            </param>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.Radio.Dispose">\r
+            <summary>\r
+            Releases all resources used by the <see cref="T:Tizen.Multimedia.Radio"/> object.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Multimedia.RadioInterruptedEventArgs">\r
+            <summary>\r
+            Provides data for the <see cref="E:Tizen.Multimedia.Radio.Interrupted"/> event.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.RadioInterruptedEventArgs.Reason">\r
+            <summary>\r
+            Gets the reason.\r
+            </summary>\r
+            <value>The reason for interruption.</value>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.RadioInterruptedEventArgs.ToString">\r
+            <summary>\r
+            Returns a string that represents the current object.\r
+            </summary>\r
+            <returns>A string that represents the current object.</returns>\r
+        </member>\r
+        <member name="T:Tizen.Multimedia.RadioInterruptedReason">\r
+            <summary>\r
+            Specifies <see cref="T:Tizen.Multimedia.Radio"/> interrupted reasons.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Multimedia.RadioInterruptedReason.ResourceConflict">\r
+            <summary>\r
+            By a resource conflict.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Multimedia.RadioState">\r
+            <summary>\r
+            Specifies states of the <see cref="T:Tizen.Multimedia.Radio"/>.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Multimedia.RadioState.Ready">\r
+            <summary>\r
+            Ready to play or scan.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Multimedia.RadioState.Playing">\r
+            <summary>\r
+            Playing audio from the tuner.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Multimedia.RadioState.Scanning">\r
+            <summary>\r
+            Scanning; searching for the next station for signal.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Multimedia.ScanUpdatedEventArgs">\r
+            <summary>\r
+            Provides data for the <see cref="E:Tizen.Multimedia.Radio.ScanUpdated"/> event.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.ScanUpdatedEventArgs.Frequency">\r
+            <summary>\r
+            Gets the tuned radio frequency that is scanned, in range [87500 ~ 108000] (kHz).\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.ScanUpdatedEventArgs.ToString">\r
+            <summary>\r
+            Returns a string that represents the current object.\r
+            </summary>\r
+            <returns>A string that represents the current object.</returns>\r
+        </member>\r
+    </members>\r
+</doc>\r