.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "ZBar::Processor 3pm" .TH ZBar::Processor 3pm 2024-02-06 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Barcode::ZBar::Processor \- self\-contained bar code reader .SH SYNOPSIS .IX Header "SYNOPSIS" setup: .PP .Vb 1 \& use Barcode::ZBar; \& \& my $reader = Barcode::ZBar::Processor\->new(); \& $reader\->init("/dev/video1", 1); \& $reader\->parse_config(\*(Aqcode39.disable\*(Aq); \& $reader\->set_data_handler(\e&my_handler); .Ve .PP scan an image: .PP .Vb 1 \& $reader\->process_image($image); .Ve .PP scan from video: .PP .Vb 3 \& $reader\->set_visible(); \& $reader\->set_active(); \& $reader\->user_wait(); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" A Barcode::ZBar::Processor may be used to quickly create stand-alone bar code scanning applications. It has interfaces to scan images or video and to optionally display a video/image preview to a window. .PP This interface is not well suited for integration with an existing GUI, as the library manages the optional preview window and any user interaction. Use a Barcode::ZBar::ImageScanner or Investigate the available widget interfaces for GUI applications. .SH REFERENCE .IX Header "REFERENCE" .SS Methods .IX Subsection "Methods" .IP \fBnew()\fR 4 .IX Item "new()" Create a new bar code reader instance. .IP "init([\fIvideo_device\fR], [\fIenable_display\fR])" 4 .IX Item "init([video_device], [enable_display])" Open a video input device and/or prepare to display output. .IP "set_data_handler([\fIhandler\fR], [\fIclosure\fR])" 4 .IX Item "set_data_handler([handler], [closure])" Setup a callback to process results whenever new results are available from the video stream or a static image. The specified callable will be invoked with the associated Barcode::ZBar::Processor object and \&\fIclosure\fR as arguments. Closure may be achieved either using standard Perl closure or by manually passing a scalar via \fIclosure\fR. .IP \fBis_visible()\fR 4 .IX Item "is_visible()" .PD 0 .IP set_visible([\fIvisible\fR]) 4 .IX Item "set_visible([visible])" .PD Test/set visibility of the output window. .IP set_active([\fIactive\fR]) 4 .IX Item "set_active([active])" Enable/disable video streaming and scanning for bar codes. .IP \fBget_results()\fR 4 .IX Item "get_results()" Return a list of Barcode::ZBar::Symbol results from the last scanned image or video frame. .IP user_wait([\fItimeout\fR]) 4 .IX Item "user_wait([timeout])" Wait for the user to press a key/button or close the window. Bar codes will continue to be processed if video is active. .IP process_one([\fItimeout\fR]) 4 .IX Item "process_one([timeout])" Enable video and scan until at least one barcode is found. Note that multiple results may still be returned. .IP process_image([\fIimage\fR]) 4 .IX Item "process_image([image])" Scan a Barcode::ZBar::Image for bar codes. .IP parse_config(\fIconfigstr\fR) 4 .IX Item "parse_config(configstr)" Apply a decoder configuration setting. See the documentation for \&\f(CW\*(C`zbarcam\*(C'\fR/\f(CW\*(C`zbarimg\*(C'\fR for available configuration options. .IP "request_size(\fIwidth\fR, \fIheight\fR)" 4 .IX Item "request_size(width, height)" Request a preferred size for the video image from the device. The request may be adjusted or completely ignored by the driver. Must be called before \f(CWinit()\fR .IP "force_format(\fIinput\fR, \fIoutput\fR)" 4 .IX Item "force_format(input, output)" force specific input and output formats for debug/testing. .IP "set_config(\fIsymbology\fR, \fIconfig\fR, \fIvalue\fR)" 4 .IX Item "set_config(symbology, config, value)" Set config for indicated symbology (0 for all) to specified value. \&\f(CW@returns\fR 0 for success, non\-0 for failure (config does not apply to specified symbology, or value out of range) .SH "SEE ALSO" .IX Header "SEE ALSO" Barcode::ZBar, Barcode::ZBar::Image, Barcode::ZBar::ImageScanner .PP \&\fBzbarimg\fR\|(1), \fBzbarcam\fR\|(1) .PP http://zbar.sf.net .SH AUTHOR .IX Header "AUTHOR" Jeff Brown, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2008\-2010 (c) Jeff Brown .PP The ZBar Bar Code Reader is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.