File_Ogg
[ class tree: File_Ogg ] [ index: File_Ogg ] [ all elements ]
Packages:
File_Ogg


Classes:
File_Ogg
File_Ogg_Bitstream
File_Ogg
   File_Ogg_Flac
   File_Ogg_Media
   File_Ogg_Speex
   File_Ogg_Theora
   File_Ogg_Vorbis
Files:
Bitstream.php
Media.php
Ogg.php

subpackage File_Ogg
Flac.php
Speex.php
Theora.php
Vorbis.php

Class: File_Ogg_Vorbis

Source Location: /File_Ogg-0.3.1/File/Ogg/Vorbis.php

Class Overview

File_Ogg_Bitstream
   |
   --File_Ogg_Media
      |
      --File_Ogg_Vorbis

Extract the contents of a Vorbis logical stream.


Author(s):

Version:

  • CVS: $Id: Vorbis.php 302834 2010-08-27 02:16:20Z tstarling $

Copyright:

  • David Grant <david@grant.org.uk>, Tim Starling <tstarling@wikimedia.org>

Methods

Inherited Variables

Inherited Methods

Class: File_Ogg_Media

File_Ogg_Media::getCommentList()
Provides a list of the comments extracted from the Vorbis stream.
File_Ogg_Media::getComments()
Get the entire comments array.
File_Ogg_Media::getField()
Provides an interface to the numerous comments located with a Vorbis stream.
File_Ogg_Media::getHeader()
Get an associative array containing header information about the stream
File_Ogg_Media::getIdentificationString()
Get the 6-byte identification string expected in the common header
File_Ogg_Media::getLength()
Get the length of the stream in seconds
File_Ogg_Media::getStartOffset()
Get the start offset of the stream in seconds
File_Ogg_Media::getType()
Get a short string describing the type of the stream
File_Ogg_Media::getVendor()
Vendor of software used to encode this stream.

Class: File_Ogg_Bitstream

File_Ogg_Bitstream::getGroup()
Get the multiplexed group ID
File_Ogg_Bitstream::getSerial()
Gives the serial number of this stream.
File_Ogg_Bitstream::getSize()
Gives the size (in bits) of this stream.

Class Details

[line 86]
Extract the contents of a Vorbis logical stream.

This class provides an interface to a Vorbis logical stream found within a Ogg stream. A variety of information may be extracted, including comment tags, running time, and bitrate. For more information, please see the following links.



[ Top ]

Method Detail

getAlbum   [line 484]

string getAlbum( )

The album or collection from which this track comes.
  • Access: public

[ Top ]

getArtist   [line 533]

string getArtist( )

The artist responsible for this track.

This function returns the name of the artist responsible for this recording, which may be either a solo-artist, duet or group.

  • Access: public

[ Top ]

getBitrate   [line 371]

float getBitrate( )

Gives the most accurate bitrate measurement from this stream.

This function returns the most accurate bitrate measurement for this recording, depending on values set in the stream header.

  • Access: public

[ Top ]

getBitrates   [line 357]

array getBitrates( )

Various bitrate measurements

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.

  • Access: public

[ Top ]

getChannels   [line 328]

int getChannels( )

Number of channels used in this stream

This function returns the number of channels used in this stream. This can range from 1 to 255, but will likely be 2 (stereo) or 1 (mono).


[ Top ]

getContact   [line 756]

string getContact( )

  • Access: public

[ Top ]

getCopyright   [line 579]

string getCopyright( )

The copyright attribution for this track.
  • Access: public

[ Top ]

getDate   [line 709]

string getDate( )

The date of the recording of this track.

This function returns the date on which this recording was made. There is no specification for the format of this date.

  • Access: public

[ Top ]

getDescription   [line 657]

string getDescription( )

A short description of the contents of this track.

This function returns a short description of this track, which might contain extra information that doesn't fit anywhere else.

  • Access: public

[ Top ]

getEncoderVersion   [line 311]

int getEncoderVersion( )

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.

  • Access: public

[ Top ]

getGenre   [line 683]

string getGenre( )

The genre of this recording (e.g. Rock)

This function returns the genre of this recording. There are no pre- defined genres, so this is completely up to the tagging software.

  • Access: public

[ Top ]

getHeader   [line 804]

array getHeader( )

Get an associative array containing header information about the stream
  • Access: public

Overrides File_Ogg_Media::getHeader() (Get an associative array containing header information about the stream)
[ Top ]

getIdentificationString   [line 297]

void getIdentificationString( )

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

Overrides File_Ogg_Media::getIdentificationString() (Get the 6-byte identification string expected in the common header)
[ Top ]

getIsrc   [line 782]

string getIsrc( )

International Standard Recording Code.

Returns the International Standard Recording Code. This code can be validated using the Validate_ISPN package.

  • Access: public

[ Top ]

getLength   [line 387]

int getLength( )

Gives the length (in seconds) of this stream.
  • Access: public

Overrides File_Ogg_Media::getLength() (Get the length of the stream in seconds)
[ Top ]

getLicense   [line 605]

string getLicense( )

The rights of distribution for this track.

This funtion returns the license for this track, and may include copyright information, or a creative commons statement.

  • Access: public

[ Top ]

getLocation   [line 735]

