stopMirroringToCompanionDevice(completion:)
Stops mirroring the workout session to the companion iOS device.
Declaration
func stopMirroringToCompanionDevice(completion: @escaping @Sendable (Bool, (any Error)?) -> Void)func stopMirroringToCompanionDevice() async throwsParameters
- completion:
A block that the system calls when the stop request is complete. The system sets the following parameters:
successA Boolean value that indicates whether the system successfully stopped mirroring the session.
errorIf
successis False, this contains an object that describes the error. Otherwise, it’snil.
Discussion
Call this method in your watchOS app to stop the mirrored workout session on the companion iOS app. After the mirroring stops, the system calls the workoutSession(_:didDisconnectFromRemoteDeviceWithError:) method on the iOS companion’s session delegate.
session.end()
// Stop the workout builder and save the workout data.
do {
try await builder.endCollection(at: Date())
try await builder.finishWorkout()
} catch {
// Handle the error here.
fatalError("*** An error occurred while stoping the workout: \(error.localizedDescription) ***")
}
// Stop the mirrored workout on the iOS companion.
do {
try await session.stopMirroringToCompanionDevice()
} catch {
// Handle the error here.
fatalError("*** An error occurred while stoping the mirrored workout: \(error.localizedDescription) ***")
}