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

Class: File_Ogg

Source Location: /File_Ogg-0.2.1/File/Ogg.php

Class Overview


Class for parsing a ogg bitstream.


Methods


Inherited Variables

Inherited Methods


Class Details

[line 88]
Class for parsing a ogg bitstream.

This class provides a means to access several types of logical bitstreams (e.g. Vorbis) within a Ogg physical bitstream.



[ Top ]


Method Detail

File_Ogg (Constructor)   [line 123]

File_Ogg File_Ogg( string $fileLocation)

Returns an interface to an Ogg physical stream.

This method takes the path to a local file and examines it for a physical ogg bitsream. After instantiation, the user should query the object for the logical bitstreams held within the ogg container.

  • Access: public

Parameters:

string   $fileLocation   —  The path of the file to be examined.

[ Top ]

getStream   [line 244]

File_Ogg_Bitstream getStream( $streamSerial)

Returns the appropriate logical bitstream that corresponds to the provided serial.

This function returns a logical bitstream contained within the ogg physical stream, corresponding to the serial used as the offset for that bitstream. The returned stream may be Vorbis, Speex, FLAC or Theora, although the only usable bitstream is Vorbis.


Parameters:

   $streamSerial   — 

[ Top ]

hasStream   [line 284]

void hasStream( int $streamType)

This function returns true if a logical bitstream of the requested type can be found.

This function checks the contents of this ogg physical bitstream for of logical bitstream corresponding to the supplied type. If one is found, the function returns true, otherwise it return false.


Parameters:

int   $streamType   — 

[ Top ]

listStreams   [line 302]

void listStreams( [ $filter = null])

Returns an array of logical streams inside this physical bitstream.

This function returns an array of logical streams found within this physical bitstream. If a filter is provided, only logical streams of the requested type are returned, as an array of serial numbers. If no filter is provided, this function returns a two-dimensional array, with the stream type as the primary key, and a value consisting of an array of stream serial numbers.


Parameters:

   $filter   — 

[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:10:46 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.