Class: File_Ogg_Vorbis
Source Location: /File_Ogg-0.2.1/File/Ogg/Vorbis.php
File_Ogg_Bitstream
|
--File_Ogg_Vorbis
Extract the contents of a Vorbis logical stream.
Author(s):
Version:
- CVS: $Id: Vorbis.php,v 1.7 2005/11/03 22:20:10 djg Exp $
Copyright:
- David Grant <david@grant.org.uk>
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Method Detail
File_Ogg_Vorbis (Constructor) [line 167]
File_Ogg_Vorbis File_Ogg_Vorbis(
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:
getAlbum [line 507]
The album from which this track comes.
getArtist [line 525]
The artist responsible for this track.
getBitrate [line 430]
Gives the most accurate bitrate measurement from this stream.
getBitrates [line 419]
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.
getChannels [line 395]
Gives the number of channels used in this stream.
getCommentList [line 330]
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.
getContact [line 599]
getCopyright [line 545]
The copyright attribution for this track.
getDate [line 589]
getDescription [line 576]
A short description of the contents of this track.
getEncoderVersion [line 370]
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.
getField [line 348]
string getField(
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:
getGenre [line 584]
getIsrc [line 604]
getLength [line 457]
Gives the length (in seconds) of this stream.
getLicense [line 555]
The rights of distribution for this track.
getLocation [line 594]
getOrganization [line 566]
string getOrganization(
)
|
|
The name of the organisation producing this track, such as a record label.
getPerformer [line 535]
The performer of this track, such as an orchestra
getSampleRate [line 406]
Gives the number of samples per second used in this stream.
getSize [line 446]
Gives the size (in bits) of this stream.
getTitle [line 487]
The title of this track, e.g. "What's Up Pussycat?".
getTrackNumber [line 515]
The number of this track if it is part of a larger collection.
getVendor [line 384]
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.
getVersion [line 497]
The version of the track, such as a remix.
isMono [line 467]
States whether this logical stream was encoded in mono.
isStereo [line 477]
States whether this logical stream was encoded in stereo.
Documentation generated on Mon, 11 Mar 2019 14:10:46 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|
