VisionManager

com.mapbox.vision.VisionManager

All Implemented Interfaces:

BaseVisionManager
```
public class VisionManager
implements BaseVisionManager
```
The main object for registering for events from the SDK, starting and stopping their delivery. It also provides some useful functions for performance configuration and data conversion.
Lifecycle of VisionManager :
1. VisionManager.create
2. VisionManager.start
3. VisionManager.startRecording (optional)
4. VisionManager.stopRecording (optional)
5. VisionManager.stop, then lifecycle may proceed with VisionManager.destroy or VisionManager.start
6. VisionManager.destroy
See Also:

VisionManager.create, VisionManager.start, VisionManager.startRecording, VisionManager.stopRecording, VisionManager.stop, VisionManager.destroy, VisionManager.start, VisionManager.destroy

Field Summary

Fields
Modifier and Type	Field and Description
`static VisionManager`	`INSTANCE` The main object for registering for events from the SDK, starting and stopping their delivery. It also provides some useful functions for performance configuration and data conversion.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`create(VideoSource videoSource)` Method for creating a `class VisionManager` instance. It's only allowed to have one living instance of `class VisionManager` or `class VisionReplayManager`. To create `class VisionManager` with different configuration call `VisionManager.destroy` on existing instance or release all references to it.
`static void`	`create()` Method for creating a `class VisionManager` instance. It's only allowed to have one living instance of `class VisionManager` or `class VisionReplayManager`. To create `class VisionManager` with different configuration call `VisionManager.destroy` on existing instance or release all references to it.
`static void`	`destroy()` Clean up the state and resources of `class VisionManager`. Do NOT call this method more than once.
`static WorldCoordinate`	`geoToWorld(GeoCoordinate geoCoordinate)` Converts the location of the point from a geographical coordinate to a world coordinate.
`android.app.Application`	`getApplication()`
`static FrameStatistics`	`getFrameStatistics()`
`java.lang.String`	`getMapboxToken()`
`static VisionEventsListener`	`getVisionEventsListener()` Listener for `class VisionManager`. It's held as a week reference.
`static void`	`init(android.app.Application application, java.lang.String mapboxToken)` Initialize SDK with mapbox access token and application instance. Do it once per application session, eg in android.app.Application.onCreate.
`static WorldCoordinate`	`pixelToWorld(PixelCoordinate pixelCoordinate)` Converts the location of the point from a frame coordinate to a world coordinate.
`void`	`registerModule(ModuleInterface moduleInterface)`
`static void`	`setModelPerformance(ModelPerformance modelPerformance)`
`static void`	`setModelPerformanceConfig(ModelPerformanceConfig modelPerformanceConfig)` Deprecated.
`static void`	`setVisionEventsListener(VisionEventsListener p)` Listener for `class VisionManager`. It's held as a week reference.
`static void`	`start()` Start delivering events from `class VisionManager`. Should be called with all permission granted, and after `VisionManager.create` is called. Do NOT call this method more than once or after `VisionManager.destroy` is called.
`static void`	`startRecording(java.lang.String path)` Start recording a session. Do NOT call this method more than once or before `VisionManager.start` or after `VisionManager.stop` is called. During the session full telemetry and video are recorded to specified path. You may use resulted directory to replay the recorded session with `class VisionReplayManager`. Important: Method serves debugging purposes. Do NOT use session recording in production applications.
`static void`	`stop()` Stop delivering events from `class VisionManager`. Do NOT call this method more than once or before `VisionManager.start` or after `VisionManager.destroy` is called. To resume call `VisionManager.start` again. Call this method after `VisionManager.start` and before `VisionManager.destroy`.
`static void`	`stopRecording()` Stop recording a session. Do NOT call this method more than once or before `VisionManager.startRecording` or after `VisionManager.stop` is called. Important: Method serves debugging purposes. Do NOT use session recording in production applications.
`void`	`unregisterModule(ModuleInterface moduleInterface)`
`static GeoCoordinate`	`worldToGeo(WorldCoordinate worldCoordinate)` Converts the location of the point in a world coordinate to a geographical coordinate.
`static PixelCoordinate`	`worldToPixel(WorldCoordinate worldCoordinate)` Converts the location of the point from a world coordinate to a frame coordinate.

Methods inherited from interface com.mapbox.vision.manager.BaseVisionManager
registerModule, unregisterModule

- Field Detail
  - INSTANCE
```
public static VisionManager INSTANCE
```
    The main object for registering for events from the SDK, starting and stopping their delivery. It also provides some useful functions for performance configuration and data conversion.
    Lifecycle of VisionManager :
    1. VisionManager.create
    2. VisionManager.start
    3. VisionManager.startRecording (optional)
    4. VisionManager.stopRecording (optional)
    5. VisionManager.stop, then lifecycle may proceed with VisionManager.destroy or VisionManager.start
    6. VisionManager.destroy
    See Also:
    
    VisionManager.create, VisionManager.start, VisionManager.startRecording, VisionManager.stopRecording, VisionManager.stop, VisionManager.destroy, VisionManager.start, VisionManager.destroy
- Method Detail
  - getApplication
```
public android.app.Application getApplication()
```
  - getMapboxToken
```
public java.lang.String getMapboxToken()
```
  - getVisionEventsListener
