Share via


RangingSession.Start(RangingPreference) Method

Definition

Starts the ranging session with the provided ranging preferences.

[Android.Runtime.Register("start", "(Landroid/ranging/RangingPreference;)Landroid/os/CancellationSignal;", "", ApiSince=36)]
[Android.Runtime.RequiresPermission("android.permission.RANGING")]
public Android.OS.CancellationSignal Start(Android.Ranging.RangingPreference rangingPreference);
[<Android.Runtime.Register("start", "(Landroid/ranging/RangingPreference;)Landroid/os/CancellationSignal;", "", ApiSince=36)>]
[<Android.Runtime.RequiresPermission("android.permission.RANGING")>]
member this.Start : Android.Ranging.RangingPreference -> Android.OS.CancellationSignal

Parameters

rangingPreference
RangingPreference

RangingPreference the preferences for configuring the ranging session.

Returns

a CancellationSignal to close the session.

Attributes

Remarks

Starts the ranging session with the provided ranging preferences.

The Callback#onOpened() will be called when the session finishes starting.

The provided RangingPreference determines the configuration for the session. A CancellationSignal is returned to allow the caller to cancel the session if needed. If the session is canceled, the #close() method will be invoked automatically to release resources.

Java documentation for android.ranging.RangingSession.start(android.ranging.RangingPreference).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to