Class Radio

    Definition

    Namespace:
    Tizen.Multimedia
    Assembly:
    Tizen.Multimedia.Radio.dll

    Provides a means for using the radio feature.

    public class Radio : IDisposable
    Inheritance
    object
    Radio
    Implements
    System.IDisposable

    Constructors

    View Source

    Radio()

    Initializes a new instance of the Radio class.

    Declaration
    public Radio()
    Exceptions
    Type Condition
    System.NotSupportedException

    The radio feature is not supported.

    Properties

    View Source

    ChannelSpacing

    Gets the channel spacing for the current region.

    Declaration
    public int ChannelSpacing { get; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The radio already has been disposed.

    View Source

    Frequency

    Gets or sets the radio frequency in the range of 87500 ~ 108000 kHz.

    Declaration
    public int Frequency { get; set; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    value is less than Min of FrequencyRange.
    -or-
    value is greater than Max of FrequencyRange.

    System.ObjectDisposedException

    The radio already has been disposed.

    View Source

    FrequencyRange

    Gets the frequency for the region in the range of 87500 ~ 108000 kHz.

    Declaration
    public Range FrequencyRange { get; }
    Property Value
    Type Description
    Range
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The radio already has been disposed.

    View Source

    IsMuted

    Gets or sets the value indicating if the radio is muted.

    Declaration
    public bool IsMuted { get; set; }
    Property Value
    Type Description
    bool

    true if the radio is muted; otherwise, false. The default is false.

    Exceptions
    Type Condition
    System.ObjectDisposedException

    The radio already has been disposed.

    View Source

    SignalStrength

    Gets the current signal strength in the range of -128 ~ 128 dBm.

    Declaration
    public int SignalStrength { get; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The radio already has been disposed.

    View Source

    State

    Gets the current state of the radio.

    Declaration
    public RadioState State { get; }
    Property Value
    Type Description
    RadioState
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The radio already has been disposed.

    View Source

    Volume

    Gets or sets the radio volume level.

    Declaration
    public float Volume { get; set; }
    Property Value
    Type Description
    float

    The default is 1.0.

    Remarks

    Valid volume range is from 0 to 1.0(100%), inclusive.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    value is less than zero.
    -or-
    value is greater than 1.0.

    System.ObjectDisposedException

    The radio already has been disposed.

    Methods

    View Source

    Dispose()

    Releases all resources used by the Radio object.

    Declaration
    public void Dispose()
    View Source

    Dispose(bool)

    Releases the resources used by the Radio.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    true to release both managed and unmanaged resources; false to release only unmanaged resources.

    View Source

    SeekDownAsync()

    Seeks down the effective frequency of the radio.

    Declaration
    public Task<int> SeekDownAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<TResult><int>

    A task that represents the asynchronous seeking operation. The result value is the current frequency in the range of 87500 ~ 108000 kHz. It can be -1 if the seeking operation has failed.

    Remarks

    The radio must be in the Playing state.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The radio is not in the valid state.
    -or-
    Seeking is in progress.

    System.ObjectDisposedException

    The radio already has been disposed.

    View Source

    SeekUpAsync()

    Seeks up the effective frequency of the radio.

    Declaration
    public Task<int> SeekUpAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<TResult><int>

    A task that represents the asynchronous seeking operation. The result value is the current frequency in the range of 87500 ~ 108000 kHz. It can be -1 if the seeking operation has failed.

    Remarks

    The radio must be in the Playing state.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The radio is not in the valid state.
    -or-
    Seeking is in progress.

    System.ObjectDisposedException

    The radio already has been disposed.

    View Source

    Start()

    Starts the radio.

    Declaration
    public void Start()
    Remarks

    The radio must be in the Ready state.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The radio is not in the valid state.

    System.ObjectDisposedException

    The radio already has been disposed.

    View Source

    StartScan()

    Starts the radio scanning and triggers the ScanUpdated event when the scan information is updated.

    Declaration
    public void StartScan()
    Remarks

    The radio must be in the Ready or Playing state.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The radio is not in the valid state.

    System.ObjectDisposedException

    The radio already has been disposed.

    See Also
    ScanUpdated
    ScanCompleted
    View Source

    Stop()

    Stops the radio.

    Declaration
    public void Stop()
    Remarks

    The radio must be in the Playing state.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The radio is not in the valid state.

    System.ObjectDisposedException

    The radio already has been disposed.

    View Source

    StopScan()

    Stops the radio scanning.

    Declaration
    public void StopScan()
    Remarks

    The radio must be in the Scanning state.

    Exceptions
    Type Condition
    System.InvalidOperationException

    The radio is not in the valid state.

    System.ObjectDisposedException

    The radio already has been disposed.

    See Also
    ScanStopped

    Events

    View Source

    Interrupted

    Occurs when the radio is interrupted.

    Declaration
    public event EventHandler<RadioInterruptedEventArgs> Interrupted
    Event Type
    Type Description
    System.EventHandler<TEventArgs><RadioInterruptedEventArgs>
    View Source

    ScanCompleted

    Occurs when the radio scanning is completed.

    Declaration
    public event EventHandler ScanCompleted
    Event Type
    Type Description
    System.EventHandler
    View Source

    ScanStopped

    Occurs when the radio scanning stops.

    Declaration
    public event EventHandler ScanStopped
    Event Type
    Type Description
    System.EventHandler
    View Source

    ScanUpdated

    Occurs when the radio scanning information is updated.

    Declaration
    public event EventHandler<ScanUpdatedEventArgs> ScanUpdated
    Event Type
    Type Description
    System.EventHandler<TEventArgs><ScanUpdatedEventArgs>

    Implements

    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX