screencapturekit

package
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 19, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Rendered for darwin/amd64

Overview

Package screencapturekit provides purego-based Go bindings for the macOS ScreenCaptureKit framework.

Apple documentation: https://developer.apple.com/documentation/screencapturekit

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func SCScreenshotConfigurationSupportedContentTypes

func SCScreenshotConfigurationSupportedContentTypes() *foundation.NSArray[*uniformtypeidentifiers.UTType]

@abstract an array of UTTypes that corresponds to the file formats that are supported. ScreenCaptureKit can save the CGImage into heic, jpeg, and png

func SCScreenshotManagerCaptureImageInRectCompletionHandler

func SCScreenshotManagerCaptureImageInRectCompletionHandler(rect corefoundation.CGRect, completionHandler func(unsafe.Pointer, unsafe.Pointer))

@abstract captureImageInRect:completionHandler: @param rect the rect for the region in points on the screen space for the screen shot, this is display agnostic and supports multiple displays @param completionHandler is the handler that will deliver the screenshot to the client @discussion this method returns an image containing the contents of the rectangle in points, specified in display space

func SCScreenshotManagerCaptureImageWithFilterConfigurationCompletionHandler

func SCScreenshotManagerCaptureImageWithFilterConfigurationCompletionHandler(contentFilter *SCContentFilter, config *SCStreamConfiguration, completionHandler func(unsafe.Pointer, unsafe.Pointer))

Captures a single frame from a stream as an image, using a filter.

func SCScreenshotManagerCaptureSampleBufferWithFilterConfigurationCompletionHandler

func SCScreenshotManagerCaptureSampleBufferWithFilterConfigurationCompletionHandler(contentFilter *SCContentFilter, config *SCStreamConfiguration, completionHandler func(unsafe.Pointer, unsafe.Pointer))

Captures a single frame directly from a stream’s buffer, using a filter.

func SCScreenshotManagerCaptureScreenshotWithFilterConfigurationCompletionHandler

func SCScreenshotManagerCaptureScreenshotWithFilterConfigurationCompletionHandler(contentFilter *SCContentFilter, config *SCScreenshotConfiguration, completionHandler func(*SCScreenshotOutput, unsafe.Pointer))

@abstract captureScreenshotWithFilter:configuration:completionHandler: @param contentFilter is the filter containing the content to take a screenshot of @param config is the screenshot configuration containing information on how to format the screenshot @param completionHandler is the handler that will deliver the SCScreenshotOutput object to the client @discussion this method returns an SCScreenshotOutput object containing CGImages of the screenshot requested by the client

func SCScreenshotManagerCaptureScreenshotWithRectConfigurationCompletionHandler

func SCScreenshotManagerCaptureScreenshotWithRectConfigurationCompletionHandler(rect corefoundation.CGRect, config *SCScreenshotConfiguration, completionHandler func(*SCScreenshotOutput, unsafe.Pointer))

@abstract captureScreenshotWithRect:configuration:completionHandler: @param rect the rect for the region in points on the screen space for the screen shot, this is display agnostic and supports multiple displays @param config is the screenshot configuration containing information on how to format the screenshot @param completionHandler is the handler that will deliver the SCScreenshotOutput object to the client @discussion this method returns an SCScreenshotOutput object containing CGImages of the screenshot requested by the client

func SCShareableContentGetCurrentProcessShareableContentWithCompletionHandler

func SCShareableContentGetCurrentProcessShareableContentWithCompletionHandler(completionHandler func(*SCShareableContent, unsafe.Pointer))

@abstract getCurrentProcessShareableContentWithCompletionHandler:completionHandler @param completionHandler the call back that will hand you back a SCShareableContent object @discussion this method will create a SCShareableContent object that is called on the supplied queue. The SCShareableContent will contain redacted information about windows, displays and applications that are available to capture by current process without user consent via TCC

func SCShareableContentGetShareableContentExcludingDesktopWindowsOnScreenWindowsOnlyAboveWindowCompletionHandler

func SCShareableContentGetShareableContentExcludingDesktopWindowsOnScreenWindowsOnlyAboveWindowCompletionHandler(excludeDesktopWindows bool, window *SCWindow, completionHandler func(*SCShareableContent, unsafe.Pointer))

Retrieves the displays, apps, and windows that are in front of the specified window.

func SCShareableContentGetShareableContentExcludingDesktopWindowsOnScreenWindowsOnlyBelowWindowCompletionHandler

func SCShareableContentGetShareableContentExcludingDesktopWindowsOnScreenWindowsOnlyBelowWindowCompletionHandler(excludeDesktopWindows bool, window *SCWindow, completionHandler func(*SCShareableContent, unsafe.Pointer))

Retrieves the displays, apps, and windows that are behind the specified window.

func SCShareableContentGetShareableContentExcludingDesktopWindowsOnScreenWindowsOnlyCompletionHandler

func SCShareableContentGetShareableContentExcludingDesktopWindowsOnScreenWindowsOnlyCompletionHandler(excludeDesktopWindows bool, onScreenWindowsOnly bool, completionHandler func(*SCShareableContent, unsafe.Pointer))

Retrieves the displays, apps, and windows that match your criteria.

func SCShareableContentGetShareableContentWithCompletionHandler

func SCShareableContentGetShareableContentWithCompletionHandler(completionHandler func(*SCShareableContent, unsafe.Pointer))

Retrieves the displays, apps, and windows that your app can capture.

func SCStreamErrorDomain

func SCStreamErrorDomain() uintptr

func SCStreamFrameInfoBoundingRect

func SCStreamFrameInfoBoundingRect() *foundation.NSString

@key SCStreamFrameInfoBoundingRect @abstract The key for the CFDictionary attached to the CMSampleBuffer for the bounding rect associated with the frame. Bounding rect is the size and location of smallest bounding box containing all captured windows in points and in surface coordinates.

func SCStreamFrameInfoContentRect

func SCStreamFrameInfoContentRect() *foundation.NSString

@key SCStreamFrameInfoContentRect @abstract The key for the CFDictionary attached to the CMSampleBuffer for the content rect associated with the frame. Content rect is the size and location of content in points in surface.

func SCStreamFrameInfoContentScale

func SCStreamFrameInfoContentScale() *foundation.NSString

@key SCStreamFrameInfoContentScale @abstract The key for the CFDictionary attached to the CMSampleBuffer for the content scale associated with the frame. Content scale is the scaling factor from original content size to its size in surface.

func SCStreamFrameInfoDirtyRects

func SCStreamFrameInfoDirtyRects() *foundation.NSString

@key SCStreamFrameInfoDirtyRects @abstract The key for the CFDictionary attached to the CMSampleBuffer for an array of rectangles that is the union of both rectangles that were redrawn and rectangles that were moved. This is an array of CGRect in NSValue. The CGRects elements are specified in pixels.

func SCStreamFrameInfoDisplayTime

func SCStreamFrameInfoDisplayTime() *foundation.NSString

@key SCStreamFrameInfoDisplayTime @abstract The key for the CFDictionary attached to the CMSampleBuffer for the mach absolute time when the event occurred. For a frame event, this is when the frame was displayed by the window server.

func SCStreamFrameInfoPresenterOverlayContentRect

func SCStreamFrameInfoPresenterOverlayContentRect() *foundation.NSString

@key SCStreamFrameInfoPresenterOverlayContentRect @abstract The key for the CFDictionary attached to the CMSampleBuffer for the content rect associated with the frame while in presenter overlay. In presenter overlay small, this content rect is the size and location of smallest bounding box containing all captured windows plus small overlay window in points and in surface coordinates. In presenter overlay large, this content rect is the size and location of shared content in points and in surface coordinates.

func SCStreamFrameInfoScaleFactor

func SCStreamFrameInfoScaleFactor() *foundation.NSString

@key SCStreamFrameInfoScaleFactor @abstract The key for the CFDictionary attached to the CMSampleBuffer for the display resolution associated with the frame. Display resolution is the pixel to point scaling factor. It should be in the range of [1, 4].

func SCStreamFrameInfoScreenRect

func SCStreamFrameInfoScreenRect() *foundation.NSString

@key SCStreamFrameInfoScreenRect @abstract The key for the CFDictionary attached to the CMSampleBuffer for the onscreen location of the captured content

func SCStreamFrameInfoStatus

func SCStreamFrameInfoStatus() *foundation.NSString

@key SCStreamFrameInfoStatus @abstract The key for the CFDictionary attached to the CMSampleBuffer that denotes the frames SCFrameStatus

Types

type Acl_entry_id_t

type Acl_entry_id_t int64
const (
	ACL_FIRST_ENTRY Acl_entry_id_t = 0
	ACL_NEXT_ENTRY  Acl_entry_id_t = -1
	ACL_LAST_ENTRY  Acl_entry_id_t = -2
)

func (Acl_entry_id_t) String

func (e Acl_entry_id_t) String() string

type Acl_flag_t

type Acl_flag_t int64
const (
	ACL_FLAG_DEFER_INHERIT      Acl_flag_t = 1
	ACL_FLAG_NO_INHERIT         Acl_flag_t = 131072
	ACL_ENTRY_INHERITED         Acl_flag_t = 16
	ACL_ENTRY_FILE_INHERIT      Acl_flag_t = 32
	ACL_ENTRY_DIRECTORY_INHERIT Acl_flag_t = 64
	ACL_ENTRY_LIMIT_INHERIT     Acl_flag_t = 128
	ACL_ENTRY_ONLY_INHERIT      Acl_flag_t = 256
)

func (Acl_flag_t) String

func (e Acl_flag_t) String() string

type Acl_perm_t

type Acl_perm_t int64
const (
	ACL_READ_DATA           Acl_perm_t = 2
	ACL_LIST_DIRECTORY      Acl_perm_t = 2
	ACL_WRITE_DATA          Acl_perm_t = 4
	ACL_ADD_FILE            Acl_perm_t = 4
	ACL_EXECUTE             Acl_perm_t = 8
	ACL_SEARCH              Acl_perm_t = 8
	ACL_DELETE              Acl_perm_t = 16
	ACL_APPEND_DATA         Acl_perm_t = 32
	ACL_ADD_SUBDIRECTORY    Acl_perm_t = 32
	ACL_DELETE_CHILD        Acl_perm_t = 64
	ACL_READ_ATTRIBUTES     Acl_perm_t = 128
	ACL_WRITE_ATTRIBUTES    Acl_perm_t = 256
	ACL_READ_EXTATTRIBUTES  Acl_perm_t = 512
	ACL_WRITE_EXTATTRIBUTES Acl_perm_t = 1024
	ACL_READ_SECURITY       Acl_perm_t = 2048
	ACL_WRITE_SECURITY      Acl_perm_t = 4096
	ACL_CHANGE_OWNER        Acl_perm_t = 8192
	ACL_SYNCHRONIZE         Acl_perm_t = 1048576
)

