NavigationUpdatesOptions

Page Summary

• NavigationUpdatesOptions defines options for reporting navigation updates to a service and is currently in preview release, subject to change.

• It allows customization of generated step images, display metrics for scaling resources, and the number of next steps to preview.

• Developers can use the provided builder to create new instances of NavigationUpdatesOptions.

• This class is part of the Navigation SDK and offers methods for accessing navigation update preferences.

• Note that generating step images at runtime might affect performance.

public class NavigationUpdatesOptions extends AbstractSafeParcelable

Defines the options used when reporting navigation updates to a service.

THIS API IS A PREVIEW RELEASE.
IT IS SUBJECT TO CHANGE AND BACKWARD COMPATIBILITY IS NOT GUARANTEED

Nested Class Summary

class	NavigationUpdatesOptions.Builder		A builder of NavigationUpdatesOptions.
@interface	NavigationUpdatesOptions.GeneratedStepImagesType		Represents the format in which StepInfo maneuver and lane guidance images will be generated.

Inherited Constant Summary

From interface com.google.android.gms.common.internal.safeparcel.SafeParcelable

String

NULL

From interface android.os.Parcelable

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

Public Method Summary

static NavigationUpdatesOptions.Builder	builder() Returns a new Builder instance that allows building new NavigationUpdatesOptions objects.
DisplayMetrics	displayMetrics() The display metrics used to scale generated resources.
int	generatedStepImagesType() The image type to generate.
int	numNextStepsToPreview() The number of next navigation steps in the route that are sent at each update if available, following the current step.

Inherited Method Summary

From class com.google.android.gms.common.internal.safeparcel.AbstractSafeParcelable

final int

describeContents()

From class java.lang.Object

boolean	equals(Object arg0)
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface android.os.Parcelable

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

Public Methods

public static NavigationUpdatesOptions.Builder builder ()

Returns a new Builder instance that allows building new NavigationUpdatesOptions objects.

public DisplayMetrics displayMetrics ()

The display metrics used to scale generated resources.

Note: Only the density factor is populated in the returned DisplayMetrics as resource generation solely relies on density for scaling.

public int generatedStepImagesType ()

The image type to generate. NOTE: When enabled, images are generated by Navigation SDK at runtime and may impact the overall performance.

public int numNextStepsToPreview ()

The number of next navigation steps in the route that are sent at each update if available, following the current step.