Hud API

Introduction

You can obtain rich navigation status data from Sygic Navigation on the go and use it for your specific needs of visualization.
It can be e.g. your own Head Up Display solution, or maybe you want to broadcast the data on a car-integrated MFD device.
We commonly call this feature as Head Up Display interface.
Typically you can provide drivers with a simplified navigation turn-by-turn instructions represented by direction control visualisation together with showing the distance to the turn to be taken, and/or a time to travel or distance to travel information, etc.
On the following picture you may see the possible exploitation of our API for an embedded display projection.

Getting started

1. Gaining access

In order to gain the access to the functionality you will need a special license. In order to obtain the license please Contact our sales.
You will obtain the trial license for navigation, which will open the API for exploiting the HUD interface.
In case of double please verify:

• the navigation license file (mlm or content.info) must contain the HUD permission: extHud=yes
  (if your license does not contain the HUD permission you should contact your sales representative)

2. Usage template

To get real-time data from Sygic navigation you can use the following class implementation.

You need to register a BroadcastReceiver with IntentFilter "com.sygic.intent.ACTION_HUD_UPDATE".
Intent extras contains the HUD data as a bundle you can exploit.
To get a particular data from the bundle you need to know a key and the data type.

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;

public class SygicUpdatesReceiver extends BroadcastReceiver {

    public static final String INTENT_ACTION_UPDATE= "com.sygic.intent.ACTION_HUD_UPDATE";

    @Override
    public void onReceive(Context context, Intent intent) {
        Bundle hudData = intent.getExtras();
        // parse selected data & send it to your device
        String sval = getStringValue(hudData, "NextStreet");
        // send sval to your device
    }

    private string getStringValue(Bundle hudData, String key) {
      if (hudData.containsKey(key)) {
         return hudData.getString(key);
      }
      return null;
   }
}

In order to instantiate the SygicUpdateReceiver in your application context you can exploit the following pattern:

import android.app.Activity;
import android.content.IntentFilter;
...
public class MainActivity extends Activity {

    private SygicUpdatesReceiver mSygicReceiver;
    ...

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        ...
        mSygicReceiver = new SygicUpdatesReceiver();
        IntentFilter filter = new IntentFilter(SygicUpdatesReceiver.INTENT_ACTION_UPDATE);
        registerReceiver(mSygicReceiver, filter);
    }

    @Override
    protected void onDestroy() {
        unregisterReceiver(mSygicReceiver);
        ...
    }

}

Received data structure

Bundle data

This bundle data retrieved through the OnReceive callback function contains the following data structure:

arrLaneData[n]

From each LaneData you can obtain the following information using these functions.

Charset font

The charset codes retrieved through the bundle data define the graphical symbols as shown in the table bellow.