func (Acl_perm_t) String

func (e Acl_perm_t) String() string

type Acl_tag_t

type Acl_tag_t int64
const (
	ACL_UNDEFINED_TAG  Acl_tag_t = 0
	ACL_EXTENDED_ALLOW Acl_tag_t = 1
	ACL_EXTENDED_DENY  Acl_tag_t = 2
)

func (Acl_tag_t) String

func (e Acl_tag_t) String() string

type Acl_type_t

type Acl_type_t int64
const (
	ACL_TYPE_EXTENDED Acl_type_t = 256
	ACL_TYPE_ACCESS   Acl_type_t = 0
	ACL_TYPE_DEFAULT  Acl_type_t = 1
	ACL_TYPE_AFS      Acl_type_t = 2
	ACL_TYPE_CODA     Acl_type_t = 3
	ACL_TYPE_NTFS     Acl_type_t = 4
	ACL_TYPE_NWFS     Acl_type_t = 5
)

func (Acl_type_t) String

func (e Acl_type_t) String() string

type CGLCPContextPriorityRequest

type CGLCPContextPriorityRequest int64
const (
	KCGLCPContextPriorityRequestHigh   CGLCPContextPriorityRequest = 0
	KCGLCPContextPriorityRequestNormal CGLCPContextPriorityRequest = 1
	KCGLCPContextPriorityRequestLow    CGLCPContextPriorityRequest = 2
)

func (CGLCPContextPriorityRequest) String

type Clockid_t

type Clockid_t int64

func (Clockid_t) String

func (e Clockid_t) String() string

type Dispatch_autorelease_frequency_t

type Dispatch_autorelease_frequency_t uint64
const (
	DISPATCH_AUTORELEASE_FREQUENCY_INHERIT   Dispatch_autorelease_frequency_t = 0
	DISPATCH_AUTORELEASE_FREQUENCY_WORK_ITEM Dispatch_autorelease_frequency_t = 1
	DISPATCH_AUTORELEASE_FREQUENCY_NEVER     Dispatch_autorelease_frequency_t = 2
)

func (Dispatch_autorelease_frequency_t) String

type Dispatch_block_flags_t

type Dispatch_block_flags_t uint64
const (
	DISPATCH_BLOCK_BARRIER           Dispatch_block_flags_t = 1
	DISPATCH_BLOCK_DETACHED          Dispatch_block_flags_t = 2
	DISPATCH_BLOCK_ASSIGN_CURRENT    Dispatch_block_flags_t = 4
	DISPATCH_BLOCK_NO_QOS_CLASS      Dispatch_block_flags_t = 8
	DISPATCH_BLOCK_INHERIT_QOS_CLASS Dispatch_block_flags_t = 16
	DISPATCH_BLOCK_ENFORCE_QOS_CLASS Dispatch_block_flags_t = 32
)

func (Dispatch_block_flags_t) String

func (e Dispatch_block_flags_t) String() string

type EvCmd

type EvCmd int64
const (
	EVNOP   EvCmd = 0
	EVHIDE  EvCmd = 1
	EVSHOW  EvCmd = 2
	EVMOVE  EvCmd = 3
	EVLEVEL EvCmd = 4
)

func (EvCmd) String

func (e EvCmd) String() string

type Filesec_property_t

type Filesec_property_t int64
const (
	FILESEC_OWNER         Filesec_property_t = 1
	FILESEC_GROUP         Filesec_property_t = 2
	FILESEC_UUID          Filesec_property_t = 3
	FILESEC_MODE          Filesec_property_t = 4
	FILESEC_ACL           Filesec_property_t = 5
	FILESEC_GRPUUID       Filesec_property_t = 6
	FILESEC_ACL_RAW       Filesec_property_t = 100
	FILESEC_ACL_ALLOCSIZE Filesec_property_t = 101
)

func (Filesec_property_t) String

func (e Filesec_property_t) String() string

type Idtype_t

type Idtype_t int64
const (
	P_ALL  Idtype_t = 0
	P_PID  Idtype_t = 1
	P_PGID Idtype_t = 2
)

func (Idtype_t) String

func (e Idtype_t) String() string

type Ipc_info_object_type_t

type Ipc_info_object_type_t int64
const (
	IPC_OTYPE_NONE                 Ipc_info_object_type_t = 0
	IPC_OTYPE_THREAD_CONTROL       Ipc_info_object_type_t = 1
	IPC_OTYPE_TASK_CONTROL         Ipc_info_object_type_t = 2
	IPC_OTYPE_HOST                 Ipc_info_object_type_t = 3
	IPC_OTYPE_HOST_PRIV            Ipc_info_object_type_t = 4
	IPC_OTYPE_PROCESSOR            Ipc_info_object_type_t = 5
	IPC_OTYPE_PROCESSOR_SET        Ipc_info_object_type_t = 6
	IPC_OTYPE_PROCESSOR_SET_NAME   Ipc_info_object_type_t = 7
	IPC_OTYPE_TIMER                Ipc_info_object_type_t = 8
	IPC_OTYPE_PORT_SUBST_ONCE      Ipc_info_object_type_t = 9
	IPC_OTYPE_MIG                  Ipc_info_object_type_t = 10
	IPC_OTYPE_MEMORY_OBJECT        Ipc_info_object_type_t = 11
	IPC_OTYPE_XMM_PAGER            Ipc_info_object_type_t = 12
	IPC_OTYPE_XMM_KERNEL           Ipc_info_object_type_t = 13
	IPC_OTYPE_XMM_REPLY            Ipc_info_object_type_t = 14
	IPC_OTYPE_UND_REPLY            Ipc_info_object_type_t = 15
	IPC_OTYPE_HOST_NOTIFY          Ipc_info_object_type_t = 16
	IPC_OTYPE_HOST_SECURITY        Ipc_info_object_type_t = 17
	IPC_OTYPE_LEDGER               Ipc_info_object_type_t = 18
	IPC_OTYPE_MAIN_DEVICE          Ipc_info_object_type_t = 19
	IPC_OTYPE_TASK_NAME            Ipc_info_object_type_t = 20
	IPC_OTYPE_SUBSYSTEM            Ipc_info_object_type_t = 21
	IPC_OTYPE_IO_DONE_QUEUE        Ipc_info_object_type_t = 22
	IPC_OTYPE_SEMAPHORE            Ipc_info_object_type_t = 23
	IPC_OTYPE_LOCK_SET             Ipc_info_object_type_t = 24
	IPC_OTYPE_CLOCK                Ipc_info_object_type_t = 25
	IPC_OTYPE_CLOCK_CTRL           Ipc_info_object_type_t = 26
	IPC_OTYPE_IOKIT_IDENT          Ipc_info_object_type_t = 27
	IPC_OTYPE_NAMED_ENTRY          Ipc_info_object_type_t = 28
	IPC_OTYPE_IOKIT_CONNECT        Ipc_info_object_type_t = 29
	IPC_OTYPE_IOKIT_OBJECT         Ipc_info_object_type_t = 30
	IPC_OTYPE_UPL                  Ipc_info_object_type_t = 31
	IPC_OTYPE_MEM_OBJ_CONTROL      Ipc_info_object_type_t = 32
	IPC_OTYPE_AU_SESSIONPORT       Ipc_info_object_type_t = 33
	IPC_OTYPE_FILEPORT             Ipc_info_object_type_t = 34
	IPC_OTYPE_LABELH               Ipc_info_object_type_t = 35
	IPC_OTYPE_TASK_RESUME          Ipc_info_object_type_t = 36
	IPC_OTYPE_VOUCHER              Ipc_info_object_type_t = 37
	IPC_OTYPE_VOUCHER_ATTR_CONTROL Ipc_info_object_type_t = 38
	IPC_OTYPE_WORK_INTERVAL        Ipc_info_object_type_t = 39
	IPC_OTYPE_UX_HANDLER           Ipc_info_object_type_t = 40
	IPC_OTYPE_UEXT_OBJECT          Ipc_info_object_type_t = 41
	IPC_OTYPE_ARCADE_REG           Ipc_info_object_type_t = 42
	IPC_OTYPE_EVENTLINK            Ipc_info_object_type_t = 43
	IPC_OTYPE_TASK_INSPECT         Ipc_info_object_type_t = 44
	IPC_OTYPE_TASK_READ            Ipc_info_object_type_t = 45
	IPC_OTYPE_THREAD_INSPECT       Ipc_info_object_type_t = 46
	IPC_OTYPE_THREAD_READ          Ipc_info_object_type_t = 47
	IPC_OTYPE_SUID_CRED            Ipc_info_object_type_t = 48
	IPC_OTYPE_HYPERVISOR           Ipc_info_object_type_t = 49
	IPC_OTYPE_TASK_ID_TOKEN        Ipc_info_object_type_t = 50
	IPC_OTYPE_TASK_FATAL           Ipc_info_object_type_t = 51
	IPC_OTYPE_KCDATA               Ipc_info_object_type_t = 52
	IPC_OTYPE_EXCLAVES_RESOURCE    Ipc_info_object_type_t = 53
	IPC_OTYPE_THREAD_RESUME        Ipc_info_object_type_t = 54
	IPC_OTYPE_UNKNOWN              Ipc_info_object_type_t = 4294967295
)

func (Ipc_info_object_type_t) String

func (e Ipc_info_object_type_t) String() string

type Launch_data_type_t

type Launch_data_type_t int64
const (
	LAUNCH_DATA_DICTIONARY Launch_data_type_t = 1
	LAUNCH_DATA_ARRAY      Launch_data_type_t = 2
	LAUNCH_DATA_FD         Launch_data_type_t = 3
	LAUNCH_DATA_INTEGER    Launch_data_type_t = 4
	LAUNCH_DATA_REAL       Launch_data_type_t = 5
	LAUNCH_DATA_BOOL       Launch_data_type_t = 6
	LAUNCH_DATA_STRING     Launch_data_type_t = 7
	LAUNCH_DATA_OPAQUE     Launch_data_type_t = 8
	LAUNCH_DATA_ERRNO      Launch_data_type_t = 9
	LAUNCH_DATA_MACHPORT   Launch_data_type_t = 10
)