string getLocation( )

Where this recording was made.

This function returns where this recording was made, such as a recording studio, or concert venue.

  • Access: public

[ Top ]

getOrganization   [line 631]

string getOrganization( )

The organisation responsible for this track.

This function returns the name of the organisation responsible for the production of this track, such as the record label.

  • Access: public

[ Top ]

getPerformer   [line 556]

string getPerformer( )

The performer of this track, such as an orchestra
  • Access: public

[ Top ]

getSampleRate   [line 342]

int getSampleRate( )

Samples per second.

This function returns the number of samples used per second in this recording. Probably the most common value here is 44,100.

  • Access: public

[ Top ]

getSecondsFromGranulePos   [line 188]

void getSecondsFromGranulePos( $granulePos)


Parameters:

   $granulePos   — 

[ Top ]

getStartOffset   [line 396]

int getStartOffset( )

Get the start offset of the stream in seconds
  • Access: public

Overrides File_Ogg_Media::getStartOffset() (Get the start offset of the stream in seconds)
[ Top ]

getTitle   [line 438]

string getTitle( )

The title of this track, e.g. "What's Up Pussycat?".
  • Access: public

[ Top ]

getTrackNumber   [line 507]

string getTrackNumber( )

The number of this track if it is part of a larger collection.
  • Access: public

[ Top ]

getType   [line 196]

void getType( )

Get a short string describing the type of the stream

Overrides File_Ogg_Media::getType() (Get a short string describing the type of the stream)
[ Top ]

getVersion   [line 461]

string getVersion( )

The version of the track, such as a remix.
  • Access: public

[ Top ]

isMono   [line 405]

boolean isMono( )

States whether this logical stream was encoded in mono.
  • Access: public

[ Top ]

isQuadrophonic   [line 427]

boolean isQuadrophonic( )

States whether this logical stream was encoded in quadrophonic sound.
  • Access: public

[ Top ]

isStereo   [line 416]

boolean isStereo( )

States whether this logical stream was encoded in stereo.
  • Access: public

[ Top ]

setAlbum   [line 496]

void setAlbum( string $album, [boolean $replace = true])

Set the album or collection for this track.
  • Access: public

Parameters:

string   $album   — 
boolean   $replace   — 

[ Top ]

setArtist   [line 545]

void setArtist( string $artist, [boolean $replace = true])

Set the artist of this track.
  • Access: public

Parameters:

string   $artist   — 
boolean   $replace   — 

[ Top ]

setContact   [line 768]

void setContact( string $contact, [boolean $replace = true])

Set the contact information for this track.
  • Access: public

Parameters:

string   $contact   — 
boolean   $replace   — 

[ Top ]

setCopyright   [line 591]

void setCopyright( string $copyright, [boolean $replace = true])

Set the copyright attribution for this track.
  • Access: public

Parameters:

string   $copyright   — 
boolean   $replace   — 

[ Top ]

setDate   [line 721]

void setDate( string $date, [boolean $replace = true])

Set the date of recording for this track.
  • Access: public

Parameters:

string   $date   — 
boolean   $replace   — 

[ Top ]

setDescription   [line 669]

void setDescription( string $description, [boolean $replace = true])

Set the description of this track.
  • Access: public

Parameters:

string   $description   — 
boolean   $replace   — 

[ Top ]

setGenre   [line 695]

void setGenre( string $genre, [boolean $replace = true])

Set the genre of this track.
  • Access: public

Parameters:

string   $genre   — 
boolean   $replace   — 

[ Top ]

setIsrc   [line 794]

void setIsrc( string $isrc, [boolean $replace = true])

Set the ISRC for this track.
  • Access: public

Parameters:

string   $isrc   — 
boolean   $replace   — 

[ Top ]

setLicense   [line 617]

void setLicense( string $license, [boolean $replace = true])

Set the distribution rights for this track.
  • Access: public

Parameters:

string   $license   — 
boolean   $replace   — 

[ Top ]

setLocation   [line 747]

void setLocation( string $location, [boolean $replace = true])

Set the location of the recording of this track.
  • Access: public

Parameters:

string   $location   — 
boolean   $replace   — 

[ Top ]

setOrganziation   [line 643]

void setOrganziation( string $organization, [boolean $replace = true])

Set the organisation responsible for this track.
  • Access: public

Parameters:

string   $organization   — 
boolean   $replace   — 

[ Top ]

setPerformer   [line 568]

void setPerformer( string $performer, [boolean $replace = true])

Set the performer of this track.
  • Access: public

Parameters:

string   $performer   — 
boolean   $replace   — 

[ Top ]

setTitle   [line 450]

void setTitle( string $title, [boolean $replace = true])

Set the title of this track.
  • Access: public

Parameters:

string   $title   — 
boolean   $replace   — 

[ Top ]

setTrackNumber   [line 519]

void setTrackNumber( int $number, [boolean $replace = true])

Set the number of this relative to the collection.
  • Access: public

Parameters:

int   $number   — 
boolean   $replace   — 

[ Top ]

setVersion   [line 473]

void setVersion( string $version, [boolean $replace = true])

Set the version of this track.
  • Access: public

Parameters:

string   $version   — 
boolean   $replace   — 

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:38:26 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.