imagecapturecore

package
v0.19.0 Latest Latest
Warning

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

 Go to latest Published: Aug 11, 2026 License: MIT Imports: 18 Imported by: 0

Documentation

Rendered for darwin/amd64

Overview

Package imagecapturecore provides a fluent Go API over the macOS ImageCaptureCore framework.

Construction

New… functions create objects; each With… method sets one property and returns its receiver, so configuration calls chain. A <Type>FromID constructor adopts an Objective-C object obtained elsewhere.

Lifecycle

A wrapper releases its Objective-C object automatically once the garbage collector finds it unreachable. Call Release to relinquish the reference deterministically (for objects holding scarce resources); Release is idempotent, and afterwards the wrapper's methods are no-ops returning zero values.

Errors

Failing calls return errors carrying the Objective-C error domain and code. Match them against this package's Err… sentinel values with errors.Is, or inspect domain, code, and Apple's prose via errors.As with *errkit.Error.

Delegates

A …Delegate interface is implemented by a plain Go value and installed with the matching With… setter; the package builds the Objective-C delegate object behind the scenes. Optional protocol methods are separate one-method …Handler interfaces — implement the ones you need on the same value and the framework calls them too.

Types

Each base type below lists the concrete types you construct and pass where the base is accepted:

Index

Constants

This section is empty.

Variables

View Source 
var ErrICReturnCodeObjectCouldNotBeRead = errkit.New("ICReturnObjectErrorDomain", -21448)

ErrICReturnCodeObjectCouldNotBeRead matches the ImageCaptureCore error ICReturnCodeObjectCouldNotBeRead.

View Source 
var ErrICReturnCodeObjectDataEmpty = errkit.New("ICReturnObjectErrorDomain", -21447)

ErrICReturnCodeObjectDataEmpty matches the ImageCaptureCore error ICReturnCodeObjectDataEmpty.

View Source 
var ErrICReturnCodeObjectDataOffsetInvalid = errkit.New("ICReturnObjectErrorDomain", -21449)

ErrICReturnCodeObjectDataOffsetInvalid matches the ImageCaptureCore error ICReturnCodeObjectDataOffsetInvalid.

View Source 
var ErrICReturnCodeObjectDataRequestTooLarge = errkit.New("ICReturnObjectErrorDomain", -21446)

ErrICReturnCodeObjectDataRequestTooLarge matches the ImageCaptureCore error ICReturnCodeObjectDataRequestTooLarge.

View Source 
var ErrICReturnCodeObjectDoesNotExist = errkit.New("ICReturnObjectErrorDomain", -21450)

ErrICReturnCodeObjectDoesNotExist matches the ImageCaptureCore error ICReturnCodeObjectDoesNotExist.

View Source 
var ErrICReturnConnectionClosedSessionSuddenly = errkit.New("ICReturnConnectionErrorDomain", -21349)

ErrICReturnConnectionClosedSessionSuddenly matches the ImageCaptureCore error ICReturnConnectionClosedSessionSuddenly.

View Source 
var ErrICReturnConnectionDriverExited = errkit.New("ICReturnConnectionErrorDomain", -21350)

ErrICReturnConnectionDriverExited matches the ImageCaptureCore error ICReturnConnectionDriverExited.

View Source 
var ErrICReturnConnectionEjectFailed = errkit.New("ICReturnConnectionErrorDomain", -21346)

ErrICReturnConnectionEjectFailed matches the ImageCaptureCore error ICReturnConnectionEjectFailed.

View Source 
var ErrICReturnConnectionEjectedSuddenly = errkit.New("ICReturnConnectionErrorDomain", -21348)

ErrICReturnConnectionEjectedSuddenly matches the ImageCaptureCore error ICReturnConnectionEjectedSuddenly.

View Source 
var ErrICReturnConnectionFailedToOpen = errkit.New("ICReturnConnectionErrorDomain", -21345)

ErrICReturnConnectionFailedToOpen matches the ImageCaptureCore error ICReturnConnectionFailedToOpen.

View Source 
var ErrICReturnConnectionFailedToOpenDevice = errkit.New("ICReturnConnectionErrorDomain", -21344)

ErrICReturnConnectionFailedToOpenDevice matches the ImageCaptureCore error ICReturnConnectionFailedToOpenDevice.

View Source 
var ErrICReturnConnectionNotAuthorizedToOpenDevice = errkit.New("ICReturnConnectionErrorDomain", -21343)

ErrICReturnConnectionNotAuthorizedToOpenDevice matches the ImageCaptureCore error ICReturnConnectionNotAuthorizedToOpenDevice.

View Source 
var ErrICReturnConnectionSessionAlreadyOpen = errkit.New("ICReturnConnectionErrorDomain", -21347)

ErrICReturnConnectionSessionAlreadyOpen matches the ImageCaptureCore error ICReturnConnectionSessionAlreadyOpen.

View Source 
var ErrICReturnDownloadFileWritable = errkit.New("ICReturnDownloadErrorDomain", -21099)

ErrICReturnDownloadFileWritable matches the ImageCaptureCore error ICReturnDownloadFileWritable.

View Source 
var ErrICReturnDownloadPathInvalid = errkit.New("ICReturnDownloadErrorDomain", -21100)

ErrICReturnDownloadPathInvalid matches the ImageCaptureCore error ICReturnDownloadPathInvalid.

View Source 
var ErrICReturnMetadataAlreadyFetching = errkit.New("ICReturnMetadataErrorDomain", -20149)

ErrICReturnMetadataAlreadyFetching matches the ImageCaptureCore error ICReturnMetadataAlreadyFetching.

View Source 
var ErrICReturnMetadataCanceled = errkit.New("ICReturnMetadataErrorDomain", -20148)

ErrICReturnMetadataCanceled matches the ImageCaptureCore error ICReturnMetadataCanceled.

View Source 
var ErrICReturnMetadataInvalid = errkit.New("ICReturnMetadataErrorDomain", -20147)

ErrICReturnMetadataInvalid matches the ImageCaptureCore error ICReturnMetadataInvalid.

View Source 
var ErrICReturnMetadataNotAvailable = errkit.New("ICReturnMetadataErrorDomain", -20150)

ErrICReturnMetadataNotAvailable matches the ImageCaptureCore error ICReturnMetadataNotAvailable.

View Source 
var ErrICReturnPTPFailedToSendCommand = errkit.New("ICReturnPTPDeviceErrorDomain", -21250)

ErrICReturnPTPFailedToSendCommand matches the ImageCaptureCore error ICReturnPTPFailedToSendCommand.

View Source 
var ErrICReturnPTPNotAuthorizedToSendCommand = errkit.New("ICReturnPTPDeviceErrorDomain", -21249)

ErrICReturnPTPNotAuthorizedToSendCommand matches the ImageCaptureCore error ICReturnPTPNotAuthorizedToSendCommand.

View Source 
var ErrICReturnThumbnailAlreadyFetching = errkit.New("ICReturnThumbnailErrorDomain", -20999)

ErrICReturnThumbnailAlreadyFetching matches the ImageCaptureCore error ICReturnThumbnailAlreadyFetching.

View Source 
var ErrICReturnThumbnailCanceled = errkit.New("ICReturnThumbnailErrorDomain", -20098)

ErrICReturnThumbnailCanceled matches the ImageCaptureCore error ICReturnThumbnailCanceled.

View Source 
var ErrICReturnThumbnailInvalid = errkit.New("ICReturnThumbnailErrorDomain", -20097)

ErrICReturnThumbnailInvalid matches the ImageCaptureCore error ICReturnThumbnailInvalid.

View Source 
var ErrICReturnThumbnailNotAvailable = errkit.New("ICReturnThumbnailErrorDomain", -21000)

ErrICReturnThumbnailNotAvailable matches the ImageCaptureCore error ICReturnThumbnailNotAvailable.

Functions

func FingerprintForFileAtURL added in v0.17.0 

func FingerprintForFileAtURL(url string) string

FingerprintForFileAtURL generates a fingerprint given a URL date, or nil.

func ICButtonTypeCopy 

func ICButtonTypeCopy() obj.Object

ICButtonTypeCopy returns the string constant ICButtonTypeCopy, for use as a dictionary key or argument.

func ICButtonTypeMail 

func ICButtonTypeMail() obj.Object

ICButtonTypeMail returns the string constant ICButtonTypeMail, for use as a dictionary key or argument.

func ICButtonTypePrint 

func ICButtonTypePrint() obj.Object

ICButtonTypePrint returns the string constant ICButtonTypePrint, for use as a dictionary key or argument.

func ICButtonTypeScan 

func ICButtonTypeScan() obj.Object

ICButtonTypeScan returns the string constant ICButtonTypeScan, for use as a dictionary key or argument.

func ICButtonTypeTransfer 

func ICButtonTypeTransfer() obj.Object

ICButtonTypeTransfer returns the string constant ICButtonTypeTransfer, for use as a dictionary key or argument.

func ICButtonTypeWeb 

func ICButtonTypeWeb() obj.Object

ICButtonTypeWeb returns the string constant ICButtonTypeWeb, for use as a dictionary key or argument.

func ICCameraDeviceCanAcceptPTPCommands 

func ICCameraDeviceCanAcceptPTPCommands() obj.Object

ICCameraDeviceCanAcceptPTPCommands returns the string constant ICCameraDeviceCanAcceptPTPCommands, for use as a dictionary key or argument.

func ICCameraDeviceCanDeleteAllFiles 

func ICCameraDeviceCanDeleteAllFiles() obj.Object

ICCameraDeviceCanDeleteAllFiles returns the string constant ICCameraDeviceCanDeleteAllFiles, for use as a dictionary key or argument.

func ICCameraDeviceCanDeleteOneFile 

func ICCameraDeviceCanDeleteOneFile() obj.Object

ICCameraDeviceCanDeleteOneFile returns the string constant ICCameraDeviceCanDeleteOneFile, for use as a dictionary key or argument.

func ICCameraDeviceCanReceiveFile 

func ICCameraDeviceCanReceiveFile() obj.Object

ICCameraDeviceCanReceiveFile returns the string constant ICCameraDeviceCanReceiveFile, for use as a dictionary key or argument.

func ICCameraDeviceCanSyncClock 

func ICCameraDeviceCanSyncClock() obj.Object

ICCameraDeviceCanSyncClock returns the string constant ICCameraDeviceCanSyncClock, for use as a dictionary key or argument.

func ICCameraDeviceCanTakePicture 

func ICCameraDeviceCanTakePicture() obj.Object

ICCameraDeviceCanTakePicture returns the string constant ICCameraDeviceCanTakePicture, for use as a dictionary key or argument.

func ICCameraDeviceCanTakePictureUsingShutterReleaseOnCamera 

func ICCameraDeviceCanTakePictureUsingShutterReleaseOnCamera() obj.Object

ICCameraDeviceCanTakePictureUsingShutterReleaseOnCamera returns the string constant ICCameraDeviceCanTakePictureUsingShutterReleaseOnCamera, for use as a dictionary key or argument.

func ICCameraDeviceSupportsHEIF 

func ICCameraDeviceSupportsHEIF() obj.Object

ICCameraDeviceSupportsHEIF returns the string constant ICCameraDeviceSupportsHEIF, for use as a dictionary key or argument.

func ICDeleteAfterSuccessfulDownload 

func ICDeleteAfterSuccessfulDownload() obj.Object

ICDeleteAfterSuccessfulDownload returns the string constant ICDeleteAfterSuccessfulDownload, for use as a dictionary key or argument.

func ICDeleteCanceled 

func ICDeleteCanceled() obj.Object

ICDeleteCanceled returns the string constant ICDeleteCanceled, for use as a dictionary key or argument.

func ICDeleteErrorCanceled 

func ICDeleteErrorCanceled() obj.Object

ICDeleteErrorCanceled returns the string constant ICDeleteErrorCanceled, for use as a dictionary key or argument.

func ICDeleteErrorDeviceMissing 

func ICDeleteErrorDeviceMissing() obj.Object

ICDeleteErrorDeviceMissing returns the string constant ICDeleteErrorDeviceMissing, for use as a dictionary key or argument.

func ICDeleteErrorFileMissing 

func ICDeleteErrorFileMissing() obj.Object

ICDeleteErrorFileMissing returns the string constant ICDeleteErrorFileMissing, for use as a dictionary key or argument.

func ICDeleteErrorReadOnly 

func ICDeleteErrorReadOnly() obj.Object

ICDeleteErrorReadOnly returns the string constant ICDeleteErrorReadOnly, for use as a dictionary key or argument.

func ICDeleteFailed 

func ICDeleteFailed() obj.Object

ICDeleteFailed returns the string constant ICDeleteFailed, for use as a dictionary key or argument.

func ICDeleteSuccessful 

func ICDeleteSuccessful() obj.Object

ICDeleteSuccessful returns the string constant ICDeleteSuccessful, for use as a dictionary key or argument.

func ICDeviceCanEjectOrDisconnect 

func ICDeviceCanEjectOrDisconnect() obj.Object

ICDeviceCanEjectOrDisconnect returns the string constant ICDeviceCanEjectOrDisconnect, for use as a dictionary key or argument.

func ICDeviceLocationDescriptionBluetooth 

func ICDeviceLocationDescriptionBluetooth() obj.Object

ICDeviceLocationDescriptionBluetooth returns the string constant ICDeviceLocationDescriptionBluetooth, for use as a dictionary key or argument.

func ICDeviceLocationDescriptionFireWire 

func ICDeviceLocationDescriptionFireWire() obj.Object

ICDeviceLocationDescriptionFireWire returns the string constant ICDeviceLocationDescriptionFireWire, for use as a dictionary key or argument.

func ICDeviceLocationDescriptionMassStorage 

func ICDeviceLocationDescriptionMassStorage() obj.Object

ICDeviceLocationDescriptionMassStorage returns the string constant ICDeviceLocationDescriptionMassStorage, for use as a dictionary key or argument.

func ICDeviceLocationDescriptionUSB 

func ICDeviceLocationDescriptionUSB() obj.Object

ICDeviceLocationDescriptionUSB returns the string constant ICDeviceLocationDescriptionUSB, for use as a dictionary key or argument.

func ICDownloadSidecarFiles 

func ICDownloadSidecarFiles() obj.Object

ICDownloadSidecarFiles returns the string constant ICDownloadSidecarFiles, for use as a dictionary key or argument.

func ICDownloadsDirectoryURL 

func ICDownloadsDirectoryURL() obj.Object

ICDownloadsDirectoryURL returns the string constant ICDownloadsDirectoryURL, for use as a dictionary key or argument.

func ICEnumerationChronologicalOrder 

func ICEnumerationChronologicalOrder() obj.Object

ICEnumerationChronologicalOrder returns the string constant ICEnumerationChronologicalOrder, for use as a dictionary key or argument.

func ICErrorDomain 

func ICErrorDomain() obj.Object

ICErrorDomain returns the string constant ICErrorDomain, for use as a dictionary key or argument.

func ICImageSourceShouldCache 

func ICImageSourceShouldCache() obj.Object

ICImageSourceShouldCache returns the string constant ICImageSourceShouldCache, for use as a dictionary key or argument.

func ICImageSourceThumbnailMaxPixelSize 

func ICImageSourceThumbnailMaxPixelSize() obj.Object

ICImageSourceThumbnailMaxPixelSize returns the string constant ICImageSourceThumbnailMaxPixelSize, for use as a dictionary key or argument.

func ICLocalizedStatusNotificationKey 

func ICLocalizedStatusNotificationKey() obj.Object

ICLocalizedStatusNotificationKey returns the string constant ICLocalizedStatusNotificationKey, for use as a dictionary key or argument.

func ICOverwrite 

func ICOverwrite() obj.Object

ICOverwrite returns the string constant ICOverwrite, for use as a dictionary key or argument.

func ICRunLoopMode 

func ICRunLoopMode() obj.Object

ICRunLoopMode returns the string constant ICRunLoopMode, for use as a dictionary key or argument.

func ICSaveAsFilename 

func ICSaveAsFilename() obj.Object

ICSaveAsFilename returns the string constant ICSaveAsFilename, for use as a dictionary key or argument.

func ICSavedAncillaryFiles 

func ICSavedAncillaryFiles() obj.Object

ICSavedAncillaryFiles returns the string constant ICSavedAncillaryFiles, for use as a dictionary key or argument.

func ICSavedFilename 

func ICSavedFilename() obj.Object

ICSavedFilename returns the string constant ICSavedFilename, for use as a dictionary key or argument.

func ICScannerStatusRequestsOverviewScan 

func ICScannerStatusRequestsOverviewScan() obj.Object

ICScannerStatusRequestsOverviewScan returns the string constant ICScannerStatusRequestsOverviewScan, for use as a dictionary key or argument.

func ICScannerStatusWarmUpDone 

func ICScannerStatusWarmUpDone() obj.Object

ICScannerStatusWarmUpDone returns the string constant ICScannerStatusWarmUpDone, for use as a dictionary key or argument.

func ICScannerStatusWarmingUp 

func ICScannerStatusWarmingUp() obj.Object

ICScannerStatusWarmingUp returns the string constant ICScannerStatusWarmingUp, for use as a dictionary key or argument.

func ICStatusCodeKey 

func ICStatusCodeKey() obj.Object

ICStatusCodeKey returns the string constant ICStatusCodeKey, for use as a dictionary key or argument.

func ICStatusNotificationKey 

func ICStatusNotificationKey() obj.Object

ICStatusNotificationKey returns the string constant ICStatusNotificationKey, for use as a dictionary key or argument.

func ICTransportTypeBluetooth 

func ICTransportTypeBluetooth() obj.Object

ICTransportTypeBluetooth returns the string constant ICTransportTypeBluetooth, for use as a dictionary key or argument.

func ICTransportTypeFireWire 

func ICTransportTypeFireWire() obj.Object

ICTransportTypeFireWire returns the string constant ICTransportTypeFireWire, for use as a dictionary key or argument.

func ICTransportTypeMassStorage 

func ICTransportTypeMassStorage() obj.Object

ICTransportTypeMassStorage returns the string constant ICTransportTypeMassStorage, for use as a dictionary key or argument.

func ICTransportTypeProximity 

func ICTransportTypeProximity() obj.Object

ICTransportTypeProximity returns the string constant ICTransportTypeProximity, for use as a dictionary key or argument.

func ICTransportTypeTCPIP 

func ICTransportTypeTCPIP() obj.Object

ICTransportTypeTCPIP returns the string constant ICTransportTypeTCPIP, for use as a dictionary key or argument.

func ICTransportTypeUSB 

func ICTransportTypeUSB() obj.Object

ICTransportTypeUSB returns the string constant ICTransportTypeUSB, for use as a dictionary key or argument.

func ICTruncateAfterSuccessfulDownload 

func ICTruncateAfterSuccessfulDownload() obj.Object

ICTruncateAfterSuccessfulDownload returns the string constant ICTruncateAfterSuccessfulDownload, for use as a dictionary key or argument.

Types

type CGLCPContextPriorityRequest 

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

func (CGLCPContextPriorityRequest) String 

func (e CGLCPContextPriorityRequest) String() string

String returns the CGLCPContextPriorityRequest constant's name, or its numeric form when the value is not a known constant.

type CameraDevice added in v0.17.0 

type CameraDevice struct {
	Device
}

CameraDevice is an idiomatic wrapper over the Objective-C class ICCameraDevice.

It embeds Device, promoting that type's methods.

An object that represents a camera.

func CameraDeviceFromID added in v0.17.0 

func CameraDeviceFromID(id objc.ID) *CameraDevice

CameraDeviceFromID adopts an existing Objective-C object as a CameraDevice (nil for 0), retaining it and registering a release finalizer.

func NewCameraDevice added in v0.17.0 

func NewCameraDevice() *CameraDevice

NewCameraDevice creates a new CameraDevice.

func (*CameraDevice) BatteryLevel added in v0.17.0 

func (cd *CameraDevice) BatteryLevel() int

BatteryLevel returns Indicates the battery charge level. Its value ranges from 0 to 100.

func (*CameraDevice) BatteryLevelAvailable added in v0.17.0 

func (cd *CameraDevice) BatteryLevelAvailable() bool