func (Launch_data_type_t) String

func (e Launch_data_type_t) String() string

type MDLabelDomain

type MDLabelDomain int64

@typedef MDLabelDomain @abstract These constants are used to specify a domain to MDLabelCreate().

const (
	KMDLabelUserDomain  MDLabelDomain = 0
	KMDLabelLocalDomain MDLabelDomain = 1
)

func (MDLabelDomain) String

func (e MDLabelDomain) String() string

type MDQueryOptionFlags

type MDQueryOptionFlags int64
const (
	KMDQuerySynchronous        MDQueryOptionFlags = 1
	KMDQueryWantsUpdates       MDQueryOptionFlags = 4
	KMDQueryAllowFSTranslation MDQueryOptionFlags = 8
)

func (MDQueryOptionFlags) String

func (e MDQueryOptionFlags) String() string

type MDQuerySortOptionFlags

type MDQuerySortOptionFlags int64

@enum MDQuerySortOptionFlags @constant kMDQueryReverseSortOrderFlag Sort the attribute in reverse order.

const (
	KMDQueryReverseSortOrderFlag MDQuerySortOptionFlags = 1
)

func (MDQuerySortOptionFlags) String

func (e MDQuerySortOptionFlags) String() string

type Mach_vm_range_flags_t

type Mach_vm_range_flags_t int64
const (
	MACH_VM_RANGE_NONE Mach_vm_range_flags_t = 0
)

func (Mach_vm_range_flags_t) String

func (e Mach_vm_range_flags_t) String() string

type Mach_vm_range_flavor_t

type Mach_vm_range_flavor_t int64
const (
	MACH_VM_RANGE_FLAVOR_INVALID Mach_vm_range_flavor_t = 0
	MACH_VM_RANGE_FLAVOR_V1      Mach_vm_range_flavor_t = 1
)

func (Mach_vm_range_flavor_t) String

func (e Mach_vm_range_flavor_t) String() string

type Mach_vm_range_tag_t

type Mach_vm_range_tag_t int64
const (
	MACH_VM_RANGE_DEFAULT Mach_vm_range_tag_t = 0
	MACH_VM_RANGE_DATA    Mach_vm_range_tag_t = 1
	MACH_VM_RANGE_FIXED   Mach_vm_range_tag_t = 2
)

func (Mach_vm_range_tag_t) String

func (e Mach_vm_range_tag_t) String() string

type Mpo_flags_t

type Mpo_flags_t int64
const (
	MPO_PORT                            Mpo_flags_t = 0
	MPO_SERVICE_PORT                    Mpo_flags_t = 1024
	MPO_CONNECTION_PORT                 Mpo_flags_t = 2048
	MPO_REPLY_PORT                      Mpo_flags_t = 4096
	MPO_WEAK_REPLY_PORT                 Mpo_flags_t = 16384
	MPO_NOTIFICATION_PORT               Mpo_flags_t = 17408
	MPO_EXCEPTION_PORT                  Mpo_flags_t = 32768
	MPO_CONNECTION_PORT_WITH_PORT_ARRAY Mpo_flags_t = 65536
)

func (Mpo_flags_t) String

func (e Mpo_flags_t) String() string

type NXMouseButton

type NXMouseButton int64
const (
	NX_OneButton   NXMouseButton = 0
	NX_LeftButton  NXMouseButton = 1
	NX_RightButton NXMouseButton = 2
)

func (NXMouseButton) String

func (e NXMouseButton) String() string

type Os_clockid_t

type Os_clockid_t int64
const (
	OS_CLOCK_MACH_ABSOLUTE_TIME Os_clockid_t = 32
)

func (Os_clockid_t) String

func (e Os_clockid_t) String() string

type Os_unfair_lock_flags_t

type Os_unfair_lock_flags_t int64
const (
	OS_UNFAIR_LOCK_FLAG_NONE          Os_unfair_lock_flags_t = 0
	OS_UNFAIR_LOCK_FLAG_ADAPTIVE_SPIN Os_unfair_lock_flags_t = 262144
)

func (Os_unfair_lock_flags_t) String

func (e Os_unfair_lock_flags_t) String() string

type PMPageToPaperMappingType

type PMPageToPaperMappingType int64
const (
	KPMPageToPaperMappingNone       PMPageToPaperMappingType = 1
	KPMPageToPaperMappingScaleToFit PMPageToPaperMappingType = 2
)

func (PMPageToPaperMappingType) String

func (e PMPageToPaperMappingType) String() string

type Ptrauth_key

type Ptrauth_key int64
const (
	Ptrauth_key_none                     Ptrauth_key = -1
	Ptrauth_key_asia                     Ptrauth_key = 0
	Ptrauth_key_asib                     Ptrauth_key = 1
	Ptrauth_key_asda                     Ptrauth_key = 2
	Ptrauth_key_asdb                     Ptrauth_key = 3
	Ptrauth_key_process_independent_code Ptrauth_key = 0
	Ptrauth_key_process_dependent_code   Ptrauth_key = 1
	Ptrauth_key_process_independent_data Ptrauth_key = 2
	Ptrauth_key_process_dependent_data   Ptrauth_key = 3
	Ptrauth_key_return_address           Ptrauth_key = 1
	Ptrauth_key_frame_pointer            Ptrauth_key = 3
	Ptrauth_key_function_pointer         Ptrauth_key = 0
	Ptrauth_key_block_function           Ptrauth_key = 0
	Ptrauth_key_cxx_vtable_pointer       Ptrauth_key = 2
	Ptrauth_key_method_list_pointer      Ptrauth_key = 2
	Ptrauth_key_objc_isa_pointer         Ptrauth_key = 2
	Ptrauth_key_objc_super_pointer       Ptrauth_key = 2
	Ptrauth_key_objc_sel_pointer         Ptrauth_key = 3
	Ptrauth_key_objc_class_ro_pointer    Ptrauth_key = 2
	Ptrauth_key_block_descriptor_pointer Ptrauth_key = 2
	Ptrauth_key_init_fini_pointer        Ptrauth_key = 0
)

func (Ptrauth_key) String

func (e Ptrauth_key) String() string

type Qos_class_t

type Qos_class_t uint32
const (
	QOS_CLASS_USER_INTERACTIVE Qos_class_t = 33
	QOS_CLASS_USER_INITIATED   Qos_class_t = 25
	QOS_CLASS_DEFAULT          Qos_class_t = 21
	QOS_CLASS_UTILITY          Qos_class_t = 17
	QOS_CLASS_BACKGROUND       Qos_class_t = 9
	QOS_CLASS_UNSPECIFIED      Qos_class_t = 0
)

func (Qos_class_t) String

func (e Qos_class_t) String() string

type SCCaptureDynamicRange

type SCCaptureDynamicRange int64

Specifies whether the captured screen output is standard or high dynamic range.

const (
	// Specifies that the system captures the screen in standard dynamic range.
	SCCaptureDynamicRangeSDR SCCaptureDynamicRange = 0
	// Specifies that the system captures the screen in high dynamic range with attributes of the local display.
	SCCaptureDynamicRangeHDRLocalDisplay SCCaptureDynamicRange = 1
	// Specifies that the system captures the screen in high dynamic range with attributes of the canonical display.
	SCCaptureDynamicRangeHDRCanonicalDisplay SCCaptureDynamicRange = 2
)

func (SCCaptureDynamicRange) String

func (e SCCaptureDynamicRange) String() string

type SCCaptureResolutionType

type SCCaptureResolutionType int64

Available resolutions for content capture.

const (
	// Allow ScreenCaptureKit to automatically select the quality of content depending on factors such as network connection.
	SCCaptureResolutionAutomatic SCCaptureResolutionType = 0
	// Capture streaming content at the best available resolution.
	SCCaptureResolutionBest SCCaptureResolutionType = 1
	// Capture streaming content with a one point to one pixel conversion factor.
	SCCaptureResolutionNominal SCCaptureResolutionType = 2
)

func (SCCaptureResolutionType) String

func (e SCCaptureResolutionType) String() string

type SCContentFilter

type SCContentFilter struct {
	foundation.NSObject
}

An instance that filters the content a stream captures.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/sccontentfilter

func SCContentFilterFromID

func SCContentFilterFromID(id objc.ID) *SCContentFilter

func (*SCContentFilter) ContentRect

func (o *SCContentFilter) ContentRect() corefoundation.CGRect

@abstract Size and location of content in points

func (*SCContentFilter) IncludeMenuBar

func (o *SCContentFilter) IncludeMenuBar() bool

@abstract To include menu bar as part of the capture. This property has no effect for the desktop independent window filter. For content filters created with initWithDisplay:excluding, the default value is YES. Display excluding content filters contains the desktop and dock. For content filters created with initWithDisplay:including, the default value is NO. Display including content filters do not contain the desktop and dock

func (*SCContentFilter) IncludedApplications

func (o *SCContentFilter) IncludedApplications() *foundation.NSArray[*SCRunningApplication]

@abstract Applications that are included in the content filter

func (*SCContentFilter) IncludedDisplays

func (o *SCContentFilter) IncludedDisplays() *foundation.NSArray[*SCDisplay]

@abstract SCDisplays that are included in the content filter

func (*SCContentFilter) IncludedWindows

func (o *SCContentFilter) IncludedWindows() *foundation.NSArray[*SCWindow]

@abstract Windows that are included in the content filter

func (*SCContentFilter) InitWithDesktopIndependentWindow

func (o *SCContentFilter) InitWithDesktopIndependentWindow(window *SCWindow) *SCContentFilter

Creates a filter that captures only the specified window.

func (*SCContentFilter) InitWithDisplayExcludingApplicationsExceptingWindows

func (o *SCContentFilter) InitWithDisplayExcludingApplicationsExceptingWindows(display *SCDisplay, applications *foundation.NSArray[*SCRunningApplication], exceptingWindows *foundation.NSArray[*SCWindow]) *SCContentFilter

Creates a filter that captures a display, excluding windows of the specified apps.

func (*SCContentFilter) InitWithDisplayExcludingWindows

func (o *SCContentFilter) InitWithDisplayExcludingWindows(display *SCDisplay, excluded *foundation.NSArray[*SCWindow]) *SCContentFilter

Creates a filter that captures the contents of a display, excluding the specified windows.

func (*SCContentFilter) InitWithDisplayIncludingApplicationsExceptingWindows

