ScreenShareCaptureOptions

class ScreenShareCaptureOptions

Overview

let options = ScreenShareCaptureOptions(
    dimensions: .h1080_169,
    fps: 30,
    appAudio: true
)
localParticipant.setScreenShare(enabled: true, options: options)

Topics

Initializers

• init(dimensions: CameraCaptureOptions.Dimensions, fps: Int, showCursor: Bool, appAudio: Bool, useBroadcastExtension: Bool, includeCurrentApplication: Bool, excludeWindowIDs: [UInt32], displayId: UInt32?)

Instance Properties

• var appAudio: Bool

  是否擷取 App 音訊（預設 false） Broadcast 模式：使用者切到別的 App 時、可擷取那個 App 的音訊

• var dimensions: CameraCaptureOptions.Dimensions

  ⚠️ iOS 為宣告性 hint、不生效：iOS 螢幕分享（ReplayKit / in-app）走 buffer 注入， frame 原尺寸直通，實際尺寸以擷取到的畫面為準。 macOS（ScreenCaptureKit）未來實作時，此值會作為 aspectFit 縮放上限生效

• var displayId: UInt32?

  指定螢幕 ID（macOS 專屬） TODO(macOS): macOS 多螢幕支援用；iOS 一律 nil

• var excludeWindowIDs: [UInt32]

  排除視窗 ID（macOS 專屬）

• var fps: Int

  ⚠️ iOS 為宣告性 hint：實際幀率由系統擷取回調頻率決定。macOS ScreenCaptureKit 未來實作時會用此值設 SCStreamConfiguration.minimumFrameInterval。

• var includeCurrentApplication: Bool

  是否包含自己 App 畫面（macOS 專屬、預設 true）

• var showCursor: Bool

  是否顯示游標（macOS 專屬、預設 true）

• var useBroadcastExtension: Bool

  是否使用 Broadcast Extension（iOS） 預設由 defaultToBroadcastExtension 靜態偵測「App 有沒有配 Extension」決定

Type Properties

• static let defaultToBroadcastExtension: Bool

  靜態動態偵測：App 是否配了 Broadcast Extension iOS：由 BroadcastBundleInfo.hasExtension 動態算出 macOS：一律 false