GuidanceNavigator GuidanceNavigator GuidanceNavigator 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 : sealed class GuidanceNavigator : IGuidanceNavigator, IGuidanceNavigator2public sealed class GuidanceNavigator : IGuidanceNavigator, IGuidanceNavigator2Public NotInheritable Class GuidanceNavigator Implements IGuidanceNavigator, IGuidanceNavigator2// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0) Windows Mobile Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Services.Maps.GuidanceContract (introduced v1)

Properties

AudioMeasurementSystem AudioMeasurementSystem AudioMeasurementSystem 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.

public : GuidanceAudioMeasurementSystem AudioMeasurementSystem { get; set; }public GuidanceAudioMeasurementSystem AudioMeasurementSystem { get; set; }Public ReadWrite Property AudioMeasurementSystem As GuidanceAudioMeasurementSystem// This API is not available in Javascript.

Remarks

Regardless of the measurement system used for audio guidance (AudioMeasurementSystem ), the metric system is always used for distance and speed API values.

AudioNotifications AudioNotifications AudioNotifications 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.

public : GuidanceAudioNotifications AudioNotifications { get; set; }public GuidanceAudioNotifications AudioNotifications { get; set; }Public ReadWrite Property AudioNotifications As GuidanceAudioNotifications// This API is not available in Javascript.
Value
GuidanceAudioNotifications GuidanceAudioNotifications GuidanceAudioNotifications GuidanceAudioNotifications

The types of audio notifications provided by the navigational guidance.

IsGuidanceAudioMuted IsGuidanceAudioMuted IsGuidanceAudioMuted 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.

public : PlatForm::Boolean IsGuidanceAudioMuted { get; set; }public bool IsGuidanceAudioMuted { get; set; }Public ReadWrite Property IsGuidanceAudioMuted As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

The audio guidance is muted when the value is true; otherwise the audio guidance is not muted.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10586.0) Windows Mobile Extension SDK (introduced v10.0.10586.0) Windows Team Extension SDK (introduced v10.0.14393.0)
API contract
Windows.Services.Maps.GuidanceContract (introduced v2)

UseAppProvidedVoice UseAppProvidedVoice UseAppProvidedVoice 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.

public : static PlatForm::Boolean UseAppProvidedVoice { get; }public static bool UseAppProvidedVoice { get; }Public Static ReadOnly Property UseAppProvidedVoice As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

When the value is true, Cortana is being used on the device; otherwise, false.

Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10586.0) Windows Mobile Extension SDK (introduced v10.0.10586.0) Windows Team Extension SDK (introduced v10.0.14393.0)
API contract
Windows.Services.Maps.GuidanceContract (introduced v2)

Methods

GetCurrent() GetCurrent() GetCurrent() 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.

public : static GuidanceNavigator GetCurrent()public static GuidanceNavigator GetCurrent()Public Static Function GetCurrent() As GuidanceNavigator// This API is not available in Javascript.
Returns

The GuidanceNavigator object that represents the current navigational guidance.

Pause() Pause() Pause() 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.

public : void Pause()public void Pause()Public Function Pause() As void// This API is not available in Javascript.

RepeatLastAudioNotification() RepeatLastAudioNotification() RepeatLastAudioNotification() 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.

public : void RepeatLastAudioNotification()public void RepeatLastAudioNotification()Public Function RepeatLastAudioNotification() As void// This API is not available in Javascript.

Resume() Resume() Resume() 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.

public : void Resume()public void Resume()Public Function Resume() As void// This API is not available in Javascript.

SetGuidanceVoice(Int32, String) SetGuidanceVoice(Int32, String) SetGuidanceVoice(Int32, String) 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.

public : void SetGuidanceVoice(int voiceId, PlatForm::String voiceFolder)public void SetGuidanceVoice(Int32 voiceId, String voiceFolder)Public Function SetGuidanceVoice(voiceId As Int32, voiceFolder As String) As void// This API is not available in Javascript.
Parameters
voiceId
int Int32 Int32 Int32

The voice identifier.

voiceFolder
PlatForm::String String String String

The folder path of the specified voice.

StartNavigating(GuidanceRoute) StartNavigating(GuidanceRoute) StartNavigating(GuidanceRoute) 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.

public : void StartNavigating(GuidanceRoute route)public void StartNavigating(GuidanceRoute route)Public Function StartNavigating(route As GuidanceRoute) As void// This API is not available in Javascript.
Parameters
route
GuidanceRoute GuidanceRoute GuidanceRoute GuidanceRoute

The route to be navigated.

StartSimulating(GuidanceRoute, Int32) StartSimulating(GuidanceRoute, Int32) StartSimulating(GuidanceRoute, Int32) 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.

public : void StartSimulating(GuidanceRoute route, int speedInMetersPerSecond)public void StartSimulating(GuidanceRoute route, Int32 speedInMetersPerSecond)Public Function StartSimulating(route As GuidanceRoute, speedInMetersPerSecond As Int32) As void// This API is not available in Javascript.
Parameters
route
GuidanceRoute GuidanceRoute GuidanceRoute GuidanceRoute

The route to be navigated.

speedInMetersPerSecond
int Int32 Int32 Int32