func (o *SCContentFilter) InitWithDisplayIncludingApplicationsExceptingWindows(display *SCDisplay, applications *foundation.NSArray[*SCRunningApplication], exceptingWindows *foundation.NSArray[*SCWindow]) *SCContentFilter

Creates a filter that captures a display, including only windows of the specified apps.

func (*SCContentFilter) InitWithDisplayIncludingWindows

func (o *SCContentFilter) InitWithDisplayIncludingWindows(display *SCDisplay, includedWindows *foundation.NSArray[*SCWindow]) *SCContentFilter

Creates a filter that captures only specific windows from a display.

func (*SCContentFilter) PointPixelScale

func (o *SCContentFilter) PointPixelScale() float32

@abstract Pixel to points scaling factor

func (*SCContentFilter) SetIncludeMenuBar

func (o *SCContentFilter) SetIncludeMenuBar(includeMenuBar bool)

func (*SCContentFilter) StreamType

func (o *SCContentFilter) StreamType() SCStreamType

@abstract streamType type of stream Deprecated: Use style instead

func (*SCContentFilter) Style

@abstract style of stream

type SCContentSharingPicker

type SCContentSharingPicker struct {
	foundation.NSObject
}

An instance of a picker presented by the operating system for managing frame-capture streams.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/sccontentsharingpicker

func SCContentSharingPickerFromID

func SCContentSharingPickerFromID(id objc.ID) *SCContentSharingPicker

func SCContentSharingPickerSharedPicker

func SCContentSharingPickerSharedPicker() *SCContentSharingPicker

@abstract sharedPicker the singleton shared picker for the application

func (*SCContentSharingPicker) AddObserver

func (o *SCContentSharingPicker) AddObserver(observer SCContentSharingPickerObserver)

Adds an observer instance to notify of changes in the content-sharing picker.

func (*SCContentSharingPicker) DefaultConfiguration

@abstract defaultConfiguration for the content sharing picker. If a stream does not have a configuration, the default configuration will be used.

func (*SCContentSharingPicker) IsActive

func (o *SCContentSharingPicker) IsActive() bool

@abstract active A picker needs to be marked as active for its UI to appear. If `startPickingContent` is called and the picker is not marked as active, the picker will not appear.

func (*SCContentSharingPicker) MaximumStreamCount

func (o *SCContentSharingPicker) MaximumStreamCount() *foundation.NSNumber

@abstract maximumStreamCount An integer value that, if set, limits when Control Center will show the UI to present a picker with no associated stream. If set to 0, Control Center will never ever show UI to present a picker without an associated stream.

func (*SCContentSharingPicker) Present

func (o *SCContentSharingPicker) Present()

Displays the picker with no active selection for capture.

func (*SCContentSharingPicker) PresentPickerForStream

func (o *SCContentSharingPicker) PresentPickerForStream(stream *SCStream)

Displays the picker with an already running capture stream.

func (*SCContentSharingPicker) PresentPickerForStreamUsingContentStyle

func (o *SCContentSharingPicker) PresentPickerForStreamUsingContentStyle(stream *SCStream, contentStyle SCShareableContentStyle)

Displays the picker with an existing capture stream, allowing for a single type of capture selection.

func (*SCContentSharingPicker) PresentPickerUsingContentStyle

func (o *SCContentSharingPicker) PresentPickerUsingContentStyle(contentStyle SCShareableContentStyle)

Displays the picker for a single type of capture selection.

func (*SCContentSharingPicker) RemoveObserver

func (o *SCContentSharingPicker) RemoveObserver(observer SCContentSharingPickerObserver)

Removes an observer instance from the content-sharing picker.

func (*SCContentSharingPicker) SetActive

func (o *SCContentSharingPicker) SetActive(active bool)

func (*SCContentSharingPicker) SetConfigurationForStream

func (o *SCContentSharingPicker) SetConfigurationForStream(pickerConfig *SCContentSharingPickerConfiguration[objc.ID], stream *SCStream)

Sets the configuration for the content capture picker for a capture stream, providing allowed selection modes and content excluded from selection.

func (*SCContentSharingPicker) SetDefaultConfiguration

func (o *SCContentSharingPicker) SetDefaultConfiguration(defaultConfiguration *SCContentSharingPickerConfiguration[objc.ID])

func (*SCContentSharingPicker) SetMaximumStreamCount

func (o *SCContentSharingPicker) SetMaximumStreamCount(maximumStreamCount *foundation.NSNumber)

type SCContentSharingPickerConfiguration

type SCContentSharingPickerConfiguration[NSCopying purego.AnyObject] struct {
	foundation.NSObject
}

An instance for configuring the system content-sharing picker.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/sccontentsharingpickerconfiguration

func SCContentSharingPickerConfigurationFromID

func SCContentSharingPickerConfigurationFromID[NSCopying purego.AnyObject](id objc.ID) *SCContentSharingPickerConfiguration[NSCopying]

func (*SCContentSharingPickerConfiguration[NSCopying]) AllowedPickerModes

func (o *SCContentSharingPickerConfiguration[NSCopying]) AllowedPickerModes() SCContentSharingPickerMode

@abstract allowedPickerModes Limits the type of selections available to the user when the picker is presented. Default is 0, no excluded picking modes

func (*SCContentSharingPickerConfiguration[NSCopying]) AllowsChangingSelectedContent

func (o *SCContentSharingPickerConfiguration[NSCopying]) AllowsChangingSelectedContent() bool

@abstract allowsChangingSelectedContent Controls if the user can make updates to the content filter after the initial selection. Defaults is YES.

func (*SCContentSharingPickerConfiguration[NSCopying]) ExcludedBundleIDs

func (o *SCContentSharingPickerConfiguration[NSCopying]) ExcludedBundleIDs() *foundation.NSArray[*foundation.NSString]

@abstract excludedBundleIDs Excludes bundle IDs for picking

func (*SCContentSharingPickerConfiguration[NSCopying]) ExcludedWindowIDs

func (o *SCContentSharingPickerConfiguration[NSCopying]) ExcludedWindowIDs() *foundation.NSArray[*foundation.NSNumber]

@abstract excludedWindowIDs Excludes CGWindowIDs for picking

func (*SCContentSharingPickerConfiguration[NSCopying]) SetAllowedPickerModes

func (o *SCContentSharingPickerConfiguration[NSCopying]) SetAllowedPickerModes(allowedPickerModes SCContentSharingPickerMode)

func (*SCContentSharingPickerConfiguration[NSCopying]) SetAllowsChangingSelectedContent

func (o *SCContentSharingPickerConfiguration[NSCopying]) SetAllowsChangingSelectedContent(allowsChangingSelectedContent bool)

func (*SCContentSharingPickerConfiguration[NSCopying]) SetExcludedBundleIDs

func (o *SCContentSharingPickerConfiguration[NSCopying]) SetExcludedBundleIDs(excludedBundleIDs *foundation.NSArray[*foundation.NSString])

func (*SCContentSharingPickerConfiguration[NSCopying]) SetExcludedWindowIDs

func (o *SCContentSharingPickerConfiguration[NSCopying]) SetExcludedWindowIDs(excludedWindowIDs *foundation.NSArray[*foundation.NSNumber])

type SCContentSharingPickerMode

type SCContentSharingPickerMode uint64

Available modes for selecting streaming content from a picker presented by the operating system.

const (
	// The mode allowing the selection of a single window through the presented picker.
	SCContentSharingPickerModeSingleWindow SCContentSharingPickerMode = 1
	// The mode allowing the selection of multiple windows through the presented picker.
	SCContentSharingPickerModeMultipleWindows SCContentSharingPickerMode = 2
	// The mode allowing the selection of a single application through the presented picker.
	SCContentSharingPickerModeSingleApplication SCContentSharingPickerMode = 4
	// The mode allowing the selection of multiple applications through the presented picker.
	SCContentSharingPickerModeMultipleApplications SCContentSharingPickerMode = 8
	// The mode allowing the selection of a single display through the presented picker.
	SCContentSharingPickerModeSingleDisplay SCContentSharingPickerMode = 16
)

func (SCContentSharingPickerMode) String

type SCContentSharingPickerObserver

type SCContentSharingPickerObserver interface {
	ContentSharingPickerDidCancelForStream(picker *SCContentSharingPicker, stream *SCStream)
	ContentSharingPickerDidUpdateWithFilterForStream(picker *SCContentSharingPicker, filter *SCContentFilter, stream *SCStream)
	ContentSharingPickerStartDidFailWithError(error_ unsafe.Pointer)
}

SCContentSharingPickerObserver wraps the ObjC protocol SCContentSharingPickerObserver.

type SCDisplay

type SCDisplay struct {
	foundation.NSObject
}

An instance that represents a display device.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/scdisplay

func SCDisplayFromID

func SCDisplayFromID(id objc.ID) *SCDisplay

func (*SCDisplay) DisplayID

func (o *SCDisplay) DisplayID() uint32

@abstract displayId the CGDirectDisplayID for the SCDisplay

func (*SCDisplay) Frame

func (o *SCDisplay) Frame() corefoundation.CGRect

@abstract frame the CGRect frame for the SCDisplay

func (*SCDisplay) Height

func (o *SCDisplay) Height() int

@abstract height the height, in points, for the SCDisplay

func (*SCDisplay) Width

func (o *SCDisplay) Width() int

@abstract width the width, in points, for the SCDisplay

type SCFrameStatus

type SCFrameStatus int64

Status values for a frame from a stream.

const (
	// A status that indicates the system successfully generated a new frame.
	SCFrameStatusComplete SCFrameStatus = 0
	// A status that indicates the system didn’t generate a new frame because the display didn’t change.
	SCFrameStatusIdle SCFrameStatus = 1
	// A status that indicates the system didn’t generate a new frame because the display is blank.
	SCFrameStatusBlank SCFrameStatus = 2
	// A status that indicates the system didn’t generate a new frame because you suspended updates.
	SCFrameStatusSuspended SCFrameStatus = 3
	// A status that indicates the frame is the first one sent after the stream starts.
	SCFrameStatusStarted SCFrameStatus = 4
	// A status that indicates the frame is in a stopped state.
	SCFrameStatusStopped SCFrameStatus = 5
)

func (SCFrameStatus) String

func (e SCFrameStatus) String() string

type SCPresenterOverlayAlertSetting

type SCPresenterOverlayAlertSetting int64

Configures how to present streaming notifications to a streamer of Presenter Overlay.

