Docs For Class File_Ogg

getCommentList [line 150]

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.

Access: public

[ Top ]

getComments [line 188]

array getComments(
)

Get the entire comments array.

May return an empty array if the bitstream does not support comments.

Access: public

[ Top ]

getField [line 169]

string getField(
string
$commentTitle, [string
$separator = ", "])

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.

Access: public

Parameters:

string	`$commentTitle`	—	Comment title to search for, e.g. TITLE.
string	`$separator`	—	String to separate multiple values.

[ Top ]

getHeader [line 212]

array getHeader(
)

Get an associative array containing header information about the stream

Access: public

Overridden in child classes as:

File_Ogg_Theora::getHeader(): Get an associative array containing header information about the stream

File_Ogg_Flac::getHeader(): Get an associative array containing header information about the stream

File_Ogg_Speex::getHeader(): Get an associative array containing header information about the stream

File_Ogg_Vorbis::getHeader(): Get an associative array containing header information about the stream

[ Top ]

getIdentificationString [line 65]

string getIdentificationString(
)

Get the 6-byte identification string expected in the common header

Overridden in child classes as:

File_Ogg_Theora::getIdentificationString(): Get the 6-byte identification string expected in the common header

File_Ogg_Vorbis::getIdentificationString(): Get the 6-byte identification string expected in the common header

[ Top ]

getLength [line 221]

float getLength(
)

Get the length of the stream in seconds

Overridden in child classes as:

File_Ogg_Vorbis::getLength(): Gives the length (in seconds) of this stream.

[ Top ]

getStartOffset [line 230]

float getStartOffset(
)

Get the start offset of the stream in seconds

Overridden in child classes as:

File_Ogg_Vorbis::getStartOffset(): Get the start offset of the stream in seconds

[ Top ]

getType [line 59]

string getType(
)

Get a short string describing the type of the stream

Abstract:

Overridden in child classes as:

File_Ogg_Theora::getType(): Get a short string describing the type of the stream

File_Ogg_Flac::getType(): Get a short string describing the type of the stream

File_Ogg_Speex::getType(): Get a short string describing the type of the stream

File_Ogg_Vorbis::getType(): Get a short string describing the type of the stream

[ Top ]

getVendor [line 202]

string getVendor(
)

Vendor of software used to encode this stream.

Gives the vendor string for the software used to encode this stream. It is common to find libVorbis here. The majority of encoders appear to use libvorbis from Xiph.org.

Access: public

[ Top ]

Class: File_Ogg_Media

Class Overview

Author(s):

Version:

Copyright:

Methods

Child classes:

Inherited Variables

Inherited Methods

Class: File_Ogg_Bitstream

Class Details

Method Detail

getCommentList [line 150]

getComments [line 188]

getField [line 169]

Parameters:

getHeader [line 212]

getIdentificationString [line 65]

getLength [line 221]

getStartOffset [line 230]

getType [line 59]

getVendor [line 202]