Request Frame

REQUEST_FRAME

Used to request a single image frame during an Imager Frames Streaming workflow.

Note: This command is functional only when the Imager Frames Streaming workflow is in the CAPTURING_STARTED state from the Register for Notification API.

Function Prototype

    Intent i = new Intent();
    i.setAction("com.symbol.datawedge.api.ACTION");
    i.setPackage("com.symbol.datawedge");
    i.putExtra("com.symbol.datawedge.api.REQUEST_FRAME", "");
    i.setFlags(Intent.FLAG_RECEIVER_FOREGROUND); 
    mContext.sendBroadcast(i);

Parameters

ACTION [String]: "com.symbol.datawedge.api.ACTION"

EXTRA_DATA [String]: "com.symbol.datawedge.api.REQUEST_FRAME"

EXTRA VALUE[string]: Empty string

Result Codes

DataWedge returns the following error codes if the app includes the intent extras SEND_RESULT and COMMAND_IDENTIFIER to enable the app to get results using the DataWedge result intent mechanism. See Example, below.

• DATAWEDGE_DISABLED - FAILURE
• FEATURE_NOT_SUPPORTED - FAILURE
• PROFILE_DISABLED - FAILURE
• WORKFLOW_IN_INVALID_STATE - FAILURE

Also see the Result Codes guide for more information.

Example Code

    Intent i = new Intent();
    i.setAction("com.symbol.datawedge.api.ACTION");
    i.setPackage("com.symbol.datawedge");
    i.putExtra("com.symbol.datawedge.api.REQUEST_FRAME", "");
    i.setFlags(Intent.FLAG_RECEIVER_FOREGROUND);
    i.putExtra("SEND_RESULT","LAST_RESULT");
    i.putExtra("COMMAND_IDENTIFIER","<Command Identifier>");
    mContext.sendBroadcast(i);

Handling image frame data and barcode data is identical to Free-Form OCR. For an example, refer to the Workflow Input Programmer's Guide.

SEE ALSO:

Zebra Support Central | Integrator Guides, Product Manuals, Software Downloads and Support

LaunchPad | Zebra Developer Community

Intent | Android Developers

Intents and Intent Filters | Android Developers

Android Intents | Tutorial