ScreenCaptureKitの紹介

ScreenCaptureKitの紹介

ScreenCaptureKitが、macOSの画面共有・ビデオ会議・ゲームストリーミングサービスなどのAppに、高性能のスクリーンキャプチャを提供する仕組みについて解説します。このAPIの構成要素について解説し、ストリームを設定して画面上の動画およびオーディオコンテンツをキャプチャする方法や、それを既存のAppに統合するためのヒントを紹介します。

リソース
関連ビデオ

WWDC23
- ScreenCaptureKitの新機能
WWDC22
- ScreenCaptureKitを次のレベルへ引き上げる
（音楽）
こんにちは僕はErnest ScreenCaptureKitチームのソフトウェアエンジニアですこの２年間リモートでの共同作業でしばしば画面の共有を行います
それに加え OBS Studioのような録画アプリケーションを使ったゲームプレイのストリーミングやコンテンツ制作そのものが教育や娯楽において成長し続けています
このような背景から開発者のニーズに応えパフォーマンスと堅牢性に優れたスクリーンキャプチャーのフレームワークを作りました ScreenCaptureKitです
これはmacOSの新しいフレームワークで Appにおける画面共有を実現します ScreenCaptureKit はアプリケーションのニーズに合わせてデベロッパのコントロールやトグルを使ってキャプチャしたいコンテンツを選択可能な API を提供しますフィルターやコントロールは即座に更新できます
このフレームワークはディスプレイのネイティブの解像度やフレームレートに対応する最高の品質と性能を実現しプライバシーにも重点を置いています
このセッションでは ScreenCaptureKit を使い始めるためのお手伝いをします
基本を押さえた上で「Take ScreenCaptureKit to the next level」でより高度なトピックをご覧ください
まずフレームワークの主な機能を説明します
次に ScreenCaptureKit の主な構成要素について API の概要を説明します
次にフィルタと設定を使ってストリームをセットアップする方法を説明します
そして最後にビデオとオーディオのサンプルをアプリケーションにストリーミングする方法を説明します
では主な特徴からです
ScreenCaptureKitは共有したいコンテンツや除去したいコンテンツの種類を指定できますディスプレイアプリケーションウィンドウのあらゆる組み合わせから画面のコンテンツをキャプチャできそれに付随する音声もキャプチャできます
ScreenCaptureKitはピクセルフォーマット色空間フレームレート解像度そしてオーディオ側ではサンプルレートやチャンネル数などのコントロールなどさまざまな開発者向けコントロールをサポートしています
これらのフィルターや設定はオンザフライで調節できより柔軟なAppデザインが可能です
最大48kHzステレオの音声とディスプレイのネイティブ解像度フレームレートの映像を取り込むために既存のキャプチャ方法よりも低い CPU オーバーヘッドで Mac GPU のパワーを活用しますもちろんScreenCaptureKit はプライバシーを考慮して構築されておりすべてのアプリケーションに対してグローバルなプライバシー保護機能を提供します
映像と音声を取り込む前に承諾が必要でシステム環境設定の Screen Recordingのプライバシー設定に保存されます
ScreenCaptureKitが何かわかったところで APIの最も重要な概念をお見せしましょう ScreenCaptureKitの中心はSCStreamです
SCStreamはstartやstopなどの制御メソッドを扱い SCShareableContentとSCContentFilter SCStreamConfigurationと共に作られます
これらは何のコンテンツをどう取り込むか決定します
いざ作成されスタートするとメディアサンプルは SCStreamOutputプロトコルで Appに配信されます後ほど説明します
Appでのストリーム設定のAPIについてです
ストリームをセットアップする際に知っておきたいオブジェクトを紹介します
これらのオブジェクトがキャプチャーの内容や品質パフォーマンスを決定します
SCShareableContentから始めましょう
このデスクトップ上にはウィンドウアプリケーションディスプレイがあります
ScreenCaptureKitには共有コンテンツ作成のためそれぞれに対応するクラスがあります
まずはSCDisplayです
ディスプレイをSCDisplaysと分類しリードオンリーのDisplay identifierとサイズのWidthとHeightのプロパティがあります
ディスプレイ内で開いているAppにはそれぞれ SCRunningApplicationがあります
SCRunningApplicationsにはApp情報のリードオンリープロパティがありそれらはBundle identifierや Application nameとProcess identifierです
この例ではKeynoteとSafariの SCRunningApplicationがあります
そしてこれらのAppにはウィンドウがあります
これらのウィンドウにはSCWindowがありそれぞれを定義するリードオンリープロパティの Window IDやFrameとTitle そしてOn screenか最小化されてるかです
またSCWindowにはOwning applicationがあり
この場合両方のSafariのSCWindowsに同じowning applicationのSafariがあります
SCWindows SCRunningApplications SCDisplays が SCShareableContentにまとめられて共有できるコンテンツを提供しますデバイスの共有可能なコンテンツのリストを得るかパラメーターで指定できます
共有するものを選ぶためにスクリーン上のAppやウィンドウのリストが欲しい場合 ScreenCaptureKitにはシンプルなAPIがあります
このコードはdeveloper.apple.comにあるサンプルコードの一部です
画面上にあるウィンドウだけが SCShareableContent で返され関連する SCWindows SCApplications SCDisplays が含まれます
共有可能なコンテンツが得られたのでフィルターを作ります
SCContentFiltersには２種類ありますディスプレイを指定しないフィルタは複数のディスプレイのウィンドウを取得しディスプレイ指定のフィルタは特定のウィンドウやアプリケーションを含めたり除外したりするオプションがあります
音声の取り込みはAppレベルでのみフィルター可能です
ではフィルターのデモをお見せしましょう
Keynoteのウィンドウだけを共有したいとします
ディスプレイを指定しないフィルタを使ってディスプレイ間を移動するウィンドウを取得します
ディスプレイ内のすべてを共有したい場合も共有したくないものがあるかもしれません例えばキャプチャを行う自身のAppを除外して鏡の回廊効果を回避したいはずです
また機密情報が画面上に出ている場合もキャプチャの対象から外すべきです SCContentFilterがこれらをすべて処理しますコードを見てみましょう
これは先ほどのコードです
共有可能なコンテンツを検索したらこのサンプルコードと同じ Bundle IDのAppを探し
ディスプレイ指定のフィルターでそのAppを除外します
ScreenCaptureKitはストリーム毎に品質と性能を調整できます
SCStreamConfigurationで設定します
映像の調整には出力解像度やフレームレートカーソルの有無などがあります
オーディオの方はオーディオでの有無やサンプルレートチャンネル数があります
これらを調整するシナリオを見てみましょう
メモやスプレッドシートなど文字の鮮明度が重要なコンテンツの場合出力解像度を４Ｋフレームを10fpsにします
このコンテンツには音声がないので音声をオフにしておきます
休暇のビデオの共有など動きの多いコンテンツの場合解像度よりフレームレートを優先し出力解像度を1080pに下げフレームレートを60fpsに増やします
カーソルは邪魔になるのでカーソルを隠します
また音声を取り込めば没入感が高まります
これらの調整はSCStreamConfigurationで行うことができます
動きの多いコンテンツの設定例です
ここでは出力解像度が1080pになっています minimum Frame Interval は 60fpsで取り込むために 1/60の設定です
そしてstreamConfigでカーソルを隠しています
音声では captures Audio を true にして音声を取り込みサンプルレートは48kHz チャンネル数は２です
SCContentFilter と SCStreamConfiguration で Appのニーズに応えた取り込み設定に必要な情報が得られました
これでSCStreamが作成できます
オーバービューに戻りましょう
フィルターとコンフィグでストリームを初期化します
エラーの対応にデリゲートを追加できます
それからStart captureしScreenCaptureKitがサンプルをSCStreamで提供します
フィルタとコンフィグが作成されたのでコードでストリームを開始するのは簡単ですお見せしましょう
再びフィルターとコンフィグで SCStreamを初期化します
エラー処理のデリゲートとして self を指定
SCStreamを作成しStart captureを呼びます
ストリームの初期化と起動が完了したら次のステップはメディアサンプルをアプリケーションに取り込むことです
音声と映像サンプルはCMSampleBuffersとして Appに送られます
それらのサンプルを得るためには SCStreamOutput プロトコルを実装したオブジェクトをストリームに追加する必要があります
ハンドラーキューも指定します
これは余分な dispatch なしに特定のキューにサンプルを送るのに最適です
指定しなければデフォルトキューです
ストリームが始まるとサンプルができた時コールバックを行います
ではコードでメディアサンプルを得る方法です
SCStreamOutputプロトコルの実装を示しています新しいサンプルができると呼び出されます
CMSampleBuffersとしてサンプルが送られストリームとサンプルタイプを提供します
サンプルバッファのハンドラーを実装し StreamOutputを追加するだけです
これでストリームからのサンプルが希望するコンテンツとフォーマットで Appに送られます
CMSampleBuffersとしてサンプルを配信するので使い方について話しましょう
映像の方では CMSampleBuffer は IOSurface-backed です
SCStreamFrameInfo で CMSampleBufferにアタッチメントを提供しています
これにはビデオサンプルの情報が含まれています
Frame Status で現在のストリーム状況を確認します completeは新しいビデオフレームがあることを意味し idleはサンプルに変わりがないことを意味し新しいIOSurfaceはありません
それ以外の場合提供されるサンプルは他の CMSampleBuffer と同様なので既存の CMSampleBuffer ユーティリティを使用することができます
ScreenCaptureKit には画面上の音声と映像を選択するAPIがありますさらにフレームワークは Appのニーズに応えるコントロールを提供します
キャプチャの方法の基本もここでカバーしました
ScreenCaptureKitの登場でCGDisplayStreamや CGWindowListは近い将来非推奨となります
ScreenCaptureKitの導入が皆様の助けとなることを願っています
さらに高度な情報は "ScreenCaptureKitを次のレベルに" をご覧ください
ありがとうございました（音楽）

