Other Type Definitions

The following type definitions are available globally.

  • These option values correspond to the frame retention option for readers.

    Declaration

    Objective-C

    typedef NSUInteger DMSReaderFrameRetentionOption

    Swift

    struct ReaderFrameRetentionOption : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

Image Reader Options

  • The available strategies to use with an image reader. Strategies control how many frames are processed and how efficient a reader will be.

    Declaration

    Objective-C

    typedef NSInteger DMSImageDetectionType

    Swift

    struct ImageDetectionType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  • Defines the possible representations that can be derived from a payload.

    Declaration

    Objective-C

    typedef NS_EXTENSIBLE_STRING_ENUM NSString *DMSPayloadRepresentationType

    Swift

    struct PayloadRepresentationType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  • Defines the options that can be used with a reader.

    Declaration

    Objective-C

    typedef NS_EXTENSIBLE_STRING_ENUM NSString *DMSReaderOptionKey

    Swift

    struct ReaderOptionKey : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  • Undocumented

    Declaration

    Objective-C

    NS_SWIFT_NAME(ReaderErrorUserInfoKey)
/// Defines the keys for userinfo returned by a reader result
typedef NSString * DMSReaderErrorUserInfoKey

    Swift

    struct ReaderErrorUserInfoKey : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  • Undocumented

    Declaration

    Objective-C

    __attribute__((swift_name("ResultMetadataType")))
/// Defines the options that can be used with a reader.
typedef NSString * _Nonnull DMSResultMetadataType

    Swift

    struct ResultMetadataType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  • Defines the options that can be used with a resolver.

    Declaration

    Objective-C

    typedef NS_EXTENSIBLE_STRING_ENUM NSString *DMSResolverOptionKey

    Swift

    struct ResolverOptionKey : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  • Block called on completion of a resolve.

    Declaration

    Objective-C

    typedef void (^DMSResolveCompletionBlock)(DMSResolvedContent *_Nullable,
                                          NSError *_Nullable)

    Swift

    typealias ResolveCompletionBlock = (ResolvedContent?, (any Error)?) -> Void

    Parameters

    resolvedContent

    The DMSResolvedContent wrapping incoming DMSPayload, resulting DMSResolvedContent, and status information.
    error

    Error code if resolve query failed.