ZebraHud

java.lang.Object
- com.symbol.zebrahud.ZebraHud

public class ZebraHud
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ZebraHud.EventListener` Interface that defines events an activity can choose to listener for.
`static class`	`ZebraHud.HudCameraResolution` Camera resolution data.
`static class`	`ZebraHud.HudViewBinding` Return result from `showHudViewBinding(HudViewBinding)`, to support Callers implementing the v3.6 View Binding feature.
`static interface`	`ZebraHud.ImuListener` Interface for the IMU data event

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BrightnessStepValue` Current brightness percent step-value
`static int[]`	`ListCamera720pFramerates` List of supported framerates for the 720p camera video.
`static int`	`ScaleStepValue` Current scale percent step-value

Constructor Summary

Constructors
Constructor and Description

ZebraHud()

Constructors
Constructor and Description
`ZebraHud()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attachToContext(Context context, ZebraHud.EventListener listener)` Interacting with the HUD without using the Android application lifecycle.
`void`	`clearDisplay()` Clear the HUD display.
`View`	`createHudView(int layout)` Create a View to be drawn on the HUD display.
`void`	`deinit(Application applicationContext)` Interacting with the HUD may be tied to your Android application lifecycle.
`void`	`detachFromContext(Context context, java.lang.Boolean showInterrupt)` Interacting with the HUD without using the Android application lifecycle.
`int`	`getBrightness()` Get the HUD display brightness.
`int`	`getCamera720pFramerate()` Get the framerate of the 720p camera video.
`java.util.List<ZebraHud.HudCameraResolution>`	`getCameraAllResolutions()` Get the list of all supported camera resolutions.
`ZebraHud.HudCameraResolution`	`getCameraCurrentResolution()` Get the current camera resolution.
`boolean`	`getCameraEnabled()` Get the HUD camera state.
`int`	`getCameraZoom()` Get the camera digital zoom value, as a percentage.
`java.lang.String`	`getDeviceInfo()` Returns information about the current HUD device.
`ZebraHud.HudViewBinding`	`getHudViewBinding()` Create a View to be drawn on the HUD display, using the v3.6 View Binding feature.
`boolean`	`getImuStatus()` Get the status of the HUD IMU data streaming.
`boolean`	`getMicrophoneEnabled()` Get the HUD microphone state.
`int`	`getScale()` Get the HUD display scale.
`java.lang.String`	`getServiceVersion()` Returns the HUD service version.
`void`	`init(Application applicationContext)` Interacting with the HUD may be tied to your Android application lifecycle.
`boolean`	`isConnected()`
`boolean`	`isDisplayOn()` Get if the HUD display is on or off.
`void`	`onPause(Activity activity)` Interacting with the HUD is tied to your Android activity lifecycle.
`void`	`onResume(Activity activity, ZebraHud.EventListener listener)` Interacting with the HUD is tied to your Android activity lifecycle.
`void`	`onStart(Activity activity)` Interacting with the HUD is tied to your Android activity lifecycle.
`void`	`onStop(Activity activity, java.lang.Boolean showInterrupt)` Interacting with the HUD is tied to your Android activity lifecycle.
`void`	`setBrightness(int percent)` Set the HUD display brightness.
`void`	`setCamera720pFramerate(int framerate)` Set the framerate of the 720p camera video, which is stored in non-volatile HUD memory.
`java.lang.Boolean`	`setCameraCurrentResolution(ZebraHud.HudCameraResolution resolution)` Set the current camera resolution.
`boolean`	`setCameraZoom(int zoom)` Set the camera digital zoom value
`void`	`setDisplayOn(boolean on)` Set the HUD display on or off.
`void`	`setMicrophoneEnabled(boolean enable)` Set the the HUD microphone state.
`void`	`setScale(int percent)` Set the HUD display scale.
`boolean`	`showBitmapDirect(Bitmap bitmap)` Use the direct (fastest) method to show a bitmap on the HUD display.
`void`	`showCachedImage(byte[] bytes)` Show a byte array on the HUD display.
`byte[]`	`showHudView(View view)` Create a View to be drawn on the HUD display.
`byte[]`	`showHudViewBinding(ZebraHud.HudViewBinding hudViewBinding)` Create a View to be drawn on the HUD display.
`byte[]`	`showImage(Bitmap bitmap)` Show a bitmap on the HUD display.
`byte[]`	`showJim(java.lang.String jim)` Show a JSON image model on the HUD display.
`byte[]`	`showJim(java.lang.String jim, byte[] jpegImage)` Show an existing background image (such as the returned image from `showHudView(View)`) and apply a JSON image model to overlay the image.
`byte[]`	`showJim(java.lang.String jim, java.lang.String directoryImages, java.lang.String imageFilename, java.lang.String jimBase)` Show a JSON image model on the HUD display, with optional background image and Base JIM.
`boolean`	`showJpegDirect(byte[] jpeg)` Use the direct (fastest) method to show a jpeg on the HUD display.
`byte[]`	`showMessage(java.lang.String title, java.lang.String message)` Show a message on the HUD display.
`void`	`startCameraCapture()` Start the HUD camera capturing images.
`void`	`startCameraCaptureRawJpeg()` Start the HUD camera capturing images, and returning them as raw jpeg frames (from the motion-jpeg stream on the UVC camera).
`void`	`startImu(ZebraHud.ImuListener imuListener)` Start HUD IMU data streaming.
`void`	`stopCameraCapture()` Stop the HUD camera capturing images.
`void`	`stopImu()` Stop HUD IMU data streaming.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BrightnessStepValue
```
public static int BrightnessStepValue
```
    Current brightness percent step-value
  - ScaleStepValue
