Box
in package
Table of Contents
Properties
- $content_size : mixed
- $flags : mixed
- $size : mixed
- $type : mixed
- $version : mixed
Methods
- parse() : Status
- Reads the box header.
Properties
$content_size
public
mixed
$content_size
$flags
public
mixed
$flags
$size
public
mixed
$size
$type
public
mixed
$type
$version
public
mixed
$version
Methods
parse()
Reads the box header.
public
parse(stream $handle, int &$num_parsed_boxes[, int $num_remaining_bytes = MAX_SIZE ]) : Status
Parameters
- $handle : stream
-
The resource the header will be parsed from.
- $num_parsed_boxes : int
-
The total number of parsed boxes. Prevents timeouts.
- $num_remaining_bytes : int = MAX_SIZE
-
The number of bytes that should be available from the resource.
Return values
Status —FOUND on success or an error on failure.