MBMMapRecorder

 
@interface MBMMapRecorder : NSObject

// This class provides custom init which should be called
- (nonnull instancetype)init NS_UNAVAILABLE;

// This class provides custom init which should be called
+ (nonnull instancetype)new NS_UNAVAILABLE;

/**
 * Initializes the map recorder object.
 *
 * @param map The `map` to record.
 */
- (nonnull instancetype)initWithMap:(nonnull MBMMap *)map;

/** Begins the API call sequence recording. */
- (void)startRecording;
/**
 * Stops the current recording session.
 *
 * @return a JSON string which contains the recorded sequence.
 */
- (nonnull NSString *)stopRecording __attribute((ns_returns_retained));
- (void)replayForContent:(nonnull NSString *)content
           playbackCount:(int32_t)playbackCount
 playbackSpeedMultiplier:(double)playbackSpeedMultiplier
                callback:(nonnull MBMPlaybackFinished)callback;
/** Temporarily pauses or resumes playback if already paused. */
- (void)togglePauseReplay;
/** Returns the string description of the current state of playback. */
- (nonnull NSString *)getPlaybackState __attribute((ns_returns_retained));

@end

Undocumented

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)init NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (nonnull instancetype)new NS_UNAVAILABLE;

  • Initializes the map recorder object.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMap:(nonnull MBMMap *)map;

    Swift

    init(map: MBMMap)

    Parameters

    map

    The map to record.

  • Begins the API call sequence recording.

    Declaration

    Objective-C

    - (void)startRecording;

    Swift

    func startRecording()

  • Stops the current recording session.

    Declaration

    Objective-C

    - (nonnull NSString *)stopRecording;

    Swift

    func stopRecording() -> String

    Return Value

    a JSON string which contains the recorded sequence.

  • Undocumented

    Declaration

    Objective-C

    - (void)replayForContent:(nonnull NSString *)content
           playbackCount:(int32_t)playbackCount
 playbackSpeedMultiplier:(double)playbackSpeedMultiplier
                callback:(nonnull MBMPlaybackFinished)callback;

    Swift

    func replay(forContent content: String, playbackCount: Int32, playbackSpeedMultiplier: Double, callback: @escaping PlaybackFinished)

  • Temporarily pauses or resumes playback if already paused.

    Declaration

    Objective-C

    - (void)togglePauseReplay;

    Swift

    func togglePauseReplay()

  • Returns the string description of the current state of playback.

    Declaration

    Objective-C

    - (nonnull NSString *)getPlaybackState;

    Swift

    func getPlaybackState() -> String