```
public static int ScaleStepValue
```
    Current scale percent step-value
  - ListCamera720pFramerates
```
public static int[] ListCamera720pFramerates
```
    List of supported framerates for the 720p camera video.
- Constructor Detail
  - ZebraHud
```
public ZebraHud()
```
- Method Detail
  - init
```
public void init(Application applicationContext)
```
    Interacting with the HUD may be tied to your Android application lifecycle.
    Optionally call from Application.onCreate().
    Recommended if your application uses many activities with the HUD.
    
    Parameters:
    
    applicationContext - The application context to be associated with the HUD
  - deinit
```
public void deinit(Application applicationContext)
```
    Interacting with the HUD may be tied to your Android application lifecycle.
    Optionally call from Application.onTerminate().
    Recommended if your application uses many activities with the HUD.
    
    Parameters:
    
    applicationContext - The application context to be associated with the HUD
  - attachToContext
```
public void attachToContext(Context context,
                            ZebraHud.EventListener listener)
```
    Interacting with the HUD without using the Android application lifecycle. Recommended for Android Services.
    
    Parameters:
    
    context - Application context to be associated with the HUD
    
    listener - Callback interface
  - detachFromContext
```
public void detachFromContext(Context context,
                              java.lang.Boolean showInterrupt)
```
    Interacting with the HUD without using the Android application lifecycle. Recommended for Android Services.
    
    Parameters:
    
    context - Application context to be associated with the HUD
    
    showInterrupt - If true show "app interrupted" message on HUD, otherwise leave last image
  - onStart
```
public void onStart(Activity activity)
```
    Interacting with the HUD is tied to your Android activity lifecycle.
    Call from Activity.onStart().
    
    Parameters:
    
    activity - The activity to be associated with the HUD
  - onStop
```
public void onStop(Activity activity,
                   java.lang.Boolean showInterrupt)
```
    Interacting with the HUD is tied to your Android activity lifecycle.
    Call from Activity.onStop().
    This call will not clear the HUD display. Use clearDisplay() if this is desired.
    
    Parameters:
    
    activity - The activity to be associated with the HUD
    
    showInterrupt - If true show "app interrupted" message on HUD, otherwise leave last image
  - onResume
```
public void onResume(Activity activity,
                     ZebraHud.EventListener listener)
```
    Interacting with the HUD is tied to your Android activity lifecycle.
    Call from Activity.onResume().
    
    Parameters:
    
    activity - The activity to be associated with the HUD
    
    listener - Callback interface
  - onPause
```
public void onPause(Activity activity)
```
    Interacting with the HUD is tied to your Android activity lifecycle.
    Call from Activity.onPause().
    
    Parameters:
    
    activity - The activity to be associated with the HUD
  - getDeviceInfo
```
public java.lang.String getDeviceInfo()
```
    Returns information about the current HUD device.
    The format of this information will be specific to the device.
    
    Returns:
    
    Information about the current HUD device or an empty string if unavailable
  - getServiceVersion
```
public java.lang.String getServiceVersion()
```
    Returns the HUD service version.
    
    Returns:
    
    The version of this library
  - isConnected
```
public boolean isConnected()
```
    Returns:
    
    The version of this library
  - setDisplayOn
```
public void setDisplayOn(boolean on)
```
    Set the HUD display on or off.
    
    Parameters:
    
    on - True to set to on, false to set to off
  - isDisplayOn
```
public boolean isDisplayOn()
```
    Get if the HUD display is on or off.
    
    Returns:
    
    True if on, false if off
  - clearDisplay
```
public void clearDisplay()
```
    Clear the HUD display.
  - setBrightness
```
public void setBrightness(int percent)
```
    Set the HUD display brightness.
    Note: do not call this API more than once per second. To ensure this, use the UI Button control (and not a Slider control) to adjust the brightness.
    
    Parameters:
    
    percent - The percentage brightness. The HUD display will set the nearest permitted value.
  - getBrightness
```
public int getBrightness()
```
    Get the HUD display brightness.
    
    Returns:
    
    The HUD display brightness in percent
  - setScale
```
public void setScale(int percent)
```
    Set the HUD display scale.
    
    Parameters:
    
    percent - The percentage scale. The HUD display will set the nearest permitted value
  - getScale
```
public int getScale()
```
    Get the HUD display scale.
    
    Returns:
    
    The HUD display scale in percent
  - showMessage
```
public byte[] showMessage(java.lang.String title,
                          java.lang.String message)
```
    Show a message on the HUD display.
    
    Parameters:
    
    title - The title of the message
    
    message - The body of the message
    
    Returns:
    
    Array of bytes representing the display content, or null on error.
  - showImage
```
public byte[] showImage(Bitmap bitmap)
```
    Show a bitmap on the HUD display.
    
    Parameters:
    
    bitmap - The bitmap to show
    
    Returns:
    
    Array of bytes representing the display content, or null on error.
  - showJim
```
public byte[] showJim(java.lang.String jim)
```
    Show a JSON image model on the HUD display.
    
    Parameters:
    
    jim - The JSON image model
    
    Returns:
    
    Array of bytes representing the display content, or null on error. Caller can use BitmapFactory.decodeByteArray() to convert this to a Bitmap.
  - showJim
```
public byte[] showJim(java.lang.String jim,
                      byte[] jpegImage)
```
    Show an existing background image (such as the returned image from showHudView(View)) and apply a JSON image model to overlay the image. This can be used to 'annotate' a previously generated image.
    
    Parameters:
    
    jim - The JSON image model
    
    jpegImage - Background jpeg image to use
    
    Returns:
    
    Array of bytes representing the display content, or null on error. Caller can use BitmapFactory.decodeByteArray() to convert this to a Bitmap.
  - showJim
```
public byte[] showJim(java.lang.String jim,
                      java.lang.String directoryImages,
                      java.lang.String imageFilename,
                      java.lang.String jimBase)
```
    Show a JSON image model on the HUD display, with optional background image and Base JIM.
    
    Parameters:
    
    jim - The JSON image model
    
    directoryImages - Absolute directory path for all relative-path image filenames
    
    imageFilename - (Optional) filename of the background image to use as default
    
    jimBase - (Optional) Base JIM to use, for global defaults
    
    Returns:
    
    Array of bytes representing the display content, or null on error. Caller can use BitmapFactory.decodeByteArray() to convert this to a Bitmap.
  - showBitmapDirect
```
public boolean showBitmapDirect(Bitmap bitmap)
```
    Use the direct (fastest) method to show a bitmap on the HUD display. Using this method skips all image pre/post-processing, such as auto-resizing the image and the setScale(int) functionality. Note: the image will not appear in the HUD display, if it is not correctly sized to fit the display dimensions (which is reported in getDeviceInfo())
    
    Parameters:
    
    bitmap - The bitmap to show
    
    Returns:
    
    Success if HUD was connected and image was sent
  - showJpegDirect
```
public boolean showJpegDirect(byte[] jpeg)
```
    Use the direct (fastest) method to show a jpeg on the HUD display. Using this method skips all image pre/post-processing, such as auto-resizing the image and the setScale(int) functionality. Note: the image will not appear in the HUD display, if it is not correctly sized to fit the display dimensions (which is reported in getDeviceInfo())
    
    Parameters:
    
    jpeg - The jpeg to show
    
    Returns:
    
    Success if HUD was connected and image was sent
  - createHudView
```
public View createHudView(int layout)
```
    Create a View to be drawn on the HUD display.
    To draw must call showHudView(View)
    
    Parameters:
    
    layout - The layout id to inflate
    
    Returns:
    
    A view that can be shown on the HUD.
  - showHudView
```
public byte[] showHudView(View view)
```
    Create a View to be drawn on the HUD display.
    View must be created with createHudView(int)
    
    Parameters:
    
    view - The view to draw to the HUD.
    
    Returns:
    
    Array of bytes representing the display content, or null on error.
  - getHudViewBinding
```
public ZebraHud.HudViewBinding getHudViewBinding()
```
    Create a View to be drawn on the HUD display, using the v3.6 View Binding feature.
    To draw must call showHudViewBinding(HudViewBinding)
    
    Returns:
    
    Parameters to be used for the View Binding feature.
  - showHudViewBinding
```
public byte[] showHudViewBinding(ZebraHud.HudViewBinding hudViewBinding)
```
    Create a View to be drawn on the HUD display.
    View must be created with getHudViewBinding() and the v3.6 View Binding feature.
    
    Parameters:
    
    hudViewBinding - The result from getHudViewBinding()
    
    Returns:
    
    Array of bytes representing the display content, or null on error.
  - showCachedImage
```
public void showCachedImage(byte[] bytes)
```
    Show a byte array on the HUD display.
    Restore the HUD display using data received by ZebraHud.EventListener.onImageUpdated(byte[]).
    
    Parameters:
    
    bytes - The byte array to send to the display
  - setMicrophoneEnabled
```
public void setMicrophoneEnabled(boolean enable)
```
    Set the the HUD microphone state. When enabled, Android will detect and use the HUD microphone as the default microphone. This enable/disable state is stored in non-volatile HUD memory.
    Warning: The HUD may disconnect and reconnect when changing the microphone state.
    
    Parameters:
    
    enable - True to enable, false to disable
  - getMicrophoneEnabled
```
public boolean getMicrophoneEnabled()
```
    Get the HUD microphone state.
    
    Returns:
    
    True if enabled, false if disabled
  - getCameraEnabled
```
public boolean getCameraEnabled()
```
    Get the HUD camera state.
    
    Returns:
    
    True if enabled, false if disabled
  - startCameraCapture
```
public void startCameraCapture()
```
    Start the HUD camera capturing images. Images will be sent with ZebraHud.EventListener.onCameraImage(Bitmap).
  - startCameraCaptureRawJpeg
```
public void startCameraCaptureRawJpeg()
```
    Start the HUD camera capturing images, and returning them as raw jpeg frames (from the motion-jpeg stream on the UVC camera). Images will be sent with ZebraHud.EventListener.onCameraImageRawJpeg(byte[]).
  - stopCameraCapture
```
public void stopCameraCapture()
```
    Stop the HUD camera capturing images.
  - getCameraAllResolutions
```
public java.util.List<ZebraHud.HudCameraResolution> getCameraAllResolutions()
```
    Get the list of all supported camera resolutions.
    
    Returns:
    
    List of camera resolutions
  - getCameraCurrentResolution
```
public ZebraHud.HudCameraResolution getCameraCurrentResolution()
```
    Get the current camera resolution.
    
    Returns:
    
    Current camera resolution
  - setCameraCurrentResolution
```
public java.lang.Boolean setCameraCurrentResolution(ZebraHud.HudCameraResolution resolution)
```
    Set the current camera resolution.
    
    Parameters:
    
    resolution - Camera resolution to set, matching an entry from getCameraAllResolutions()
    
    Returns:
    
    success or failure
  - getCameraZoom
```
public int getCameraZoom()
```
    Get the camera digital zoom value, as a percentage.
    
    Returns:
    
    percentage value
  - setCameraZoom
```
public boolean setCameraZoom(int zoom)
```
    Set the camera digital zoom value
    
    Parameters:
    
    zoom - value from 0 to maxZoom from ZebraHud.HudCameraResolution.maxZoom, for the current resolution from getCameraCurrentResolution()
    
    Returns:
    
    success or failure
  - getCamera720pFramerate
```
public int getCamera720pFramerate()
```
    Get the framerate of the 720p camera video.
    
    Returns:
    
    framerate, matching one of ListCamera720pFramerates
  - setCamera720pFramerate
```
public void setCamera720pFramerate(int framerate)
```
    Set the framerate of the 720p camera video, which is stored in non-volatile HUD memory.
    Note: Changing the framerate may require re-connecting the HUD to take effect.
    
    Parameters:
    
    framerate - framerate, matching one of ListCamera720pFramerates. An invalid value may default the framerate to its factory setting.
  - getImuStatus
```
public boolean getImuStatus()
```
    Get the status of the HUD IMU data streaming.
    
    Returns:
    
    True if on, false if off
  - startImu
```
public void startImu(ZebraHud.ImuListener imuListener)
```
    Start HUD IMU data streaming. Data will be sent with ZebraHud.ImuListener.onImuData(ImuData).
    
    Parameters:
    
    imuListener - Callback interface for the IMU data listener
  - stopImu
```
public void stopImu()
```
    Stop HUD IMU data streaming.

Class ZebraHud

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BrightnessStepValue

ScaleStepValue

ListCamera720pFramerates

Constructor Detail

ZebraHud

Method Detail

init

deinit

attachToContext

detachFromContext

onStart

onStop

onResume

onPause

getDeviceInfo

getServiceVersion

isConnected

setDisplayOn

isDisplayOn

clearDisplay

setBrightness

getBrightness

setScale

getScale

showMessage

showImage

showJim

showJim

showJim

showBitmapDirect

showJpegDirect

createHudView

showHudView

getHudViewBinding

showHudViewBinding

showCachedImage

setMicrophoneEnabled

getMicrophoneEnabled

getCameraEnabled

startCameraCapture

startCameraCaptureRawJpeg

stopCameraCapture

getCameraAllResolutions

getCameraCurrentResolution

setCameraCurrentResolution

getCameraZoom

setCameraZoom

getCamera720pFramerate

setCamera720pFramerate

getImuStatus

startImu

stopImu