MMKAnnotator

Warning

This feature is available in the NaviKit SDK version.

class MMKAnnotator : NSObject

Summary

Instance methods

func setSpeakerWith(_ speaker: MMKSpeaker?)
The class does not retain the object in the 'speaker' parameter

func mute()

func unmute()

func addListener(with annotatorListener: MMKAnnotatorListener)
The class does not retain the object in the 'annotatorListener' parameter

func removeListener(with annotatorListener: MMKAnnotatorListener)

Properties

var annotatedEvents: MMKAnnotatedEvents { get set }

var annotatedRoadEvents: MMKAnnotatedRoadEvents { get set }

var isValid: Bool { get }
Tells if this object is valid or no

Instance methods

setSpeakerWith(_:)

func setSpeakerWith(_ speaker: MMKSpeaker?)

The class does not retain the object in the 'speaker' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.


mute()

func mute()


unmute()

func unmute()


addListener(with:)

func addListener(with annotatorListener: MMKAnnotatorListener)

The class does not retain the object in the 'annotatorListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.


removeListener(with:)

func removeListener(with annotatorListener: MMKAnnotatorListener)


Properties

annotatedEvents

var annotatedEvents: MMKAnnotatedEvents { get set }


annotatedRoadEvents

var annotatedRoadEvents: MMKAnnotatedRoadEvents { get set }


isValid

var isValid: Bool { get }

Tells if this object is valid or no. Any method called on an invalid object will throw an exception. The object becomes invalid only on UI thread, and only when its implementation depends on objects already destroyed by now. Please refer to general docs about the interface for details on its invalidation.