capacitor-plugin-scanbot-barcode-scanner-sdk
    Preparing search index...

    Class ImageRefProfile

    ImageRef profile which provides detailed information about stored object.

    Index

    Constructors

    Properties

    Methods

    Constructors

    • Parameters

      • Optionalsource: DeepPartial<ImageRefProfile>

      Returns ImageRefProfile

    Properties

    imageInfo: ImageProfile

    Image-specific information, e.g. memory consumption.

    imageSource: ImageSource | null

    Description of source from which the ImageRef was created. Non-null only if detailed profiling has been previously enabled by a call to enableDetailedProfiling.

    Information about the strong and serialized references to the image.

    Methods

    • Parameters

      Returns {
          imageInfo?: {
              bitmapMemoryConsumption?: number;
              hibernationMemoryConsumption?: number;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { bitmapMemoryConsumption?: number | undefined; hibernationMemoryConsumption?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          };
          imageSource?: | {
              filePath?: string
              | null;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => {
                  filePath?: string | null;
                  serialize?: ((config?: ToJsonConfiguration | undefined) => { type?: ImageSourceType | undefined; filePath?: string | null | undefined; serialize?: ... | undefined; }) | undefined;
                  type?: ImageSourceType;
              };
              type?: ImageSourceType;
          } & {}
          | null;
          refInfo?: {
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly uniqueId?: string | undefined; readonly timestampCreated?: number | undefined; readonly strongReferences?: number | undefined; readonly serializedReferences?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              serializedReferences?: number;
              strongReferences?: number;
              timestampCreated?: number;
              uniqueId?: string;
          };
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { refInfo?: { readonly uniqueId?: string | undefined; readonly timestampCreated?: number | undefined; readonly strongReferences?: number | undefined; readonly serializedReferences?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; imageInfo?: { ...; } | ...;
      }

      • OptionalimageInfo?: {
            bitmapMemoryConsumption?: number;
            hibernationMemoryConsumption?: number;
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { bitmapMemoryConsumption?: number | undefined; hibernationMemoryConsumption?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
        }

        Image-specific information, e.g. memory consumption.

        • OptionalbitmapMemoryConsumption?: number

          Memory consumption of a memory-backed bitmap. Zero, if the image is hibernating.

          Default is 0

        • OptionalhibernationMemoryConsumption?: number

          Memory consumption of the hibernation buffer. Zero, if the image is not hibernating, or is hibernated to a file.

          Default is 0

        • Optionalserialize?: (
              config?: ToJsonConfiguration,
          ) => { bitmapMemoryConsumption?: number | undefined; hibernationMemoryConsumption?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }
      • OptionalimageSource?:
            | {
                filePath?: string
                | null;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => {
                    filePath?: string | null;
                    serialize?: ((config?: ToJsonConfiguration | undefined) => { type?: ImageSourceType | undefined; filePath?: string | null | undefined; serialize?: ... | undefined; }) | undefined;
                    type?: ImageSourceType;
                };
                type?: ImageSourceType;
            } & {}
            | null

        Description of source from which the ImageRef was created. Non-null only if detailed profiling has been previously enabled by a call to enableDetailedProfiling.

      • OptionalrefInfo?: {
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly uniqueId?: string | undefined; readonly timestampCreated?: number | undefined; readonly strongReferences?: number | undefined; readonly serializedReferences?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            serializedReferences?: number;
            strongReferences?: number;
            timestampCreated?: number;
            uniqueId?: string;
        }

        Information about the strong and serialized references to the image.

        • Optionalserialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly uniqueId?: string | undefined; readonly timestampCreated?: number | undefined; readonly strongReferences?: number | undefined; readonly serializedReferences?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }
        • Optional ReadonlyserializedReferences?: number

          Number of serialized references to the object. The serialized reference count increases when an ImageRef is written to JSON or a Parcel on Android and decrease when the respective JSON or Parcel is deserialized.

          Default is 0

        • Optional ReadonlystrongReferences?: number

          Number of strong references associated with the object. The strong reference count increases when a new instance of a platform ImageRef class is created from the object's unique ID and decreases when the ImageRef instance is destroyed.

          Default is 0

        • Optional ReadonlytimestampCreated?: number

          Timestamp (milliseconds since the UNIX epoch), at which the object was first created.

        • Optional ReadonlyuniqueId?: string

          Unique ID of the object.

      • Optionalserialize?: (
            config?: ToJsonConfiguration,
        ) => { refInfo?: { readonly uniqueId?: string | undefined; readonly timestampCreated?: number | undefined; readonly strongReferences?: number | undefined; readonly serializedReferences?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; imageInfo?: { ...; } | ...