const (
	// Displays an alert when using Presenter Overlay based on the System Settings.
	SCPresenterOverlayAlertSettingSystem SCPresenterOverlayAlertSetting = 0
	// Never display an alert when using Presenter Overlay.
	SCPresenterOverlayAlertSettingNever SCPresenterOverlayAlertSetting = 1
	// Always display an alert when using Presenter Overlay.
	SCPresenterOverlayAlertSettingAlways SCPresenterOverlayAlertSetting = 2
)

func (SCPresenterOverlayAlertSetting) String

type SCRecordingOutput

type SCRecordingOutput struct {
	foundation.NSObject
}

Apple documentation: https://developer.apple.com/documentation/screencapturekit/screcordingoutput

func SCRecordingOutputFromID

func SCRecordingOutputFromID(id objc.ID) *SCRecordingOutput

func (*SCRecordingOutput) InitWithConfigurationDelegate

func (o *SCRecordingOutput) InitWithConfigurationDelegate(recordingOutputConfiguration *SCRecordingOutputConfiguration, delegate SCRecordingOutputDelegate) *SCRecordingOutput

@method initWithConfiguration:delegate: @abstract initialize SCRecordingOutput object with SCRecordingOutputConfiguration and SCRecordingOutputDelegate @param recordingOutputConfiguration the requested recording configuration to be applied to the SCRecordingOutput @parame delegate object conforming SCRecordingOutputDelegate protocol. Clients must specify a delegate so that they can be notified about recording event. @discussion Client can create a SCRecordingOutput with this initializer and add to SCStream to record all captured media into one recording file given output url specified in recordingOutputConfig. The recording will be using H264 and file format is MPEG-4.

func (*SCRecordingOutput) RecordedDuration

func (o *SCRecordingOutput) RecordedDuration() coremedia.CMTime

@abstract Indicates current duration of recording to the output file.

func (*SCRecordingOutput) RecordedFileSize

func (o *SCRecordingOutput) RecordedFileSize() int

@abstract Indicates current size, in bytes, of the data recorded to the output file.

type SCRecordingOutputConfiguration

type SCRecordingOutputConfiguration struct {
	foundation.NSObject
}

Apple documentation: https://developer.apple.com/documentation/screencapturekit/screcordingoutputconfiguration

func SCRecordingOutputConfigurationFromID

func SCRecordingOutputConfigurationFromID(id objc.ID) *SCRecordingOutputConfiguration

func (*SCRecordingOutputConfiguration) AvailableOutputFileTypes

func (o *SCRecordingOutputConfiguration) AvailableOutputFileTypes() *foundation.NSArray[*foundation.NSString]

@abstract Returns an array of supported file types that can be specified in SCRecordingOutputConfiguration for outputFileType Provides the file types AVCaptureAudioFileOutput can write.

func (*SCRecordingOutputConfiguration) AvailableVideoCodecTypes

func (o *SCRecordingOutputConfiguration) AvailableVideoCodecTypes() *foundation.NSArray[*foundation.NSString]

@abstract Returns an array of supported video codec formats that can be specified in SCRecordingOutputConfiguration for videoCodecType

func (*SCRecordingOutputConfiguration) OutputFileType

func (o *SCRecordingOutputConfiguration) OutputFileType() *foundation.NSString

@abstract Specifies file type for the recording output, default is AVFileTypeMPEG4, supported values can be obtained using availableOutputFileTypes

func (*SCRecordingOutputConfiguration) OutputURL

@abstract Specifies output URL to save the recording.

func (*SCRecordingOutputConfiguration) SetOutputFileType

func (o *SCRecordingOutputConfiguration) SetOutputFileType(outputFileType *foundation.NSString)

func (*SCRecordingOutputConfiguration) SetOutputURL

func (o *SCRecordingOutputConfiguration) SetOutputURL(outputURL *foundation.NSURL)

func (*SCRecordingOutputConfiguration) SetVideoCodecType

func (o *SCRecordingOutputConfiguration) SetVideoCodecType(videoCodecType *foundation.NSString)

func (*SCRecordingOutputConfiguration) VideoCodecType

func (o *SCRecordingOutputConfiguration) VideoCodecType() *foundation.NSString

@abstract Specifies video codec for the recording output, default is AVVideoCodecTypeH264, supported values can be obtained using availableVideoCodecTypes

type SCRecordingOutputDelegate

type SCRecordingOutputDelegate interface {
}

SCRecordingOutputDelegate wraps the ObjC protocol SCRecordingOutputDelegate.

type SCRunningApplication

type SCRunningApplication struct {
	foundation.NSObject
}

An instance that represents an app running on a device.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/scrunningapplication

func SCRunningApplicationFromID

func SCRunningApplicationFromID(id objc.ID) *SCRunningApplication

func (*SCRunningApplication) ApplicationName

func (o *SCRunningApplication) ApplicationName() *foundation.NSString

@abstract applicationName the application name for the SCRunningApplication

func (*SCRunningApplication) BundleIdentifier

func (o *SCRunningApplication) BundleIdentifier() *foundation.NSString

@abstract bundleIdentifier the bundleIdentifier for the SCRunningApplication

func (*SCRunningApplication) ProcessID

func (o *SCRunningApplication) ProcessID() int

@abstract processID the SCRunningApplication

type SCScreenshotConfiguration

type SCScreenshotConfiguration struct {
	foundation.NSObject
}

An object that contains screenshot properties such as output width, height, and image quality specifications.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/scscreenshotconfiguration

func SCScreenshotConfigurationFromID

func SCScreenshotConfigurationFromID(id objc.ID) *SCScreenshotConfiguration

func (*SCScreenshotConfiguration) ContentType

@abstract Specifies the screenshot file format.

func (*SCScreenshotConfiguration) DestinationRect

func (o *SCScreenshotConfiguration) DestinationRect() corefoundation.CGRect

@abstract SCScreenshotProperty that specifies that the screenshot outputs into a subset of the output CGimage.If not set then the output surface is used. The rectangle is specified in pixels in the display's coordinate system.

func (*SCScreenshotConfiguration) DisplayIntent

@abstract Specifies the render type of the screenshot.

func (*SCScreenshotConfiguration) DynamicRange

@abstract Specifies the CGImage to return to the client.

func (*SCScreenshotConfiguration) FileURL

@abstract Specifies output URL to save the screenshot. If the imageOutputURL is nil, then the file will not be saved.

func (*SCScreenshotConfiguration) Height

func (o *SCScreenshotConfiguration) Height() int

@abstract SCScreenshotProperty for output height as measured in pixels. Default is the height of the content being captured.

func (*SCScreenshotConfiguration) IgnoreClipping

func (o *SCScreenshotConfiguration) IgnoreClipping() bool

@abstract SCScreenshotProperty to ignore framing on windows in the display bounded sharing case (will ignore shadows).

func (*SCScreenshotConfiguration) IgnoreShadows

func (o *SCScreenshotConfiguration) IgnoreShadows() bool

@abstract SCScreenshotProperty to ignore framing on windows (will ignore shadows).

func (*SCScreenshotConfiguration) IncludeChildWindows

func (o *SCScreenshotConfiguration) IncludeChildWindows() bool

@abstract SCScreenshotProperty to show the child windows of the applications and windows being captured. Child windows are included by default.

func (*SCScreenshotConfiguration) SetContentType

func (o *SCScreenshotConfiguration) SetContentType(contentType *uniformtypeidentifiers.UTType)

func (*SCScreenshotConfiguration) SetDestinationRect

func (o *SCScreenshotConfiguration) SetDestinationRect(destinationRect corefoundation.CGRect)

func (*SCScreenshotConfiguration) SetDisplayIntent

func (o *SCScreenshotConfiguration) SetDisplayIntent(displayIntent SCScreenshotDisplayIntent)

func (*SCScreenshotConfiguration) SetDynamicRange

func (o *SCScreenshotConfiguration) SetDynamicRange(dynamicRange SCScreenshotDynamicRange)

func (*SCScreenshotConfiguration) SetFileURL

func (o *SCScreenshotConfiguration) SetFileURL(fileURL *foundation.NSURL)

func (*SCScreenshotConfiguration) SetHeight

func (o *SCScreenshotConfiguration) SetHeight(height int)

func (*SCScreenshotConfiguration) SetIgnoreClipping

func (o *SCScreenshotConfiguration) SetIgnoreClipping(ignoreClipping bool)

func (*SCScreenshotConfiguration) SetIgnoreShadows

func (o *SCScreenshotConfiguration) SetIgnoreShadows(ignoreShadows bool)

func (*SCScreenshotConfiguration) SetIncludeChildWindows

func (o *SCScreenshotConfiguration) SetIncludeChildWindows(includeChildWindows bool)

func (*SCScreenshotConfiguration) SetShowsCursor

func (o *SCScreenshotConfiguration) SetShowsCursor(showsCursor bool)

func (*SCScreenshotConfiguration) SetSourceRect

func (o *SCScreenshotConfiguration) SetSourceRect(sourceRect corefoundation.CGRect)

func (*SCScreenshotConfiguration) SetWidth

func (o *SCScreenshotConfiguration) SetWidth(width int)

func (*SCScreenshotConfiguration) ShowsCursor

func (o *SCScreenshotConfiguration) ShowsCursor() bool

@abstract SCScreenshotProperty that specifies whether the cursor should appear in the screenshot. By default the cursor is visible.

func (*SCScreenshotConfiguration) SourceRect

@abstract SCScreenshotProperty that specifies that the screenshot only samples a subset of the frame input. If not set, then the entire screenshot will be captured. The rectangle is specified in points in the display’s logical coordinate system.

func (*SCScreenshotConfiguration) Width

func (o *SCScreenshotConfiguration) Width() int

@abstract SCScreenshotProperty for output width as measured in pixels. Default is the width of the content being captured.

type SCScreenshotDisplayIntent

type SCScreenshotDisplayIntent int64
const (
	SCScreenshotDisplayIntentCanonical SCScreenshotDisplayIntent = 0
	SCScreenshotDisplayIntentLocal     SCScreenshotDisplayIntent = 1
)

func (SCScreenshotDisplayIntent) String

func (e SCScreenshotDisplayIntent) String() string

type SCScreenshotDynamicRange

type SCScreenshotDynamicRange int64
const (
	SCScreenshotDynamicRangeSDR       SCScreenshotDynamicRange = 0
	SCScreenshotDynamicRangeHDR       SCScreenshotDynamicRange = 1
	SCScreenshotDynamicRangeSDRAndHDR SCScreenshotDynamicRange = 2
)

func (SCScreenshotDynamicRange) String

func (e SCScreenshotDynamicRange) String() string

