merged master; fixed tests
Christoph Oberhofer
9 years ago
commit
e7c62221c1
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
@ -0,0 +1,478 @@
|
||||
// Type definitions for QuaggaJS v2015.05.20 Project:
|
||||
// http://serratus.github.io/quaggaJS/ Definitions by: Cam Birch, Peter
|
||||
// Horwood aka Madman Pierre
|
||||
|
||||
declare var Quagga: QuaggaJSStatic;
|
||||
export default Quagga;
|
||||
|
||||
interface QuaggaJSStatic {
|
||||
/**
|
||||
* This method initializes the library for a given
|
||||
* configuration config (see below) and invokes the callback when Quagga is
|
||||
* ready to start. The initialization process also requests for camera
|
||||
* access if real-time detection is configured.
|
||||
*/
|
||||
init(
|
||||
config: QuaggaJSConfigObject,
|
||||
callback?: (err: any) => void
|
||||
): void;
|
||||
|
||||
init(
|
||||
config: QuaggaJSConfigObject,
|
||||
callback: (err: any) => void,
|
||||
imageWrapper: any
|
||||
): void;
|
||||
|
||||
/**
|
||||
* When the library is initialized, the start()
|
||||
* method starts the video-stream and begins locating and decoding the
|
||||
* images.
|
||||
*/
|
||||
start(): void;
|
||||
|
||||
/**
|
||||
* If the decoder is currently running, after calling
|
||||
* stop() the decoder does not process any more images.
|
||||
* Additionally, if a camera-stream was requested upon initialization,
|
||||
* this operation also disconnects the camera.
|
||||
*/
|
||||
stop(): void;
|
||||
|
||||
/**
|
||||
* Pauses processing, but does not release any handlers
|
||||
*/
|
||||
pause(): void;
|
||||
|
||||
/**
|
||||
* This method registers a callback(data) function that is
|
||||
* called for each frame after the processing is done. The data object
|
||||
* contains detailed information about the success/failure of the operation.
|
||||
* The output varies, depending whether the detection and/or decoding were
|
||||
* successful or not.
|
||||
*/
|
||||
onProcessed(callback: QuaggaJSResultCallbackFunction): void;
|
||||
|
||||
/**
|
||||
* Removes a callback that was previously registered with @see onProcessed
|
||||
*/
|
||||
offProcessed(callback: QuaggaJSResultCallbackFunction): void;
|
||||
|
||||
/**
|
||||
* Registers a callback(data) function which is triggered whenever a
|
||||
* barcode- pattern has been located and decoded successfully. The passed
|
||||
* data object contains information about the decoding process including the
|
||||
* detected code which can be obtained by calling data.codeResult.code.
|
||||
*/
|
||||
onDetected(callback: QuaggaJSResultCallbackFunction): void;
|
||||
|
||||
/**
|
||||
* Removes a callback that was previously registered with @see onDetected
|
||||
*/
|
||||
offDetected(callback: QuaggaJSResultCallbackFunction): void;
|
||||
|
||||
ResultCollector: QuaggaJSResultCollector;
|
||||
registerResultCollector(resultCollector: QuaggaJSResultCollector): void;
|
||||
setReaders(readers: any): void;
|
||||
|
||||
/**
|
||||
* In contrast to the calls described
|
||||
* above, this method does not rely on getUserMedia and operates on a single
|
||||
* image instead. The provided callback is the same as in onDetected and
|
||||
* contains the result data object.
|
||||
*/
|
||||
decodeSingle(
|
||||
config: QuaggaJSConfigObject,
|
||||
resultCallback: QuaggaJSResultCallbackFunction
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Constructs used for debugging purposes
|
||||
*/
|
||||
ImageDebug: {
|
||||
drawPath: QuaggaJSDebugDrawPath;
|
||||
drawRect: QuaggaJSDebugDrawRect;
|
||||
};
|
||||
ImageWrapper: any;
|
||||
|
||||
/**
|
||||
* an object Quagga uses for drawing and processing, useful for calling code
|
||||
* when debugging
|
||||
*/
|
||||
canvas: {
|
||||
ctx: {
|
||||
image: CanvasRenderingContext2D;
|
||||
overlay: CanvasRenderingContext2D
|
||||
};
|
||||
dom: {
|
||||
image: HTMLCanvasElement;
|
||||
overlay: HTMLCanvasElement
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Called whenever an item is detected or a process step has been completed.
|
||||
*/
|
||||
interface QuaggaJSResultCallbackFunction {
|
||||
(
|
||||
data: QuaggaJSResultObject
|
||||
): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Called to draw debugging path. The path is an array of array of 2 numbers.
|
||||
* The def.x specifies element in the sub array is the x, and similary the def.y
|
||||
* defines the y.
|
||||
* typical values 0, 1, 'x', 'y'
|
||||
*/
|
||||
interface QuaggaJSDebugDrawPath {
|
||||
(
|
||||
path: any[],
|
||||
def: QuaggaJSxyDef,
|
||||
ctx: CanvasRenderingContext2D,
|
||||
style: QuaggaJSStyle
|
||||
): void
|
||||
}
|
||||
|
||||
/**
|
||||
* Called to draw debugging Rectangle
|
||||
*/
|
||||
interface QuaggaJSDebugDrawRect {
|
||||
(
|
||||
pos: any[],
|
||||
size: QuaggaJSRectSize,
|
||||
ctx: CanvasRenderingContext2D,
|
||||
style: QuaggaJSStyle
|
||||
): void
|
||||
}
|
||||
|
||||
/**
|
||||
* an object with an x and a y value, the x and y specify which element in
|
||||
* another array is the x or y value.
|
||||
* typical values 0, 1, 'x', 'y'
|
||||
*/
|
||||
interface QuaggaJSxyDef {
|
||||
x: any;
|
||||
y: any;
|
||||
}
|
||||
|
||||
/**
|
||||
* an object with an x and a y value
|
||||
*/
|
||||
interface QuaggaJSxy {
|
||||
x: number;
|
||||
y: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* an object with a pair of x and a y values.
|
||||
* Used for giving a htiml canvas context.strokeRect function it's x, y, width
|
||||
* and height values.
|
||||
*/
|
||||
interface QuaggaJSRectSize {
|
||||
pos: QuaggaJSxy;
|
||||
size: QuaggaJSxy;
|
||||
}
|
||||
|
||||
/**
|
||||
* an object with the styles, color can actually be a color, a gradient or a
|
||||
* pattern (see defintions for context.strokeStyle. But is most commonly a
|
||||
* colour.
|
||||
*/
|
||||
interface QuaggaJSStyle {
|
||||
color: string;
|
||||
|
||||
/* http://www.w3schools.com/tags/canvas_linewidth.asp */
|
||||
lineWidth: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pass when creating a ResultCollector
|
||||
*/
|
||||
interface QuaggaJSResultCollector {
|
||||
/**
|
||||
* keep track of the image producing this result
|
||||
*/
|
||||
capture?: boolean;
|
||||
|
||||
/**
|
||||
* maximum number of results to store
|
||||
*/
|
||||
capacity?: number;
|
||||
|
||||
/**
|
||||
* a list of codes that should not be recorded. This is effectively a list
|
||||
* of filters that return false.
|
||||
*/
|
||||
blacklist?: QuaggaJSCodeResult;
|
||||
|
||||
/**
|
||||
* passed a QuaggaJSCodeResult, return true if you want this to be stored,
|
||||
* false if you don't. Note: The black list is effectively a list of filters
|
||||
* that return false. So if you only want to store results that are ean_13,
|
||||
* you would say return codeResult.format==="ean_13"
|
||||
*/
|
||||
filter?: QuaggaJSResultCollectorFilterFunction;
|
||||
|
||||
/*
|
||||
* a static function that returns you a ResultCollector
|
||||
*/
|
||||
create?(QuaggaJSResultCollector): QuaggaJSResultCollector;
|
||||
|
||||
getResults?(): QuaggaJSCodeResult[];
|
||||
}
|
||||
|
||||
/**
|
||||
* used for ResultCollector blacklists and filters
|
||||
*/
|
||||
interface QuaggaJSCodeResult {
|
||||
code?: string;
|
||||
format?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Called to filter which Results to collect in ResultCollector
|
||||
*/
|
||||
interface QuaggaJSResultCollectorFilterFunction {
|
||||
(
|
||||
data: QuaggaJSCodeResult
|
||||
): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* The callbacks passed into onProcessed, onDetected and decodeSingle receive a
|
||||
* data object upon execution. The data object contains the following
|
||||
* information. Depending on the success, some fields may be undefined or just
|
||||
* empty.
|
||||
*/
|
||||
interface QuaggaJSResultObject {
|
||||
codeResult: QuaggaJSResultObject_CodeResult;
|
||||
line: {
|
||||
x: number;
|
||||
y: number;
|
||||
}[];
|
||||
angle: number;
|
||||
pattern: number[];
|
||||
box: number[][];
|
||||
boxes: number[][][];
|
||||
}
|
||||
|
||||
interface QuaggaJSResultObject_CodeResult {
|
||||
code: string;
|
||||
start: number;
|
||||
end: number;
|
||||
codeset: number;
|
||||
startInfo: {
|
||||
error: number;
|
||||
code: number;
|
||||
start: number;
|
||||
end: number;
|
||||
};
|
||||
decodedCodes: {
|
||||
error?: number;
|
||||
code: number;
|
||||
start: number;
|
||||
end: number;
|
||||
}[];
|
||||
|
||||
endInfo: {
|
||||
error: number;
|
||||
code: number;
|
||||
start: number;
|
||||
end: number;
|
||||
};
|
||||
direction: number;
|
||||
format: string;
|
||||
}
|
||||
|
||||
interface QuaggaJSConfigObject {
|
||||
/**
|
||||
* The image path to load from, or a data url
|
||||
* Ex: '/test/fixtures/code_128/image-001.jpg'
|
||||
* or: 'data:image/jpg;base64,' + data
|
||||
*/
|
||||
src?: string; inputStream?: {
|
||||
/**
|
||||
* @default "Live"
|
||||
*/
|
||||
name?: string;
|
||||
|
||||
/**
|
||||
* @default "LiveStream"
|
||||
*/
|
||||
type?: string;
|
||||
|
||||
constraints?: {
|
||||
/**
|
||||
* @default 640
|
||||
*/
|
||||
width?: number;
|
||||
|
||||
/**
|
||||
* @default 480
|
||||
*/
|
||||
height?: number;
|
||||
|
||||
/**
|
||||
* In cases where height/width does not suffice
|
||||
*/
|
||||
aspectRatio?: number
|
||||
|
||||
/**
|
||||
* @default "environment"
|
||||
*/
|
||||
facingMode?: string;
|
||||
|
||||
/**
|
||||
* Explicitly set the camera to the user's choice
|
||||
*/
|
||||
deviceId?: string
|
||||
};
|
||||
|
||||
/**
|
||||
* defines rectangle of the detection/localization area. Useful when you
|
||||
* KNOW that certain parts of the image will not contain a barcode, also
|
||||
* useful when you have multiple barcodes in a row and you want to make
|
||||
* sure that only a code in, say the middle quarter is read not codes
|
||||
* above or below
|
||||
*/
|
||||
area?: {
|
||||
/**
|
||||
* @default "0%", set this and bottom to 25% if you only want to
|
||||
* read a 'line' that is in the middle quarter
|
||||
*/
|
||||
top?: string;
|
||||
|
||||
/**
|
||||
* @default "0%"
|
||||
*/
|
||||
right?: string;
|
||||
|
||||
/**
|
||||
* @default "0%"
|
||||
*/
|
||||
left?: string;
|
||||
|
||||
/**
|
||||
* @default "0%", set this and top to 50% if you only want to read a
|
||||
* 'line' that is in the middle half
|
||||
*/
|
||||
bottom?: string;
|
||||
};
|
||||
|
||||
singleChannel?: boolean;
|
||||
size?: number;
|
||||
sequence?: boolean;
|
||||
};
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
debug?: boolean;
|
||||
|
||||
/**
|
||||
* @default true
|
||||
*/
|
||||
locate?: boolean;
|
||||
|
||||
/**
|
||||
* @default 4
|
||||
*/
|
||||
numOfWorkers?: number;
|
||||
|
||||
decoder?: {
|
||||
/**
|
||||
* @default [ "code_128_reader" ]
|
||||
*/
|
||||
readers?: string[];
|
||||
|
||||
debug?: {
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
drawBoundingBox?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showFrequency?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
drawScanline?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showPattern?: boolean;
|
||||
}
|
||||
};
|
||||
|
||||
locator?: {
|
||||
/**
|
||||
* @default true
|
||||
*/
|
||||
halfSample?: boolean;
|
||||
|
||||
/**
|
||||
* @default "medium"
|
||||
* Available values: x-small, small, medium, large, x-large
|
||||
*/
|
||||
patchSize?: string;
|
||||
|
||||
debug?: {
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showCanvas?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showPatches?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showFoundPatches?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showSkeleton?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showLabels?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showPatchLabels?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showRemainingPatchLabels?: boolean;
|
||||
|
||||
boxFromPatches?: {
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showTransformed?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showTransformedBox?: boolean;
|
||||
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
showBB?: boolean;
|
||||
};
|
||||
}
|
||||
};
|
||||
}
|
||||
Loading…
Reference in New Issue