GuidanceNavigator Class

Definition

Provides navigational guidance.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public ref class GuidanceNavigator sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Services.Maps.GuidanceContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class GuidanceNavigator final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Services.Maps.GuidanceContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class GuidanceNavigator
Public NotInheritable Class GuidanceNavigator
Inheritance
Object Platform::Object IInspectable GuidanceNavigator
Attributes

Windows requirements

Device family
Windows Desktop Extension SDK (introduced in 10.0.10240.0)
Windows Mobile Extension SDK (introduced in 10.0.10240.0)
API contract
Windows.Services.Maps.GuidanceContract (introduced in v1.0)

Remarks

Version history

Windows version SDK version Value added
1511 10586 AudioNotificationRequested
1511 10586 IsGuidanceAudioMuted
1511 10586 UseAppProvidedVoice

Properties

AudioMeasurementSystem

Gets or sets the measurement system used for audio guidance.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

AudioNotifications

Gets or sets the types of audio notifications provided by the navigational guidance.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

IsGuidanceAudioMuted

Gets or sets a value that indicates if the audio guidance is muted.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

UseAppProvidedVoice

Gets a value that indicates if Cortana is being used on the device.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Methods

GetCurrent()

Gets the GuidanceNavigator object that represents the current navigational guidance.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Pause()

Pauses navigational guidance.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

RepeatLastAudioNotification()

Repeats the last audio notification.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Resume()

Resumes navigational guidance.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

SetGuidanceVoice(Int32, String)

Sets the voice used for audio notifications.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

StartNavigating(GuidanceRoute)

Starts navigational guidance, using the specified route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

StartSimulating(GuidanceRoute, Int32)

Starts simulation of the navigational guidance, using the specified route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

StartTracking()

Starts navigational guidance, without a specified route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Stop()

Stops navigational guidance.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

UpdateUserLocation(Geocoordinate)

Updates navigational guidance, using the specified geographic location.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

UpdateUserLocation(Geocoordinate, BasicGeoposition)

Updates navigational guidance, using the specified geographic location.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Events

AudioNotificationRequested

Occurs when audio notifications are appropriate for navigational guidance, such as prior to an upcoming turn or exit.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

DestinationReached

Occurs when the route destination has been reached.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

GuidanceUpdated

Occurs when the navigational guidance has been updated.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Rerouted

Occurs when the navigational guidance has been rerouted.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

RerouteFailed

Occurs when rerouting of the navigational guidance fails.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Rerouting

Occurs when navigational guidance is rerouting.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

UserLocationLost

Occurs when the user's location has been lost.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

UserLocationRestored

Occurs when the user's location has been restored.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Applies to