type SCScreenshotManager

type SCScreenshotManager struct {
	foundation.NSObject
}

An instance for the capture of single frames from a stream.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/scscreenshotmanager

func SCScreenshotManagerFromID

func SCScreenshotManagerFromID(id objc.ID) *SCScreenshotManager

type SCScreenshotOutput

type SCScreenshotOutput struct {
	foundation.NSObject
}

An object that contains all images requested by the client.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/scscreenshotoutput

func SCScreenshotOutputFromID

func SCScreenshotOutputFromID(id objc.ID) *SCScreenshotOutput

func (*SCScreenshotOutput) FileURL

func (o *SCScreenshotOutput) FileURL() *foundation.NSURL

@abstract SCScreenshotOutput property to specify the location where the image was saved. If a fileURL in the screenshot configuration was not specified, then the fileURL will be nil

func (*SCScreenshotOutput) HdrImage

func (o *SCScreenshotOutput) HdrImage() unsafe.Pointer

@abstract SCScreenshotOutput property that denotes the HDR CGimage. The output CGImage uses the extended sRGB color space.

func (*SCScreenshotOutput) SdrImage

func (o *SCScreenshotOutput) SdrImage() unsafe.Pointer

@abstract SCScreenshotOutput property that denotes the SDR CGimage. The output CGImage uses the same color space as the display

func (*SCScreenshotOutput) SetFileURL

func (o *SCScreenshotOutput) SetFileURL(fileURL *foundation.NSURL)

func (*SCScreenshotOutput) SetHdrImage

func (o *SCScreenshotOutput) SetHdrImage(hdrImage unsafe.Pointer)

func (*SCScreenshotOutput) SetSdrImage

func (o *SCScreenshotOutput) SetSdrImage(sdrImage unsafe.Pointer)

type SCShareableContent

type SCShareableContent struct {
	foundation.NSObject
}

An instance that represents a set of displays, apps, and windows that your app can capture.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/scshareablecontent

func SCShareableContentFromID

func SCShareableContentFromID(id objc.ID) *SCShareableContent

func (*SCShareableContent) Applications

@abstract applications SCShareableContent property that contains all the sharable SCRunningApplications

func (*SCShareableContent) Displays

@abstract displays SCShareableContent property that contains all the sharable SCDisplays

func (*SCShareableContent) Windows

@abstract windows SCShareableContent property that contains all the sharable SCWindows

type SCShareableContentInfo

type SCShareableContentInfo struct {
	foundation.NSObject
}

An instance that provides information for the content in a given stream.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/scshareablecontentinfo

func SCShareableContentInfoForFilter

func SCShareableContentInfoForFilter(filter *SCContentFilter) *SCShareableContentInfo

Retrieves any available sharable content information that matches the provided filter.

func SCShareableContentInfoFromID

func SCShareableContentInfoFromID(id objc.ID) *SCShareableContentInfo

func (*SCShareableContentInfo) ContentRect

func (o *SCShareableContentInfo) ContentRect() corefoundation.CGRect

@abstract Size and location of content in points

func (*SCShareableContentInfo) PointPixelScale

func (o *SCShareableContentInfo) PointPixelScale() float32

@abstract Pixel to points scaling factor

func (*SCShareableContentInfo) Style

@abstract style of stream

type SCShareableContentStyle

type SCShareableContentStyle int64

The style of content presented in a stream.

const (
	// The stream isn’t currently presenting any content.
	SCShareableContentStyleNone SCShareableContentStyle = 0
	// The stream is currently presenting one or more windows.
	SCShareableContentStyleWindow SCShareableContentStyle = 1
	// The stream is currently presenting a complete display.
	SCShareableContentStyleDisplay SCShareableContentStyle = 2
	// The stream is currently presenting one or more applications.
	SCShareableContentStyleApplication SCShareableContentStyle = 3
)

func (SCShareableContentStyle) String

func (e SCShareableContentStyle) String() string

type SCStream

type SCStream struct {
	foundation.NSObject
}

An instance that represents a stream of shareable content.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/scstream

func SCStreamFromID

func SCStreamFromID(id objc.ID) *SCStream

func (*SCStream) AddRecordingOutputError

func (o *SCStream) AddRecordingOutputError(recordingOutput *SCRecordingOutput) (bool, error)

@method addRecordingOutput @abstract Add a SCRecordingOutput to the SCStream. Starts Recording if stream is already capturing, otherwise recording will be started after capture starts. Recording will be written into a file url specified in SCRecordingOutput. Media(Screen/Audio/Microphone) to be recorded will be based on the SCStream configuration. @param recordingOutput an SCRecordingOutput that including configuration of recording, and delegate for recording event. @param error the error pertaining to the add recording output @discussion Returns a BOOL denoting if the add was successful. Currently only support one recordingOutput on a stream. To guarantee the first sample captured in the stream to be written into the recording file, client need to add recordingOutput before startCapture. Delegate for recordingDidStart will be notified in SCRecordingOutput or recordingDidFinishWithError will be notified with an error associated if recording failed to start.

func (*SCStream) AddStreamOutputTypeSampleHandlerQueueError

func (o *SCStream) AddStreamOutputTypeSampleHandlerQueueError(output SCStreamOutput, type_ SCStreamOutputType, sampleHandlerQueue *foundation.NSObject) (bool, error)

Adds a destination that receives the stream output.

func (*SCStream) InitWithFilterConfigurationDelegate

func (o *SCStream) InitWithFilterConfigurationDelegate(contentFilter *SCContentFilter, streamConfig *SCStreamConfiguration, delegate SCStreamDelegate) *SCStream

Creates a stream with a content filter and configuration.

func (*SCStream) RemoveRecordingOutputError

func (o *SCStream) RemoveRecordingOutputError(recordingOutput *SCRecordingOutput) (bool, error)

@method removeRecordingOutput @abstract Remove SCRecordingOutput from the SCStream. Stops Recording if the stream is currently recording. @param recordingOutput an SCRecordingOutput that including configuration of recording, and delegate for recording event. @param error the error pertaining to the remove recording output @discussion Returns a BOOL denoting if the remove was successful. Delegate for recordingDidFinishWithError will be notified in SCRecordingOutput, associate with an error code if recording failed to finish written to the file. If stopCapture is called without removing recordingOutput, recording will be stopped and finish writting into the file. In case client update the stream configuration during recording, recording will be stopped as well.

func (*SCStream) RemoveStreamOutputTypeError

func (o *SCStream) RemoveStreamOutputTypeError(output SCStreamOutput, type_ SCStreamOutputType) (bool, error)

Removes a destination from receiving stream output.

func (*SCStream) StartCaptureWithCompletionHandler

func (o *SCStream) StartCaptureWithCompletionHandler(completionHandler func(unsafe.Pointer))

Starts the stream with a callback to indicate whether it successfully starts.

func (*SCStream) StopCaptureWithCompletionHandler

func (o *SCStream) StopCaptureWithCompletionHandler(completionHandler func(unsafe.Pointer))

Stops the stream.

func (*SCStream) SynchronizationClock

func (o *SCStream) SynchronizationClock() unsafe.Pointer

@abstract Synchronization clock used for media capture.

func (*SCStream) UpdateConfigurationCompletionHandler

func (o *SCStream) UpdateConfigurationCompletionHandler(streamConfig *SCStreamConfiguration, completionHandler func(unsafe.Pointer))

Updates the stream with a new configuration.

func (*SCStream) UpdateContentFilterCompletionHandler

func (o *SCStream) UpdateContentFilterCompletionHandler(contentFilter *SCContentFilter, completionHandler func(unsafe.Pointer))

Updates the stream by applying a new content filter.

type SCStreamConfiguration

type SCStreamConfiguration struct {
	foundation.NSObject
}

An instance that provides the output configuration for a stream.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/scstreamconfiguration

func SCStreamConfigurationFromID

func SCStreamConfigurationFromID(id objc.ID) *SCStreamConfiguration

func SCStreamConfigurationStreamConfigurationWithPreset

func SCStreamConfigurationStreamConfigurationWithPreset(preset SCStreamConfigurationPreset) *SCStreamConfiguration

@method streamConfigurationWithPreset: @abstract Returns an instance of SCStreamConfiguration corresponding to the given preset @param preset The enum identifier for the desired preset @discussion The SCStreamConfiguration of the returned object can be used as a guide for creating and configuring an SCStream. If all the suggested properties are respected in creating the SCStream, the resulting capture result will conform to the criteria implied by the preset.

func (*SCStreamConfiguration) BackgroundColor

func (o *SCStreamConfiguration) BackgroundColor() unsafe.Pointer

@abstract SCStreamProperty for background color. By default the background color is clear.

func (*SCStreamConfiguration) CaptureDynamicRange

func (o *SCStreamConfiguration) CaptureDynamicRange() SCCaptureDynamicRange

@abstract SCStreamProperty client will choose captureDynamicRange between SCCaptureDynamicRangeSDR, SCCaptureDynamicRangeHDRLocalDisplay, SCCaptureDynamicRangeHDRCanonicalDisplay. By default, the stream is capturing with SCCaptureDynamicRangeSDR. HDR capture is only supported with Apple Silicon Mac, setting this property on Intel Mac will have no effect. HDR recording is not support yet, adding a recording output to a stream with SCCaptureDynamicRangeHDR set will fail.

func (*SCStreamConfiguration) CaptureMicrophone

func (o *SCStreamConfiguration) CaptureMicrophone() bool

@abstract SCStreamProperty that specifies whether the microphone audio will be captured. By default microphone is not captured.

func (*SCStreamConfiguration) CaptureResolution

func (o *SCStreamConfiguration) CaptureResolution() SCCaptureResolutionType

@abstract captureResolution Choose between automatic, best, and nominal.

func (*SCStreamConfiguration) CapturesAudio

func (o *SCStreamConfiguration) CapturesAudio() bool

@abstract SCStreamProperty that specifies whether the audio will be captured. By default audio is not captured.

func (*SCStreamConfiguration) CapturesShadowsOnly

func (o *SCStreamConfiguration) CapturesShadowsOnly() bool

@abstract SCStreamProperty to capture only the shadows of windows.

func (*SCStreamConfiguration) ChannelCount

func (o *SCStreamConfiguration) ChannelCount() int

@abstract SCStreamProperty to specify channel count. Default is set to two.

func (*SCStreamConfiguration) ColorMatrix

func (o *SCStreamConfiguration) ColorMatrix() unsafe.Pointer

