SetUserhintBigSignExt

Shows a user hint as a big sign. More...

Variables
static final int	MSG_RI_SET_USERHINT_BIG_SIGN_FROM_EXTERNAL_DIR = 128

Detailed Description

Shows a user hint as a big sign.

Displays the given text and icon in the signpost sign during navigation or tracking. The text is displayed for the given time. The current signpost will not be shown during this time.

This method works on all Android versions, please use this in future implementations instead of MSG_RI_SET_USERHINT_BIG_SIGN.

Sending bundle:

Key	Value	Type	Info
Text	The text to show	String
Icon	The filename including absolute path of the icon to show	String
Duration	The time span in milliseconds	Int
ColorSign	The background color of the sign	Int
ColorText	The text color of the sign	Int
ColorFrame	The frame color of the sign (deprecated)	Int

The icon which should be displayed on the sign has to reside on the file system of the target device.
The client software must use a FileProvider to grant access to the file.

Adding a user hint sign with an icon is done by using the android FileProvider class to be able to grant the foreign navigator app access to files of this client (needed for Android 10/11). The steps to grant a permission is as following:

• Create an xml file in the res/xml folder of your project and list all directories in your app namespace that should be able to be accessed from outside, see the res/xml/filepaths.xml file in this project as an example.

• Add a FileProvider to the manifest file (in the application section). Set the android:resource to above created xml file

  <provider android:name="androidx.core.content.FileProvider" android:authorities="com.ptvag.navigation.ritest.fileprovider" android:exported="false" android:grantUriPermissions="true"> <meta-data android:name="android.support.FILE_PROVIDER_PATHS" android:resource="@xml/filepaths" /> </provider>

• Create a file object with the file you want to transfer/share
• Create an uri for that file with FileProvider.getUriForFile()
• Grant access permissions to this file for a specific package (here we use the navigator as the receiver) with getContext().grantUriPermission(). Use FLAG_GRANT_READ_URI_PERMISSION for minimal reading permission
• If wanted, you can revoke the permission after the navigator sent back the response that the user hint was added (the navigator will copy the bitmap to a temporary folder in the navigator namespace to be able to access it, and therefore it is save to revoke the permission after the navigator response).

Color value are specified as packed ints, made up of 4 bytes: alpha, red, green, blue. The single color components are stored as follows (alpha << 24) | (red << 16) | (green << 8) | blue. Each component ranges between 0..255 with 0 meaning no contribution for that component, and 255 meaning 100% contribution.

Returned error codes:

RI_ERROR_NONE in case the text was shown correctly.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

RI_ERROR_FILE_ACCESS if the file could not be loaded (either because of not granted permissions or of other load error).