BatteryLevelAvailable reports whether indicates if the device has reported battery charge level.

func (*CameraDevice) CancelDelete added in v0.17.0 

func (cd *CameraDevice) CancelDelete()

CancelDelete cancels the current delete operation.

func (*CameraDevice) CancelDownload added in v0.17.0 

func (cd *CameraDevice) CancelDownload()

CancelDownload cancels a download from the camera.

func (*CameraDevice) ContentCatalogPercentCompleted added in v0.17.0 

func (cd *CameraDevice) ContentCatalogPercentCompleted() int

ContentCatalogPercentCompleted returns Indicates the percentage of content cataloging completed on the device. Its value ranges from 0 to 100.

func (*CameraDevice) Contents added in v0.17.0 

func (cd *CameraDevice) Contents() []*CameraItem

Contents returns Contents of the camera. The structure of the elements in this array will reflect the folder structure of the storage reported by the camera. Each item in this array will correspond to a storage on the camera.

Contents returns the collection as a Go slice.

func (*CameraDevice) FilesOfType added in v0.17.0 

func (cd *CameraDevice) FilesOfType(fileUTType string) []string

FilesOfType returns an array of files of the selected type on the camera.

func (*CameraDevice) ICloudPhotosEnabled added in v0.17.0 

func (cd *CameraDevice) ICloudPhotosEnabled() bool

ICloudPhotosEnabled reports whether set to true if the device is made by Apple and is pass-coded locked and connected to an untrusted host.

func (*CameraDevice) IsAccessRestrictedAppleDevice added in v0.17.0 

func (cd *CameraDevice) IsAccessRestrictedAppleDevice() bool

IsAccessRestrictedAppleDevice reports whether set to true if the device is made by Apple and is pass-coded locked and connected to an untrusted host.

func (*CameraDevice) IsEjectable added in v0.17.0 

func (cd *CameraDevice) IsEjectable() bool

IsEjectable reports whether Indicates whether the device can be 'soft' removed or disconnected.

func (*CameraDevice) IsLocked added in v0.17.0 

func (cd *CameraDevice) IsLocked() bool

IsLocked reports whether Indicates whether the device is locked. A locked device does not allow for deletion of any asset.

func (*CameraDevice) MediaFiles added in v0.17.0 

func (cd *CameraDevice) MediaFiles() []*CameraItem

MediaFiles returns The property mediaFiles represents all image, movie and audio files on the camera. These files are returned as a single array without regard to the folder hierarchy used to store these files on the camera.

MediaFiles returns the collection as a Go slice.

func (*CameraDevice) MediaPresentation added in v0.17.0 

func (cd *CameraDevice) MediaPresentation() MediaPresentation

MediaPresentation returns the media presentation describes the visible assets from a device that may contain multiple formats of each media asset. The asigngments are of the type ICMediaPresentation enumeration. This property is available only if the capability ICCameraDeviceSupportsHEIF is present. A device supporting this capability can specify the following presentations: ICMediaPresentationConverted - The default behavior for applications retrieving images from a device supporting HEIF is to show only converted JPG from HEIF originals, and only H264 encoded video assets from HEVC. ICMediaPresentationOriginal - This presentation will show only original images from a device supporting HEIF and HEVC. Burned in renders are always exported in JPG, as are burned in effects for MOV clips.

func (*CameraDevice) MountPoint added in v0.18.0 

func (cd *CameraDevice) MountPoint() unsafe.Pointer

MountPoint returns filesystem mount point for a device with transportType of ICTransportTypeMassStorage. This will be NULL for all other devices.

func (*CameraDevice) RequestDeleteFiles added in v0.17.0 

func (cd *CameraDevice) RequestDeleteFiles(files []*CameraItem)

RequestDeleteFiles deletes files from the camera.

func (*CameraDevice) RequestDeleteFilesDeleteFailedCompletion added in v0.18.0 

func (cd *CameraDevice) RequestDeleteFilesDeleteFailedCompletion(files []*CameraItem, deleteFailed func(obj.Object), completion func(obj.Object, unsafe.Pointer)) *foundation.Progress

RequestDeleteFilesDeleteFailedCompletion deletes files from the camera, with the ability to catch failures and execute a completion block.

func (*CameraDevice) RequestDisableTethering added in v0.17.0 

func (cd *CameraDevice) RequestDisableTethering()

RequestDisableTethering disables tethered capture on the camera.

func (*CameraDevice) RequestEnableTethering added in v0.17.0 

func (cd *CameraDevice) RequestEnableTethering()

RequestEnableTethering enables tethered capture if the camera has the capability to take pictures while connected.

func (*CameraDevice) RequestSendPTPCommandOutDataCompletion added in v0.18.0 

func (cd *CameraDevice) RequestSendPTPCommandOutDataCompletion(ptpCommand []byte, ptpData []byte, completion func(obj.Object, obj.Object, unsafe.Pointer))

RequestSendPTPCommandOutDataCompletion sends a Picture Transfer Protocol (PTP) command to a camera asynchronously.

func (*CameraDevice) RequestSyncClock added in v0.17.0 

func (cd *CameraDevice) RequestSyncClock()

RequestSyncClock synchronizes the camera’s clock with the computer’s clock.

func (*CameraDevice) RequestTakePicture added in v0.17.0 

func (cd *CameraDevice) RequestTakePicture()

RequestTakePicture captures a new image using the camera.

func (*CameraDevice) TetheredCaptureEnabled added in v0.17.0 

func (cd *CameraDevice) TetheredCaptureEnabled() bool

TetheredCaptureEnabled reports whether this property is always set to true when the device has the capability 'ICCameraDeviceCanTakePicture' requestEnableTethering/requestDisableTethering is no longer required to setup and destroy the standard take picture functionality of supported cameras.

func (*CameraDevice) TimeOffset added in v0.17.0 

func (cd *CameraDevice) TimeOffset() float64

TimeOffset indicates the time offset, in seconds, between the camera's clock and the computer's clock. This value is positive if the camera's clock is ahead of the computer's clock. This property should be ignored if the camera's capabilities property does not contain ICCameraDeviceCanSyncClock.

func (*CameraDevice) WithAutolaunchApplicationPath added in v0.17.0 

func (cd *CameraDevice) WithAutolaunchApplicationPath(autolaunchApplicationPath unsafe.Pointer) *CameraDevice

WithAutolaunchApplicationPath sets the file system path of an application to launch automatically when this device is added.

func (*CameraDevice) WithMediaPresentation added in v0.17.0 

func (cd *CameraDevice) WithMediaPresentation(mediaPresentation MediaPresentation) *CameraDevice

WithMediaPresentation sets the media presentation describes the visible assets from a device that may contain multiple formats of each media asset. The asigngments are of the type ICMediaPresentation enumeration. This property is available only if the capability ICCameraDeviceSupportsHEIF is present. A device supporting this capability can specify the following presentations: ICMediaPresentationConverted - The default behavior for applications retrieving images from a device supporting HEIF is to show only converted JPG from HEIF originals, and only H264 encoded video assets from HEVC. ICMediaPresentationOriginal - This presentation will show only original images from a device supporting HEIF and HEVC. Burned in renders are always exported in JPG, as are burned in effects for MOV clips.

func (*CameraDevice) WithPtpEventHandler added in v0.17.0 

func (cd *CameraDevice) WithPtpEventHandler(ptpEventHandler func(obj.Object)) *CameraDevice

WithPtpEventHandler sets a closure for handling PTP event packets.

type CameraDeviceDelegate added in v0.17.0 

type CameraDeviceDelegate interface {
	CameraDeviceDidAddItems(camera *CameraDevice, items []*CameraItem)
	CameraDeviceDidRemoveItems(camera *CameraDevice, items []*CameraItem)
	CameraDeviceDidReceiveThumbnailForItemError(camera *CameraDevice, thumbnail coregraphics.CGImageRef, item *CameraItem, err unsafe.Pointer)
	CameraDeviceDidReceiveMetadataForItemError(camera *CameraDevice, metadata obj.Object, item *CameraItem, err unsafe.Pointer)
	CameraDeviceDidRenameItems(camera *CameraDevice, items []*CameraItem)
	CameraDeviceDidChangeCapability(camera *CameraDevice)
	CameraDeviceDidReceivePTPEvent(camera *CameraDevice, eventData []byte)
	DeviceDidBecomeReadyWithCompleteContentCatalog(device *CameraDevice)
	CameraDeviceDidRemoveAccessRestriction(device *Device)
	CameraDeviceDidEnableAccessRestriction(device *Device)
}

CameraDeviceDelegate is the Go form of the Objective-C protocol ICCameraDeviceDelegate.

type CameraDeviceDownloadDelegate added in v0.17.0 

type CameraDeviceDownloadDelegate interface {
}

CameraDeviceDownloadDelegate receives the callbacks of the Objective-C protocol ICCameraDeviceDownloadDelegate. Pass an implementation to the matching With… setter; the wrapper builds the Objective-C delegate object for you. Every method listed here is required. The protocol's optional methods are separate one-method interfaces (CameraDeviceDownloadDelegate…Handler): implement the ones you need on the same value and the framework will call them too.

type CameraDeviceDownloadDelegateDidReceiveDownloadProgressForFileDownloadedBytesMaxBytesHandler added in v0.17.0 

type CameraDeviceDownloadDelegateDidReceiveDownloadProgressForFileDownloadedBytesMaxBytesHandler interface {
	DidReceiveDownloadProgressForFileDownloadedBytesMaxBytes(file *CameraFile, downloadedBytes int64, maxBytes int64)
}

CameraDeviceDownloadDelegateDidReceiveDownloadProgressForFileDownloadedBytesMaxBytesHandler is the optional ICCameraDeviceDownloadDelegate method didReceiveDownloadProgressForFile:downloadedBytes:maxBytes:. Implement it on a CameraDeviceDownloadDelegate value to receive that callback; a value without it is simply never sent one.

type CameraFile added in v0.17.0 

type CameraFile struct {
	CameraItem
}

CameraFile is an idiomatic wrapper over the Objective-C class ICCameraFile.

It embeds CameraItem, promoting that type's methods.

An object that represents a file on a camera.

func CameraFileFromID added in v0.17.0 

func CameraFileFromID(id objc.ID) *CameraFile

CameraFileFromID adopts an existing Objective-C object as a CameraFile (nil for 0), retaining it and registering a release finalizer.

func NewCameraFile added in v0.17.0 

func NewCameraFile() *CameraFile

NewCameraFile creates a new CameraFile.

func (*CameraFile) BurstFavorite added in v0.17.0 

func (cf *CameraFile) BurstFavorite() bool

BurstFavorite reports whether burst favorite, ignored if not in a burst or not a burst favorite.

func (*CameraFile) BurstPicked added in v0.17.0 

func (cf *CameraFile) BurstPicked() bool

BurstPicked reports whether burst user picked, ignored if not in a burst or not a burst user picked.

func (*CameraFile) BurstUUID added in v0.17.0 

func (cf *CameraFile) BurstUUID() string

BurstUUID returns burstUUID of file if present, nil if not in a burst.

func (*CameraFile) CreatedFilename added in v0.17.0 

func (cf *CameraFile) CreatedFilename() string

CreatedFilename returns created filename

func (*CameraFile) Duration added in v0.17.0 

func (cf *CameraFile) Duration() float64

Duration returns Duration of audio/video file in seconds.

func (*CameraFile) ExifCreationDate added in v0.17.0 

func (cf *CameraFile) ExifCreationDate() time.Time

ExifCreationDate returns properties will either represent the exif creation date, or nil.

func (*CameraFile) ExifModificationDate added in v0.17.0 

func (cf *CameraFile) ExifModificationDate() time.Time

ExifModificationDate returns properties will either represent the exif modification date, or nil.

func (*CameraFile) FileCreationDate added in v0.17.0 

func (cf *CameraFile) FileCreationDate() time.Time

FileCreationDate returns properties will either represent the actual file creation date, or nil.

func (*CameraFile) FileModificationDate added in v0.17.0 

func (cf *CameraFile) FileModificationDate() time.Time

FileModificationDate returns properties will either represent the actual file modification date, or nil.

func (*CameraFile) FileSize added in v0.17.0 

func (cf *CameraFile) FileSize() int64

FileSize returns Size of file in bytes.

func (*CameraFile) Fingerprint added in v0.17.0 

func (cf *CameraFile) Fingerprint() string

Fingerprint returns a fingerprint generated from the camera file data date, or nil.

func (*CameraFile) FirstPicked added in v0.17.0 

func (cf *CameraFile) FirstPicked() bool

FirstPicked reports whether file is a firstPicked nil otherwise.

func (*CameraFile) GpsString added in v0.17.0 

func (cf *CameraFile) GpsString() string

GpsString returns GPS String in standard format.

func (*CameraFile) GroupUUID added in v0.17.0 

func (cf *CameraFile) GroupUUID() string

GroupUUID returns groupUUID of file if present, nil if file has no groupUUID.

func (*CameraFile) Height added in v0.17.0 

func (cf *CameraFile) Height() int

Height returns height of an image or movie frame.

func (*CameraFile) HighFramerate added in v0.17.0 

func (cf *CameraFile) HighFramerate() bool

HighFramerate reports whether file is a slo-mo or high framerate video file, nil otherwise.

func (*CameraFile) Orientation added in v0.17.0 

func (cf *CameraFile) Orientation() EXIFOrientationType

Orientation returns Desired orientation of image to use when it is downloaded. This property is set to ICEXIFOrientation1 initially. If the format of this file supports EXIF orientation tag, then this property will be updated to match the value of that tag, when the thumbnail or metadata for this file is received.

func (*CameraFile) OriginalFilename added in v0.17.0 

func (cf *CameraFile) OriginalFilename() string

OriginalFilename returns original filename on disk

func (*CameraFile) OriginatingAssetID added in v0.17.0 

func (cf *CameraFile) OriginatingAssetID() string

OriginatingAssetID returns originatingAssetID of file if present, nil if not a HEIF or HVEC.

func (*CameraFile) PairedRawImage added in v0.17.0 

func (cf *CameraFile) PairedRawImage() *CameraFile

PairedRawImage returns a single item subset of the sidecarFiles array, which contains the logical RAW compliment of a JPG or other format image.

func (*CameraFile) RelatedUUID added in v0.17.0 

func (cf *CameraFile) RelatedUUID() string

RelatedUUID returns internal related UUID for dbg/aae/etc.

func (*CameraFile) RequestDownloadWithOptionsCompletion added in v0.18.0 

func (cf *CameraFile) RequestDownloadWithOptionsCompletion(options obj.Object, completion func(obj.Object, unsafe.Pointer)) *foundation.Progress

RequestDownloadWithOptionsCompletion requests a download and executes the completion block in place of the delegate.

func (*CameraFile) RequestFingerprintWithCompletion added in v0.17.0 

func (cf *CameraFile) RequestFingerprintWithCompletion(ctx context.Context) (result string, err error)

RequestFingerprintWithCompletion Requests a fingerprint be generated for camera file.

RequestFingerprintWithCompletion blocks until the operation completes or ctx is cancelled.

func (*CameraFile) RequestMetadataDictionaryWithOptionsCompletion added in v0.18.0 

func (cf *CameraFile) RequestMetadataDictionaryWithOptionsCompletion(options obj.Object, completion func(obj.Object, unsafe.Pointer))

RequestMetadataDictionaryWithOptionsCompletion requests metadata and executes the completion block in place of the delegate.

func (*CameraFile) RequestReadDataAtOffsetLengthCompletion added in v0.17.0 

func (cf *CameraFile) RequestReadDataAtOffsetLengthCompletion(ctx context.Context, offset int64, length int64) (result obj.Object, err error)

RequestReadDataAtOffsetLengthCompletion requests to asynchronously read data of a specified length from a specified offset, then executes the completion block.

RequestReadDataAtOffsetLengthCompletion blocks until the operation completes or ctx is cancelled.

func (*CameraFile) RequestSecurityScopedURLWithCompletion added in v0.17.0 

func (cf *CameraFile) RequestSecurityScopedURLWithCompletion(ctx context.Context) (result obj.Object, err error)

RequestSecurityScopedURLWithCompletion Requests a security scoped NSURL* for a media file on a mass storage volume. The returned NSURL* requires the use of startAccessingSecurityScopedResource, and stopAccessingSecurityScopedResource for access.

RequestSecurityScopedURLWithCompletion blocks until the operation completes or ctx is cancelled.

func (*CameraFile) RequestThumbnailDataWithOptionsCompletion added in v0.17.0 

func (cf *CameraFile) RequestThumbnailDataWithOptionsCompletion(ctx context.Context, options obj.Object) (result obj.Object, err error)

RequestThumbnailDataWithOptionsCompletion requests a thumbnail and executes the completion block in place of the delegate.

RequestThumbnailDataWithOptionsCompletion blocks until the operation completes or ctx is cancelled.

func (*CameraFile) SidecarFiles added in v0.17.0 

func (cf *CameraFile) SidecarFiles() []*CameraItem

SidecarFiles returns this property is NULL if there are no sidecar files associated with this file. Otherwise it is an array of ICCameraFile instances of sidecar files associated with this file. An example of a sidecar file is a file with the same base name as this file and having an extension XMP.

SidecarFiles returns the collection as a Go slice.

func (*CameraFile) TimeLapse added in v0.17.0 

func (cf *CameraFile) TimeLapse() bool

TimeLapse reports whether file is a time-lapse video file, nil otherwise.

func (*CameraFile) Width added in v0.17.0 

func (cf *CameraFile) Width() int

Width returns width of an image or movie frame.

func (*CameraFile) WithOrientation added in v0.17.0 

func (cf *CameraFile) WithOrientation(orientation EXIFOrientationType) *CameraFile

WithOrientation sets the orientation to use when downloading the image.

type CameraFolder added in v0.17.0 

type CameraFolder struct {
	CameraItem
}

CameraFolder is an idiomatic wrapper over the Objective-C class ICCameraFolder.

It embeds CameraItem, promoting that type's methods.

An object that represents a folder on a camera.

func CameraFolderFromID added in v0.17.0 

func CameraFolderFromID(id objc.ID) *CameraFolder

CameraFolderFromID adopts an existing Objective-C object as a CameraFolder (nil for 0), retaining it and registering a release finalizer.

func NewCameraFolder added in v0.17.0 

func NewCameraFolder() *CameraFolder

NewCameraFolder creates a new CameraFolder.

func (*CameraFolder) Contents added in v0.17.0 

func (cf *CameraFolder) Contents() []*CameraItem

Contents returns the contents.

Contents returns the collection as a Go slice.

type CameraItem added in v0.17.0 

type CameraItem struct {
	objref.Handle
}

CameraItem is an idiomatic wrapper over the Objective-C class ICCameraItem.

CameraItem is an abstract base — you do not construct it directly. Construct one of CameraFile, CameraFolder and pass it where a CameraItem is accepted.

An abstract class that represents a camera item.

func CameraItemFromID added in v0.17.0 

func CameraItemFromID(id objc.ID) *CameraItem

CameraItemFromID adopts an existing Objective-C object as a CameraItem (nil for 0), retaining it and registering a release finalizer.

func (*CameraItem) CreationDate added in v0.17.0 

func (ci *CameraItem) CreationDate() time.Time

CreationDate returns Creation date of this file. This information is usually the same as the EXIF creation date.

func (*CameraItem) Description added in v0.17.0 

func (ci *CameraItem) Description() string

Description returns the object's -description text.

func (*CameraItem) Device added in v0.17.0 

func (ci *CameraItem) Device() *CameraDevice

Device returns Parent device of this item.

func (*CameraItem) FileSystemPath added in v0.18.0 

func (ci *CameraItem) FileSystemPath() unsafe.Pointer

FileSystemPath returns The file system path of the item for items on a device with transportType of ICTransportTypeMassStorage.

func (*CameraItem) FlushMetadataCache added in v0.17.0 

func (ci *CameraItem) FlushMetadataCache()

FlushMetadataCache deletes the item’s cached metadata.

func (*CameraItem) FlushThumbnailCache added in v0.17.0 

func (ci *CameraItem) FlushThumbnailCache()

FlushThumbnailCache deletes the item’s cached thumbnail.

