Class: File_Ogg_Vorbis_Pear

File_Ogg_Vorbis_Pear File_Ogg_Vorbis_Pear( int $streamSerial, array $streamData, pointer $filePointer, string $filePath)

Constructor for accessing a Vorbis logical stream.

This method is the constructor for the native-PHP interface to a Vorbis logical stream, embedded within an Ogg physical stream.

Parameters:

float getBitrate( )

Gives the most accurate bitrate measurement from this stream.

array getBitrates( )

Gives an array of the values of four different types of bitrates for this stream. The nominal, maximum and minimum values are found within the file, whereas the average value is computed.

int getChannels( )

Gives the number of channels used in this stream.

mixed getComment( string $commentTitle)

Provides an interface to the numerous comments located with a Vorbis stream.

A Vorbis stream may contain one or more instances of each comment, so the user should check the variable type before printing out the result of this method. The situation in which multiple instances of a comment occurring are not as rare as one might think, since they are conceivable at least for ARTIST comments in the situation where a track is a duet.

Parameters:

array getCommentList( )

Provides a list of the comments extracted from the Vorbis stream.

It is recommended that the user fully inspect the array returned by this function rather than blindly requesting a comment in false belief that it will always be present. Whilst the Vorbis specification dictates a number of popular comments (e.g. TITLE, ARTIST, etc.) for use in Vorbis streams, they are not guaranteed to appear.

int getLength( )

Gives the length (in seconds) of this stream.

int getSampleRate( )

Gives the number of samples per second used in this stream.

int getSerial( )

Gives the serial number of this stream.

The stream serial number is of fairly academic importance, as it makes little difference to the end user. The serial number is used by the Ogg physical stream to distinguish between concurrent logical streams.

int getSize( )

Gives the size (in bits) of this stream.

string getVendor( )

Gives the vendor string for the software used to encode this stream.

It is common to find libVorbis here. A previous version of this package compared this vendor string against a release table, but this has been removed, as encoding software is not limited to libvorbis.

int getVersion( )

Version of the Vorbis specification referred to in the encoding of this stream.

This method returns the version of the Vorbis specification (currently 0 (ZERO)) referred to by the encoder of this stream. The Vorbis specification is well- defined, and thus one does not expect this value to change on a frequent basis.