6:53 - Creating a SCShareableContent object

// Creating a SCShareableContent object

// Get the content that's available to capture.
let content = try await SCShareableContent.excludingDesktopWindows(
    false,
    onScreenWindowsOnly: true
)

8:32 - Creating a SCContentFilter object

// Creating a SCContentFilter object

// Get the content that's available to capture.
let content = try await SCShareableContent.excludingDesktopWindows(
    false,
    onScreenWindowsOnly: true
)

// Exclude the sample app by matching the bundle identifier.
let excludedApps = content.applications.filter { app in
    Bundle.main.bundleIdentifier == app.bundleIdentifier
}

// Create a content filter that excludes the sample app.
filter = SCContentFilter(display: display,
                         excludingApplications: excludedApps,
                         exceptingWindows: [])

10:23 - Creating a SCStreamConfiguration object

// Creating a SCStreamConfiguration object
let streamConfig = SCStreamConfiguration()
        
// Set output resolution to 1080p
streamConfig.width = 1920
streamConfig.height = 1080

// Set the capture interval at 60 fps
streamConfig.minimumFrameInterval = CMTime(value: 1, timescale: CMTimeScale(60))

// Hides cursor
streamConfig.showsCursor = false

// Enable audio capture
streamConfig.capturesAudio = true

// Set sample rate to 48000 kHz stereo
streamConfig.sampleRate = 48000
streamConfig.channelCount = 2

