SafeMediaKit is a Swift-native sensitive media intervention toolkit for Apple apps. It helps apps analyze user-provided images and videos before display and present privacy-preserving blur, reveal, block, and report flows.
SafeMediaKit relies on Apple's public SensitiveContentAnalysis
framework when available. It only works on media your app provides to it. It cannot inspect or modify content inside other apps.
Background reading: What Apple's SensitiveContentAnalysis actually does (and doesn't) covers the framework's opt-in reality and where SafeMediaKit fits.
SafeMediaKit is not a universal iPhone screen filter, Safari content blocker, Network Extension filter, Screen Time shield, backend moderation service, custom Core ML classifier, or telemetry SDK.
It does not upload media to a server and does not include telemetry.
Note for adopters: Apple's developer agreement prohibits transmitting off the device any information about whether SensitiveContentAnalysis
flagged a given image or video. SafeMediaKit keeps verdicts in process; keep them local in your app too. Do not log them remotely, sync them, or attach them to report payloads.
Add SafeMediaKit as a Swift Package dependency in Xcode (File > Add Package Dependencies…
):
https://github.com/SardorbekR/SafeMediaKit
Or in Package.swift
:
dependencies: [
.package(url: "https://github.com/SardorbekR/SafeMediaKit.git", from: "0.1.0")
]
Add SafeMediaKit
to your app target. For tests and previews, add SafeMediaKitTesting
to the relevant test or demo target.
SafeMediaKit targets:
- iOS 17+
- macOS 14+
- Mac Catalyst 17+
The package does not claim watchOS, tvOS, or visionOS support.
The host app must enable Apple's Sensitive Content Analysis capability with the entitlement:
com.apple.developer.sensitivecontentanalysis.client = analysis
Apple's framework may still report analysisPolicy == .disabled
when the entitlement is missing, Sensitive Content Warning is off, Communication Safety is not active, or the app-specific toggle is disabled. SafeMediaKit maps that state to .unavailable(.analysisPolicyDisabled)
and applies your configured unavailable policy.
import SafeMediaKit
import SwiftUI
struct MessageImage: View {
let imageURL: URL
let engine: SafeMediaEngine
var body: some View {
SafeMediaImage(
url: imageURL,
engine: engine,
context: .incomingMessage,
policy: .teenMessaging,
onReveal: {
print("User revealed sensitive image")
},
onReport: {
print("User reported sensitive image")
}
)
.frame(width: 240, height: 180)
.clipShape(RoundedRectangle(cornerRadius: 16))
}
}
You can also inject the engine through the SwiftUI environment:
RootView()
.environment(\.safeMediaEngine, engine)
Then use:
SafeMediaImage(
url: imageURL,
context: .incomingMessage,
policy: .teenMessaging
)
Reveal state is intentionally per-view-instance for privacy. In virtualized lists such as LazyVStack
, scrolling away and back may re-blur a revealed image. To persist reveal choices, record your own message/media ID in onReveal
and skip re-wrapping media the user already revealed.
import SafeMediaKit
import UIKit
let imageView = SafeMediaImageView()
imageView.configure(
imageURL: imageURL,
engine: engine,
context: .incomingMessage,
policy: .teenMessaging,
onReveal: {
print("User revealed sensitive image")
},
onReport: {
print("User reported sensitive image")
}
)
SafeMediaImageView
is compiled only when UIKit is available, so pure macOS builds do not expose it.
Brand the intervention UI without rebuilding the flow. Pass a trailing overlay
closure; it receives a SafeMediaOverlayState
and replaces the built-in overlay for every non-allow state (blur, block, unavailable, and load failure):
SafeMediaImage(url: imageURL, context: .incomingMessage, policy: .teenMessaging) { state in
VStack(spacing: 12) {
Text(state.title).font(.headline)
Text(state.message).font(.footnote)
if state.canReveal {
Button("Show anyway") { state.reveal() }
}
if state.canReport {
Button("Report") { state.report() }
}
}
.padding()
.frame(maxWidth: .infinity, maxHeight: .infinity)
.background(.ultraThickMaterial)
}
state.title
/state.message
are resolved from yourSafeMediaImageConfiguration
for the current decision;state.decision
exposes the raw action and reason.state.reveal()
unblurs and firesonReveal
. It is a no-op whenstate.canReveal
is false — custom overlays cannot bypassblock
or no-reveal policies.- The image underneath stays blurred or hidden regardless of what the overlay draws.
- To ignore the state, write
{ _ in MyOverlay() }
. A bare{ MyOverlay() }
matches theonReveal
callback parameter instead of the overlay slot. SafeMediaOverlayState
has a public initializer, so you can preview and test custom overlays with fabricated decisions.
UIKit: pass overlayProvider:
to configure(...)
. The provided view replaces the built-in stack above the redaction blur, is pinned edge-to-edge, and is rebuilt on each reconfigure or new decision.
One source note: SafeMediaImage
is generic over its overlay. Call sites are unaffected, but explicit type annotations must become SafeMediaImage<SensitiveMediaOverlay>
(or use some View
).
import SafeMediaKit
let analyzer = AppleSensitiveContentAnalyzer()
let engine = SafeMediaEngine(
analyzer: analyzer,
cache: InMemorySafeMediaVerdictCache()
)
let decision = await engine.evaluate(
.imageFile(imageURL),
context: .incomingMessage,
policy: .teenMessaging
)
SafeMediaEngine.evaluate
never throws. Analyzer failures become .analysisFailed
decisions using policy.failureAction
. That includes cancellation: if the surrounding task is cancelled during analysis, evaluate
returns a failure decision — callers that cancel evaluations should discard the result (the bundled views do).
AppleSensitiveContentAnalyzer
is only available on platforms where the SensitiveContentAnalysis
framework can be imported (iOS 17+, macOS 14+, Mac Catalyst 17+).
SafeMediaKit separates sensitive, unknown, unavailable, and failure behavior:
| Policy | Sensitive | Unknown | Unavailable | Failure | Reveal | Report |
|---|---|---|---|---|---|---|
adultMinimal |
||||||
blurWithReveal |
||||||
allow |
||||||
allow |
||||||
allow |
||||||
| yes | no | |||||
teenMessaging |
||||||
blurWithReveal |
||||||
blurWithReveal |
||||||
blurWithReveal |
||||||
blurWithReveal |
||||||
| yes | yes | |||||
childStrict |
||||||
block |
||||||
block |
||||||
block |
||||||
block |
||||||
| no | yes | |||||
classroomStrict |
||||||
block |
||||||
block |
||||||
block |
||||||
block |
||||||
| no | yes |
Preset names are UX defaults, not legal classifications, age-verification mechanisms, or safety guarantees. Host apps remain responsible for account policy, parental consent, and age-assurance requirements.
Blur radius: the bundled SwiftUI/UIKit views use SafeMediaImageConfiguration.blurRadius
. SafeMediaPolicy.blurRadius
is carried on the policy for custom UIs that render decisions themselves.
Use SafeMediaKitTesting
to test UI states without explicit content:
import SafeMediaKit
import SafeMediaKitTesting
let engine = SafeMediaEngine(
analyzer: MockSafeMediaAnalyzer(result: .success(.mockSensitive))
)
Mock fixtures include:
.mockSafe
.mockSensitive
.mockUnknownUnavailable
Do not commit explicit test media. Apple documents a QR-code/profile testing flow for triggering sensitive results without storing or displaying explicit content:
SafeMediaKit's CI does not depend on Apple's QR profile, entitlements, user settings, or real positive detection.
Apple Sensitive Content Analysis is only active when the host app has the entitlement and either Sensitive Content Warning or Communication Safety is active. If neither setting is active, Apple's analysisPolicy
is .disabled
and SafeMediaKit cannot detect sensitive content through Apple SCA.
To enable Apple's user preference manually: Settings > Privacy & Security > Sensitive Content Warning.
Apps can open their own Settings page with UIApplication.openSettingsURLString
, but SafeMediaKit does not use undocumented Settings URLs and does not claim to deep-link directly to the Sensitive Content Warning pane.
Examples/SafeMediaChatDemo
contains a copy-paste SwiftUI demo showing safe, sensitive, and unavailable states with mock analyzers — no explicit media. See its README for setup.
All user-facing strings in the default SwiftUI and UIKit intervention UI are configurable:
let configuration = SafeMediaImageConfiguration(
warningTitle: String(localized: "This may be sensitive"),
warningMessage: String(localized: "You can choose whether to view it."),
unavailableTitle: String(localized: "Sensitive Content Analysis is off"),
unavailableMessage: String(localized: "To use Apple sensitive-content warnings, turn on Sensitive Content Warning in Settings > Privacy & Security, or enable Communication Safety through Screen Time."),
blockedTitle: String(localized: "Media hidden"),
blockedMessage: String(localized: "This media is hidden by the current safety policy."),
Title: String(localized: "Scanning media"),
revealButtonTitle: String(localized: "Show"),
reportButtonTitle: String(localized: "Report")
)
SafeMediaImage(
url: imageURL,
context: .incomingMessage,
policy: .teenMessaging,
configuration: configuration
)
The same configuration:
parameter exists on SafeMediaImageView.configure(...)
.
SafeMediaKit processes only local media that your app passes to it. The package does not download remote URLs, upload media, log media URLs by default, or include analytics.
When compiled with an SDK that exposes SCSensitivityAnalysis.detectedTypes
, SafeMediaKit maps Apple's sexuallyExplicit
and goreOrViolence
categories into SDK-level content types behind runtime availability checks. With older SDKs, SafeMediaKit falls back to generic sensitive-content mapping.
- Video thumbnail and
AVPlayer
polish - Live stream analysis through
SCVideoStreamAnalyzer
-
More category-aware policies when newer Apple APIs are broadly available
-
DocC documentation
-
Snapshot/UI tests
-
SensitiveContentAnalysis: https://developer.apple.com/documentation/sensitivecontentanalysis
SCSensitivityAnalyzer
:https://developer.apple.com/documentation/sensitivecontentanalysis/scsensitivityanalyzer- Entitlement:
https://developer.apple.com/documentation/bundleresources/entitlements/com.apple.developer.sensitivecontentanalysis.client - Sensitive Content Warning settings:
https://support.apple.com/guide/iphone/receive-warnings-about-sensitive-content-iphede874992/ios UIApplication.openSettingsURLString
:https://developer.apple.com/documentation/uikit/uiapplication/opensettingsurlstring- App Store Review Guidelines: https://developer.apple.com/app-store/review/guidelines/
See CONTRIBUTING.md
.