Class VLCServer

Description

Located in /VLCServer.class.php (line 3)


	
			
Variable Summary
Method Summary
VLCServer __construct ([mixed $pEnigmaVersion = "enigma2"], [mixed $pAuthentication = array()])
string getCurrentChannel ()
boolean getCurrentStream ()
string getEmbbedType ()
string getEmbeddedPlayer ()
string getJSSettings ()
string getStreamingUrl ()
boolean isLinux ()
boolean isServerRunning ()
string openExternal (string $pStreamingUrl)
boolean saveSettingsToFile ()
void setAudioBitrate (string $pRate)
void setAudioCodec (string $pCodec)
void setBitrate (string $pRate)
void setChannel (string $pChannel)
void setDimentions (string $pSizes)
boolean setEnigmaVersion (string $pType)
void setFPS (string $pFPS)
void setStreamType (string $pStreamType)
void setVideoCodec (string $pCodec)
string startServer (boolean $pDebug)
void stopServer ()
Variables
int $lAudioBitrate (line 51)
  • access: private
string $lAudioCodec (line 21)
  • access: private
array $lAuthentication (line 87)
  • access: private
int $lBitrate (line 45)
  • access: private
string $lChannel (line 15)
  • access: private
int $lChannels (line 75)
  • access: private
array $lDimensions (line 9)
  • access: private
string $lEnigmaVersion (line 81)
  • access: private
int $lFPS (line 33)
  • access: private
int $lScale (line 63)
  • access: private
string $lSettingsFile (line 93)
  • access: private
string $lStreamType (line 39)
  • access: private
string $lVideoCodec (line 27)
  • access: private
string $lVLCExecutable (line 69)
  • access: private
int $lVolume (line 57)
  • access: private
Methods
Constructor __construct (line 99)

Constructor.

Constructor. This creates a VLC Server object. Some defaults are already set. These are: volume, scale and audio channels. It alse detects if it is running on Windows or Linux.

VLCServer __construct ([mixed $pEnigmaVersion = "enigma2"], [mixed $pAuthentication = array()])
getCurrentChannel (line 155)

Returns the current playing channel.

Returns the current playing channel. This is red form the vlc settings file.

  • access: public
string getCurrentChannel ()
getCurrentStream (line 389)

This method will load the vlc server settings file.

This method will load the vlc server settings file. This file contains information about the current stream that is being transcoded. When the file is not available, notting will be set. Return true when all settings are loadded!

  • access: public
boolean getCurrentStream ()
getEmbbedType (line 211)

Get the return type code for the code that generates the embed player.

Get the return type code for the code that generates the embed player. If it is rtmp, which is flash, it should be done with javascript. Else you could just send back the html code

  • access: public
string getEmbbedType ()
getEmbeddedPlayer (line 436)

Get the HTML code for the embeded player.

Get the HTML code for the embeded player. This code is based on the chosen protocols, and encoding settings.

  • access: public
string getEmbeddedPlayer ()
getJSSettings (line 223)

Set the current settings to the page with javascript.

Set the current settings to the page with javascript. This will generate a bounche of jQuery actions that set the bitrares, boutique and channel etc.

  • access: public
string getJSSettings ()
getStreamingUrl (line 353)

Get the streaming url.

Get the streaming url. This is based on the protocols and ip addresses.

  • access: public
string getStreamingUrl ()
isLinux (line 491)

Check if we are running on Linux.

Check if we are running on Linux.

  • access: private
  • static:
boolean isLinux ()
isServerRunning (line 340)

Check if the server is still running.

Check if the server is still running.

  • access: public
boolean isServerRunning ()
openExternal (line 472)

Get the external stream data.

Get the external stream data. This will return a m3u playlist file of a asx file for Media Player. This is based on the input streaming url.

  • access: public
string openExternal (string $pStreamingUrl)
  • string $pStreamingUrl
saveSettingsToFile (line 374)

This method writes the settings to a vlc settings file.

This method writes the settings to a vlc settings file. These settings will be loaded later to show what is currently played. Returns tru on success

  • access: public
boolean saveSettingsToFile ()
setAudioBitrate (line 203)

Set the VLC Server streaming audio bitrate.

Set the VLC Server streaming audio bitrate. The higher the bitrate, the better the audio qualitiy will be.

  • access: public
void setAudioBitrate (string $pRate)
  • string $pRate
setAudioCodec (line 163)

Set the VLC Server encoding audio codec.

Set the VLC Server encoding audio codec. This sets the output audio codec.

  • access: public
void setAudioCodec (string $pCodec)
  • string $pCodec
setBitrate (line 195)

Set the VLC Server streaming video bitrate.

Set the VLC Server streaming video bitrate. The higher the bitrate, the better the image qualitiy will be.

  • access: public
void setBitrate (string $pRate)
  • string $pRate
setChannel (line 146)

Set the VLC Server source channel.

Set the VLC Server source channel. This is the ID of a Channel Object.

  • access: public
void setChannel (string $pChannel)
  • string $pChannel
setDimentions (line 135)

Set the VLC Server encoding dimentions.

Set the VLC Server encoding dimentions. This is the size of the re-encoded stream.

  • access: public
void setDimentions (string $pSizes)
  • string $pSizes
setEnigmaVersion (line 115)

Set the Enigma type.

Set the Enigma type. Valid values are 'enigma1' and 'enigma2'.

  • access: public
boolean setEnigmaVersion (string $pType)
  • string $pType
setFPS (line 179)

Set the VLC Server frames per second.

Set the VLC Server frames per second.

  • access: public
void setFPS (string $pFPS)
  • string $pFPS
setStreamType (line 187)

Set the VLC Server stream type.

Set the VLC Server stream type. This sets also the streamplayer type when you need the embedded player.

  • access: public
void setStreamType (string $pStreamType)
  • string $pStreamType
setVideoCodec (line 171)

Set the VLC Server encoding video codec.

Set the VLC Server encoding video codec. This sets the output video codec.

  • access: public
void setVideoCodec (string $pCodec)
  • string $pCodec
startServer (line 233)

Start the VLC Server by executing the vlc command line.

Start the VLC Server by executing the vlc command line. You have to set all options before starting this server. If the server is started, you should be able to connect to it and watch some tv.

  • access: public
string startServer (boolean $pDebug)
  • boolean $pDebug
stopServer (line 325)

Stop the VLC Server.

Stop the VLC Server. This is handy to spare some system resources.

  • access: public
void stopServer ()

Documentation generated on Tue, 24 Jun 2008 18:59:41 +0200 by phpDocumentor 1.3.0RC3