The speed of the navigational simulation, in meters per second.

StartTracking() StartTracking() StartTracking() 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.

public : void StartTracking()public void StartTracking()Public Function StartTracking() As void// This API is not available in Javascript.

Stop() Stop() Stop() 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.

public : void Stop()public void Stop()Public Function Stop() As void// This API is not available in Javascript.

UpdateUserLocation(Geocoordinate) UpdateUserLocation(Geocoordinate) UpdateUserLocation(Geocoordinate) 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.

public : void UpdateUserLocation(Geocoordinate userLocation)public void UpdateUserLocation(Geocoordinate userLocation)Public Function UpdateUserLocation(userLocation As Geocoordinate) As void// This API is not available in Javascript.
Parameters
userLocation
Geocoordinate Geocoordinate Geocoordinate Geocoordinate

The user's current location.

Remarks

To find the user's current location, use the Geolocator object in the Windows.Devices.Geolocation namespace. For more information, see Get current location.

See Also

UpdateUserLocation(Geocoordinate, BasicGeoposition) UpdateUserLocation(Geocoordinate, BasicGeoposition) UpdateUserLocation(Geocoordinate, BasicGeoposition) 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.

public : void UpdateUserLocation(Geocoordinate userLocation, BasicGeoposition positionOverride)public void UpdateUserLocation(Geocoordinate userLocation, BasicGeoposition positionOverride)Public Function UpdateUserLocation(userLocation As Geocoordinate, positionOverride As BasicGeoposition) As void// This API is not available in Javascript.
Parameters
userLocation
Geocoordinate Geocoordinate Geocoordinate Geocoordinate

The user's current location.

positionOverride
BasicGeoposition BasicGeoposition BasicGeoposition BasicGeoposition

The altitude, latitude, and longitude to use instead of what's specified in userLocation.

Remarks

See the remarks in the UpdateUserLocation(Geocoordinate) overload of this method.

See Also

Events

AudioNotificationRequested AudioNotificationRequested AudioNotificationRequested 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.

public : event TypedEventHandler AudioNotificationRequested<GuidanceNavigator,  GuidanceAudioNotificationRequestedEventArgs>public event TypedEventHandler AudioNotificationRequested<GuidanceNavigator,  GuidanceAudioNotificationRequestedEventArgs>Public Event AudioNotificationRequested<GuidanceNavigator,  GuidanceAudioNotificationRequestedEventArgs>// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10586.0) Windows Mobile Extension SDK (introduced v10.0.10586.0) Windows Team Extension SDK (introduced v10.0.14393.0)
API contract
Windows.Services.Maps.GuidanceContract (introduced v2)

Remarks

Registering to handle this event turns off automatic audio notifications. Use the GuidanceAudioNotificationRequestedEventArgs to provide your own audio notifications.

DestinationReached DestinationReached DestinationReached 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.

public : event TypedEventHandler DestinationReached<GuidanceNavigator,  object>public event TypedEventHandler DestinationReached<GuidanceNavigator,  object>Public Event DestinationReached<GuidanceNavigator,  object>// This API is not available in Javascript.

GuidanceUpdated GuidanceUpdated GuidanceUpdated 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.

public : event TypedEventHandler GuidanceUpdated<GuidanceNavigator,  GuidanceUpdatedEventArgs>public event TypedEventHandler GuidanceUpdated<GuidanceNavigator,  GuidanceUpdatedEventArgs>Public Event GuidanceUpdated<GuidanceNavigator,  GuidanceUpdatedEventArgs>// This API is not available in Javascript.

Rerouted Rerouted Rerouted 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.

public : event TypedEventHandler Rerouted<GuidanceNavigator,  GuidanceReroutedEventArgs>public event TypedEventHandler Rerouted<GuidanceNavigator,  GuidanceReroutedEventArgs>Public Event Rerouted<GuidanceNavigator,  GuidanceReroutedEventArgs>// This API is not available in Javascript.

RerouteFailed RerouteFailed RerouteFailed 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.

public : event TypedEventHandler RerouteFailed<GuidanceNavigator,  object>public event TypedEventHandler RerouteFailed<GuidanceNavigator,  object>Public Event RerouteFailed<GuidanceNavigator,  object>// This API is not available in Javascript.

Rerouting Rerouting Rerouting 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.

public : event TypedEventHandler Rerouting<GuidanceNavigator,  object>public event TypedEventHandler Rerouting<GuidanceNavigator,  object>Public Event Rerouting<GuidanceNavigator,  object>// This API is not available in Javascript.

UserLocationLost UserLocationLost UserLocationLost 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.

public : event TypedEventHandler UserLocationLost<GuidanceNavigator,  object>public event TypedEventHandler UserLocationLost<GuidanceNavigator,  object>Public Event UserLocationLost<GuidanceNavigator,  object>// This API is not available in Javascript.

UserLocationRestored UserLocationRestored UserLocationRestored 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.

public : event TypedEventHandler UserLocationRestored<GuidanceNavigator,  object>public event TypedEventHandler UserLocationRestored<GuidanceNavigator,  object>Public Event UserLocationRestored<GuidanceNavigator,  object>// This API is not available in Javascript.