Metadata-Version: 1.0
Name: hexagonit.swfheader
Version: 1.0
Summary: SWF metadata parser
Home-page: UNKNOWN
Author: Kai Lautaportti
Author-email: kai.lautaportti@hexagonit.fi
License: GPL
Description: The ``hexagonit.swfheader`` package provides a single function --
        ``parse`` -- that is able to parse the metadata in a SWF (Flash
        animation) file. It has no dependencies outside the standard
        library. The main use case is to interrogate the dimensions of a SWF
        file to help in embedding the file in a HTML page.
        
        Usage
        *****
        
        Using the parser is very simple, simply call the
        ``hexagonit.swfheader.parse`` function and call it with either a
        filesystem path or a file-like object.
        
        >>> import hexagonit.swfheader
        >>> metadata = hexagonit.swfheader.parse(TEST_SWF)
        >>> list(sorted(metadata.keys()))
        ['compressed', 'fps', 'frames', 'height', 'size', 'version', 'width', 'xmax', 'xmin', 'ymax', 'ymin']
        
        >>> metadata['width'], metadata['height']
        (550, 400)
        
        
        The ``parse`` function returns a dictionary that contains the
        following items:
        
        ``version (int)``
        
        The version of the Flash format, e.g. 7.
        
        ``compressed (bool)``
        
        ``True``, if the contents of the file are compressed using zlib
        compression, ``False`` otherwise.
        
        ``size (int)``
        
        Byte size of the (uncompressed) contents of the SWF file.
        
        ``xmin (int)``
        
        The lesser x-coordinate of the bounding rectangle of the contents.
        
        ``xmax (int)``
        
        The greater x-coordinate of the bounding rectangle of the contents.
        
        ``ymin (int)``
        
        The lesser y-coordinate of the bounding rectangle of the contents.
        
        ``ymax (int)``
        
        The greater y-coordinate of the bounding rectangle of the contents.
        
        ``width (int)``
        
        The width of the SWF file in pixels.
        
        ``height (int)``
        
        The height of the SWF file in pixels.
        
        ``frames (int)``
        
        The number of frames in the SWF file.
        
        ``fps (int)``
        
        Frames per second.
        
        
        Change history
        **************
        
        1.0 (2008-04-16)
        ================
        
        - First public release [dokai]
        
Keywords: SWF
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Topic :: Multimedia
Classifier: Topic :: Software Development :: Libraries :: Python Modules