func (*CameraItem) IsEqual added in v0.17.0 

func (ci *CameraItem) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*CameraItem) IsInTemporaryStore added in v0.17.0 

func (ci *CameraItem) IsInTemporaryStore() bool

IsInTemporaryStore reports whether Indicates if this folder is in a temporary store. A temporary store may be used by the device when images are captures on the device when it is tethered to the computer.

func (*CameraItem) IsKind added in v0.17.0 

func (ci *CameraItem) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*CameraItem) IsLocked added in v0.17.0 

func (ci *CameraItem) IsLocked() bool

IsLocked reports whether Indicates the protection state of this item. It is locked if the storage card in the camera is locked.

func (*CameraItem) IsRaw added in v0.17.0 

func (ci *CameraItem) IsRaw() bool

IsRaw reports whether Indicates if the file is a raw image file.

func (*CameraItem) LargeThumbnailIfAvailable added in v0.17.0 

func (ci *CameraItem) LargeThumbnailIfAvailable() coregraphics.CGImageRef

LargeThumbnailIfAvailable returns the large thumbnail if available.

func (*CameraItem) Metadata added in v0.17.0 

func (ci *CameraItem) Metadata() obj.Object

Metadata returns Metadata for the item. The value of this property is NULL unless a 'requestMetadata' message is sent to this object.

func (*CameraItem) MetadataIfAvailable added in v0.18.0 

func (ci *CameraItem) MetadataIfAvailable() unsafe.Pointer

MetadataIfAvailable returns the metadata if available.

func (*CameraItem) ModificationDate added in v0.17.0 

func (ci *CameraItem) ModificationDate() time.Time

ModificationDate returns Modification date of this file. This information is usually the same as the EXIF modification date.

func (*CameraItem) Name added in v0.17.0 

func (ci *CameraItem) Name() string

Name returns Name of this item.

func (*CameraItem) ParentFolder added in v0.17.0 

func (ci *CameraItem) ParentFolder() *CameraFolder

ParentFolder returns Parent folder of this folder. The root folder's parentFolder is nil.

func (*CameraItem) PtpObjectHandle added in v0.17.0 

func (ci *CameraItem) PtpObjectHandle() int

PtpObjectHandle returns PTP object handle value if the item is on a camera that uses PTP protocol. The value of this property is set to 0 if the camera does not use PTP protocol.

func (*CameraItem) RequestMetadata added in v0.17.0 

func (ci *CameraItem) RequestMetadata()

RequestMetadata requests metadata for the item.

func (*CameraItem) RequestThumbnail added in v0.17.0 

func (ci *CameraItem) RequestThumbnail()

RequestThumbnail requests a thumbnail for the item.

func (*CameraItem) String added in v0.17.0 

func (ci *CameraItem) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*CameraItem) Thumbnail added in v0.17.0 

func (ci *CameraItem) Thumbnail() coregraphics.CGImageRef

Thumbnail returns Thumbnail for the item. The value of this property is NULL unless a 'requestThumbnail' message is sent to this object.

func (*CameraItem) ThumbnailIfAvailable added in v0.17.0 

func (ci *CameraItem) ThumbnailIfAvailable() coregraphics.CGImageRef

ThumbnailIfAvailable returns the thumbnail if available.

func (*CameraItem) UTI added in v0.17.0 

func (ci *CameraItem) UTI() string

UTI returns Item UTI. This is an Uniform Type Identifier string. It is one of: kUTTypeFolder, kUTTypeImage, kUTTypeMovie, kUTTypeAudio, or kUTTypeData.

func (*CameraItem) UserData added in v0.17.0 

func (ci *CameraItem) UserData() obj.Object

UserData returns A mutable dictionary to store arbitrary key-value pairs associated with a camera item object. This can be used by view objects that bind to this object to store "house-keeping" information.

func (*CameraItem) WasAddedAfterContentCatalogCompleted added in v0.17.0 

func (ci *CameraItem) WasAddedAfterContentCatalogCompleted() bool

WasAddedAfterContentCatalogCompleted reports whether this property is set if the file is captured on the device after the device's content is fully enumerated. This does not apply to files added as a result of adding a new store to the device.

type CameraItemProvider added in v0.17.0 

type CameraItemProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

CameraItemProvider is accepted wherever a ICCameraItem (or one of its subclasses) is expected.

type Clockid added in v0.17.0 

type Clockid int32
const (
	ClockidRealtime           Clockid = 0
	ClockidMonotonic          Clockid = 6
	ClockidMonotonicRaw       Clockid = 4
	ClockidMonotonicRawApprox Clockid = 5
	ClockidUptimeRaw          Clockid = 8
	ClockidUptimeRawApprox    Clockid = 9
	ClockidProcessCputimeID   Clockid = 12
	ClockidThreadCputimeID    Clockid = 16
)

func (Clockid) String added in v0.17.0 

func (e Clockid) String() string

String returns the Clockid constant's name, or its numeric form when the value is not a known constant.

type Device added in v0.17.0 

type Device struct {
	objref.Handle
}

Device is an idiomatic wrapper over the Objective-C class ICDevice.

Device is an abstract base — you do not construct it directly. Construct one of CameraDevice, ScannerDevice and pass it where a Device is accepted.

An abstract object that represents a device.

func DeviceFromID added in v0.17.0 

func DeviceFromID(id objc.ID) *Device

DeviceFromID adopts an existing Objective-C object as a Device (nil for 0), retaining it and registering a release finalizer.

func (*Device) AutolaunchApplicationPath added in v0.18.0 

func (d *Device) AutolaunchApplicationPath() unsafe.Pointer

AutolaunchApplicationPath returns Filesystem path of an application that is to be automatically launched when this device is added. This property is unavailable for devices of ICTransportTypeProximity.

func (*Device) Capabilities added in v0.17.0 

func (d *Device) Capabilities() []string

Capabilities returns The capabilities of the device as reported by the device module.

Capabilities returns the collection as a Go slice.

func (*Device) Description added in v0.17.0 

func (d *Device) Description() string

Description returns the object's -description text.

func (*Device) HasOpenSession added in v0.17.0 

func (d *Device) HasOpenSession() bool

HasOpenSession reports whether Indicates whether the device has an open session.

func (*Device) Icon added in v0.17.0 

func (d *Device) Icon() coregraphics.CGImageRef

Icon returns Icon image for the device class. If there is no custom icon present from a device manufacturer, this will be a rendered version of the system symbol for the device class. Using a rendered system symbol instead of the systemSymbolName is discouraged.

func (*Device) IsEqual added in v0.17.0 

func (d *Device) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*Device) IsKind added in v0.17.0 

func (d *Device) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*Device) IsRemote added in v0.17.0 

func (d *Device) IsRemote() bool

IsRemote reports whether Indicates whether the device is a remote device published by Image Capture device sharing facility. Name of the device as reported by the device module or by the device transport when a device module is not in control of this device.

func (*Device) LocationDescription added in v0.18.0 

func (d *Device) LocationDescription() unsafe.Pointer

LocationDescription returns A non-localized location description string for the device. The value returned in one of the location description strings defined above, or location obtained from the Bonjour TXT record of a network device.

func (*Device) ModuleExecutableArchitecture added in v0.17.0 

func (d *Device) ModuleExecutableArchitecture() int

ModuleExecutableArchitecture returns reports the device module servicing the requests executable architecture.

func (*Device) ModulePath added in v0.18.0 

func (d *Device) ModulePath() unsafe.Pointer

ModulePath returns Filesystem path of the device module that is associated with this device. Camera-specific capabilities are defined in ICCameraDevice.h and scanner-specific capabilities are defined in ICScannerDevice.h.

func (*Device) ModuleVersion added in v0.18.0 

func (d *Device) ModuleVersion() unsafe.Pointer

ModuleVersion returns The bundle version of the device module associated with this device.

func (*Device) Name added in v0.17.0 

func (d *Device) Name() string

Name returns Name of the device as reported by the device module or by the device transport when a device module is not in control of this device.

func (*Device) PersistentIDString added in v0.18.0 

func (d *Device) PersistentIDString() unsafe.Pointer

PersistentIDString returns A string representation of the persistent ID of the device.

func (*Device) ProductKind added in v0.17.0 

func (d *Device) ProductKind() string

ProductKind returns Type of the device. Possible values are:

func (*Device) RequestCloseSession added in v0.17.0 

func (d *Device) RequestCloseSession()

RequestCloseSession requests to close an open session on the device.

func (*Device) RequestCloseSessionWithOptionsCompletion added in v0.17.0 

func (d *Device) RequestCloseSessionWithOptionsCompletion(ctx context.Context, options obj.Object) error

RequestCloseSessionWithOptionsCompletion requests to close an open session on the device, then executes the completion handler.

RequestCloseSessionWithOptionsCompletion blocks until the operation completes or ctx is cancelled.

func (*Device) RequestEject added in v0.17.0 

func (d *Device) RequestEject()

RequestEject requests to eject the media if permitted by the device, or to disconnect from a remote device.

func (*Device) RequestEjectOrDisconnect added in v0.17.0 

func (d *Device) RequestEjectOrDisconnect()

RequestEjectOrDisconnect requests to eject the media if permitted by the device, or to disconnect from a remote device.

func (*Device) RequestEjectWithCompletion added in v0.17.0 

func (d *Device) RequestEjectWithCompletion(ctx context.Context) error

RequestEjectWithCompletion requests to eject the media if permitted by the device, or to disconnect from a remote device, then executes the completion handler.

RequestEjectWithCompletion blocks until the operation completes or ctx is cancelled.

func (*Device) RequestOpenSession added in v0.17.0 

func (d *Device) RequestOpenSession()

RequestOpenSession requests to open a session on the device.

func (*Device) RequestOpenSessionWithOptionsCompletion added in v0.17.0 

func (d *Device) RequestOpenSessionWithOptionsCompletion(ctx context.Context, options obj.Object) error

RequestOpenSessionWithOptionsCompletion requests to open a session on the device, then executes the completion handler.

RequestOpenSessionWithOptionsCompletion blocks until the operation completes or ctx is cancelled.

func (*Device) RequestYield added in v0.17.0 

func (d *Device) RequestYield()

RequestYield requests that device module in control of this device yield control.

func (*Device) SerialNumberString added in v0.18.0 

func (d *Device) SerialNumberString() unsafe.Pointer

SerialNumberString returns The serial number of the device. This will be NULL if the device does not provide a serial number.

func (*Device) String added in v0.17.0 

func (d *Device) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*Device) SystemSymbolName added in v0.17.0 

func (d *Device) SystemSymbolName() string

SystemSymbolName returns Standard system symbol used to represent the device class. Using the symbol to render an appropriate device icon will ensure proper scaling for high resolution devices.

func (*Device) TransportType added in v0.17.0 

func (d *Device) TransportType() string

TransportType returns The transport type used by the device. The possible values are: ICTransportTypeUSB or ICTransportTypeMassStorage.

func (*Device) Type added in v0.17.0 

func (d *Device) Type() DeviceType

Type returns The type of the device as defined by ICDeviceType OR'd with its ICDeviceLocationType.

func (*Device) USBLocationID added in v0.17.0 

func (d *Device) USBLocationID() int

USBLocationID returns The USB location of which the device is occupying.

func (*Device) USBProductID added in v0.17.0 

func (d *Device) USBProductID() int

USBProductID returns The USB PID associated with the device attached.

func (*Device) USBVendorID added in v0.17.0 

func (d *Device) USBVendorID() int

USBVendorID returns The USB VID associated with the device attached.

func (*Device) UUIDString added in v0.17.0 

func (d *Device) UUIDString() string

UUIDString returns A string representation of the Universally Unique ID of the device.

func (*Device) UserData added in v0.17.0 

func (d *Device) UserData() obj.Object

UserData returns Client convenience bookkeeping object retained by the framework.

func (*Device) WithAutolaunchApplicationPath added in v0.17.0 

func (d *Device) WithAutolaunchApplicationPath(autolaunchApplicationPath unsafe.Pointer) *Device

WithAutolaunchApplicationPath sets the file system path of an application to launch automatically when this device is added.

type DeviceBrowser added in v0.17.0 

type DeviceBrowser struct {
	objref.Handle
}

DeviceBrowser is an idiomatic wrapper over the Objective-C class ICDeviceBrowser.

An object for finding digital cameras and scanners.

func DeviceBrowserFromID added in v0.17.0 

func DeviceBrowserFromID(id objc.ID) *DeviceBrowser

DeviceBrowserFromID adopts an existing Objective-C object as a DeviceBrowser (nil for 0), retaining it and registering a release finalizer.

func NewDeviceBrowser added in v0.17.0 

func NewDeviceBrowser() *DeviceBrowser

NewDeviceBrowser creates a new DeviceBrowser.

func (*DeviceBrowser) BrowsedDeviceTypeMask added in v0.17.0 

func (db *DeviceBrowser) BrowsedDeviceTypeMask() DeviceTypeMask

BrowsedDeviceTypeMask returns a mask whose set bits indicate the type of device(s) being browsed after the receiver receives the start message. This property can be changed while the browser is browsing for devices. This property can be constructed by OR'd values of ICDeviceTypeMask with values of ICDeviceLocationTypeMask.

func (*DeviceBrowser) Description added in v0.17.0 

func (db *DeviceBrowser) Description() string

Description returns the object's -description text.

func (*DeviceBrowser) Devices added in v0.17.0 

func (db *DeviceBrowser) Devices() []*Device

Devices returns all devices found by the browser. This property will change as devices appear and disappear. This array is empty before the first invocation of the delegate method 'deviceBrowser:didAddDevice:moreComing:'.

Devices returns the collection as a Go slice.

func (*DeviceBrowser) IsBrowsing added in v0.17.0 

func (db *DeviceBrowser) IsBrowsing() bool

IsBrowsing reports whether the device browser is browsing for devices.

func (*DeviceBrowser) IsEqual added in v0.17.0 

func (db *DeviceBrowser) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*DeviceBrowser) IsKind added in v0.17.0 

func (db *DeviceBrowser) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*DeviceBrowser) PreferredDevice added in v0.18.0 

func (db *DeviceBrowser) PreferredDevice() unsafe.Pointer

PreferredDevice returns this property returns a device object that should be selected by the client application when it is launched. If the client application that calls this method is the auto-launch application associated with a device and that device is the last device attached (through USB, FireWire or network), then that device will be the preferred device. The best place to call this method is in the implmentation of the ICDeviceBrowser delegate method "deviceBrowser:didAddDevice:moreComing:", if the "moreComing" parameter passed to the delegate is "NO"; or in the delegate method "deviceBrowserDidEnumerateLocalDevices:".

func (*DeviceBrowser) Start added in v0.17.0 

func (db *DeviceBrowser) Start()

Start tells the delegate to start looking for devices.

func (*DeviceBrowser) Stop added in v0.17.0 

func (db *DeviceBrowser) Stop()

Stop tells the delegate to stop looking for devices.

func (*DeviceBrowser) String added in v0.17.0 

func (db *DeviceBrowser) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*DeviceBrowser) WithBrowsedDeviceTypeMask added in v0.17.0 

func (db *DeviceBrowser) WithBrowsedDeviceTypeMask(browsedDeviceTypeMask DeviceTypeMask) *DeviceBrowser

WithBrowsedDeviceTypeMask sets a mask whose set bits indicate the type of devices being browsed after the delegate receives the start message.

func (*DeviceBrowser) WithDelegate added in v0.17.0 

func (db *DeviceBrowser) WithDelegate(delegate DeviceBrowserDelegate) *DeviceBrowser

WithDelegate sets the object that acts as the delegate of the device browser.

type DeviceBrowserDelegate added in v0.17.0 

type DeviceBrowserDelegate interface {
	// DeviceBrowserDidAddDeviceMoreComing this message is sent to the delegate to inform that a device has been added. If several devices are found during the initial search, then this message is sent once for each device with the value of 'moreComing' set to YES in each message except the last one.
	DeviceBrowserDidAddDeviceMoreComing(browser *DeviceBrowser, device *Device, moreComing bool)
	// DeviceBrowserDidRemoveDeviceMoreGoing this message is sent to the delegate to inform that a device has been removed. If several devices are removed at the same time, then this message is sent once for each device with the value of 'moreGoing' set to YES in each message except the last one.
	DeviceBrowserDidRemoveDeviceMoreGoing(browser *DeviceBrowser, device *Device, moreGoing bool)
}

DeviceBrowserDelegate receives the callbacks of the Objective-C protocol ICDeviceBrowserDelegate. Pass an implementation to the matching With… setter; the wrapper builds the Objective-C delegate object for you. Every method listed here is required. The protocol's optional methods are separate one-method interfaces (DeviceBrowserDelegate…Handler): implement the ones you need on the same value and the framework will call them too.

type DeviceBrowserDelegateDeviceBrowserDeviceDidChangeNameHandler added in v0.17.0 

type DeviceBrowserDelegateDeviceBrowserDeviceDidChangeNameHandler interface {
	DeviceBrowserDeviceDidChangeName(browser *DeviceBrowser, device *Device)
}

DeviceBrowserDelegateDeviceBrowserDeviceDidChangeNameHandler is the optional ICDeviceBrowserDelegate method deviceBrowser:deviceDidChangeName:. Implement it on a DeviceBrowserDelegate value to receive that callback; a value without it is simply never sent one.

type DeviceBrowserDelegateDeviceBrowserDeviceDidChangeSharingStateHandler added in v0.17.0 

type DeviceBrowserDelegateDeviceBrowserDeviceDidChangeSharingStateHandler interface {
	DeviceBrowserDeviceDidChangeSharingState(browser *DeviceBrowser, device *Device)
}

DeviceBrowserDelegateDeviceBrowserDeviceDidChangeSharingStateHandler is the optional ICDeviceBrowserDelegate method deviceBrowser:deviceDidChangeSharingState:. Implement it on a DeviceBrowserDelegate value to receive that callback; a value without it is simply never sent one.

type DeviceBrowserDelegateDeviceBrowserDidEnumerateLocalDevicesHandler added in v0.17.0 

type DeviceBrowserDelegateDeviceBrowserDidEnumerateLocalDevicesHandler interface {
	DeviceBrowserDidEnumerateLocalDevices(browser *DeviceBrowser)
}

DeviceBrowserDelegateDeviceBrowserDidEnumerateLocalDevicesHandler is the optional ICDeviceBrowserDelegate method deviceBrowserDidEnumerateLocalDevices:. Implement it on a DeviceBrowserDelegate value to receive that callback; a value without it is simply never sent one.

type DeviceBrowserDelegateDeviceBrowserRequestsSelectDeviceHandler added in v0.17.0 

type DeviceBrowserDelegateDeviceBrowserRequestsSelectDeviceHandler interface {
	DeviceBrowserRequestsSelectDevice(browser *DeviceBrowser, device *Device)
}

DeviceBrowserDelegateDeviceBrowserRequestsSelectDeviceHandler is the optional ICDeviceBrowserDelegate method deviceBrowser:requestsSelectDevice:. Implement it on a DeviceBrowserDelegate value to receive that callback; a value without it is simply never sent one.

type DeviceDelegate added in v0.17.0 

type DeviceDelegate interface {
}

DeviceDelegate is the Go form of the Objective-C protocol ICDeviceDelegate.

type DeviceLocationType added in v0.17.0 

type DeviceLocationType uint64

The location of the image capture device. 

const (
	// A device that’s directly attached to the Mac through its USB or FireWire port.
	DeviceLocationTypeLocal DeviceLocationType = 256
	// A device that’s shared by other Mac hosts.
	DeviceLocationTypeShared DeviceLocationType = 512
	// A supported Bonjour services device.
	DeviceLocationTypeBonjour DeviceLocationType = 1024
	// A paired Bluetooth device.
	DeviceLocationTypeBluetooth DeviceLocationType = 2048
)

func (DeviceLocationType) String added in v0.17.0 

func (e DeviceLocationType) String() string

String returns the DeviceLocationType constant's name, or its numeric form when the value is not a known constant.

type DeviceLocationTypeMask added in v0.17.0 

type DeviceLocationTypeMask uint64

Masks for detecting different device locations. 

