Cheetah
Public Member Functions | Static Public Member Functions | Public Attributes | Static Protected Attributes | List of all members
Atom Class Reference

Public Member Functions

 getType ()
 
 setType ($type)
 
 getSize ()
 
 setSize ($value)
 
 getOffset ()
 
 setOffset ($value)
 
 toString ()
 

Static Public Member Functions

static isValidAtom ($fourByteString)
 

Public Attributes

const FTYP_ATOM = 'ftyp'
 
const MOOV_ATOM = 'moov'
 
const CMOV_ATOM = 'cmov'
 
const STCO_ATOM = 'stco'
 
const CO64_ATOM = 'co64'
 
const URL_ATOM = 'url '
 
const XML_ATOM = 'xml '
 

Static Protected Attributes

static $validAtoms
 

Detailed Description

Definition at line 65 of file Atom.class.php.

Member Function Documentation

◆ getOffset()

Atom::getOffset ( )

returns the offset of where the atom/box resides in the file in bytes

Definition at line 241 of file Atom.class.php.

◆ getSize()

Atom::getSize ( )

returns the size of atom in bytes

Definition at line 220 of file Atom.class.php.

◆ getType()

Atom::getType ( )

returns the atom type (ISO code of the atom) i.e.: moov, ftyp, mdat etc...

Definition at line 202 of file Atom.class.php.

◆ isValidAtom()

static Atom::isValidAtom (   $fourByteString)
static

returns true if $fourByteString is a character string and atom type (ISO code of the atom) is valid ($validAtoms)

Definition at line 187 of file Atom.class.php.

◆ setOffset()

Atom::setOffset (   $value)

sets the offset of where the atom/box resides in the file in bytes

Definition at line 250 of file Atom.class.php.

◆ setSize()

Atom::setSize (   $value)

sets the size of atom in bytes

Definition at line 228 of file Atom.class.php.

◆ setType()

Atom::setType (   $type)

sets the atom type (ISO code of the atom) i.e.: moov, ftyp, mdat etc...

Definition at line 211 of file Atom.class.php.

◆ toString()

Atom::toString ( )

returns formatted informations about the instance

Definition at line 259 of file Atom.class.php.

Member Data Documentation

◆ $validAtoms

Atom::$validAtoms
staticprotected

Definition at line 110 of file Atom.class.php.

◆ CMOV_ATOM

const Atom::CMOV_ATOM = 'cmov'

Definition at line 104 of file Atom.class.php.

◆ CO64_ATOM

const Atom::CO64_ATOM = 'co64'

Definition at line 106 of file Atom.class.php.

◆ FTYP_ATOM

const Atom::FTYP_ATOM = 'ftyp'

ISO family codes / atom types

Definition at line 102 of file Atom.class.php.

◆ MOOV_ATOM

const Atom::MOOV_ATOM = 'moov'

Definition at line 103 of file Atom.class.php.

◆ STCO_ATOM

const Atom::STCO_ATOM = 'stco'

Definition at line 105 of file Atom.class.php.

◆ URL_ATOM

const Atom::URL_ATOM = 'url '

Definition at line 107 of file Atom.class.php.

◆ XML_ATOM

const Atom::XML_ATOM = 'xml '

Definition at line 108 of file Atom.class.php.


The documentation for this class was generated from the following file: