Class BluetoothAdapter

    Definition

    Namespace:
    Tizen.Network.Bluetooth
    Assembly:
    Tizen.Network.Bluetooth.dll

    This class is used to control the Bluetooth adapter and get the list of bonded devices.
    The BluetoothAdapter class is used to discover neighbouring bluetooth devices.

    public static class BluetoothAdapter
    Inheritance
    object
    BluetoothAdapter

    Properties

    View Source

    Address

    The local adapter address.

    Declaration
    public static string Address { get; }
    Property Value
    Type Description
    string
    Remarks

    The Bluetooth must be enabled.

    View Source

    IsBluetoothEnabled

    A property to check whether the Bluetooth is enabled.

    Declaration
    public static bool IsBluetoothEnabled { get; }
    Property Value
    Type Description
    bool
    View Source

    IsDiscoveryInProgress

    A property to check whether the device discovery process is in progress.

    Declaration
    public static bool IsDiscoveryInProgress { get; }
    Property Value
    Type Description
    bool
    Remarks

    The Bluetooth must be enabled.

    View Source

    Name

    The name of the local adapter.

    Declaration
    public static string Name { get; set; }
    Property Value
    Type Description
    string
    Remarks

    The Bluetooth must be enabled.

    View Source

    RemainingTimeAsVisible

    The remaining time, in seconds, until the visibility mode is changed from TimeLimitedDiscoverable to NonDiscoverable.

    Declaration
    public static int RemainingTimeAsVisible { get; }
    Property Value
    Type Description
    int
    Remarks

    The Bluetooth must be enabled.

    View Source

    Visibility

    The visibility mode of the Bluetooth adapter.

    Declaration
    public static VisibilityMode Visibility { get; }
    Property Value
    Type Description
    VisibilityMode
    Remarks

    The Bluetooth must be enabled.

    Methods

    View Source

    CreateServerSocket(string)

    Registers a rfcomm server socket with a specific UUID.

    Declaration
    public static BluetoothServerSocket CreateServerSocket(string serviceUuid)
    Parameters
    Type Name Description
    string serviceUuid

    The UUID of service to provide.

    Returns
    Type Description
    BluetoothServerSocket

    The BluetoothServerSocket instance.

    Remarks

    The Bluetooth must be enabled before calling this API.

    View Source

    DestroyServerSocket(BluetoothServerSocket)

    Removes the rfcomm server socket which was created using CreateServerSocket().

    Declaration
    public static void DestroyServerSocket(BluetoothServerSocket socket)
    Parameters
    Type Name Description
    BluetoothServerSocket socket

    The server socket instance is created using CreateServerSocket().

    Remarks

    The socket must be created with CreateServerSocket(). The ConnectionStateChanged event is raised after this API is called.

    View Source

    Disable()

    Disables the local Bluetooth adapter asynchronously.

    Declaration
    public static void Disable()
    View Source

    DisableDiscoverable()

    Disables the discoverable mode.

    Declaration
    public static void DisableDiscoverable()
    View Source

    Enable()

    Enables the local Bluetooth adapter asynchronously.

    Declaration
    public static void Enable()
    View Source

    EnableDiscoverable()

    Enables the discoverable mode.

    Declaration
    public static void EnableDiscoverable()
    View Source

    EnableDiscoverable(int)

    Enables the discoverable mode for the duration.

    Declaration
    public static void EnableDiscoverable(int duration)
    Parameters
    Type Name Description
    int duration

    The duration until the discoverable mode is to be disabled(in seconds).

    View Source

    GetBluetoothLeAdvertiser()

    Returns the BluetoothLeAdvertiser instance.

    Declaration
    public static BluetoothLeAdvertiser GetBluetoothLeAdvertiser()
    Returns
    Type Description
    BluetoothLeAdvertiser

    The BluetoothLeAdvertiser instance.

    Remarks

    The Bluetooth must be enabled before calling this API.

    View Source

    GetBondedDevice(string)

    Gets the device information of a bonded device.

    Declaration
    public static BluetoothDevice GetBondedDevice(string address)
    Parameters
    Type Name Description
    string address

    The remote device address.

    Returns
    Type Description
    BluetoothDevice

    Information of the bonded BluetoothDeviceInfo object.

    Remarks

    The Bluetooth must be enabled.

    View Source

    GetBondedDevices()

    Retrieves the device information of all bonded devices.

    Declaration
    public static IEnumerable<BluetoothDevice> GetBondedDevices()
    Returns
    Type Description
    IEnumerable<><BluetoothDevice>

    The list of the bonded BluetoothDeviceInfo objects.

    Remarks

    The Bluetooth must be enabled.

    View Source

    GetLocalOobData()

    Gets the hash and the randomizer value of the local OOB data object.

    Declaration
    public static BluetoothOobData GetLocalOobData()
    Returns
    Type Description
    BluetoothOobData

    The BluetoothOobData object.

    Remarks

    The Bluetooth must be enabled.

    View Source

    GetUuidSpecificationName(string)

    Gets the name of the specification UUID.

    Declaration
    public static string GetUuidSpecificationName(string uuid)
    Parameters
    Type Name Description
    string uuid

    The UUID.

    Returns
    Type Description
    string
    View Source

    IsServiceUsed(string)

    Checks whether the UUID of service is used or not.

    Declaration
    public static bool IsServiceUsed(string serviceUuid)
    Parameters
    Type Name Description
    string serviceUuid

    The UUID of Service.

    Returns
    Type Description
    bool

    true if the specified serviceUuid is used, otherwise false.

    View Source

    RemoveRemoteOobData(string)

    Removes the hash and the randomizer value of the OOB data from the remote device.

    Declaration
    public static void RemoveRemoteOobData(string address)
    Parameters
    Type Name Description
    string address

    The remote device address.

    Remarks

    The Bluetooth must be enabled.

    View Source

    SelectRole(BluetoothAudioRole)

    Select the A2DP source/sink role.

    Declaration
    public static void SelectRole(BluetoothAudioRole role)
    Parameters
    Type Name Description
    BluetoothAudioRole role

    The A2DP source/sink role.

    View Source

    SetRemoteOobData(string, BluetoothOobData)

    Sets the hash and the randmoizer value of the OOB data into the remote device.

    Declaration
    public static void SetRemoteOobData(string address, BluetoothOobData oobData)
    Parameters
    Type Name Description
    string address

    The remote device address.

    BluetoothOobData oobData

    The BluetoothOobData object.

    Remarks

    The Bluetooth must be enabled.

    View Source

    StartDiscovery()

    Starts the device discovery process.

    Declaration
    public static void StartDiscovery()
    Remarks

    The Bluetooth must be enabled and the device discovery process can be stopped by StopDiscovery(). If this succeeds, the DiscoveryStateChanged event will be invoked.

    View Source

    StartLeScan()

    Starts the Bluetooth LE scan operation to discover BLE devices

    Declaration
    public static void StartLeScan()
    Remarks

    The Bluetooth must be enabled.

    View Source

    StartLeScan(BluetoothLeScanMode)

    Starts the Bluetooth LE scan operation with scan mode.

    Declaration
    public static void StartLeScan(BluetoothLeScanMode mode)
    Parameters
    Type Name Description
    BluetoothLeScanMode mode

    The LE scan mode.

    Remarks

    The Bluetooth must be enabled.

    View Source

    StopDiscovery()

    Stops the device discovery process.

    Declaration
    public static void StopDiscovery()
    Remarks

    The device discovery process must be in progress with StartDiscovery(). If this succeeds, the DiscoveryStateChanged event will be invoked.

    View Source

    StopLeScan()

    Stops the Bluetooth LE scan operation.

    Declaration
    public static void StopLeScan()
    Remarks

    The Bluetooth must be enabled.

    Events

    View Source

    AuthenticationChanged

    The AuthenticationChanged event is raised when the Bluetooth adapter authentication is changed.

    Declaration
    public static event EventHandler<AuthenticationRequestedEventArgs> AuthenticationChanged
    Event Type
    Type Description
    EventHandler<><AuthenticationRequestedEventArgs>
    View Source

    DiscoveryStateChanged

    The DiscoveryStateChanged event is raised when the device discovery state is changed.

    Declaration
    public static event EventHandler<DiscoveryStateChangedEventArgs> DiscoveryStateChanged
    Event Type
    Type Description
    EventHandler<><DiscoveryStateChangedEventArgs>
    View Source

    NameChanged

    The NameChanged event is raised when the Bluetooth adapter name is changed.

    Declaration
    public static event EventHandler<NameChangedEventArgs> NameChanged
    Event Type
    Type Description
    EventHandler<><NameChangedEventArgs>
    View Source

    ScanResultChanged

    This event is called when the LE scan result is obtained.

    Declaration
    public static event EventHandler<AdapterLeScanResultChangedEventArgs> ScanResultChanged
    Event Type
    Type Description
    EventHandler<><AdapterLeScanResultChangedEventArgs>
    View Source

    StateChanged

    The StateChanged event is raised when the Bluetooth adapter state is changed.

    Declaration
    public static event EventHandler<StateChangedEventArgs> StateChanged
    Event Type
    Type Description
    EventHandler<><StateChangedEventArgs>
    View Source

    VisibilityDurationChanged

    The VisibilityDurationChanged event is raised very second until the visibility mode is changed to NonDiscoverable.

    Declaration
    public static event EventHandler<VisibilityDurationChangedEventArgs> VisibilityDurationChanged
    Event Type
    Type Description
    EventHandler<><VisibilityDurationChangedEventArgs>
    View Source

    VisibilityModeChanged

    The VisibilityModeChanged event is raised when the Bluetooth adapter visibility mode is changed.

    Declaration
    public static event EventHandler<VisibilityModeChangedEventArgs> VisibilityModeChanged
    Event Type
    Type Description
    EventHandler<><VisibilityModeChangedEventArgs>
    • View Source
    Back to top Copyright © 2016-2025 Samsung
    Generated by DocFX