routoMapSDK Android/com.mapbox.maps/MapboxMapRecorder

MapboxMapRecorder

@MapboxExperimental

class MapboxMapRecorder

MapboxMapRecorder provides functions to record and replay API calls of a MapboxMap instance. These recordings can be used to debug issues which require multiple steps to reproduce. Additionally, playbacks can be used for performance testing custom scenarios.

Note: The raw format produced by stopRecording is experimental and there is no guarantee for version cross-compatibility when feeding it to replay.

To create the MapboxMapRecorder instance refer to MapboxMap.createRecorder.

Functions

getPlaybackState

fun getPlaybackState(): String

Returns the string description of the current state of playback.

@JvmOverloads

fun replay(recordedSequence: ByteBuffer, options: MapPlayerOptions = mapPlayerOptions { }, onEnded: () -> Unit = { })

Replay a supplied sequence.

@JvmOverloads

fun startRecording(options: MapRecorderOptions = mapRecorderOptions { })

Begins the recording session.

fun stopRecording(): ByteBuffer

Stops the current recording session. Recorded section could be replayed with replay function.

togglePauseReplay

fun togglePauseReplay()

Temporarily pauses or resumes playback if already paused.