11:46 - Creating and starting a SCStream object

// Creating and starting a SCStream object

// Create a capture stream with the filter and stream configuration
stream = SCStream(filter: filter, configuration: streamConfig, delegate: self)

// Start the capture session
try await stream?.startCapture()      


// ...
// Error handling delegate 
func stream(_ stream: SCStream, didStopWithError error: Error) {
    DispatchQueue.main.async {
        self.logger.error("Stream stopped with error: \(error.localizedDescription)")
        self.error = error
        self.isRecording = false
   }
}

13:07 - Getting media samples

// SCStreamOutput protocol implementation
func stream(_ stream: SCStream, didOutputSampleBuffer sampleBuffer: CMSampleBuffer, of type: SCStreamOutputType) {
    switch type {
    case .screen:
        handleLatestScreenSample(sampleBuffer)
    case .audio:         handleLatestAudioSample(sampleBuffer)
    }
}

// ...
// Create a capture stream with the filter and stream configuration
stream = SCStream(filter: filter, configuration: streamConfig, delegate: self)

// Add a stream output to capture screen and audio content
try stream?.addStreamOutput(self, type: .screen, sampleHandlerQueue: screenFrameOutputQueue)
try stream?.addStreamOutput(self, type: .audio, sampleHandlerQueue: audioFrameOutputQueue)

// Start the capture session
try await stream?.startCapture()

リソース

関連ビデオ

WWDC23

WWDC22