William Herrera > iTunes-Sid-0.42 > iTunes::Sid::Atom

Download:
iTunes-Sid-0.42.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 0.042   Source  

NAME ^

iTunes::Sid::Atom - Apple iTunes database component interface

SYNOPSIS ^

    See iTunes::Sid documentation.

DESCRIPTION ^

    This module represents a chunk of data in Apple iTunes sid* format database files.

METHODS ^

new
    my $atm = iTunes::Sid::Atom( rbuf => \$buf, read_buffer_position => $position );
    
    Create an atom object.  rbuf => \$buf is a named argument which is a 
    reference to the memory buffer containing the atom.
    read_buffer_position => $position is the offset in the buffer where the 
    atom's start for reading is located.
isContainer
    $atom->isContainer;

    Overloaded for parent, to allow reading of atom types for container versus
    non-container atoms during parsing.
isRootAtomType
    $atom->isRootAtomType();

    returns 1 if the atom is a root type, otherwise undef.
Ending
    Returns the buffer location of the ending of the atom (the first byte position after the data's end)
VersionString
    Returns the version as string of 3 ints, as in version 3.4.5 or 0.0.1
MainVersion
    Returns the first version field integer, so version 3.4.5 returns just 3
NonVersionData
    Returnsdata after the 12 byte version fields
Data32
    Returns a 32 bit bigendian int after the 12 byte version string for a data atom

SEE ALSO ^

iTunes::Sid

AUTHOR ^

William Herrera ( wherrera@skylightview.com ).

SUPPORT ^

Questions, feature requests and bug reports should go to <wherrera@skylightview.com>.

COPYRIGHT ^

  Copyright (c) 2008 William Herrera. All rights reserved.  
  
  This program is restricted use but free software; you can redistribute it 
  and/or modify it under the same terms as Perl itself, BUT with the same 
  additional restrictions seen in the COPYRIGHT section of B<iTunes::Sid>.