ScreenShareCaptureOptions

螢幕分享擷取選項

nonisolated final class ScreenShareCaptureOptions

Overview

let options = ScreenShareCaptureOptions(
    dimensions: .h1080_169,
    fps: 30,
    appAudio: true
)
try await localParticipant.set(source: .screenShareVideo, enabled: true, captureOptions: options)

⚠️ 目前擷取器不讀任何欄位：傳入的結果和 setScreenShare(enabled:) 相同。

Topics

Initializers

init(dimensions: CameraCaptureOptions.Dimensions, fps: Int, showCursor: Bool, appAudio: Bool, useBroadcastExtension: Bool, useScreenCaptureKit: Bool, includeCurrentApplication: Bool, excludeWindowIDs: [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 excludeWindowIDs: [UInt32]
排除視窗 ID（macOS 專屬）
var fps: Int
⚠️ iOS 為宣告性 hint：實際幀率由系統擷取回調頻率決定。macOS ScreenCaptureKit 未來實作時會用此值設 SCStreamConfiguration.minimumFrameInterval。
var hash: Int
var includeCurrentApplication: Bool
是否包含自己 App 畫面（macOS 專屬、預設 false）
var showCursor: Bool
是否顯示游標（macOS 專屬、預設 true）
var useBroadcastExtension: Bool
是否使用 Broadcast Extension（iOS）預設由 defaultToBroadcastExtension 靜態偵測「App 有沒有配 Extension」決定
var useScreenCaptureKit: Bool
iOS 27 起改用 ScreenCaptureKit 在 App 內擷取（預設 true）

Instance Methods

func isEqual(Any?) -> Bool

Type Properties

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

Relationships

Conforms To

CaptureOptions