@abstract SCStreamProperty that specifies the YCbCr matrix applied to the output surface. The value must be one of the strings specified in https://developer.apple.com/documentation/coregraphics/quartz_display_services/display_stream_ycbcr_to_rgb_conversion_matrix_options. Should only be used if your pixel format is 420v or 420f.

func (*SCStreamConfiguration) ColorSpaceName

func (o *SCStreamConfiguration) ColorSpaceName() unsafe.Pointer

@abstract SCStreamProperty that specifies the color space of the output buffer. If not set the output buffer uses the same color space as the display. The value must be one of the strings specified in https://developer.apple.com/documentation/coregraphics/cgcolorspace/color_space_names.

func (*SCStreamConfiguration) DestinationRect

func (o *SCStreamConfiguration) DestinationRect() corefoundation.CGRect

@abstract SCStreamProperty that specifies that the stream outputs the frame data into a subset of the output IOSurface object. For both display streams and independent window streams, if not set, then the entire output surface is used. The rectangle is specified in pixels in the display's coordinate system.

func (*SCStreamConfiguration) ExcludesCurrentProcessAudio

func (o *SCStreamConfiguration) ExcludesCurrentProcessAudio() bool

@abstract SCAudioProperty whether to exclude audio from current process. Default is set to NO.

func (*SCStreamConfiguration) Height

func (o *SCStreamConfiguration) Height() uint

@abstract SCStreamProperty for output height as measured in pixels. Default is set to 1080.

func (*SCStreamConfiguration) IgnoreGlobalClipDisplay

func (o *SCStreamConfiguration) IgnoreGlobalClipDisplay() bool

@abstract SCStreamProperty to ignore framing on windows in the display sharing case (will ignore shadows).

func (*SCStreamConfiguration) IgnoreGlobalClipSingleWindow

func (o *SCStreamConfiguration) IgnoreGlobalClipSingleWindow() bool

@abstract SCStreamProperty to ignore global clipping when on single window share. When set to true, single window captures that are partially off the screen will not be clipped. (will ignore window placement in display context).

func (*SCStreamConfiguration) IgnoreShadowsDisplay

func (o *SCStreamConfiguration) IgnoreShadowsDisplay() bool

@abstract SCStreamProperty to ignore framing on windows in the display sharing case (will ignore shadows).

func (*SCStreamConfiguration) IgnoreShadowsSingleWindow

func (o *SCStreamConfiguration) IgnoreShadowsSingleWindow() bool

@abstract SCStreamProperty to ignore framing on windows in the single window sharing case (will ignore shadows).

func (*SCStreamConfiguration) IncludeChildWindows

func (o *SCStreamConfiguration) IncludeChildWindows() bool

@abstract SCStreamProperty to show the child windows in display bound windows and applications sharing. Child windows are included by default.

func (*SCStreamConfiguration) MicrophoneCaptureDeviceID

func (o *SCStreamConfiguration) MicrophoneCaptureDeviceID() *foundation.NSString

@abstract SCStreamProperty that specifies which microphone device to capture. This deviceID is the uniqueID from AVCaptureDevice for the microphone. System Default Microphone will be used if not specified by client. For Mac Catalyst apps, the System Default Microphone will be captured.

func (*SCStreamConfiguration) MinimumFrameInterval

func (o *SCStreamConfiguration) MinimumFrameInterval() coremedia.CMTime

@abstract SCStreamProperty that specifies the desired minimum time in seconds between frame updates, allowing you to throttle the rate at which updates are received. The default value is 1/60, meaning that updates are coming in at or up to 60fps. Set this to kCMTimeZero to capture at display's native refresh rate.

func (*SCStreamConfiguration) PixelFormat

func (o *SCStreamConfiguration) PixelFormat() uint

@abstract SCStreamProperty for output pixel format. Supported pixel formats are: 'BGRA': Packed Little Endian ARGB8888 'l10r': Packed Little Endian ARGB2101010 '420v': 2-plane "video" range YCbCr 4:2:0 '420f': 2-plane "full" range YCbCr 4:2:0 'xf44': 2 plane "full" range YCbCr10 4:4:4 'RGhA': 64 bit RGBA IEEE half-precision float, 16-bit little-endian See https://developer.apple.com/documentation/coregraphics/1455170-cgdisplaystreamcreate

func (*SCStreamConfiguration) PresenterOverlayPrivacyAlertSetting

func (o *SCStreamConfiguration) PresenterOverlayPrivacyAlertSetting() SCPresenterOverlayAlertSetting

@abstract SCStreamProperty that informs the system if a privacy alert should be shown when using presenter overlay for a stream. Defaults to SCPresenterOverlayAlertSettingSystem;

func (*SCStreamConfiguration) PreservesAspectRatio

func (o *SCStreamConfiguration) PreservesAspectRatio() bool

@abstract SCStreamProperty that specifies whether the stream preserves the aspect ratio of the source pixel data. By default the aspect ratio is preserved.

func (*SCStreamConfiguration) QueueDepth

func (o *SCStreamConfiguration) QueueDepth() int

@abstract SCStreamProperty that specifies the number of frames to keep in the queue. If not set the default value is 8 frames. Specifying more frames uses more memory, but may allow you to process frame data without stalling the display stream and should not exceed 8 frames.

func (*SCStreamConfiguration) SampleRate

func (o *SCStreamConfiguration) SampleRate() int

@abstract SCStreamProperty to specify the sample rate for audio. Default is set to 48000.

func (*SCStreamConfiguration) ScalesToFit

func (o *SCStreamConfiguration) ScalesToFit() bool

@abstract SCStreamProperty for output to be always scaled to fit into the provided width and height. For use for independent window capture. When true, the output scales up and down. When false, the output only scales down.

func (*SCStreamConfiguration) SetBackgroundColor

func (o *SCStreamConfiguration) SetBackgroundColor(backgroundColor unsafe.Pointer)

func (*SCStreamConfiguration) SetCaptureDynamicRange

func (o *SCStreamConfiguration) SetCaptureDynamicRange(captureDynamicRange SCCaptureDynamicRange)

func (*SCStreamConfiguration) SetCaptureMicrophone

func (o *SCStreamConfiguration) SetCaptureMicrophone(captureMicrophone bool)

func (*SCStreamConfiguration) SetCaptureResolution

func (o *SCStreamConfiguration) SetCaptureResolution(captureResolution SCCaptureResolutionType)

func (*SCStreamConfiguration) SetCapturesAudio

func (o *SCStreamConfiguration) SetCapturesAudio(capturesAudio bool)

func (*SCStreamConfiguration) SetCapturesShadowsOnly

func (o *SCStreamConfiguration) SetCapturesShadowsOnly(capturesShadowsOnly bool)

func (*SCStreamConfiguration) SetChannelCount

func (o *SCStreamConfiguration) SetChannelCount(channelCount int)

func (*SCStreamConfiguration) SetColorMatrix

func (o *SCStreamConfiguration) SetColorMatrix(colorMatrix unsafe.Pointer)

func (*SCStreamConfiguration) SetColorSpaceName

func (o *SCStreamConfiguration) SetColorSpaceName(colorSpaceName unsafe.Pointer)

func (*SCStreamConfiguration) SetDestinationRect

func (o *SCStreamConfiguration) SetDestinationRect(destinationRect corefoundation.CGRect)

func (*SCStreamConfiguration) SetExcludesCurrentProcessAudio

func (o *SCStreamConfiguration) SetExcludesCurrentProcessAudio(excludesCurrentProcessAudio bool)

func (*SCStreamConfiguration) SetHeight

func (o *SCStreamConfiguration) SetHeight(height uint)

func (*SCStreamConfiguration) SetIgnoreGlobalClipDisplay

func (o *SCStreamConfiguration) SetIgnoreGlobalClipDisplay(ignoreGlobalClipDisplay bool)

func (*SCStreamConfiguration) SetIgnoreGlobalClipSingleWindow

func (o *SCStreamConfiguration) SetIgnoreGlobalClipSingleWindow(ignoreGlobalClipSingleWindow bool)

func (*SCStreamConfiguration) SetIgnoreShadowsDisplay

func (o *SCStreamConfiguration) SetIgnoreShadowsDisplay(ignoreShadowsDisplay bool)

func (*SCStreamConfiguration) SetIgnoreShadowsSingleWindow

func (o *SCStreamConfiguration) SetIgnoreShadowsSingleWindow(ignoreShadowsSingleWindow bool)

func (*SCStreamConfiguration) SetIncludeChildWindows

func (o *SCStreamConfiguration) SetIncludeChildWindows(includeChildWindows bool)

func (*SCStreamConfiguration) SetMicrophoneCaptureDeviceID

func (o *SCStreamConfiguration) SetMicrophoneCaptureDeviceID(microphoneCaptureDeviceID *foundation.NSString)

func (*SCStreamConfiguration) SetMinimumFrameInterval

func (o *SCStreamConfiguration) SetMinimumFrameInterval(minimumFrameInterval coremedia.CMTime)

func (*SCStreamConfiguration) SetPixelFormat

func (o *SCStreamConfiguration) SetPixelFormat(pixelFormat uint)

func (*SCStreamConfiguration) SetPresenterOverlayPrivacyAlertSetting

func (o *SCStreamConfiguration) SetPresenterOverlayPrivacyAlertSetting(presenterOverlayPrivacyAlertSetting SCPresenterOverlayAlertSetting)

func (*SCStreamConfiguration) SetPreservesAspectRatio

func (o *SCStreamConfiguration) SetPreservesAspectRatio(preservesAspectRatio bool)

func (*SCStreamConfiguration) SetQueueDepth

func (o *SCStreamConfiguration) SetQueueDepth(queueDepth int)

func (*SCStreamConfiguration) SetSampleRate

func (o *SCStreamConfiguration) SetSampleRate(sampleRate int)

func (*SCStreamConfiguration) SetScalesToFit

func (o *SCStreamConfiguration) SetScalesToFit(scalesToFit bool)

func (*SCStreamConfiguration) SetShouldBeOpaque

func (o *SCStreamConfiguration) SetShouldBeOpaque(shouldBeOpaque bool)

func (*SCStreamConfiguration) SetShowMouseClicks

func (o *SCStreamConfiguration) SetShowMouseClicks(showMouseClicks bool)

func (*SCStreamConfiguration) SetShowsCursor

func (o *SCStreamConfiguration) SetShowsCursor(showsCursor bool)

func (*SCStreamConfiguration) SetSourceRect

func (o *SCStreamConfiguration) SetSourceRect(sourceRect corefoundation.CGRect)

