UnityでiOSのスクショ撮影を検出する方法
この記事は、iOS Unityアプリでスクリーンショットを検出する方法を紹介します。ゲーム内の特殊演出や、シェア機能を強化するために活用できると思います!また、ネイティブプラグインを介してiOSのAPIを呼び出すため、ネイティブプラグインを用意する例としても参考になります。
ネイティブプラグインとは
今回は、スクリーンショットを検出するためにiOSのネイティブAPIを使います。UnityのC#スクリプトからはiOSのネイティブAPIを直接呼び出せないため、ネイティブプラグインを用意する必要があります。この方法はiOSに限らず、Unityが標準で対応していないOSの機能を使う場合にも利用できます。
呼び出しの流れは以下のとおりです。
C#スクリプト → ネイティブプラグイン → ネイティブAPI実はUnityがiOS用のプラグインをビルドしてくれる
ネイティブライブラリを用意するにはXcodeでビルドする必要があるのでは…と思うかもしれませんが、実はUnityはいくつかの形式のネイティブプラグインに対応しています。今回のような軽量な用途なら、Assets/Plugins/iOS/以下に.mmファイルを置くだけで済みます。UnityでiOS向けにビルドすると、このファイルが出力されるXcodeプロジェクトにコピーされ、Xcodeでのビルド時に自動でコンパイルとリンクが行われます。
もちろん、事前に.aファイル(静的ライブラリ)をビルドしておく方法もありますが、今回はできるだけ手軽な方法を取りたいので、ここでは説明を省きます。
ScreenshotNotifier.mm(ネイティブプラグイン)を用意する
今回使用するサンプルコードはこちらのGistから確認できます。ブログでは一部を抜粋して説明します。
ScreenshotNotifier.mmは、iOSのネイティブAPIを呼び出すコードです。スクリーンショットのOS通知を受け取ったときにコールバックを発火する役割と、画面録画の状態を監視する役割を持っています。(後ほど、C#スクリプトからコールバック関数を登録して、OSからの通知をC#側で受け取れるようにします。)
監視セッションを開始/終了
iOSからスクリーンショットの通知を受け取るには、オブザーバーを登録する必要があります。そのため、登録から解除までを「監視セッション」として管理し、多重初期化やメモリリークに注意しなければなりません。
SN_StartCaptureMonitoring()は、セッションを開始する関数です。iOSはスクリーンショットが撮影されるとUIApplicationUserDidTakeScreenshotNotificationを通知します。SN_StartCaptureMonitoring()では、この通知を受け取るオブザーバーを作成し、通知を受けたときに、登録済みのコールバック関数を発火します。
画面録画(またはAirPlayや外部ディスプレイへの出力)の状態が変わったときには、UIScreenCapturedDidChangeNotificationが通知されます。SN_StartCaptureMonitoring()は同時に画面録画状態を監視するオブザーバーとコールバックを用意します。
また、セッション開始時点の状態を伝えるため、開始時に録画状態のコールバックを一度発火します。これにより、C#側でセッション開始時の状態を確認し、アプリで適切に対応できます。つまり、セッション開始前から録画が始まっていた場合も検知できます。
そして、監視セッションを終了するためのSN_StopCaptureMonitoring()もあります。各オブザーバーを破棄し、リソースを解放する役割です。
コールバックを登録する関数
SN_SetCaptureStatusChangedCallback(SN_CaptureStatusChangedCallback callback)とSN_SetScreenshotDetectedCallback(SN_ScreenshotDetectedCallback callback)はコールバック関数を登録する関数です。
スクリーンショット検知のコールバックには引数がありません(単に発火されるだけです)。一方、録画状態変更のコールバックには、状態を表すboolが引数として渡されます。そのため、2つのコールバックは関数の型が異なります。
録画状態を確認するヘルパー関数
録画状態が変わったときだけでなく、任意のタイミングで録画状態を確認したい場合もあります。そのためにSN_IsScreenBeingCaptured()関数を用意しています。iOSから[UIScreen mainScreen].isCapturedの値を取得して返します。
(おまけ)一回のスクリーンショットを多重通知するのを防ぐ
デバイスやiOSのバージョンによって、一回のスクリーンショットでUIApplicationUserDidTakeScreenshotNotificationが2回通知される場合があります。ScreenshotNotifier.mmには、kScreenshotDedupeInterval = 0.5として、重複した通知を無視する0.5秒間の区間を設けています。この区間内に通知が複数回届いても、コールバックは1回しか発火しません。また、0.5秒以内に2枚以上のスクリーンショットを撮ることは実用上ほぼ起きないので、本来の通知を誤って取りこぼす心配もありません。
ScreenshotNotifier.cs(C#スクリプト)を用意する
C#のサンプルコードもこちらのGistから確認できます。ブログでは一部を抜粋して説明します。
ScreenshotNotifier.csは、ネイティブプラグインの関数をC#から呼び出すためのラッパーです。ネイティブ側から届いた通知をC#のイベントに変換するので、Unityのほかのスクリプトはネイティブコードを意識せずに、スクリーンショットの検知や録画状態の変化を扱えます。
公開しているAPIは以下のとおりです。
Start()/Stop():監視セッションを開始・終了するScreenshotDetected:スクリーンショットが撮影されたときに発火するイベントCaptureStateChanged:録画状態が変わったときに発火するイベント(引数は録画中かどうか)IsScreenBeingCaptured:現在の録画状態を取得するプロパティIsMonitoring:監視セッション中かどうか
ネイティブ関数を宣言する
C#からネイティブ関数を呼び出すには、DllImport属性を付けて関数を宣言します。
[DllImport("__Internal")] private static extern void SN_StartCaptureMonitoring();iOSでは、ネイティブプラグインはアプリ本体のバイナリに静的リンクされます。そのため、ライブラリ名には外部ライブラリの名前ではなく"__Internal"を指定します。
ただし、この関数が実在するのはiOSの実機ビルドだけです。そこで、#if UNITY_IOS && !UNITY_EDITORで宣言を切り替えています。それ以外の環境(Unityエディターや他のプラットフォーム)では、何もしない空の関数に置き換えています。こうしておけば、エディター上でもエラーにならずに実行でき、IsScreenBeingCapturedは常にfalseを返します。
ネイティブ側と型を合わせる
ネイティブ側の関数に渡すコールバックは、C#ではデリゲートとして定義します。ネイティブ側の2種類のコールバック型に合わせて、デリゲートも2種類用意しています。
private delegate void CaptureStateChangedCallback([MarshalAs(UnmanagedType.U1)] bool isCaptured);private delegate void ScreenshotDetectedCallback();ここで注意したいのがboolの扱いです。C#のboolは、マーシャリング時にデフォルトで4バイトとして扱われます。一方、C++のboolは1バイトです。サイズが合わないと値を正しく受け渡せないため、[MarshalAs(UnmanagedType.U1)]で1バイトとして扱うよう指定しています。戻り値がboolのSN_IsScreenBeingCaptured()にも、同じく[return: MarshalAs(UnmanagedType.U1)]を付けています。
コールバックを受け取る関数
ネイティブ側から呼び出される関数がOnNativeCaptureStateChanged()とOnNativeScreenshotDetected()です。受け取った通知を、そのままC#のイベントとして発火します。
[MonoPInvokeCallback(typeof(ScreenshotDetectedCallback))]private static void OnNativeScreenshotDetected(){ try { ScreenshotDetected?.Invoke(); } catch (Exception e) { UnityEngine.Debug.LogException(e); }}iOSビルドではIL2CPPによってC#コードが事前にネイティブコードへ変換(AOTコンパイル)されます。そのため、ネイティブ側から呼び出されるメソッドはstaticにして、[MonoPInvokeCallback]属性を付ける必要があります。
また、イベントの呼び出しをtry-catchで囲んでいます。イベントの登録先で例外が発生したとき、それがネイティブ側まで伝わるとアプリがクラッシュするおそれがあるためです。
デリゲートがGCに回収されないようにする
ネイティブ側に渡したデリゲートがC#のGC(ガベージコレクション)で回収されると、ネイティブ側は解放済みの関数を呼び出してしまい、クラッシュの原因になります。
private static readonly CaptureStateChangedCallback s_CaptureStateCallback = OnNativeCaptureStateChanged;private static readonly ScreenshotDetectedCallback s_ScreenshotCallback = OnNativeScreenshotDetected;これを防ぐため、デリゲートをstatic readonlyフィールドに保持しています。こうすることで、アプリの実行中は常に参照が残り、GCに回収されません。
監視セッションの開始・終了
Start()では、最初の1回だけネイティブ側にコールバックを登録し、そのあとで監視セッションを開始します。ネイティブ側では、セッションを終了してもコールバックの登録は解除されないため、2回目以降のStart()で再登録する必要はありません。
なお、SN_StartCaptureMonitoring()は内部で既存のオブザーバーを破棄してから作り直します。そのため、Start()を続けて呼んでも、オブザーバーが重複して登録されることはありません。
Stop()は、監視セッション中の場合にだけSN_StopCaptureMonitoring()を呼び、IsMonitoringをfalseに戻します。
実際に使ってみる
ほかのスクリプトからは、イベントを登録してStart()を呼ぶだけで使えます。
void OnEnable(){ ScreenshotNotifier.ScreenshotDetected += OnScreenshot; ScreenshotNotifier.CaptureStateChanged += OnCaptureStateChanged; ScreenshotNotifier.Start();}
void OnDisable(){ ScreenshotNotifier.Stop(); ScreenshotNotifier.ScreenshotDetected -= OnScreenshot; ScreenshotNotifier.CaptureStateChanged -= OnCaptureStateChanged;}
void OnScreenshot() => Debug.Log("スクリーンショットが撮影されました");void OnCaptureStateChanged(bool isCaptured) => Debug.Log($"録画状態:{isCaptured}");Androidは…?
実は、Androidにも似たAPIがあります。ただし、比較的新しいバージョンのAndroidでしか使えません。
たとえば、UIApplicationUserDidTakeScreenshotNotificationと同じような役割を持つActivity.registerScreenCaptureCallback()がありますが、使えるのはAndroid 14(API 34)以降です。また、UIScreenCapturedDidChangeNotificationに近い役割を持つWindowManager.addScreenRecordingCallback()は、Android 15(API 35)以降でしか使えません。
Android 13以前には公式のAPIがありません。昔からよく使われてきたのは、ContentObserverで画像フォルダを監視し、ファイル名に「Screenshot」が含まれるかどうかで判断する方法です。ただ、この方法はストレージへのアクセス権限が必要なうえ、端末メーカーによって保存先や命名規則が異なるため、信頼性が高いとは言えません。
UnityでAndroidのOS APIを使う場合は、Javaで書いたプラグイン(.javaファイル、またはビルド済みの.aarファイル)をAssets/Plugins/Android/以下に配置します。C#からはAndroidJavaObjectやAndroidJavaProxyを使って呼び出します。iOSの.mmファイルと同じく、.javaファイルも置くだけでビルド時に自動でコンパイルされます。