start(completionHandler:)
Submits the request to create a snapshot and delivers the results to the specified block.
Declaration
func start(completionHandler: @escaping @MainActor @Sendable (MKMapSnapshotter.Snapshot?, (any Error)?) -> Void)func start() async throws -> MKMapSnapshotter.SnapshotParameters
- completionHandler:
The block to call with the resulting snapshot. This snapshotter executes this block on the app’s main thread and can’t be
nil.
Discussion
Call this method to begin generating a snapshot image based on the specified parameters. This method executes the request asynchronously.
The snapshotter delivers the final image to your app only when it’s running in the foreground. The snapshotter needs to render the final image while your app is in the foreground. If you start generating a snapshot while the app is in the background, or if your app moves to the background while a snapshot is in progress, this behavior delays the delivery of the snapshot until your app returns to the foreground.
In macOS, this method creates both standard and high-resolution representations of the map data and includes both in the returned image object. In iOS, you need to specify the image scale you want using the snapshot options, which defaults to the scale on the current device.