func (*SCStreamConfiguration) SetStreamName

func (o *SCStreamConfiguration) SetStreamName(streamName *foundation.NSString)

func (*SCStreamConfiguration) SetWidth

func (o *SCStreamConfiguration) SetWidth(width uint)

func (*SCStreamConfiguration) ShouldBeOpaque

func (o *SCStreamConfiguration) ShouldBeOpaque() bool

@abstract SCStreamProperty to ensure partially transparent areas on windows are backed by a solid white color so that the resulting image is fully opaque.

func (*SCStreamConfiguration) ShowMouseClicks

func (o *SCStreamConfiguration) ShowMouseClicks() bool

@abstract SCStreamProperty that specifies whether to draw a circle around the cursor click, default is NO. This property will not be affected by showsCursor. This property currently applies when pixelFormat is set to BGRA.

func (*SCStreamConfiguration) ShowsCursor

func (o *SCStreamConfiguration) ShowsCursor() bool

@abstract SCStreamProperty that specifies whether the cursor should appear in the stream. By default the cursor is visible.

func (*SCStreamConfiguration) SourceRect

@abstract SCStreamProperty that specifies that the stream only samples a subset of the frame input. For display streams, if not set, then the entire display is streamed. For independent window streams, if not set, then the entire window is streamed. The rectangle is specified in points in the display’s logical coordinate system.

func (*SCStreamConfiguration) StreamName

func (o *SCStreamConfiguration) StreamName() *foundation.NSString

@abstract SCStreamProperty the name of the stream

func (*SCStreamConfiguration) Width

func (o *SCStreamConfiguration) Width() uint

@abstract SCStreamProperty for output width as measured in pixels. Default is set to 1920.

type SCStreamConfigurationPreset

type SCStreamConfigurationPreset int64
const (
	SCStreamConfigurationPresetCaptureHDRStreamLocalDisplay         SCStreamConfigurationPreset = 0
	SCStreamConfigurationPresetCaptureHDRStreamCanonicalDisplay     SCStreamConfigurationPreset = 1
	SCStreamConfigurationPresetCaptureHDRScreenshotLocalDisplay     SCStreamConfigurationPreset = 2
	SCStreamConfigurationPresetCaptureHDRScreenshotCanonicalDisplay SCStreamConfigurationPreset = 3
	SCStreamConfigurationPresetCaptureHDRRecordingPreservedSDRHDR10 SCStreamConfigurationPreset = 4
)

func (SCStreamConfigurationPreset) String

type SCStreamDelegate

type SCStreamDelegate interface {
}

SCStreamDelegate wraps the ObjC protocol SCStreamDelegate.

type SCStreamErrorCode

type SCStreamErrorCode int64

Codes for user cancellation events and errors that can occur in ScreenCaptureKit.

const (
	SCStreamErrorUserDeclined                           SCStreamErrorCode = -3801
	SCStreamErrorFailedToStart                          SCStreamErrorCode = -3802
	SCStreamErrorMissingEntitlements                    SCStreamErrorCode = -3803
	SCStreamErrorFailedApplicationConnectionInvalid     SCStreamErrorCode = -3804
	SCStreamErrorFailedApplicationConnectionInterrupted SCStreamErrorCode = -3805
	SCStreamErrorFailedNoMatchingApplicationContext     SCStreamErrorCode = -3806
	SCStreamErrorAttemptToStartStreamState              SCStreamErrorCode = -3807
	SCStreamErrorAttemptToStopStreamState               SCStreamErrorCode = -3808
	SCStreamErrorAttemptToUpdateFilterState             SCStreamErrorCode = -3809
	SCStreamErrorAttemptToConfigState                   SCStreamErrorCode = -3810
	SCStreamErrorInternalError                          SCStreamErrorCode = -3811
	SCStreamErrorInvalidParameter                       SCStreamErrorCode = -3812
	SCStreamErrorNoWindowList                           SCStreamErrorCode = -3813
	SCStreamErrorNoDisplayList                          SCStreamErrorCode = -3814
	SCStreamErrorNoCaptureSource                        SCStreamErrorCode = -3815
	SCStreamErrorRemovingStream                         SCStreamErrorCode = -3816
	SCStreamErrorUserStopped                            SCStreamErrorCode = -3817
	SCStreamErrorFailedToStartAudioCapture              SCStreamErrorCode = -3818
	SCStreamErrorFailedToStopAudioCapture               SCStreamErrorCode = -3819
	SCStreamErrorFailedToStartMicrophoneCapture         SCStreamErrorCode = -3820
	SCStreamErrorSystemStoppedStream                    SCStreamErrorCode = -3821
)

func (SCStreamErrorCode) String

func (e SCStreamErrorCode) String() string

type SCStreamOutput

type SCStreamOutput interface {
}

SCStreamOutput wraps the ObjC protocol SCStreamOutput.

type SCStreamOutputType

type SCStreamOutputType int64

Constants that represent output types for a stream frame.

const (
	// An output type that represents a screen capture sample buffer.
	SCStreamOutputTypeScreen SCStreamOutputType = 0
	// An output type that represents an audio capture sample buffer.
	SCStreamOutputTypeAudio      SCStreamOutputType = 1
	SCStreamOutputTypeMicrophone SCStreamOutputType = 2
)

func (SCStreamOutputType) String

func (e SCStreamOutputType) String() string

type SCStreamType

type SCStreamType int64

The display type of the presented stream. Deprecated: Use SCShareableContentStyle instead

const (
	// The stream is currently presented as a window.
	SCStreamTypeWindow SCStreamType = 0
	// The stream is currently on a complete display.
	SCStreamTypeDisplay SCStreamType = 1
)

func (SCStreamType) String

func (e SCStreamType) String() string

type SCWindow

type SCWindow struct {
	foundation.NSObject
}

An instance that represents an onscreen window.

Apple documentation: https://developer.apple.com/documentation/screencapturekit/scwindow

func SCWindowFromID

func SCWindowFromID(id objc.ID) *SCWindow

func (*SCWindow) Frame

func (o *SCWindow) Frame() corefoundation.CGRect

@abstract frame the CGRect for the SCWindow

func (*SCWindow) IsActive

func (o *SCWindow) IsActive() bool

@abstract active the bool property denoting of the SCWindow is active. with Stage Manager, SCWindow can be offScreen and active

func (*SCWindow) IsOnScreen

func (o *SCWindow) IsOnScreen() bool

@abstract onScreen the bool property denoting of the SCWindow is on the screen

func (*SCWindow) OwningApplication

func (o *SCWindow) OwningApplication() *SCRunningApplication

@abstract owningApplication is the SCRunningApplication that owns this SCWindow

func (*SCWindow) Title

func (o *SCWindow) Title() *foundation.NSString

@abstract title the window title for the SCWindow

func (*SCWindow) WindowID

func (o *SCWindow) WindowID() uint32

@abstract windowID the CGWindowID for the SCWindow

func (*SCWindow) WindowLayer

func (o *SCWindow) WindowLayer() int

@abstract windowLayer the window layer for the SCWindow

type Virtual_memory_guard_exception_code_t

type Virtual_memory_guard_exception_code_t int64
const (
	KGUARD_EXC_DEALLOC_GAP                   Virtual_memory_guard_exception_code_t = 1
	KGUARD_EXC_RECLAIM_COPYIO_FAILURE        Virtual_memory_guard_exception_code_t = 2
	KGUARD_EXC_RECLAIM_INDEX_FAILURE         Virtual_memory_guard_exception_code_t = 4
	KGUARD_EXC_RECLAIM_DEALLOCATE_FAILURE    Virtual_memory_guard_exception_code_t = 8
	KGUARD_EXC_RECLAIM_ACCOUNTING_FAILURE    Virtual_memory_guard_exception_code_t = 9
	KGUARD_EXC_SEC_IOPL_ON_EXEC_PAGE         Virtual_memory_guard_exception_code_t = 10
	KGUARD_EXC_SEC_EXEC_ON_IOPL_PAGE         Virtual_memory_guard_exception_code_t = 11
	KGUARD_EXC_SEC_UPL_WRITE_ON_EXEC_REGION  Virtual_memory_guard_exception_code_t = 12
	KGUARD_EXC_LARGE_ALLOCATION_TELEMETRY    Virtual_memory_guard_exception_code_t = 13
	KGUARD_EXC_SEC_ACCESS_FAULT              Virtual_memory_guard_exception_code_t = 98
	KGUARD_EXC_SEC_ASYNC_ACCESS_FAULT        Virtual_memory_guard_exception_code_t = 99
	KGUARD_EXC_SEC_COPY_DENIED               Virtual_memory_guard_exception_code_t = 100
	KGUARD_EXC_SEC_SHARING_DENIED            Virtual_memory_guard_exception_code_t = 101
	KGUARD_EXC_MTE_SYNC_FAULT                Virtual_memory_guard_exception_code_t = 200
	KGUARD_EXC_MTE_ASYNC_USER_FAULT          Virtual_memory_guard_exception_code_t = 201
	KGUARD_EXC_MTE_ASYNC_KERN_FAULT          Virtual_memory_guard_exception_code_t = 202
	KGUARD_EXC_GUARD_OBJECT_ASYNC_USER_FAULT Virtual_memory_guard_exception_code_t = 203
	KGUARD_EXC_GUARD_OBJECT_ASYNC_KERN_FAULT Virtual_memory_guard_exception_code_t = 204
)

func (Virtual_memory_guard_exception_code_t) String

type Xpc_listener_create_flags_t

type Xpc_listener_create_flags_t int64
const (
	XPC_LISTENER_CREATE_NONE             Xpc_listener_create_flags_t = 0
	XPC_LISTENER_CREATE_INACTIVE         Xpc_listener_create_flags_t = 1
	XPC_LISTENER_CREATE_FORCE_MACH       Xpc_listener_create_flags_t = 2
	XPC_LISTENER_CREATE_FORCE_XPCSERVICE Xpc_listener_create_flags_t = 4
)

func (Xpc_listener_create_flags_t) String

type Xpc_session_create_flags_t

type Xpc_session_create_flags_t int64
const (
	XPC_SESSION_CREATE_NONE            Xpc_session_create_flags_t = 0
	XPC_SESSION_CREATE_INACTIVE        Xpc_session_create_flags_t = 1
	XPC_SESSION_CREATE_MACH_PRIVILEGED Xpc_session_create_flags_t = 2
)

func (Xpc_session_create_flags_t) String

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL