com.upek.android.ptapi.callback
Class PtStdGuiStateCallback

java.lang.Object
  extended by com.upek.android.ptapi.callback.PtStdGuiStateCallback
All Implemented Interfaces:
PtGuiStateCallback, java.io.Serializable

public class PtStdGuiStateCallback
extends java.lang.Object
implements PtGuiStateCallback, java.io.Serializable

This class represents standard PT_GUI_STATE_CALLBACK provided by PtApi. It doesn't implement any functionality, it only serves for internal purpose during method setPtConneciton.GuiCallback(), which if get this class, then sets callback to standard native function from PtApi.

See Also:
Serialized Form

Constructor Summary
PtStdGuiStateCallback()
           
 
Method Summary
 byte guiStateCallbackInvoke(int guiState, int message, byte progress, PtGuiSampleImage sampleBuffer, byte[] data)
          Invoke callback function of this interface.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PtStdGuiStateCallback

public PtStdGuiStateCallback()
Method Detail

guiStateCallbackInvoke

public byte guiStateCallbackInvoke(int guiState,
                                   int message,
                                   byte progress,
                                   PtGuiSampleImage sampleBuffer,
                                   byte[] data)
                            throws PtException
Description copied from interface: PtGuiStateCallback
Invoke callback function of this interface.

Specified by:
guiStateCallbackInvoke in interface PtGuiStateCallback
Parameters:
guiState - A bitmask indicating the current GUI state plus an indication of what others parameters are available. It can be combined from values PT_SAMPLE_AVAILABLE, PT_MESSAGE_PROVIDED and PT_PROGRESS_PROVIDED. In the current implementation only PT_MESSAGE_PROVIDED is used.
message - The number of a message to display to the user. For message numbers see PT_GUIMSG_XXXX. GuiState indicates if a Message is provided; if not the parameter is 0.
progress - A Value that indicates (as a percentage) the amount of progress in the development of a Sample/BIR. The value may be used to display a progress bar. GuiState indicates if a sample Progress value is provided in the call; if not the parameter is 0. This parameter is reserved for future use, currently it is always 0.
sampleBuffer - The current sample buffer for the application to display. GuiState indicates if a sample Buffer is provided; if not the parameter is NULL. This parameter is reserved for future use, currently it is always NULL.
data - Optional data, which may be available for some GUI message codes. If no data is provided the parameter is NULL.
Returns:
The response from the application back to the PerfectTrust Proxy API on return from the callback. Can be one of values PT_CANCEL or PT_CONTINUE. Other values are reserved for future use. (Corresponds with parameter pbyResponse in original function)
Throws:
PtException - Error code of fail, if any was occurred.