Package adams.data.video

Class AbstractScreenRecorder

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    Direct Known Subclasses:
    XuggleScreenRecorder
    public abstract class AbstractScreenRecorder
extends AbstractVideoRecorder
    Ancestor for screen recorders.
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_CaptureMouse
      whether to capture the mouse cursor.
      protected int m_Height
      the height of the screen portion to grab (-1 = remainder).
      protected int m_Width
      the width of the screen portion to grab (-1 = remainder).
      protected int m_X
      the X position of the screen portion to grab (0-based).
      protected int m_Y
      the Y position of the screen portion to grab (0-based).

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Field Detail

      • m_X

        protected int m_X
        the X position of the screen portion to grab (0-based).

      • m_Y

        protected int m_Y
        the Y position of the screen portion to grab (0-based).

      • m_Width

        protected int m_Width
        the width of the screen portion to grab (-1 = remainder).

      • m_Height

        protected int m_Height
        the height of the screen portion to grab (-1 = remainder).

      • m_CaptureMouse

        protected boolean m_CaptureMouse
        whether to capture the mouse cursor.

    • Constructor Detail

      • AbstractScreenRecorder

        public AbstractScreenRecorder()

    • Method Detail

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class AbstractVideoRecorder

      • setX

        public void setX​(int value)
        Sets the X position of the screen portion (0-based).
        Parameters:
        value - the X position

      • getX

        public int getX()
        Returns the X position of the screen portion (0-based).
        Returns:
        the Y position

      • XTipText

        public String XTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setY

        public void setY​(int value)
        Sets the Y position of the screen portion (0-based).
        Parameters:
        value - the Y position

      • getY

        public int getY()
        Returns the Y position of the screen portion (0-based).
        Returns:
        the Y position

      • YTipText

        public String YTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setWidth

        public void setWidth​(int value)
        Sets the width of the screen portion (-1 = remainder).
        Parameters:
        value - the width

      • getWidth

        public int getWidth()
        Returns the width of the screen portion (-1 = remainder).
        Returns:
        the width

      • widthTipText

        public String widthTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setHeight

        public void setHeight​(int value)
        Sets the height of the screen portion (-1 = remainder).
        Parameters:
        value - the height

      • getHeight

        public int getHeight()
        Returns the height of the screen portion (-1 = remainder).
        Returns:
        the height

      • heightTipText

        public String heightTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setCaptureMouse

        public void setCaptureMouse​(boolean value)
        Sets whether to capture the mouse cursor.
        Parameters:
        value - true if to capture

      • getCaptureMouse

        public boolean getCaptureMouse()
        Returns whether to capture the mouse cursor.
        Returns:
        true if to capture

      • captureMouseTipText

        public String captureMouseTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.