```
public static VisionEventsListener getVisionEventsListener()
```
    Listener for class VisionManager. It's held as a week reference.
    
    See Also:
    
    class VisionManager
  - setVisionEventsListener
```
public static void setVisionEventsListener(VisionEventsListener p)
```
    Listener for class VisionManager. It's held as a week reference.
    
    See Also:
    
    class VisionManager
  - init
```
public static void init(android.app.Application application,
                        java.lang.String mapboxToken)
```
    Initialize SDK with mapbox access token and application instance. Do it once per application session, eg in android.app.Application.onCreate.
    
    See Also:
    
    android.app.Application.onCreate
  - create
```
public static void create(VideoSource videoSource)
```
    Method for creating a class VisionManager instance. It's only allowed to have one living instance of class VisionManager or class VisionReplayManager. To create class VisionManager with different configuration call VisionManager.destroy on existing instance or release all references to it.
    
    Parameters:
    
    videoSource - : Video source which will be utilized by class VisionManager.
    
    See Also:
    
    class VisionManager, class VisionManager, class VisionReplayManager, class VisionManager, VisionManager.destroy
  - create
```
public static void create()
```
    Method for creating a class VisionManager instance. It's only allowed to have one living instance of class VisionManager or class VisionReplayManager. To create class VisionManager with different configuration call VisionManager.destroy on existing instance or release all references to it.
    
    See Also:
    
    class VisionManager, class VisionManager, class VisionReplayManager, class VisionManager, VisionManager.destroy
  - start
```
public static void start()
```
    Start delivering events from class VisionManager. Should be called with all permission granted, and after VisionManager.create is called. Do NOT call this method more than once or after VisionManager.destroy is called.
    
    See Also:
    
    class VisionManager, VisionManager.create, VisionManager.destroy
  - startRecording
```
public static void startRecording(java.lang.String path)
```
    Start recording a session. Do NOT call this method more than once or before VisionManager.start or after VisionManager.stop is called. During the session full telemetry and video are recorded to specified path. You may use resulted directory to replay the recorded session with class VisionReplayManager. Important: Method serves debugging purposes. Do NOT use session recording in production applications.
    
    Parameters:
    
    path - : Path to directory where you'd like session to be recorded.
    
    See Also:
    
    VisionManager.start, VisionManager.stop, class VisionReplayManager
  - stopRecording
```
public static void stopRecording()
```
    Stop recording a session. Do NOT call this method more than once or before VisionManager.startRecording or after VisionManager.stop is called. Important: Method serves debugging purposes. Do NOT use session recording in production applications.
    
    See Also:
    
    VisionManager.startRecording, VisionManager.stop
  - stop
```
public static void stop()
```
    Stop delivering events from class VisionManager. Do NOT call this method more than once or before VisionManager.start or after VisionManager.destroy is called. To resume call VisionManager.start again. Call this method after VisionManager.start and before VisionManager.destroy.
    
    See Also:
    
    class VisionManager, VisionManager.start, VisionManager.destroy, VisionManager.start, VisionManager.start, VisionManager.destroy
  - destroy
```
public static void destroy()
```
    Clean up the state and resources of class VisionManager. Do NOT call this method more than once.
    
    See Also:
    
    class VisionManager
  - setModelPerformanceConfig
```
public static void setModelPerformanceConfig(ModelPerformanceConfig modelPerformanceConfig)
```
    Deprecated.
  - setModelPerformance
```
public static void setModelPerformance(ModelPerformance modelPerformance)
```
  - worldToPixel
```
public static PixelCoordinate worldToPixel(WorldCoordinate worldCoordinate)
```
    Converts the location of the point from a world coordinate to a frame coordinate.
    
    Returns:
    
    class PixelCoordinate if worldCoordinate can be represented in screen coordinates and null otherwise
  - pixelToWorld
```
public static WorldCoordinate pixelToWorld(PixelCoordinate pixelCoordinate)
```
    Converts the location of the point from a frame coordinate to a world coordinate.
    
    Returns:
    
    class WorldCoordinate if pixelCoordinate can be projected on the road and null otherwise
  - worldToGeo
```
public static GeoCoordinate worldToGeo(WorldCoordinate worldCoordinate)
```
    Converts the location of the point in a world coordinate to a geographical coordinate.
  - geoToWorld
```
public static WorldCoordinate geoToWorld(GeoCoordinate geoCoordinate)
```
    Converts the location of the point from a geographical coordinate to a world coordinate.
  - getFrameStatistics
```
public static FrameStatistics getFrameStatistics()
```
  - registerModule
```
public void registerModule(ModuleInterface moduleInterface)
```
  - unregisterModule
```
public void unregisterModule(ModuleInterface moduleInterface)
```

Class VisionManager

Field Summary

Method Summary

Methods inherited from interface com.mapbox.vision.manager.BaseVisionManager

Field Detail

INSTANCE

Method Detail

getApplication

getMapboxToken

getVisionEventsListener

setVisionEventsListener

init

create

create

start

startRecording

stopRecording

stop

destroy

setModelPerformanceConfig

setModelPerformance

worldToPixel

pixelToWorld

worldToGeo

geoToWorld

getFrameStatistics

registerModule

unregisterModule