palio.modules
Class FrameGrabber

java.lang.Object
  palio.modules.core.Module
      palio.modules.FrameGrabber

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public class FrameGrabber
extends palio.modules.core.Module

Frame grabber module is responsible for grabbing and saving to database an video frame.

Field Summary

Fields inherited from interface palio.modules.core.CurrentModuleDataKeys

DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT

Constructor Summary

FrameGrabber(palio.Instance instance, java.util.Properties properties)

Method Summary

java.lang.String	getVersion() Returns the module version
void	saveFrame(java.lang.Long materialId, java.lang.String timeCode, java.lang.String name, java.lang.String desc, int width, int height, java.lang.Long userId) Grabs and saves to database an frame.
void	saveFrame(java.lang.Long materialId, java.lang.String timeCode, java.lang.String name, java.lang.String desc, java.lang.Long userId) Grabs and saves to database an frame.

Methods inherited from class palio.modules.core.Module

getConfigParam, getDescription, getModuleTranslation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FrameGrabber

public FrameGrabber(palio.Instance instance,
                    java.util.Properties properties)
             throws palio.PalioException

Parameters:

instance - Module instance.

properties - Initial module properties.

Throws:

palio.PalioException - Module init error.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from class: palio.modules.core.Module

Returns the module version

Specified by:

getVersion in class palio.modules.core.Module

saveFrame

public void saveFrame(java.lang.Long materialId,
                      java.lang.String timeCode,
                      java.lang.String name,
                      java.lang.String desc,
                      java.lang.Long userId)
               throws java.lang.Exception

Grabs and saves to database an frame.

Parameters:

materialId - Material identifier

timeCode - Time code of the frame

name - Name of the frame

desc - Description of the frame

userId - Identifier of user

Throws:

java.lang.Exception - Error while grabbing frame

saveFrame

public void saveFrame(java.lang.Long materialId,
                      java.lang.String timeCode,
                      java.lang.String name,
                      java.lang.String desc,
                      int width,
                      int height,
                      java.lang.Long userId)
               throws java.lang.Exception

Grabs and saves to database an frame.

Parameters:

materialId - Material identifier

timeCode - Time code of the frame

name - Name of the frame

desc - Description of the frame

width - target frame width

height - target frame height

userId - Identifier of user

Throws:

java.lang.Exception - Error while grabbing frame