const (
	// A mask for detecting a local device, such as USB or FireWire.
	DeviceLocationTypeMaskLocal DeviceLocationTypeMask = 256
	// A mask for detecting a device shared by another Mac host.
	DeviceLocationTypeMaskShared DeviceLocationTypeMask = 512
	// A mask for detecting a network device that publishes a Bonjour service.
	DeviceLocationTypeMaskBonjour DeviceLocationTypeMask = 1024
	// A mask for detecting a paired Bluetooth device.
	DeviceLocationTypeMaskBluetooth DeviceLocationTypeMask = 2048
	// A mask for detecting a remote device, such as a shared, Bonjour, or Bluetooth device.
	DeviceLocationTypeMaskRemote DeviceLocationTypeMask = 65024
)

func (DeviceLocationTypeMask) String added in v0.17.0 

func (e DeviceLocationTypeMask) String() string

String returns the DeviceLocationTypeMask constant's name, or its numeric form when the value is not a known constant.

type DeviceProvider added in v0.17.0 

type DeviceProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

DeviceProvider is accepted wherever a ICDevice (or one of its subclasses) is expected.

type DeviceType added in v0.17.0 

type DeviceType uint64

The type of image capture device. 

const (
	// The device is a camera.
	DeviceTypeCamera DeviceType = 1
	// The device is a scanner.
	DeviceTypeScanner DeviceType = 2
)

func (DeviceType) String added in v0.17.0 

func (e DeviceType) String() string

String returns the DeviceType constant's name, or its numeric form when the value is not a known constant.

type DeviceTypeMask added in v0.17.0 

type DeviceTypeMask uint64

Masks for detecting different device types. 

const (
	// A mask for detecting a camera.
	DeviceTypeMaskCamera DeviceTypeMask = 1
	// A mask for detecting a scanner.
	DeviceTypeMaskScanner DeviceTypeMask = 2
)

func (DeviceTypeMask) String added in v0.17.0 

func (e DeviceTypeMask) String() string

String returns the DeviceTypeMask constant's name, or its numeric form when the value is not a known constant.

type DispatchAutoreleaseFrequency added in v0.17.0 

type DispatchAutoreleaseFrequency uint64
const (
	DispatchAutoreleaseFrequencyInherit  DispatchAutoreleaseFrequency = 0
	DispatchAutoreleaseFrequencyWorkItem DispatchAutoreleaseFrequency = 1
	DispatchAutoreleaseFrequencyNever    DispatchAutoreleaseFrequency = 2
)

func (DispatchAutoreleaseFrequency) String added in v0.17.0 

func (e DispatchAutoreleaseFrequency) String() string

String returns the DispatchAutoreleaseFrequency constant's name, or its numeric form when the value is not a known constant.

type DispatchBlockFlags added in v0.17.0 

type DispatchBlockFlags uint64

Bitmask — values may be combined with |. 

const (
	DispatchBlockFlagsBarrier         DispatchBlockFlags = 1
	DispatchBlockFlagsDetached        DispatchBlockFlags = 2
	DispatchBlockFlagsAssignCurrent   DispatchBlockFlags = 4
	DispatchBlockFlagsNoQosClass      DispatchBlockFlags = 8
	DispatchBlockFlagsInheritQosClass DispatchBlockFlags = 16
	DispatchBlockFlagsEnforceQosClass DispatchBlockFlags = 32
)

func (DispatchBlockFlags) String added in v0.17.0 

func (e DispatchBlockFlags) String() string

String returns the DispatchBlockFlags constant's name, or its numeric form when the value is not a known constant.

type EXIFOrientationType added in v0.17.0 

type EXIFOrientationType uint64

The file’s orientation type. 

const (
	// Normal
	EXIFOrientation1 EXIFOrientationType = 1
	// Flipped horizontally
	EXIFOrientation2 EXIFOrientationType = 2
	// Rotated 180°
	EXIFOrientation3 EXIFOrientationType = 3
	// Flipped vertically
	EXIFOrientation4 EXIFOrientationType = 4
	// Rotated 90° CCW and flipped vertically
	EXIFOrientation5 EXIFOrientationType = 5
	// Rotated 90° CCW
	EXIFOrientation6 EXIFOrientationType = 6
	// Rotated 90° CW and flipped vertically
	EXIFOrientation7 EXIFOrientationType = 7
	// Rotated 90° CW
	EXIFOrientation8 EXIFOrientationType = 8
)

func (EXIFOrientationType) String added in v0.17.0 

func (e EXIFOrientationType) String() string

String returns the EXIFOrientationType constant's name, or its numeric form when the value is not a known constant.

type EntryID added in v0.17.0 

type EntryID int32
const (
	EntryIDFirstEntry EntryID = 0
	EntryIDNextEntry  EntryID = -1
	EntryIDLastEntry  EntryID = -2
)

func (EntryID) String added in v0.17.0 

func (e EntryID) String() string

String returns the EntryID constant's name, or its numeric form when the value is not a known constant.

type EvCmd 

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

func (EvCmd) String 

func (e EvCmd) String() string

String returns the EvCmd constant's name, or its numeric form when the value is not a known constant.

type FilesecProperty added in v0.17.0 

type FilesecProperty int32
const (
	FilesecPropertyOwner        FilesecProperty = 1
	FilesecPropertyGroup        FilesecProperty = 2
	FilesecPropertyUUID         FilesecProperty = 3
	FilesecPropertyMode         FilesecProperty = 4
	FilesecPropertyACL          FilesecProperty = 5
	FilesecPropertyGrpuuid      FilesecProperty = 6
	FilesecPropertyACLRaw       FilesecProperty = 100
	FilesecPropertyACLAllocsize FilesecProperty = 101
)

func (FilesecProperty) String added in v0.17.0 

func (e FilesecProperty) String() string

String returns the FilesecProperty constant's name, or its numeric form when the value is not a known constant.

type Flag added in v0.17.0 

type Flag int32
const (
	FlagFlagDeferInherit      Flag = 1
	FlagFlagNoInherit         Flag = 131072
	FlagEntryInherited        Flag = 16
	FlagEntryFileInherit      Flag = 32
	FlagEntryDirectoryInherit Flag = 64
	FlagEntryLimitInherit     Flag = 128
	FlagEntryOnlyInherit      Flag = 256
)

func (Flag) String added in v0.17.0 

func (e Flag) String() string

String returns the Flag constant's name, or its numeric form when the value is not a known constant.

type Idtype added in v0.17.0 

type Idtype int32
const (
	IdtypeAll  Idtype = 0
	IdtypePid  Idtype = 1
	IdtypePgid Idtype = 2
)

func (Idtype) String added in v0.17.0 

func (e Idtype) String() string

String returns the Idtype constant's name, or its numeric form when the value is not a known constant.

type IpcInfoObjectType added in v0.17.0 

type IpcInfoObjectType uint32
const (
	IpcInfoObjectTypeNone               IpcInfoObjectType = 0
	IpcInfoObjectTypeThreadControl      IpcInfoObjectType = 1
	IpcInfoObjectTypeTaskControl        IpcInfoObjectType = 2
	IpcInfoObjectTypeHost               IpcInfoObjectType = 3
	IpcInfoObjectTypeHostPriv           IpcInfoObjectType = 4
	IpcInfoObjectTypeProcessor          IpcInfoObjectType = 5
	IpcInfoObjectTypeProcessorSet       IpcInfoObjectType = 6
	IpcInfoObjectTypeProcessorSetName   IpcInfoObjectType = 7
	IpcInfoObjectTypeTimer              IpcInfoObjectType = 8
	IpcInfoObjectTypePortSubstOnce      IpcInfoObjectType = 9
	IpcInfoObjectTypeMig                IpcInfoObjectType = 10
	IpcInfoObjectTypeMemoryObject       IpcInfoObjectType = 11
	IpcInfoObjectTypeXmmPager           IpcInfoObjectType = 12
	IpcInfoObjectTypeXmmKernel          IpcInfoObjectType = 13
	IpcInfoObjectTypeXmmReply           IpcInfoObjectType = 14
	IpcInfoObjectTypeUndReply           IpcInfoObjectType = 15
	IpcInfoObjectTypeHostNotify         IpcInfoObjectType = 16
	IpcInfoObjectTypeHostSecurity       IpcInfoObjectType = 17
	IpcInfoObjectTypeLedger             IpcInfoObjectType = 18
	IpcInfoObjectTypeMainDevice         IpcInfoObjectType = 19
	IpcInfoObjectTypeTaskName           IpcInfoObjectType = 20
	IpcInfoObjectTypeSubsystem          IpcInfoObjectType = 21
	IpcInfoObjectTypeIODoneQueue        IpcInfoObjectType = 22
	IpcInfoObjectTypeSemaphore          IpcInfoObjectType = 23
	IpcInfoObjectTypeLockSet            IpcInfoObjectType = 24
	IpcInfoObjectTypeClock              IpcInfoObjectType = 25
	IpcInfoObjectTypeClockCtrl          IpcInfoObjectType = 26
	IpcInfoObjectTypeIokitIdent         IpcInfoObjectType = 27
	IpcInfoObjectTypeNamedEntry         IpcInfoObjectType = 28
	IpcInfoObjectTypeIokitConnect       IpcInfoObjectType = 29
	IpcInfoObjectTypeIokitObject        IpcInfoObjectType = 30
	IpcInfoObjectTypeUpl                IpcInfoObjectType = 31
	IpcInfoObjectTypeMemObjControl      IpcInfoObjectType = 32
	IpcInfoObjectTypeAuSessionport      IpcInfoObjectType = 33
	IpcInfoObjectTypeFileport           IpcInfoObjectType = 34
	IpcInfoObjectTypeLabelh             IpcInfoObjectType = 35
	IpcInfoObjectTypeTaskResume         IpcInfoObjectType = 36
	IpcInfoObjectTypeVoucher            IpcInfoObjectType = 37
	IpcInfoObjectTypeVoucherAttrControl IpcInfoObjectType = 38
	IpcInfoObjectTypeWorkInterval       IpcInfoObjectType = 39
	IpcInfoObjectTypeUxHandler          IpcInfoObjectType = 40
	IpcInfoObjectTypeUextObject         IpcInfoObjectType = 41
	IpcInfoObjectTypeArcadeReg          IpcInfoObjectType = 42
	IpcInfoObjectTypeEventlink          IpcInfoObjectType = 43
	IpcInfoObjectTypeTaskInspect        IpcInfoObjectType = 44
	IpcInfoObjectTypeTaskRead           IpcInfoObjectType = 45
	IpcInfoObjectTypeThreadInspect      IpcInfoObjectType = 46
	IpcInfoObjectTypeThreadRead         IpcInfoObjectType = 47
	IpcInfoObjectTypeSuidCred           IpcInfoObjectType = 48
	IpcInfoObjectTypeHypervisor         IpcInfoObjectType = 49
	IpcInfoObjectTypeTaskIDToken        IpcInfoObjectType = 50
	IpcInfoObjectTypeTaskFatal          IpcInfoObjectType = 51
	IpcInfoObjectTypeKcdata             IpcInfoObjectType = 52
	IpcInfoObjectTypeExclavesResource   IpcInfoObjectType = 53
	IpcInfoObjectTypeThreadResume       IpcInfoObjectType = 54
	IpcInfoObjectTypeUnknown            IpcInfoObjectType = 4294967295
)

func (IpcInfoObjectType) String added in v0.17.0 

func (e IpcInfoObjectType) String() string

String returns the IpcInfoObjectType constant's name, or its numeric form when the value is not a known constant.

type LaunchDataType added in v0.17.0 

type LaunchDataType int32
const (
	LaunchDataTypeDictionary LaunchDataType = 1
	LaunchDataTypeArray      LaunchDataType = 2
	LaunchDataTypeFd         LaunchDataType = 3
	LaunchDataTypeInteger    LaunchDataType = 4
	LaunchDataTypeReal       LaunchDataType = 5
	LaunchDataTypeBool       LaunchDataType = 6
	LaunchDataTypeString     LaunchDataType = 7
	LaunchDataTypeOpaque     LaunchDataType = 8
	LaunchDataTypeErrno      LaunchDataType = 9
	LaunchDataTypeMachport   LaunchDataType = 10
)

func (LaunchDataType) String added in v0.17.0 

func (e LaunchDataType) String() string

String returns the LaunchDataType constant's name, or its numeric form when the value is not a known constant.

type LegacyReturnCode added in v0.17.0 

type LegacyReturnCode int64
const (
	LegacyReturnCodeCommunicationErr               LegacyReturnCode = -9900
	LegacyReturnCodeDeviceNotFoundErr              LegacyReturnCode = -9901
	LegacyReturnCodeDeviceNotOpenErr               LegacyReturnCode = -9902
	LegacyReturnCodeFileCorruptedErr               LegacyReturnCode = -9903
	LegacyReturnCodeIOPendingErr                   LegacyReturnCode = -9904
	LegacyReturnCodeInvalidObjectErr               LegacyReturnCode = -9905
	LegacyReturnCodeInvalidPropertyErr             LegacyReturnCode = -9906
	LegacyReturnCodeIndexOutOfRangeErr             LegacyReturnCode = -9907
	LegacyReturnCodePropertyTypeNotFoundErr        LegacyReturnCode = -9908
	LegacyReturnCodeCannotYieldDevice              LegacyReturnCode = -9909
	LegacyReturnCodeDataTypeNotFoundErr            LegacyReturnCode = -9910
	LegacyReturnCodeDeviceMemoryAllocationErr      LegacyReturnCode = -9911
	LegacyReturnCodeDeviceInternalErr              LegacyReturnCode = -9912
	LegacyReturnCodeDeviceInvalidParamErr          LegacyReturnCode = -9913
	LegacyReturnCodeDeviceAlreadyOpenErr           LegacyReturnCode = -9914
	LegacyReturnCodeDeviceLocationIDNotFoundErr    LegacyReturnCode = -9915
	LegacyReturnCodeDeviceGUIDNotFoundErr          LegacyReturnCode = -9916
	LegacyReturnCodeDeviceIOServicePathNotFoundErr LegacyReturnCode = -9917
	LegacyReturnCodeDeviceUnsupportedErr           LegacyReturnCode = -9918
	LegacyReturnCodeFrameworkInternalErr           LegacyReturnCode = -9919
	LegacyReturnCodeExtensionInternalErr           LegacyReturnCode = -9920
	LegacyReturnCodeInvalidSessionErr              LegacyReturnCode = -9921
)

func (LegacyReturnCode) String added in v0.17.0 

func (e LegacyReturnCode) String() string

String returns the LegacyReturnCode constant's name, or its numeric form when the value is not a known constant.

type MDLabelDomain 

type MDLabelDomain int32

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

String returns the MDLabelDomain constant's name, or its numeric form when the value is not a known constant.

type MDQueryOptionFlags 

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

func (MDQueryOptionFlags) String 

func (e MDQueryOptionFlags) String() string

String returns the MDQueryOptionFlags constant's name, or its numeric form when the value is not a known constant.

type MDQuerySortOptionFlags 

type MDQuerySortOptionFlags int32
const (
	KMDQueryReverseSortOrderFlag MDQuerySortOptionFlags = 1
)

func (MDQuerySortOptionFlags) String 

func (e MDQuerySortOptionFlags) String() string

String returns the MDQuerySortOptionFlags constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeFlags added in v0.17.0 

type MachVMRangeFlags uint64

Bitmask — values may be combined with |. 

const (
	MachVMRangeFlagsNone MachVMRangeFlags = 0
)

func (MachVMRangeFlags) String added in v0.17.0 

func (e MachVMRangeFlags) String() string

String returns the MachVMRangeFlags constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeFlavor added in v0.17.0 

type MachVMRangeFlavor uint32
const (
	MachVMRangeFlavorInvalid MachVMRangeFlavor = 0
	MachVMRangeFlavorV1      MachVMRangeFlavor = 1
)

func (MachVMRangeFlavor) String added in v0.17.0 

func (e MachVMRangeFlavor) String() string

String returns the MachVMRangeFlavor constant's name, or its numeric form when the value is not a known constant.

type MachVMRangeTag added in v0.17.0 

type MachVMRangeTag uint16
const (
	MachVMRangeTagDefault MachVMRangeTag = 0
	MachVMRangeTagData    MachVMRangeTag = 1
	MachVMRangeTagFixed   MachVMRangeTag = 2
)

func (MachVMRangeTag) String added in v0.17.0 

func (e MachVMRangeTag) String() string

String returns the MachVMRangeTag constant's name, or its numeric form when the value is not a known constant.

type MediaPresentation added in v0.17.0 

type MediaPresentation uint64
const (
	MediaPresentationConvertedAssets MediaPresentation = 1
	MediaPresentationOriginalAssets  MediaPresentation = 2
)

func (MediaPresentation) String added in v0.17.0 

func (e MediaPresentation) String() string

String returns the MediaPresentation constant's name, or its numeric form when the value is not a known constant.

type MpoFlags added in v0.17.0 

type MpoFlags uint32

Bitmask — values may be combined with |. 

const (
	MpoFlagsPort                        MpoFlags = 0
	MpoFlagsServicePort                 MpoFlags = 1024
	MpoFlagsConnectionPort              MpoFlags = 2048
	MpoFlagsReplyPort                   MpoFlags = 4096
	MpoFlagsWeakReplyPort               MpoFlags = 16384
	MpoFlagsNotificationPort            MpoFlags = 17408
	MpoFlagsExceptionPort               MpoFlags = 32768
	MpoFlagsConnectionPortWithPortArray MpoFlags = 65536
)

func (MpoFlags) String added in v0.17.0 

func (e MpoFlags) String() string

String returns the MpoFlags constant's name, or its numeric form when the value is not a known constant.

type NXMouseButton 

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

func (NXMouseButton) String 

func (e NXMouseButton) String() string

String returns the NXMouseButton constant's name, or its numeric form when the value is not a known constant.

type OSClockid added in v0.17.0 

type OSClockid uint32
const (
	OSClockidTime OSClockid = 32
)

func (OSClockid) String added in v0.17.0 

func (e OSClockid) String() string

String returns the OSClockid constant's name, or its numeric form when the value is not a known constant.

type OSUnfairLockFlags added in v0.17.0 

type OSUnfairLockFlags uint32

Bitmask — values may be combined with |. 

const (
	OSUnfairLockFlagsNone         OSUnfairLockFlags = 0
	OSUnfairLockFlagsAdaptiveSpin OSUnfairLockFlags = 262144
)

func (OSUnfairLockFlags) String added in v0.17.0 

func (e OSUnfairLockFlags) String() string

String returns the OSUnfairLockFlags constant's name, or its numeric form when the value is not a known constant.

type PMPageToPaperMappingType 

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

func (PMPageToPaperMappingType) String 

func (e PMPageToPaperMappingType) String() string

String returns the PMPageToPaperMappingType constant's name, or its numeric form when the value is not a known constant.

type Perm added in v0.17.0 

type Perm int32
const (
	PermReadData           Perm = 2
	PermListDirectory      Perm = 2
	PermWriteData          Perm = 4
	PermAddFile            Perm = 4
	PermExecute            Perm = 8
	PermSearch             Perm = 8
	PermDelete             Perm = 16
	PermAppendData         Perm = 32
	PermAddSubdirectory    Perm = 32
	PermDeleteChild        Perm = 64
	PermReadAttributes     Perm = 128
	PermWriteAttributes    Perm = 256
	PermReadExtattributes  Perm = 512
	PermWriteExtattributes Perm = 1024
	PermReadSecurity       Perm = 2048
	PermWriteSecurity      Perm = 4096
	PermChangeOwner        Perm = 8192
	PermSynchronize        Perm = 1048576
)

func (Perm) String added in v0.17.0 

func (e Perm) String() string

String returns the Perm constant's name, or its numeric form when the value is not a known constant.

type PtrauthKey added in v0.17.0 

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

func (PtrauthKey) String added in v0.17.0 

func (e PtrauthKey) String() string

String returns the PtrauthKey constant's name, or its numeric form when the value is not a known constant.

type QosClass added in v0.17.0 

type QosClass uint32
const (
	QosClassUserInteractive QosClass = 33
	QosClassUserInitiated   QosClass = 25
	QosClassDefault         QosClass = 21
	QosClassUtility         QosClass = 17
	QosClassBackground      QosClass = 9
	QosClassUnspecified     QosClass = 0
)

