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


Classes:
File_Ogg
File_Ogg_Pear
File_Ogg_Vorbis_Pear
Files:
Ogg.php
PEAR.php
PEAR.php

Class: File_Ogg_Pear

Source Location: /File_Ogg-0.1.3/File/Ogg/PEAR.php

Class Overview




Native PHP interface to an Ogg stream.




Author(s):


    
        





    







Methods
















Inherited Variables





Inherited Methods














Class Details



[line 75]

Native PHP interface to an Ogg stream.
This class provides access to multiple streams inside an Ogg physical stream.  At the time of writing, only Vorbis streams are accessible through this class,  but will eventually provide an interface to FLAC, Speex and Theora (and anything  else wrapped in an Ogg stream).  Streams may be retrieved using the unique serial  number provided by the Ogg container.


    

  • Access: public
    • 









[ Top ]








Method Detail



	
	
File_Ogg_Pear (Constructor)   [line 112]

	

    

    

		File_Ogg_Pear File_Ogg_Pear(
string
$fileLocation)
    

    


	
		Constructor for the native PHP interface to Ogg physical streams.
This function provides an interface to Ogg physical streams which may contain  a number of different logical streams, such as Vorbis and FLAC.  Whilst it is  possible to call this function directly, it is strongly recommended that the user  use the factory method of File_Ogg to ensure a future-proof interface to a  PECL interface to Ogg physical streams.








        
Parameters:

    

    

          

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

        

    


        
[ Top ]

  

  
  
	
	
getStream   [line 275]

	

    

    

		object getStream(
int
$streamSerial)
    

    


	
		Extract a specific logical stream.
This method is a factory method for returning an interfaces to various logical  streams, such as Vorbis or FLAC.  At the time of writing, only the interface  to Vorbis is complete, but it is anticipated that other streams will be added  in the not-too-distant future.








        
Parameters:

    

    

          

        int  
        $streamSerial  
        — 
        The serial number of the requested stream.
      

        

    


        
[ Top ]

  

  
  
	
	
hasStream   [line 312]

	

    

    

		boolean hasStream(
string
$streamType)
    

    


	
		Determines whether a certain type of logical stream exists.
This function loops through the logical streams in the physical Ogg stream  in an attempt to match the stream type (e.g. Vorbis).  It is strongly  recommended that users take advantage of the provided stream constants with  this method, to avoid typographical errors.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $streamType  
        — 
        The textual name of the stream required.
      

        

    


        
[ Top ]

  

  
  
	
	
listStreams   [line 253]

	

    

    

		array listStreams(
)
    

    


	
		List all available logical streams.
This function returns an list of the available logical streams in the  supplied physical stream.  The list uses the logical stream serial number  as the array key, with the type of logical stream (e.g. Vorbis) as the array  value.


    

  • Access: public
    • 








        
[ Top ]

  

  
  



        

		    

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