func (QosClass) String added in v0.17.0 

func (e QosClass) String() string

String returns the QosClass constant's name, or its numeric form when the value is not a known constant.

type ReturnCode added in v0.17.0 

type ReturnCode int64
const (
	ReturnSuccess                              ReturnCode = 0
	ReturnInvalidParam                         ReturnCode = -9922
	ReturnCommunicationTimedOut                ReturnCode = -9923
	ReturnScanOperationCanceled                ReturnCode = -9924
	ReturnScannerInUseByLocalUser              ReturnCode = -9925
	ReturnScannerInUseByRemoteUser             ReturnCode = -9926
	ReturnDeviceFailedToOpenSession            ReturnCode = -9927
	ReturnDeviceFailedToCloseSession           ReturnCode = -9928
	ReturnScannerFailedToSelectFunctionalUnit  ReturnCode = -9929
	ReturnScannerFailedToCompleteOverviewScan  ReturnCode = -9930
	ReturnScannerFailedToCompleteScan          ReturnCode = -9931
	ReturnReceivedUnsolicitedScannerStatusInfo ReturnCode = -9932
	ReturnReceivedUnsolicitedScannerErrorInfo  ReturnCode = -9933
	ReturnDownloadFailed                       ReturnCode = -9934
	ReturnUploadFailed                         ReturnCode = -9935
	ReturnFailedToCompletePassThroughCommand   ReturnCode = -9936
	ReturnDownloadCanceled                     ReturnCode = -9937
	ReturnFailedToEnabeTethering               ReturnCode = -9938
	ReturnFailedToDisabeTethering              ReturnCode = -9939
	ReturnFailedToCompleteSendMessageRequest   ReturnCode = -9940
	ReturnDeleteFilesFailed                    ReturnCode = -9941
	ReturnDeleteFilesCanceled                  ReturnCode = -9942
	ReturnDeviceIsPasscodeLocked               ReturnCode = -9943
	ReturnDeviceFailedToTakePicture            ReturnCode = -9944
	ReturnDeviceSoftwareNotInstalled           ReturnCode = -9945
	ReturnDeviceSoftwareIsBeingInstalled       ReturnCode = -9946
	ReturnDeviceSoftwareInstallationCompleted  ReturnCode = -9947
	ReturnDeviceSoftwareInstallationCanceled   ReturnCode = -9948
	ReturnDeviceSoftwareInstallationFailed     ReturnCode = -9949
	ReturnDeviceSoftwareNotAvailable           ReturnCode = -9950
	ReturnDeviceCouldNotPair                   ReturnCode = -9951
	ReturnDeviceCouldNotUnpair                 ReturnCode = -9952
	ReturnDeviceNeedsCredentials               ReturnCode = -9953
	ReturnDeviceIsBusyEnumerating              ReturnCode = -9954
	ReturnDeviceCommandGeneralFailure          ReturnCode = -9955
	ReturnDeviceFailedToCompleteTransfer       ReturnCode = -9956
	ReturnDeviceFailedToSendData               ReturnCode = -9957
	ReturnSessionNotOpened                     ReturnCode = -9958
	ReturnExFATVolumeInvalid                   ReturnCode = 21200
	ReturnMultiErrorDictionary                 ReturnCode = -30000
)

func (ReturnCode) String added in v0.17.0 

func (e ReturnCode) String() string

String returns the ReturnCode constant's name, or its numeric form when the value is not a known constant.

type ReturnCodeOffset added in v0.17.0 

type ReturnCodeOffset int64
const (
	ReturnCodeThumbnailOffset  ReturnCodeOffset = -21000
	ReturnCodeMetadataOffset   ReturnCodeOffset = -21050
	ReturnCodeDownloadOffset   ReturnCodeOffset = -21100
	ReturnCodeDeleteOffset     ReturnCodeOffset = -21150
	ReturnCodeExFATOffset      ReturnCodeOffset = -21200
	ReturnCodePTPOffset        ReturnCodeOffset = -21250
	ReturnCodeSystemOffset     ReturnCodeOffset = -21300
	ReturnCodeDeviceOffset     ReturnCodeOffset = -21350
	ReturnCodeDeviceConnection ReturnCodeOffset = -21400
	ReturnCodeObjectOffset     ReturnCodeOffset = -21450
)

func (ReturnCodeOffset) String added in v0.17.0 

func (e ReturnCodeOffset) String() string

String returns the ReturnCodeOffset constant's name, or its numeric form when the value is not a known constant.

type ReturnConnectionErrorCode added in v0.17.0 

type ReturnConnectionErrorCode int64
const (
	ReturnConnectionDriverExited              ReturnConnectionErrorCode = -21350
	ReturnConnectionClosedSessionSuddenly     ReturnConnectionErrorCode = -21349
	ReturnConnectionEjectedSuddenly           ReturnConnectionErrorCode = -21348
	ReturnConnectionSessionAlreadyOpen        ReturnConnectionErrorCode = -21347
	ReturnConnectionEjectFailed               ReturnConnectionErrorCode = -21346
	ReturnConnectionFailedToOpen              ReturnConnectionErrorCode = -21345
	ReturnConnectionFailedToOpenDevice        ReturnConnectionErrorCode = -21344
	ReturnConnectionNotAuthorizedToOpenDevice ReturnConnectionErrorCode = -21343
)

func (ReturnConnectionErrorCode) String added in v0.17.0 

func (e ReturnConnectionErrorCode) String() string

String returns the ReturnConnectionErrorCode constant's name, or its numeric form when the value is not a known constant.

type ReturnDownloadErrorCode added in v0.17.0 

type ReturnDownloadErrorCode int64
const (
	ReturnDownloadPathInvalid  ReturnDownloadErrorCode = -21100
	ReturnDownloadFileWritable ReturnDownloadErrorCode = -21099
)

func (ReturnDownloadErrorCode) String added in v0.17.0 

func (e ReturnDownloadErrorCode) String() string

String returns the ReturnDownloadErrorCode constant's name, or its numeric form when the value is not a known constant.

type ReturnMetadataErrorCode added in v0.17.0 

type ReturnMetadataErrorCode int64
const (
	ReturnMetadataNotAvailable    ReturnMetadataErrorCode = -20150
	ReturnMetadataAlreadyFetching ReturnMetadataErrorCode = -20149
	ReturnMetadataCanceled        ReturnMetadataErrorCode = -20148
	ReturnMetadataInvalid         ReturnMetadataErrorCode = -20147
)

func (ReturnMetadataErrorCode) String added in v0.17.0 

func (e ReturnMetadataErrorCode) String() string

String returns the ReturnMetadataErrorCode constant's name, or its numeric form when the value is not a known constant.

type ReturnObjectErrorCode added in v0.17.0 

type ReturnObjectErrorCode int64
const (
	ReturnCodeObjectDoesNotExist        ReturnObjectErrorCode = -21450
	ReturnCodeObjectDataOffsetInvalid   ReturnObjectErrorCode = -21449
	ReturnCodeObjectCouldNotBeRead      ReturnObjectErrorCode = -21448
	ReturnCodeObjectDataEmpty           ReturnObjectErrorCode = -21447
	ReturnCodeObjectDataRequestTooLarge ReturnObjectErrorCode = -21446
)

func (ReturnObjectErrorCode) String added in v0.17.0 

func (e ReturnObjectErrorCode) String() string

String returns the ReturnObjectErrorCode constant's name, or its numeric form when the value is not a known constant.

type ReturnPTPDeviceErrorCode added in v0.17.0 

type ReturnPTPDeviceErrorCode int64
const (
	ReturnPTPFailedToSendCommand        ReturnPTPDeviceErrorCode = -21250
	ReturnPTPNotAuthorizedToSendCommand ReturnPTPDeviceErrorCode = -21249
)

func (ReturnPTPDeviceErrorCode) String added in v0.17.0 

func (e ReturnPTPDeviceErrorCode) String() string

String returns the ReturnPTPDeviceErrorCode constant's name, or its numeric form when the value is not a known constant.

type ReturnThumbnailErrorCode added in v0.17.0 

type ReturnThumbnailErrorCode int64
const (
	ReturnThumbnailNotAvailable    ReturnThumbnailErrorCode = -21000
	ReturnThumbnailAlreadyFetching ReturnThumbnailErrorCode = -20999
	ReturnThumbnailCanceled        ReturnThumbnailErrorCode = -20098
	ReturnThumbnailInvalid         ReturnThumbnailErrorCode = -20097
)

func (ReturnThumbnailErrorCode) String added in v0.17.0 

func (e ReturnThumbnailErrorCode) String() string

String returns the ReturnThumbnailErrorCode constant's name, or its numeric form when the value is not a known constant.

type ScannerBandData added in v0.17.0 

type ScannerBandData struct {
	objref.Handle
}

ScannerBandData is an idiomatic wrapper over the Objective-C class ICScannerBandData.

The options for each band of data that the scanner reads.

func NewScannerBandData added in v0.17.0 

func NewScannerBandData() *ScannerBandData

NewScannerBandData creates a new ScannerBandData.

func ScannerBandDataFromID added in v0.17.0 

func ScannerBandDataFromID(id objc.ID) *ScannerBandData

ScannerBandDataFromID adopts an existing Objective-C object as a ScannerBandData (nil for 0), retaining it and registering a release finalizer.

func (*ScannerBandData) BitsPerComponent added in v0.17.0 

func (sbd *ScannerBandData) BitsPerComponent() int

BitsPerComponent describes the number of bits per component for the banded image.

func (*ScannerBandData) BitsPerPixel added in v0.17.0 

func (sbd *ScannerBandData) BitsPerPixel() int

BitsPerPixel describes the number of bits per pixel for banded the image.

func (*ScannerBandData) BytesPerRow added in v0.17.0 

func (sbd *ScannerBandData) BytesPerRow() int

BytesPerRow returns descries how many bytes are in each image band row.

func (*ScannerBandData) ColorSyncProfilePath added in v0.18.0 

func (sbd *ScannerBandData) ColorSyncProfilePath() unsafe.Pointer

ColorSyncProfilePath returns the path to the color profile matching the banded data.

func (*ScannerBandData) DataBuffer added in v0.18.0 

func (sbd *ScannerBandData) DataBuffer() unsafe.Pointer

DataBuffer returns the pointer to the data buffer object.

func (*ScannerBandData) DataNumRows added in v0.17.0 

func (sbd *ScannerBandData) DataNumRows() int

DataNumRows describes the number of rows contained in the image band.

func (*ScannerBandData) DataSize added in v0.17.0 

func (sbd *ScannerBandData) DataSize() int

DataSize describes the actual data size of the image band buffer.

func (*ScannerBandData) DataStartRow added in v0.17.0 

func (sbd *ScannerBandData) DataStartRow() int

DataStartRow describes the start row of the image band.

func (*ScannerBandData) Description added in v0.17.0 

func (sbd *ScannerBandData) Description() string

Description returns the object's -description text.

func (*ScannerBandData) FullImageHeight added in v0.17.0 

func (sbd *ScannerBandData) FullImageHeight() int

FullImageHeight describes the full image height of the banded image.

func (*ScannerBandData) FullImageWidth added in v0.17.0 

func (sbd *ScannerBandData) FullImageWidth() int

FullImageWidth describes the full image width of the banded image.

func (*ScannerBandData) IsBigEndian added in v0.17.0 

func (sbd *ScannerBandData) IsBigEndian() bool

IsBigEndian reports whether describes if the banded image data is reported in big endian.

func (*ScannerBandData) IsEqual added in v0.17.0 

func (sbd *ScannerBandData) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*ScannerBandData) IsKind added in v0.17.0 

func (sbd *ScannerBandData) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*ScannerBandData) NumComponents added in v0.17.0 

func (sbd *ScannerBandData) NumComponents() int

NumComponents describes how many components are contained within the banded image.

func (*ScannerBandData) PixelDataType added in v0.17.0 

func (sbd *ScannerBandData) PixelDataType() ScannerPixelDataType

PixelDataType returns type of pixel data that is contained in the band.

func (*ScannerBandData) String added in v0.17.0 

func (sbd *ScannerBandData) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

type ScannerBitDepth added in v0.17.0 

type ScannerBitDepth uint64

The number of bits per channel in the scanned image. 

const (
	ScannerBitDepth1Bit   ScannerBitDepth = 1
	ScannerBitDepth8Bits  ScannerBitDepth = 8
	ScannerBitDepth16Bits ScannerBitDepth = 16
)

func (ScannerBitDepth) String added in v0.17.0 

func (e ScannerBitDepth) String() string

String returns the ScannerBitDepth constant's name, or its numeric form when the value is not a known constant.

type ScannerColorDataFormatType added in v0.17.0 

type ScannerColorDataFormatType uint64

The color data formats relevant to multichannel data. 

const (
	ScannerColorDataFormatTypeChunky ScannerColorDataFormatType = 0
	ScannerColorDataFormatTypePlanar ScannerColorDataFormatType = 1
)

func (ScannerColorDataFormatType) String added in v0.17.0 

func (e ScannerColorDataFormatType) String() string

String returns the ScannerColorDataFormatType constant's name, or its numeric form when the value is not a known constant.

type ScannerDevice added in v0.17.0 

type ScannerDevice struct {
	Device
}

ScannerDevice is an idiomatic wrapper over the Objective-C class ICScannerDevice.

It embeds Device, promoting that type's methods.

An object that represents a scanner.

func NewScannerDevice added in v0.17.0 

func NewScannerDevice() *ScannerDevice

NewScannerDevice creates a new ScannerDevice.

func ScannerDeviceFromID added in v0.17.0 

func ScannerDeviceFromID(id objc.ID) *ScannerDevice

ScannerDeviceFromID adopts an existing Objective-C object as a ScannerDevice (nil for 0), retaining it and registering a release finalizer.

func (*ScannerDevice) AvailableFunctionalUnitTypes added in v0.18.0 

func (sd *ScannerDevice) AvailableFunctionalUnitTypes() unsafe.Pointer

AvailableFunctionalUnitTypes returns An array of functional unit types available on this scanner device. This is an array of NSNumber objects whose values are of type ICScannerFunctionalUnitType.

func (*ScannerDevice) CancelScan added in v0.17.0 

func (sd *ScannerDevice) CancelScan()

CancelScan cancels the current scan.

func (*ScannerDevice) DefaultUsername added in v0.18.0 

func (sd *ScannerDevice) DefaultUsername() unsafe.Pointer

DefaultUsername returns if the device is protected, instead of prompting the user for a username, this property can be set to default to a specific username as a convience. The value will persist until reset by setting it to nil.

func (*ScannerDevice) DocumentName added in v0.18.0 

func (sd *ScannerDevice) DocumentName() unsafe.Pointer

DocumentName returns The document name.

func (*ScannerDevice) DocumentUTI added in v0.18.0 

func (sd *ScannerDevice) DocumentUTI() unsafe.Pointer

DocumentUTI returns The document UTI. Currently supported UTIs are: kUTTypeJPEG, kUTTypeJPEG2000, kUTTypeTIFF, kUTTypePNG etc.

func (*ScannerDevice) DownloadsDirectory added in v0.18.0 

func (sd *ScannerDevice) DownloadsDirectory() unsafe.Pointer

DownloadsDirectory returns The downloads directory.

func (*ScannerDevice) MaxMemoryBandSize added in v0.17.0 

func (sd *ScannerDevice) MaxMemoryBandSize() int

MaxMemoryBandSize returns The total maximum band size requested when performing a ICScannerTransferModeMemoryBased.

func (*ScannerDevice) RequestOpenSessionWithCredentialsPassword added in v0.17.0 

func (sd *ScannerDevice) RequestOpenSessionWithCredentialsPassword(username string, password string)

RequestOpenSessionWithCredentialsPassword opens a session on the protected device with the authorized username and passcode.

func (*ScannerDevice) RequestOverviewScan added in v0.17.0 

func (sd *ScannerDevice) RequestOverviewScan()

RequestOverviewScan starts an overview scan on the selected functional unit.

func (*ScannerDevice) RequestScan added in v0.17.0 

func (sd *ScannerDevice) RequestScan()

RequestScan starts a scan on the selected functional unit.

func (*ScannerDevice) RequestSelectFunctionalUnit added in v0.17.0 

func (sd *ScannerDevice) RequestSelectFunctionalUnit(type_ ScannerFunctionalUnitType)

RequestSelectFunctionalUnit requests to select a functional unit on the scanner.

func (*ScannerDevice) SelectedFunctionalUnit added in v0.18.0 

func (sd *ScannerDevice) SelectedFunctionalUnit() unsafe.Pointer

SelectedFunctionalUnit returns The currently selected functional unit on the scanner device.

func (*ScannerDevice) TransferMode added in v0.17.0 

func (sd *ScannerDevice) TransferMode() ScannerTransferMode

TransferMode returns The transfer mode for scanned document.

func (*ScannerDevice) WithAutolaunchApplicationPath added in v0.17.0 

func (sd *ScannerDevice) WithAutolaunchApplicationPath(autolaunchApplicationPath unsafe.Pointer) *ScannerDevice

WithAutolaunchApplicationPath sets the file system path of an application to launch automatically when this device is added.

func (*ScannerDevice) WithDefaultUsername added in v0.17.0 

func (sd *ScannerDevice) WithDefaultUsername(defaultUsername unsafe.Pointer) *ScannerDevice

WithDefaultUsername sets a default username on protected scanners.

func (*ScannerDevice) WithDocumentName added in v0.17.0 

func (sd *ScannerDevice) WithDocumentName(documentName unsafe.Pointer) *ScannerDevice

WithDocumentName sets the document’s name.

func (*ScannerDevice) WithDocumentUTI added in v0.17.0 

func (sd *ScannerDevice) WithDocumentUTI(documentUTI unsafe.Pointer) *ScannerDevice

WithDocumentUTI sets the document’s uniform type identifier.

func (*ScannerDevice) WithDownloadsDirectory added in v0.17.0 

func (sd *ScannerDevice) WithDownloadsDirectory(downloadsDirectory unsafe.Pointer) *ScannerDevice

WithDownloadsDirectory sets the downloads directory.

func (*ScannerDevice) WithMaxMemoryBandSize added in v0.17.0 

func (sd *ScannerDevice) WithMaxMemoryBandSize(maxMemoryBandSize int) *ScannerDevice

WithMaxMemoryBandSize sets the total maximum band size requested when performing a memory-based transfer.

func (*ScannerDevice) WithTransferMode added in v0.17.0 

func (sd *ScannerDevice) WithTransferMode(transferMode ScannerTransferMode) *ScannerDevice

WithTransferMode sets the transfer mode for the scanned document.

type ScannerDeviceDelegate added in v0.17.0 

type ScannerDeviceDelegate interface {
}

ScannerDeviceDelegate receives the callbacks of the Objective-C protocol ICScannerDeviceDelegate. Pass an implementation to the matching With… setter; the wrapper builds the Objective-C delegate object for you. Every method listed here is required. The protocol's optional methods are separate one-method interfaces (ScannerDeviceDelegate…Handler): implement the ones you need on the same value and the framework will call them too.

type ScannerDeviceDelegateScannerDeviceDidBecomeAvailableHandler added in v0.17.0 

type ScannerDeviceDelegateScannerDeviceDidBecomeAvailableHandler interface {
	ScannerDeviceDidBecomeAvailable(scanner *ScannerDevice)
}

ScannerDeviceDelegateScannerDeviceDidBecomeAvailableHandler is the optional ICScannerDeviceDelegate method scannerDeviceDidBecomeAvailable:. Implement it on a ScannerDeviceDelegate value to receive that callback; a value without it is simply never sent one.

type ScannerDeviceDelegateScannerDeviceDidCompleteOverviewScanWithErrorHandler added in v0.17.0 

type ScannerDeviceDelegateScannerDeviceDidCompleteOverviewScanWithErrorHandler interface {
	ScannerDeviceDidCompleteOverviewScanWithError(scanner *ScannerDevice, err error)
}

ScannerDeviceDelegateScannerDeviceDidCompleteOverviewScanWithErrorHandler is the optional ICScannerDeviceDelegate method scannerDevice:didCompleteOverviewScanWithError:. Implement it on a ScannerDeviceDelegate value to receive that callback; a value without it is simply never sent one.

type ScannerDeviceDelegateScannerDeviceDidCompleteScanWithErrorHandler added in v0.17.0 

type ScannerDeviceDelegateScannerDeviceDidCompleteScanWithErrorHandler interface {
	ScannerDeviceDidCompleteScanWithError(scanner *ScannerDevice, err error)
}

ScannerDeviceDelegateScannerDeviceDidCompleteScanWithErrorHandler is the optional ICScannerDeviceDelegate method scannerDevice:didCompleteScanWithError:. Implement it on a ScannerDeviceDelegate value to receive that callback; a value without it is simply never sent one.

type ScannerDeviceDelegateScannerDeviceDidScanToBandDataHandler added in v0.17.0 

type ScannerDeviceDelegateScannerDeviceDidScanToBandDataHandler interface {
	ScannerDeviceDidScanToBandData(scanner *ScannerDevice, data *ScannerBandData)
}

ScannerDeviceDelegateScannerDeviceDidScanToBandDataHandler is the optional ICScannerDeviceDelegate method scannerDevice:didScanToBandData:. Implement it on a ScannerDeviceDelegate value to receive that callback; a value without it is simply never sent one.

type ScannerDeviceDelegateScannerDeviceDidScanToURLDataHandler added in v0.17.0 

type ScannerDeviceDelegateScannerDeviceDidScanToURLDataHandler interface {
	ScannerDeviceDidScanToURLData(scanner *ScannerDevice, url string, data []byte)
}

ScannerDeviceDelegateScannerDeviceDidScanToURLDataHandler is the optional ICScannerDeviceDelegate method scannerDevice:didScanToURL:data:. Implement it on a ScannerDeviceDelegate value to receive that callback; a value without it is simply never sent one.

type ScannerDeviceDelegateScannerDeviceDidScanToURLHandler added in v0.17.0 

type ScannerDeviceDelegateScannerDeviceDidScanToURLHandler interface {
	ScannerDeviceDidScanToURL(scanner *ScannerDevice, url string)
}

ScannerDeviceDelegateScannerDeviceDidScanToURLHandler is the optional ICScannerDeviceDelegate method scannerDevice:didScanToURL:. Implement it on a ScannerDeviceDelegate value to receive that callback; a value without it is simply never sent one.

type ScannerDeviceDelegateScannerDeviceDidSelectFunctionalUnitErrorHandler added in v0.17.0 

type ScannerDeviceDelegateScannerDeviceDidSelectFunctionalUnitErrorHandler interface {
	ScannerDeviceDidSelectFunctionalUnitError(scanner *ScannerDevice, functionalUnit *ScannerFunctionalUnit, err error)
}

ScannerDeviceDelegateScannerDeviceDidSelectFunctionalUnitErrorHandler is the optional ICScannerDeviceDelegate method scannerDevice:didSelectFunctionalUnit:error:. Implement it on a ScannerDeviceDelegate value to receive that callback; a value without it is simply never sent one.

type ScannerDocumentType added in v0.17.0 

type ScannerDocumentType uint64

The supported document size types. 

const (
	ScannerDocumentTypeDefault      ScannerDocumentType = 0
	ScannerDocumentTypeA4           ScannerDocumentType = 1
	ScannerDocumentTypeB5           ScannerDocumentType = 2
	ScannerDocumentTypeUSLetter     ScannerDocumentType = 3
	ScannerDocumentTypeUSLegal      ScannerDocumentType = 4
	ScannerDocumentTypeA5           ScannerDocumentType = 5
	ScannerDocumentTypeISOB4        ScannerDocumentType = 6
	ScannerDocumentTypeISOB6        ScannerDocumentType = 7
	ScannerDocumentTypeUSLedger     ScannerDocumentType = 9
	ScannerDocumentTypeUSExecutive  ScannerDocumentType = 10
	ScannerDocumentTypeA3           ScannerDocumentType = 11
	ScannerDocumentTypeISOB3        ScannerDocumentType = 12
	ScannerDocumentTypeA6           ScannerDocumentType = 13
	ScannerDocumentTypeC4           ScannerDocumentType = 14
	ScannerDocumentTypeC5           ScannerDocumentType = 15
	ScannerDocumentTypeC6           ScannerDocumentType = 16
	ScannerDocumentType4A0          ScannerDocumentType = 17
	ScannerDocumentType2A0          ScannerDocumentType = 18
	ScannerDocumentTypeA0           ScannerDocumentType = 19
	ScannerDocumentTypeA1           ScannerDocumentType = 20
	ScannerDocumentTypeA2           ScannerDocumentType = 21
	ScannerDocumentTypeA7           ScannerDocumentType = 22
	ScannerDocumentTypeA8           ScannerDocumentType = 23
	ScannerDocumentTypeA9           ScannerDocumentType = 24
	ScannerDocumentType10           ScannerDocumentType = 25
	ScannerDocumentTypeISOB0        ScannerDocumentType = 26
	ScannerDocumentTypeISOB1        ScannerDocumentType = 27
	ScannerDocumentTypeISOB2        ScannerDocumentType = 28
	ScannerDocumentTypeISOB5        ScannerDocumentType = 29
	ScannerDocumentTypeISOB7        ScannerDocumentType = 30
	ScannerDocumentTypeISOB8        ScannerDocumentType = 31
	ScannerDocumentTypeISOB9        ScannerDocumentType = 32
	ScannerDocumentTypeISOB10       ScannerDocumentType = 33
	ScannerDocumentTypeJISB0        ScannerDocumentType = 34
	ScannerDocumentTypeJISB1        ScannerDocumentType = 35
	ScannerDocumentTypeJISB2        ScannerDocumentType = 36
	ScannerDocumentTypeJISB3        ScannerDocumentType = 37
	ScannerDocumentTypeJISB4        ScannerDocumentType = 38
	ScannerDocumentTypeJISB6        ScannerDocumentType = 39
	ScannerDocumentTypeJISB7        ScannerDocumentType = 40
	ScannerDocumentTypeJISB8        ScannerDocumentType = 41
	ScannerDocumentTypeJISB9        ScannerDocumentType = 42
	ScannerDocumentTypeJISB10       ScannerDocumentType = 43
	ScannerDocumentTypeC0           ScannerDocumentType = 44
	ScannerDocumentTypeC1           ScannerDocumentType = 45
	ScannerDocumentTypeC2           ScannerDocumentType = 46
	ScannerDocumentTypeC3           ScannerDocumentType = 47
	ScannerDocumentTypeC7           ScannerDocumentType = 48
	ScannerDocumentTypeC8           ScannerDocumentType = 49
	ScannerDocumentTypeC9           ScannerDocumentType = 50
	ScannerDocumentTypeC10          ScannerDocumentType = 51
	ScannerDocumentTypeUSStatement  ScannerDocumentType = 52
	ScannerDocumentTypeBusinessCard ScannerDocumentType = 53
	ScannerDocumentTypeE            ScannerDocumentType = 60
	ScannerDocumentType3R           ScannerDocumentType = 61
	ScannerDocumentType4R           ScannerDocumentType = 62
	ScannerDocumentType5R           ScannerDocumentType = 63
	ScannerDocumentType6R           ScannerDocumentType = 64
	ScannerDocumentType8R           ScannerDocumentType = 65
	ScannerDocumentTypeS8R          ScannerDocumentType = 66
	ScannerDocumentType10R          ScannerDocumentType = 67
	ScannerDocumentTypeS10R         ScannerDocumentType = 68
	ScannerDocumentType11R          ScannerDocumentType = 69
	ScannerDocumentType12R          ScannerDocumentType = 70
	ScannerDocumentTypeS12R         ScannerDocumentType = 71
	ScannerDocumentType110          ScannerDocumentType = 72
	ScannerDocumentTypeAPSH         ScannerDocumentType = 73
	ScannerDocumentTypeAPSC         ScannerDocumentType = 74
	ScannerDocumentTypeAPSP         ScannerDocumentType = 75
	ScannerDocumentType135          ScannerDocumentType = 76
	ScannerDocumentTypeMF           ScannerDocumentType = 77
	ScannerDocumentTypeLF           ScannerDocumentType = 78
)

func (ScannerDocumentType) String added in v0.17.0 

func (e ScannerDocumentType) String() string

String returns the ScannerDocumentType constant's name, or its numeric form when the value is not a known constant.

type ScannerFeature added in v0.17.0 

type ScannerFeature struct {
	objref.Handle
}

ScannerFeature is an idiomatic wrapper over the Objective-C class ICScannerFeature.

ScannerFeature is an abstract base — you do not construct it directly. Construct one of ScannerFeatureBoolean, ScannerFeatureEnumeration, ScannerFeatureRange, ScannerFeatureTemplate and pass it where a ScannerFeature is accepted.

An abstract class that describes a scanner feature.

func ScannerFeatureFromID added in v0.17.0 

func ScannerFeatureFromID(id objc.ID) *ScannerFeature

ScannerFeatureFromID adopts an existing Objective-C object as a ScannerFeature (nil for 0), retaining it and registering a release finalizer.

func (*ScannerFeature) Description added in v0.17.0 

func (sf *ScannerFeature) Description() string

Description returns the object's -description text.

func (*ScannerFeature) HumanReadableName added in v0.17.0 

func (sf *ScannerFeature) HumanReadableName() string

HumanReadableName returns the human readable name of this feature.

func (*ScannerFeature) InternalName added in v0.17.0 

func (sf *ScannerFeature) InternalName() string

InternalName returns The internal name of this feature.

func (*ScannerFeature) IsEqual added in v0.17.0 

func (sf *ScannerFeature) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*ScannerFeature) IsKind added in v0.17.0 

func (sf *ScannerFeature) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*ScannerFeature) String added in v0.17.0 

func (sf *ScannerFeature) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*ScannerFeature) Tooltip added in v0.17.0 

func (sf *ScannerFeature) Tooltip() string

Tooltip returns Tooltip text describing the feature.

func (*ScannerFeature) Type added in v0.17.0 

func (sf *ScannerFeature) Type() ScannerFeatureType

Type returns Scanner feature type.

type ScannerFeatureBoolean added in v0.17.0 

type ScannerFeatureBoolean struct {
	ScannerFeature
}

ScannerFeatureBoolean is an idiomatic wrapper over the Objective-C class ICScannerFeatureBoolean.

It embeds ScannerFeature, promoting that type's methods.

A feature with a value of YES or NO.

func NewScannerFeatureBoolean added in v0.17.0 

func NewScannerFeatureBoolean() *ScannerFeatureBoolean

NewScannerFeatureBoolean creates a new ScannerFeatureBoolean.

func ScannerFeatureBooleanFromID added in v0.17.0 

func ScannerFeatureBooleanFromID(id objc.ID) *ScannerFeatureBoolean

ScannerFeatureBooleanFromID adopts an existing Objective-C object as a ScannerFeatureBoolean (nil for 0), retaining it and registering a release finalizer.

func (*ScannerFeatureBoolean) Value added in v0.17.0 

func (sfb *ScannerFeatureBoolean) Value() bool

Value wraps the corresponding Objective-C method.

func (*ScannerFeatureBoolean) WithValue added in v0.17.0 

func (sfb *ScannerFeatureBoolean) WithValue(value bool) *ScannerFeatureBoolean

WithValue sets The value of this feature.

type ScannerFeatureEnumeration added in v0.17.0 

type ScannerFeatureEnumeration struct {
	ScannerFeature
}

ScannerFeatureEnumeration is an idiomatic wrapper over the Objective-C class ICScannerFeatureEnumeration.

It embeds ScannerFeature, promoting that type's methods.

A feature that can have one of several discrete values, strings or numbers.

func NewScannerFeatureEnumeration added in v0.17.0 

func NewScannerFeatureEnumeration() *ScannerFeatureEnumeration

NewScannerFeatureEnumeration creates a new ScannerFeatureEnumeration.

func ScannerFeatureEnumerationFromID added in v0.17.0 

func ScannerFeatureEnumerationFromID(id objc.ID) *ScannerFeatureEnumeration

ScannerFeatureEnumerationFromID adopts an existing Objective-C object as a ScannerFeatureEnumeration (nil for 0), retaining it and registering a release finalizer.

func (*ScannerFeatureEnumeration) CurrentValue added in v0.17.0 

func (sfe *ScannerFeatureEnumeration) CurrentValue() obj.Object

CurrentValue returns the current value. The current value can be set to one of the possible values in the "values" property below.

func (*ScannerFeatureEnumeration) DefaultValue added in v0.17.0 

func (sfe *ScannerFeatureEnumeration) DefaultValue() obj.Object

DefaultValue returns The default value. The default value can be set to one of the possible values in the "values" property below.

func (*ScannerFeatureEnumeration) MenuItemLabels added in v0.17.0 

func (sfe *ScannerFeatureEnumeration) MenuItemLabels() []string

MenuItemLabels returns The human readable menu item labels to be used in a menu to allow the user to select the current value from an array of possible values.

MenuItemLabels returns the collection as a Go slice.

func (*ScannerFeatureEnumeration) MenuItemLabelsTooltips added in v0.17.0 

func (sfe *ScannerFeatureEnumeration) MenuItemLabelsTooltips() []string

MenuItemLabelsTooltips returns Tooltip text associated with the menu items.

MenuItemLabelsTooltips returns the collection as a Go slice.

func (*ScannerFeatureEnumeration) Values added in v0.17.0 

func (sfe *ScannerFeatureEnumeration) Values() []obj.Object

Values returns an array of possible values. All items in this array must be of same type.

Values returns the collection as a Go slice.

func (*ScannerFeatureEnumeration) WithCurrentValue added in v0.17.0 

func (sfe *ScannerFeatureEnumeration) WithCurrentValue(currentValue obj.Object) *ScannerFeatureEnumeration

WithCurrentValue sets the current value. The current value can be set to one of the possible values in the "values" property below.

type ScannerFeatureProvider added in v0.17.0 

type ScannerFeatureProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

ScannerFeatureProvider is accepted wherever a ICScannerFeature (or one of its subclasses) is expected.

type ScannerFeatureRange added in v0.17.0 

type ScannerFeatureRange struct {
	ScannerFeature
}

ScannerFeatureRange is an idiomatic wrapper over the Objective-C class ICScannerFeatureRange.

It embeds ScannerFeature, promoting that type's methods.

A feature with a value that lies within a range.

func NewScannerFeatureRange added in v0.17.0 

func NewScannerFeatureRange() *ScannerFeatureRange

NewScannerFeatureRange creates a new ScannerFeatureRange.

func ScannerFeatureRangeFromID added in v0.17.0 

func ScannerFeatureRangeFromID(id objc.ID) *ScannerFeatureRange

ScannerFeatureRangeFromID adopts an existing Objective-C object as a ScannerFeatureRange (nil for 0), retaining it and registering a release finalizer.

func (*ScannerFeatureRange) CurrentValue added in v0.17.0 

func (sfr *ScannerFeatureRange) CurrentValue() float64

CurrentValue returns The current value. Attempting to set the current value to a value that is not coincident with a step will result in a value corresponding to the nearest step being assigned to the current value.

func (*ScannerFeatureRange) DefaultValue added in v0.17.0 

func (sfr *ScannerFeatureRange) DefaultValue() float64

DefaultValue returns the default value. Attempting to set the default value to a value that is not coincident with a step will result in a value corresponding to the nearest step being assigned to the default value.

func (*ScannerFeatureRange) MaxValue added in v0.17.0 

func (sfr *ScannerFeatureRange) MaxValue() float64

MaxValue returns The maximum value.

func (*ScannerFeatureRange) MinValue added in v0.17.0 

func (sfr *ScannerFeatureRange) MinValue() float64

MinValue returns the minimum value.

func (*ScannerFeatureRange) StepSize added in v0.17.0 

func (sfr *ScannerFeatureRange) StepSize() float64

StepSize returns The step size.

func (*ScannerFeatureRange) WithCurrentValue added in v0.17.0 

func (sfr *ScannerFeatureRange) WithCurrentValue(currentValue float64) *ScannerFeatureRange

WithCurrentValue sets The current value. Attempting to set the current value to a value that is not coincident with a step will result in a value corresponding to the nearest step being assigned to the current value.

type ScannerFeatureTemplate added in v0.17.0 

type ScannerFeatureTemplate struct {
	ScannerFeature
}

ScannerFeatureTemplate is an idiomatic wrapper over the Objective-C class ICScannerFeatureTemplate.

It embeds ScannerFeature, promoting that type's methods.

A group of one or more rectangular scan areas that can be used with a scanner functional unit.

func NewScannerFeatureTemplate added in v0.17.0 

func NewScannerFeatureTemplate() *ScannerFeatureTemplate

NewScannerFeatureTemplate creates a new ScannerFeatureTemplate.

func ScannerFeatureTemplateFromID added in v0.17.0 

func ScannerFeatureTemplateFromID(id objc.ID) *ScannerFeatureTemplate

ScannerFeatureTemplateFromID adopts an existing Objective-C object as a ScannerFeatureTemplate (nil for 0), retaining it and registering a release finalizer.

func (*ScannerFeatureTemplate) Targets added in v0.17.0 

func (sft *ScannerFeatureTemplate) Targets() []obj.Object

Targets returns the targets.

Targets returns the collection as a Go slice.

type ScannerFeatureType added in v0.17.0 

type ScannerFeatureType uint64

The types of scanner features. 

const (
	// A feature that can have one of several discrete values, strings, or numbers.
	ScannerFeatureTypeEnumeration ScannerFeatureType = 0
	// A feature with a value that lies within a range.
	ScannerFeatureTypeRange ScannerFeatureType = 1
	// A feature with a value of YES or NO.
	ScannerFeatureTypeBoolean ScannerFeatureType = 2
	// A group of one or more rectangular scan areas that can be used with a scanner functional unit.
	ScannerFeatureTypeTemplate ScannerFeatureType = 3
)

func (ScannerFeatureType) String added in v0.17.0 

func (e ScannerFeatureType) String() string

String returns the ScannerFeatureType constant's name, or its numeric form when the value is not a known constant.

type ScannerFunctionalUnit added in v0.17.0 

type ScannerFunctionalUnit struct {
	objref.Handle
}

ScannerFunctionalUnit is an idiomatic wrapper over the Objective-C class ICScannerFunctionalUnit.

ScannerFunctionalUnit is an abstract base — you do not construct it directly. Construct one of ScannerFunctionalUnitDocumentFeeder, ScannerFunctionalUnitFlatbed, ScannerFunctionalUnitNegativeTransparency, ScannerFunctionalUnitPositiveTransparency and pass it where a ScannerFunctionalUnit is accepted.

An abstract class that represents a scanner functional unit.

func ScannerFunctionalUnitFromID added in v0.17.0 

func ScannerFunctionalUnitFromID(id objc.ID) *ScannerFunctionalUnit

ScannerFunctionalUnitFromID adopts an existing Objective-C object as a ScannerFunctionalUnit (nil for 0), retaining it and registering a release finalizer.

func (*ScannerFunctionalUnit) AcceptsThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfu *ScannerFunctionalUnit) AcceptsThresholdForBlackAndWhiteScanning() bool

AcceptsThresholdForBlackAndWhiteScanning reports whether Indicates if this functional unit accepts threshold value to be used when performing a scan in black & white.

func (*ScannerFunctionalUnit) BitDepth added in v0.17.0 

func (sfu *ScannerFunctionalUnit) BitDepth() ScannerBitDepth

BitDepth returns The bit depth to use when performing the final scan. This will always be one of the supported bit depths.

func (*ScannerFunctionalUnit) CanPerformOverviewScan added in v0.17.0 

func (sfu *ScannerFunctionalUnit) CanPerformOverviewScan() bool

CanPerformOverviewScan reports whether Indicates if this functional unit can perfrom an overview scan. Not all functional units can perform an overview scan. For example, a document feeder or a sheet feeder unit cannot perform an overview scan.

func (*ScannerFunctionalUnit) DefaultThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfu *ScannerFunctionalUnit) DefaultThresholdForBlackAndWhiteScanning() uint8

DefaultThresholdForBlackAndWhiteScanning returns Default threshold value used when performing a scan in black & white. This value is from 0 to 255.

func (*ScannerFunctionalUnit) Description added in v0.17.0 

func (sfu *ScannerFunctionalUnit) Description() string

Description returns the object's -description text.

func (*ScannerFunctionalUnit) IsEqual added in v0.17.0 

func (sfu *ScannerFunctionalUnit) IsEqual(other obj.Object) bool

IsEqual reports Objective-C equality (isEqual:) with another object.

func (*ScannerFunctionalUnit) IsKind added in v0.17.0 

func (sfu *ScannerFunctionalUnit) IsKind(className string) bool

IsKind reports whether the object is an instance of the named class or a subclass.

func (*ScannerFunctionalUnit) MeasurementUnit added in v0.17.0 

func (sfu *ScannerFunctionalUnit) MeasurementUnit() ScannerMeasurementUnit

MeasurementUnit returns Current measurement unit. This will always be one of the supported measurement units.

func (*ScannerFunctionalUnit) NativeXResolution added in v0.17.0 

func (sfu *ScannerFunctionalUnit) NativeXResolution() int

NativeXResolution returns Optical resolution along the X axis.

func (*ScannerFunctionalUnit) NativeYResolution added in v0.17.0 

func (sfu *ScannerFunctionalUnit) NativeYResolution() int

NativeYResolution returns Optical resolution along the Y axis.

func (*ScannerFunctionalUnit) OverviewImage added in v0.17.0 

func (sfu *ScannerFunctionalUnit) OverviewImage() coregraphics.CGImageRef

OverviewImage returns Overview scan image. This property will be NULL for functional units that do not support overview scans.

func (*ScannerFunctionalUnit) OverviewResolution added in v0.17.0 

func (sfu *ScannerFunctionalUnit) OverviewResolution() int

OverviewResolution returns Overview image resolution. Value assigned to this will be contrained by resolutions allowed by the device.

func (*ScannerFunctionalUnit) OverviewScanInProgress added in v0.17.0 

func (sfu *ScannerFunctionalUnit) OverviewScanInProgress() bool

OverviewScanInProgress reports whether Indicates if an overview scan is in progress.

func (*ScannerFunctionalUnit) PhysicalSize added in v0.17.0 

func (sfu *ScannerFunctionalUnit) PhysicalSize() corefoundation.CGSize

PhysicalSize returns Physical size of the scan area in current measurement unit.

func (*ScannerFunctionalUnit) PixelDataType added in v0.17.0 

func (sfu *ScannerFunctionalUnit) PixelDataType() ScannerPixelDataType

PixelDataType returns The pixel data type.

func (*ScannerFunctionalUnit) PreferredResolutions added in v0.17.0 

func (sfu *ScannerFunctionalUnit) PreferredResolutions() *foundation.IndexSet

PreferredResolutions returns Preferred scan resolutions in DPI.

func (*ScannerFunctionalUnit) PreferredScaleFactors added in v0.17.0 

func (sfu *ScannerFunctionalUnit) PreferredScaleFactors() *foundation.IndexSet

PreferredScaleFactors returns Preferred scale factors in percentage.

func (*ScannerFunctionalUnit) Resolution added in v0.17.0 

func (sfu *ScannerFunctionalUnit) Resolution() int

Resolution returns Current scan resolution. This will always be one of the supported resolution values.

func (*ScannerFunctionalUnit) ScaleFactor added in v0.17.0 

func (sfu *ScannerFunctionalUnit) ScaleFactor() int

ScaleFactor returns Current scale factor. This will always be one of the supported scale factor values.

func (*ScannerFunctionalUnit) ScanArea added in v0.17.0 

func (sfu *ScannerFunctionalUnit) ScanArea() corefoundation.CGRect

ScanArea returns This property along with scanAreaOrientation describes the area to be scanned.

func (*ScannerFunctionalUnit) ScanAreaOrientation added in v0.17.0 

func (sfu *ScannerFunctionalUnit) ScanAreaOrientation() EXIFOrientationType

ScanAreaOrientation returns Desired orientation of the scan area. This property along with scanArea describes the area to be scanned. This property is set to ICEXIFOrientation1 initially. This property is not used by the ICScannerFunctionalUnitDocumentFeeder subclass.

func (*ScannerFunctionalUnit) ScanInProgress added in v0.17.0 

func (sfu *ScannerFunctionalUnit) ScanInProgress() bool

ScanInProgress reports whether Indicates if a scan is in progress.

func (*ScannerFunctionalUnit) ScanProgressPercentDone added in v0.17.0 

func (sfu *ScannerFunctionalUnit) ScanProgressPercentDone() float64

ScanProgressPercentDone returns Indicates percentage of scan completed.

func (*ScannerFunctionalUnit) State added in v0.17.0 

func (sfu *ScannerFunctionalUnit) State() ScannerFunctionalUnitState

State returns Indicates the current state of the functional unit.

func (*ScannerFunctionalUnit) String added in v0.17.0 

func (sfu *ScannerFunctionalUnit) String() string

String returns the object's -description text, so a wrapper prints usefully under fmt.

func (*ScannerFunctionalUnit) SupportedBitDepths added in v0.17.0 

func (sfu *ScannerFunctionalUnit) SupportedBitDepths() *foundation.IndexSet

SupportedBitDepths returns Supported bit depths. The values in this set are valid values defined by ICScannerBitDepth.

func (*ScannerFunctionalUnit) SupportedMeasurementUnits added in v0.17.0 

func (sfu *ScannerFunctionalUnit) SupportedMeasurementUnits() *foundation.IndexSet

SupportedMeasurementUnits returns Supported measurement units. The values in this set are valid values defined by ICScannerMeasurementUnit.

func (*ScannerFunctionalUnit) SupportedResolutions added in v0.17.0 

func (sfu *ScannerFunctionalUnit) SupportedResolutions() *foundation.IndexSet

SupportedResolutions returns Supported scan resolutions in DPI.

func (*ScannerFunctionalUnit) SupportedScaleFactors added in v0.17.0 

func (sfu *ScannerFunctionalUnit) SupportedScaleFactors() *foundation.IndexSet

SupportedScaleFactors returns Supported scale factors in percentage.

func (*ScannerFunctionalUnit) Templates added in v0.17.0 

func (sfu *ScannerFunctionalUnit) Templates() []*ScannerFeatureTemplate

Templates returns an array of objects of type ICScannerFeatureTemplate.

Templates returns the collection as a Go slice.

func (*ScannerFunctionalUnit) ThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfu *ScannerFunctionalUnit) ThresholdForBlackAndWhiteScanning() uint8

ThresholdForBlackAndWhiteScanning returns Threshold value to be used when performing a scan in black & white. This value should be from 0 to 255.

func (*ScannerFunctionalUnit) Type added in v0.17.0 

func (sfu *ScannerFunctionalUnit) Type() ScannerFunctionalUnitType

Type returns Functional unit type.

func (*ScannerFunctionalUnit) UsesThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfu *ScannerFunctionalUnit) UsesThresholdForBlackAndWhiteScanning() bool

UsesThresholdForBlackAndWhiteScanning reports whether Indicates if this functional unit uses threshold value to be used when performing a scan in black & white.

func (*ScannerFunctionalUnit) VendorFeatures added in v0.17.0 

func (sfu *ScannerFunctionalUnit) VendorFeatures() []*ScannerFeature

VendorFeatures returns an array of objects of type ICScannerFeature.

VendorFeatures returns the collection as a Go slice.

func (*ScannerFunctionalUnit) WithBitDepth added in v0.17.0 

func (sfu *ScannerFunctionalUnit) WithBitDepth(bitDepth ScannerBitDepth) *ScannerFunctionalUnit

WithBitDepth sets The bit depth to use when performing the final scan. This will always be one of the supported bit depths.

func (*ScannerFunctionalUnit) WithMeasurementUnit added in v0.17.0 

func (sfu *ScannerFunctionalUnit) WithMeasurementUnit(measurementUnit ScannerMeasurementUnit) *ScannerFunctionalUnit

WithMeasurementUnit sets Current measurement unit. This will always be one of the supported measurement units.

func (*ScannerFunctionalUnit) WithOverviewResolution added in v0.17.0 

func (sfu *ScannerFunctionalUnit) WithOverviewResolution(overviewResolution int) *ScannerFunctionalUnit

WithOverviewResolution sets Overview image resolution. Value assigned to this will be contrained by resolutions allowed by the device.

func (*ScannerFunctionalUnit) WithPixelDataType added in v0.17.0 

func (sfu *ScannerFunctionalUnit) WithPixelDataType(pixelDataType ScannerPixelDataType) *ScannerFunctionalUnit

WithPixelDataType sets The pixel data type.

func (*ScannerFunctionalUnit) WithResolution added in v0.17.0 

func (sfu *ScannerFunctionalUnit) WithResolution(resolution int) *ScannerFunctionalUnit

WithResolution sets Current scan resolution. This will always be one of the supported resolution values.

func (*ScannerFunctionalUnit) WithScaleFactor added in v0.17.0 

func (sfu *ScannerFunctionalUnit) WithScaleFactor(scaleFactor int) *ScannerFunctionalUnit

WithScaleFactor sets Current scale factor. This will always be one of the supported scale factor values.

func (*ScannerFunctionalUnit) WithScanArea added in v0.17.0 

func (sfu *ScannerFunctionalUnit) WithScanArea(scanArea corefoundation.CGRect) *ScannerFunctionalUnit

WithScanArea sets This property along with scanAreaOrientation describes the area to be scanned.

func (*ScannerFunctionalUnit) WithScanAreaOrientation added in v0.17.0 

func (sfu *ScannerFunctionalUnit) WithScanAreaOrientation(scanAreaOrientation EXIFOrientationType) *ScannerFunctionalUnit

WithScanAreaOrientation sets Desired orientation of the scan area. This property along with scanArea describes the area to be scanned. This property is set to ICEXIFOrientation1 initially. This property is not used by the ICScannerFunctionalUnitDocumentFeeder subclass.

func (*ScannerFunctionalUnit) WithThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfu *ScannerFunctionalUnit) WithThresholdForBlackAndWhiteScanning(thresholdForBlackAndWhiteScanning uint8) *ScannerFunctionalUnit

WithThresholdForBlackAndWhiteScanning sets Threshold value to be used when performing a scan in black & white. This value should be from 0 to 255.

func (*ScannerFunctionalUnit) WithUsesThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfu *ScannerFunctionalUnit) WithUsesThresholdForBlackAndWhiteScanning(usesThresholdForBlackAndWhiteScanning bool) *ScannerFunctionalUnit

WithUsesThresholdForBlackAndWhiteScanning sets Indicates if this functional unit uses threshold value to be used when performing a scan in black & white.

type ScannerFunctionalUnitDocumentFeeder added in v0.17.0 

type ScannerFunctionalUnitDocumentFeeder struct {
	ScannerFunctionalUnit
}

ScannerFunctionalUnitDocumentFeeder is an idiomatic wrapper over the Objective-C class ICScannerFunctionalUnitDocumentFeeder.

It embeds ScannerFunctionalUnit, promoting that type's methods.

An object that represents the document feeder unit on a scanner.

func NewScannerFunctionalUnitDocumentFeeder added in v0.17.0 

func NewScannerFunctionalUnitDocumentFeeder() *ScannerFunctionalUnitDocumentFeeder

NewScannerFunctionalUnitDocumentFeeder creates a new ScannerFunctionalUnitDocumentFeeder.

func ScannerFunctionalUnitDocumentFeederFromID added in v0.17.0 

func ScannerFunctionalUnitDocumentFeederFromID(id objc.ID) *ScannerFunctionalUnitDocumentFeeder

ScannerFunctionalUnitDocumentFeederFromID adopts an existing Objective-C object as a ScannerFunctionalUnitDocumentFeeder (nil for 0), retaining it and registering a release finalizer.

func (*ScannerFunctionalUnitDocumentFeeder) DocumentLoaded added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) DocumentLoaded() bool

DocumentLoaded reports whether Indicates whether the feeder has documents to scan. This value will change when the document is loaded or removed from the feeder, if the scanner module has the capability to detect this state.

func (*ScannerFunctionalUnitDocumentFeeder) DocumentSize added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) DocumentSize() corefoundation.CGSize

DocumentSize returns Document size of the current document type expressed in current measurement unit.

func (*ScannerFunctionalUnitDocumentFeeder) DocumentType added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) DocumentType() ScannerDocumentType

DocumentType returns Current document type. This will always be one of the supported document types.

func (*ScannerFunctionalUnitDocumentFeeder) DuplexScanningEnabled added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) DuplexScanningEnabled() bool

DuplexScanningEnabled reports whether Indicates whether duplex scanning is enabled.

func (*ScannerFunctionalUnitDocumentFeeder) EvenPageOrientation added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) EvenPageOrientation() EXIFOrientationType

EvenPageOrientation returns Desired orientation of the even pages of the scanned document. This property is set to ICEXIFOrientation1 initially.

func (*ScannerFunctionalUnitDocumentFeeder) OddPageOrientation added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) OddPageOrientation() EXIFOrientationType

OddPageOrientation returns Desired orientation of the odd pages of the scanned document. This property is set to ICEXIFOrientation1 initially.

func (*ScannerFunctionalUnitDocumentFeeder) ReverseFeederPageOrder added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) ReverseFeederPageOrder() bool

ReverseFeederPageOrder reports whether Indicates whether the document feeder reads pages from back to front.

func (*ScannerFunctionalUnitDocumentFeeder) SupportedDocumentTypes added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) SupportedDocumentTypes() *foundation.IndexSet

SupportedDocumentTypes returns Supported document types. The values in this set are valid values defined by ICScannerDocumentType.

func (*ScannerFunctionalUnitDocumentFeeder) SupportsDuplexScanning added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) SupportsDuplexScanning() bool

SupportsDuplexScanning reports whether Indicates whether duplex scanning is supported.

func (*ScannerFunctionalUnitDocumentFeeder) WithBitDepth added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithBitDepth(bitDepth ScannerBitDepth) *ScannerFunctionalUnitDocumentFeeder

WithBitDepth sets The bit depth to use when performing the final scan. This will always be one of the supported bit depths.

func (*ScannerFunctionalUnitDocumentFeeder) WithDocumentType added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithDocumentType(documentType ScannerDocumentType) *ScannerFunctionalUnitDocumentFeeder

WithDocumentType sets Current document type. This will always be one of the supported document types.

func (*ScannerFunctionalUnitDocumentFeeder) WithDuplexScanningEnabled added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithDuplexScanningEnabled(duplexScanningEnabled bool) *ScannerFunctionalUnitDocumentFeeder

WithDuplexScanningEnabled sets Indicates whether duplex scanning is enabled.

func (*ScannerFunctionalUnitDocumentFeeder) WithEvenPageOrientation added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithEvenPageOrientation(evenPageOrientation EXIFOrientationType) *ScannerFunctionalUnitDocumentFeeder

WithEvenPageOrientation sets Desired orientation of the even pages of the scanned document. This property is set to ICEXIFOrientation1 initially.

func (*ScannerFunctionalUnitDocumentFeeder) WithMeasurementUnit added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithMeasurementUnit(measurementUnit ScannerMeasurementUnit) *ScannerFunctionalUnitDocumentFeeder

WithMeasurementUnit sets Current measurement unit. This will always be one of the supported measurement units.

func (*ScannerFunctionalUnitDocumentFeeder) WithOddPageOrientation added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithOddPageOrientation(oddPageOrientation EXIFOrientationType) *ScannerFunctionalUnitDocumentFeeder

WithOddPageOrientation sets Desired orientation of the odd pages of the scanned document. This property is set to ICEXIFOrientation1 initially.

func (*ScannerFunctionalUnitDocumentFeeder) WithOverviewResolution added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithOverviewResolution(overviewResolution int) *ScannerFunctionalUnitDocumentFeeder

WithOverviewResolution sets Overview image resolution. Value assigned to this will be contrained by resolutions allowed by the device.

func (*ScannerFunctionalUnitDocumentFeeder) WithPixelDataType added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithPixelDataType(pixelDataType ScannerPixelDataType) *ScannerFunctionalUnitDocumentFeeder

WithPixelDataType sets The pixel data type.

func (*ScannerFunctionalUnitDocumentFeeder) WithResolution added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithResolution(resolution int) *ScannerFunctionalUnitDocumentFeeder

WithResolution sets Current scan resolution. This will always be one of the supported resolution values.

func (*ScannerFunctionalUnitDocumentFeeder) WithScaleFactor added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithScaleFactor(scaleFactor int) *ScannerFunctionalUnitDocumentFeeder

WithScaleFactor sets Current scale factor. This will always be one of the supported scale factor values.

func (*ScannerFunctionalUnitDocumentFeeder) WithScanArea added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithScanArea(scanArea corefoundation.CGRect) *ScannerFunctionalUnitDocumentFeeder

WithScanArea sets This property along with scanAreaOrientation describes the area to be scanned.

func (*ScannerFunctionalUnitDocumentFeeder) WithScanAreaOrientation added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithScanAreaOrientation(scanAreaOrientation EXIFOrientationType) *ScannerFunctionalUnitDocumentFeeder

WithScanAreaOrientation sets Desired orientation of the scan area. This property along with scanArea describes the area to be scanned. This property is set to ICEXIFOrientation1 initially. This property is not used by the ICScannerFunctionalUnitDocumentFeeder subclass.

func (*ScannerFunctionalUnitDocumentFeeder) WithThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithThresholdForBlackAndWhiteScanning(thresholdForBlackAndWhiteScanning uint8) *ScannerFunctionalUnitDocumentFeeder

WithThresholdForBlackAndWhiteScanning sets Threshold value to be used when performing a scan in black & white. This value should be from 0 to 255.

func (*ScannerFunctionalUnitDocumentFeeder) WithUsesThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfudf *ScannerFunctionalUnitDocumentFeeder) WithUsesThresholdForBlackAndWhiteScanning(usesThresholdForBlackAndWhiteScanning bool) *ScannerFunctionalUnitDocumentFeeder

WithUsesThresholdForBlackAndWhiteScanning sets Indicates if this functional unit uses threshold value to be used when performing a scan in black & white.

type ScannerFunctionalUnitFlatbed added in v0.17.0 

type ScannerFunctionalUnitFlatbed struct {
	ScannerFunctionalUnit
}

ScannerFunctionalUnitFlatbed is an idiomatic wrapper over the Objective-C class ICScannerFunctionalUnitFlatbed.

It embeds ScannerFunctionalUnit, promoting that type's methods.

An object that represents the flatbed unit on a scanner.

func NewScannerFunctionalUnitFlatbed added in v0.17.0 

func NewScannerFunctionalUnitFlatbed() *ScannerFunctionalUnitFlatbed

NewScannerFunctionalUnitFlatbed creates a new ScannerFunctionalUnitFlatbed.

func ScannerFunctionalUnitFlatbedFromID added in v0.17.0 

func ScannerFunctionalUnitFlatbedFromID(id objc.ID) *ScannerFunctionalUnitFlatbed

ScannerFunctionalUnitFlatbedFromID adopts an existing Objective-C object as a ScannerFunctionalUnitFlatbed (nil for 0), retaining it and registering a release finalizer.

func (*ScannerFunctionalUnitFlatbed) DocumentSize added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) DocumentSize() corefoundation.CGSize

DocumentSize returns Document size of the current document type expressed in current measurement unit.

func (*ScannerFunctionalUnitFlatbed) DocumentType added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) DocumentType() ScannerDocumentType

DocumentType returns Current document type. This will always be one of the supported document types.

func (*ScannerFunctionalUnitFlatbed) SupportedDocumentTypes added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) SupportedDocumentTypes() *foundation.IndexSet

SupportedDocumentTypes returns Supported document types. The values in this set are valid values defined by ICScannerDocumentType.

func (*ScannerFunctionalUnitFlatbed) WithBitDepth added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithBitDepth(bitDepth ScannerBitDepth) *ScannerFunctionalUnitFlatbed

WithBitDepth sets The bit depth to use when performing the final scan. This will always be one of the supported bit depths.

func (*ScannerFunctionalUnitFlatbed) WithDocumentType added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithDocumentType(documentType ScannerDocumentType) *ScannerFunctionalUnitFlatbed

WithDocumentType sets Current document type. This will always be one of the supported document types.

func (*ScannerFunctionalUnitFlatbed) WithMeasurementUnit added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithMeasurementUnit(measurementUnit ScannerMeasurementUnit) *ScannerFunctionalUnitFlatbed

WithMeasurementUnit sets Current measurement unit. This will always be one of the supported measurement units.

func (*ScannerFunctionalUnitFlatbed) WithOverviewResolution added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithOverviewResolution(overviewResolution int) *ScannerFunctionalUnitFlatbed

WithOverviewResolution sets Overview image resolution. Value assigned to this will be contrained by resolutions allowed by the device.

func (*ScannerFunctionalUnitFlatbed) WithPixelDataType added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithPixelDataType(pixelDataType ScannerPixelDataType) *ScannerFunctionalUnitFlatbed

WithPixelDataType sets The pixel data type.

func (*ScannerFunctionalUnitFlatbed) WithResolution added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithResolution(resolution int) *ScannerFunctionalUnitFlatbed

WithResolution sets Current scan resolution. This will always be one of the supported resolution values.

func (*ScannerFunctionalUnitFlatbed) WithScaleFactor added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithScaleFactor(scaleFactor int) *ScannerFunctionalUnitFlatbed

WithScaleFactor sets Current scale factor. This will always be one of the supported scale factor values.

func (*ScannerFunctionalUnitFlatbed) WithScanArea added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithScanArea(scanArea corefoundation.CGRect) *ScannerFunctionalUnitFlatbed

WithScanArea sets This property along with scanAreaOrientation describes the area to be scanned.

func (*ScannerFunctionalUnitFlatbed) WithScanAreaOrientation added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithScanAreaOrientation(scanAreaOrientation EXIFOrientationType) *ScannerFunctionalUnitFlatbed

WithScanAreaOrientation sets Desired orientation of the scan area. This property along with scanArea describes the area to be scanned. This property is set to ICEXIFOrientation1 initially. This property is not used by the ICScannerFunctionalUnitDocumentFeeder subclass.

func (*ScannerFunctionalUnitFlatbed) WithThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithThresholdForBlackAndWhiteScanning(thresholdForBlackAndWhiteScanning uint8) *ScannerFunctionalUnitFlatbed

WithThresholdForBlackAndWhiteScanning sets Threshold value to be used when performing a scan in black & white. This value should be from 0 to 255.

func (*ScannerFunctionalUnitFlatbed) WithUsesThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfuf *ScannerFunctionalUnitFlatbed) WithUsesThresholdForBlackAndWhiteScanning(usesThresholdForBlackAndWhiteScanning bool) *ScannerFunctionalUnitFlatbed

WithUsesThresholdForBlackAndWhiteScanning sets Indicates if this functional unit uses threshold value to be used when performing a scan in black & white.

type ScannerFunctionalUnitNegativeTransparency added in v0.17.0 

type ScannerFunctionalUnitNegativeTransparency struct {
	ScannerFunctionalUnit
}

ScannerFunctionalUnitNegativeTransparency is an idiomatic wrapper over the Objective-C class ICScannerFunctionalUnitNegativeTransparency.

It embeds ScannerFunctionalUnit, promoting that type's methods.

An object that represents the transparency unit for scanning negatives on the scanner.

func NewScannerFunctionalUnitNegativeTransparency added in v0.17.0 

func NewScannerFunctionalUnitNegativeTransparency() *ScannerFunctionalUnitNegativeTransparency

NewScannerFunctionalUnitNegativeTransparency creates a new ScannerFunctionalUnitNegativeTransparency.

func ScannerFunctionalUnitNegativeTransparencyFromID added in v0.17.0 

func ScannerFunctionalUnitNegativeTransparencyFromID(id objc.ID) *ScannerFunctionalUnitNegativeTransparency

ScannerFunctionalUnitNegativeTransparencyFromID adopts an existing Objective-C object as a ScannerFunctionalUnitNegativeTransparency (nil for 0), retaining it and registering a release finalizer.

func (*ScannerFunctionalUnitNegativeTransparency) DocumentSize added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) DocumentSize() corefoundation.CGSize

DocumentSize returns Document size of the current document type expressed in current measurement unit.

func (*ScannerFunctionalUnitNegativeTransparency) DocumentType added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) DocumentType() ScannerDocumentType

DocumentType returns Current document type. This will always be one of the supported document types.

func (*ScannerFunctionalUnitNegativeTransparency) SupportedDocumentTypes added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) SupportedDocumentTypes() *foundation.IndexSet

SupportedDocumentTypes returns Supported document types. The values in this set are valid values defined by ICScannerDocumentType.

func (*ScannerFunctionalUnitNegativeTransparency) WithBitDepth added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithBitDepth(bitDepth ScannerBitDepth) *ScannerFunctionalUnitNegativeTransparency

WithBitDepth sets The bit depth to use when performing the final scan. This will always be one of the supported bit depths.

func (*ScannerFunctionalUnitNegativeTransparency) WithDocumentType added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithDocumentType(documentType ScannerDocumentType) *ScannerFunctionalUnitNegativeTransparency

WithDocumentType sets Current document type. This will always be one of the supported document types.

func (*ScannerFunctionalUnitNegativeTransparency) WithMeasurementUnit added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithMeasurementUnit(measurementUnit ScannerMeasurementUnit) *ScannerFunctionalUnitNegativeTransparency

WithMeasurementUnit sets Current measurement unit. This will always be one of the supported measurement units.

func (*ScannerFunctionalUnitNegativeTransparency) WithOverviewResolution added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithOverviewResolution(overviewResolution int) *ScannerFunctionalUnitNegativeTransparency

WithOverviewResolution sets Overview image resolution. Value assigned to this will be contrained by resolutions allowed by the device.

func (*ScannerFunctionalUnitNegativeTransparency) WithPixelDataType added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithPixelDataType(pixelDataType ScannerPixelDataType) *ScannerFunctionalUnitNegativeTransparency

WithPixelDataType sets The pixel data type.

func (*ScannerFunctionalUnitNegativeTransparency) WithResolution added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithResolution(resolution int) *ScannerFunctionalUnitNegativeTransparency

WithResolution sets Current scan resolution. This will always be one of the supported resolution values.

func (*ScannerFunctionalUnitNegativeTransparency) WithScaleFactor added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithScaleFactor(scaleFactor int) *ScannerFunctionalUnitNegativeTransparency

WithScaleFactor sets Current scale factor. This will always be one of the supported scale factor values.

func (*ScannerFunctionalUnitNegativeTransparency) WithScanArea added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithScanArea(scanArea corefoundation.CGRect) *ScannerFunctionalUnitNegativeTransparency

WithScanArea sets This property along with scanAreaOrientation describes the area to be scanned.

func (*ScannerFunctionalUnitNegativeTransparency) WithScanAreaOrientation added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithScanAreaOrientation(scanAreaOrientation EXIFOrientationType) *ScannerFunctionalUnitNegativeTransparency

WithScanAreaOrientation sets Desired orientation of the scan area. This property along with scanArea describes the area to be scanned. This property is set to ICEXIFOrientation1 initially. This property is not used by the ICScannerFunctionalUnitDocumentFeeder subclass.

func (*ScannerFunctionalUnitNegativeTransparency) WithThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithThresholdForBlackAndWhiteScanning(thresholdForBlackAndWhiteScanning uint8) *ScannerFunctionalUnitNegativeTransparency

WithThresholdForBlackAndWhiteScanning sets Threshold value to be used when performing a scan in black & white. This value should be from 0 to 255.

func (*ScannerFunctionalUnitNegativeTransparency) WithUsesThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfunt *ScannerFunctionalUnitNegativeTransparency) WithUsesThresholdForBlackAndWhiteScanning(usesThresholdForBlackAndWhiteScanning bool) *ScannerFunctionalUnitNegativeTransparency

WithUsesThresholdForBlackAndWhiteScanning sets Indicates if this functional unit uses threshold value to be used when performing a scan in black & white.

type ScannerFunctionalUnitPositiveTransparency added in v0.17.0 

type ScannerFunctionalUnitPositiveTransparency struct {
	ScannerFunctionalUnit
}

ScannerFunctionalUnitPositiveTransparency is an idiomatic wrapper over the Objective-C class ICScannerFunctionalUnitPositiveTransparency.

It embeds ScannerFunctionalUnit, promoting that type's methods.

An object that represents the transparency unit for scanning positives on the scanner.

func NewScannerFunctionalUnitPositiveTransparency added in v0.17.0 

func NewScannerFunctionalUnitPositiveTransparency() *ScannerFunctionalUnitPositiveTransparency

NewScannerFunctionalUnitPositiveTransparency creates a new ScannerFunctionalUnitPositiveTransparency.

func ScannerFunctionalUnitPositiveTransparencyFromID added in v0.17.0 

func ScannerFunctionalUnitPositiveTransparencyFromID(id objc.ID) *ScannerFunctionalUnitPositiveTransparency

ScannerFunctionalUnitPositiveTransparencyFromID adopts an existing Objective-C object as a ScannerFunctionalUnitPositiveTransparency (nil for 0), retaining it and registering a release finalizer.

func (*ScannerFunctionalUnitPositiveTransparency) DocumentSize added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) DocumentSize() corefoundation.CGSize

DocumentSize returns Document size of the current document type expressed in current measurement unit.

func (*ScannerFunctionalUnitPositiveTransparency) DocumentType added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) DocumentType() ScannerDocumentType

DocumentType returns Current document type. This will always be one of the supported document types.

func (*ScannerFunctionalUnitPositiveTransparency) SupportedDocumentTypes added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) SupportedDocumentTypes() *foundation.IndexSet

SupportedDocumentTypes returns Supported document types. The values in this set are valid values defined by ICScannerDocumentType.

func (*ScannerFunctionalUnitPositiveTransparency) WithBitDepth added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithBitDepth(bitDepth ScannerBitDepth) *ScannerFunctionalUnitPositiveTransparency

WithBitDepth sets The bit depth to use when performing the final scan. This will always be one of the supported bit depths.

func (*ScannerFunctionalUnitPositiveTransparency) WithDocumentType added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithDocumentType(documentType ScannerDocumentType) *ScannerFunctionalUnitPositiveTransparency

WithDocumentType sets Current document type. This will always be one of the supported document types.

func (*ScannerFunctionalUnitPositiveTransparency) WithMeasurementUnit added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithMeasurementUnit(measurementUnit ScannerMeasurementUnit) *ScannerFunctionalUnitPositiveTransparency

WithMeasurementUnit sets Current measurement unit. This will always be one of the supported measurement units.

func (*ScannerFunctionalUnitPositiveTransparency) WithOverviewResolution added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithOverviewResolution(overviewResolution int) *ScannerFunctionalUnitPositiveTransparency

WithOverviewResolution sets Overview image resolution. Value assigned to this will be contrained by resolutions allowed by the device.

func (*ScannerFunctionalUnitPositiveTransparency) WithPixelDataType added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithPixelDataType(pixelDataType ScannerPixelDataType) *ScannerFunctionalUnitPositiveTransparency

WithPixelDataType sets The pixel data type.

func (*ScannerFunctionalUnitPositiveTransparency) WithResolution added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithResolution(resolution int) *ScannerFunctionalUnitPositiveTransparency

WithResolution sets Current scan resolution. This will always be one of the supported resolution values.

func (*ScannerFunctionalUnitPositiveTransparency) WithScaleFactor added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithScaleFactor(scaleFactor int) *ScannerFunctionalUnitPositiveTransparency

WithScaleFactor sets Current scale factor. This will always be one of the supported scale factor values.

func (*ScannerFunctionalUnitPositiveTransparency) WithScanArea added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithScanArea(scanArea corefoundation.CGRect) *ScannerFunctionalUnitPositiveTransparency

WithScanArea sets This property along with scanAreaOrientation describes the area to be scanned.

func (*ScannerFunctionalUnitPositiveTransparency) WithScanAreaOrientation added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithScanAreaOrientation(scanAreaOrientation EXIFOrientationType) *ScannerFunctionalUnitPositiveTransparency

WithScanAreaOrientation sets Desired orientation of the scan area. This property along with scanArea describes the area to be scanned. This property is set to ICEXIFOrientation1 initially. This property is not used by the ICScannerFunctionalUnitDocumentFeeder subclass.

func (*ScannerFunctionalUnitPositiveTransparency) WithThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithThresholdForBlackAndWhiteScanning(thresholdForBlackAndWhiteScanning uint8) *ScannerFunctionalUnitPositiveTransparency

WithThresholdForBlackAndWhiteScanning sets Threshold value to be used when performing a scan in black & white. This value should be from 0 to 255.

func (*ScannerFunctionalUnitPositiveTransparency) WithUsesThresholdForBlackAndWhiteScanning added in v0.17.0 

func (sfupt *ScannerFunctionalUnitPositiveTransparency) WithUsesThresholdForBlackAndWhiteScanning(usesThresholdForBlackAndWhiteScanning bool) *ScannerFunctionalUnitPositiveTransparency

WithUsesThresholdForBlackAndWhiteScanning sets Indicates if this functional unit uses threshold value to be used when performing a scan in black & white.

type ScannerFunctionalUnitProvider added in v0.17.0 

type ScannerFunctionalUnitProvider interface {
	objref.Object
	// contains filtered or unexported methods
}

ScannerFunctionalUnitProvider is accepted wherever a ICScannerFunctionalUnit (or one of its subclasses) is expected.

type ScannerFunctionalUnitState added in v0.17.0 

type ScannerFunctionalUnitState uint64

Flags to indicate the state of the scanner functional unit. 

const (
	// A flag indicating that the functional unit is ready for operation.
	ScannerFunctionalUnitStateReady ScannerFunctionalUnitState = 1
	// A flag indicating that the functional unit is performing a scan.
	ScannerFunctionalUnitStateScanInProgress ScannerFunctionalUnitState = 2
	// A flag indicating that the functional unit is performing an overview scan.
	ScannerFunctionalUnitStateOverviewScanInProgress ScannerFunctionalUnitState = 4
)

func (ScannerFunctionalUnitState) String added in v0.17.0 

func (e ScannerFunctionalUnitState) String() string

String returns the ScannerFunctionalUnitState constant's name, or its numeric form when the value is not a known constant.

type ScannerFunctionalUnitType added in v0.17.0 

type ScannerFunctionalUnitType uint64

The types of scanner functional units. 

const (
	// A flatbed functional unit.
	ScannerFunctionalUnitTypeFlatbed ScannerFunctionalUnitType = 0
	// A transparency functional unit for scanning positives.
	ScannerFunctionalUnitTypePositiveTransparency ScannerFunctionalUnitType = 1
	// A transparency functional unit for scanning negatives.
	ScannerFunctionalUnitTypeNegativeTransparency ScannerFunctionalUnitType = 2
	// A document feeder functional unit.
	ScannerFunctionalUnitTypeDocumentFeeder ScannerFunctionalUnitType = 3
)

func (ScannerFunctionalUnitType) String added in v0.17.0 

func (e ScannerFunctionalUnitType) String() string

String returns the ScannerFunctionalUnitType constant's name, or its numeric form when the value is not a known constant.

type ScannerMeasurementUnit added in v0.17.0 

type ScannerMeasurementUnit uint64

The unit of measurement used by the scanner. 

const (
	ScannerMeasurementUnitInches      ScannerMeasurementUnit = 0
	ScannerMeasurementUnitCentimeters ScannerMeasurementUnit = 1
	ScannerMeasurementUnitPicas       ScannerMeasurementUnit = 2
	ScannerMeasurementUnitPoints      ScannerMeasurementUnit = 3
	ScannerMeasurementUnitTwips       ScannerMeasurementUnit = 4
	ScannerMeasurementUnitPixels      ScannerMeasurementUnit = 5
)

func (ScannerMeasurementUnit) String added in v0.17.0 

func (e ScannerMeasurementUnit) String() string

String returns the ScannerMeasurementUnit constant's name, or its numeric form when the value is not a known constant.

type ScannerPixelDataType added in v0.17.0 

type ScannerPixelDataType uint64

The pixel data types. 

const (
	ScannerPixelDataTypeBW      ScannerPixelDataType = 0
	ScannerPixelDataTypeGray    ScannerPixelDataType = 1
	ScannerPixelDataTypeRGB     ScannerPixelDataType = 2
	ScannerPixelDataTypePalette ScannerPixelDataType = 3
	ScannerPixelDataTypeCMY     ScannerPixelDataType = 4
	ScannerPixelDataTypeCMYK    ScannerPixelDataType = 5
	ScannerPixelDataTypeYUV     ScannerPixelDataType = 6
	ScannerPixelDataTypeYUVK    ScannerPixelDataType = 7
	ScannerPixelDataTypeCIEXYZ  ScannerPixelDataType = 8
)

func (ScannerPixelDataType) String added in v0.17.0 

func (e ScannerPixelDataType) String() string

String returns the ScannerPixelDataType constant's name, or its numeric form when the value is not a known constant.

type ScannerTransferMode added in v0.17.0 

type ScannerTransferMode uint64

The modes for transferring scan data from the scanner functional unit. 

const (
	// The mode for transferring the scan as a file.
	ScannerTransferModeFileBased ScannerTransferMode = 0
	// The mode for transferring the scan as data.
	ScannerTransferModeMemoryBased ScannerTransferMode = 1
)

func (ScannerTransferMode) String added in v0.17.0 

func (e ScannerTransferMode) String() string

String returns the ScannerTransferMode constant's name, or its numeric form when the value is not a known constant.

type Tag added in v0.17.0 

type Tag int32
const (
	TagUndefinedTag  Tag = 0
	TagExtendedAllow Tag = 1
	TagExtendedDeny  Tag = 2
)

func (Tag) String added in v0.17.0 

func (e Tag) String() string

String returns the Tag constant's name, or its numeric form when the value is not a known constant.

type Type added in v0.17.0 

type Type int32
const (
	TypeExtended Type = 256
	TypeAccess   Type = 0
	TypeDefault  Type = 1
	TypeAfs      Type = 2
	TypeCoda     Type = 3
	TypeNtfs     Type = 4
	TypeNwfs     Type = 5
)

func (Type) String added in v0.17.0 

func (e Type) String() string

String returns the Type constant's name, or its numeric form when the value is not a known constant.

type VirtualMemoryGuardExceptionCode added in v0.17.0 

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

func (VirtualMemoryGuardExceptionCode) String added in v0.17.0 

func (e VirtualMemoryGuardExceptionCode) String() string

String returns the VirtualMemoryGuardExceptionCode constant's name, or its numeric form when the value is not a known constant.

type XpcListenerCreateFlags added in v0.17.0 

type XpcListenerCreateFlags uint64

Bitmask — values may be combined with |. 

const (
	XpcListenerCreateFlagsNone            XpcListenerCreateFlags = 0
	XpcListenerCreateFlagsInactive        XpcListenerCreateFlags = 1
	XpcListenerCreateFlagsForceMach       XpcListenerCreateFlags = 2
	XpcListenerCreateFlagsForceXpcservice XpcListenerCreateFlags = 4
)

func (XpcListenerCreateFlags) String added in v0.17.0 

func (e XpcListenerCreateFlags) String() string

String returns the XpcListenerCreateFlags constant's name, or its numeric form when the value is not a known constant.

type XpcSessionCreateFlags added in v0.17.0 

type XpcSessionCreateFlags uint64

Bitmask — values may be combined with |. 

const (
	XpcSessionCreateFlagsNone           XpcSessionCreateFlags = 0
	XpcSessionCreateFlagsInactive       XpcSessionCreateFlags = 1
	XpcSessionCreateFlagsMachPrivileged XpcSessionCreateFlags = 2
)

func (XpcSessionCreateFlags) String added in v0.17.0 

func (e XpcSessionCreateFlags) String() string

String returns the XpcSessionCreateFlags constant's name, or its numeric form when the value is not a known constant.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.