Class VLCServer

Description

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


	
			
Variable Summary
Method Summary
VLCServer __construct ([mixed $pEnigmaVersion = "enigma2"])
string getEmbeddedPlayer ()
string getStreamingUrl ()
boolean isLinux ()
boolean isServerRunning ()
string openExternal (string $pStreamingUrl)
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
string $lAudioCodec (line 21)
  • access: private
int $lBitrate (line 45)
  • access: private
string $lChannel (line 15)
  • access: private
int $lChannels (line 69)
  • access: private
array $lDimensions (line 9)
  • access: private
string $lEnigmaVersion (line 75)
  • access: private
int $lFPS (line 33)
  • access: private
int $lScale (line 57)
  • access: private
string $lStreamType (line 39)
  • access: private
string $lVideoCodec (line 27)
  • access: private
string $lVLCExecutable (line 63)
  • access: private
int $lVolume (line 51)
  • access: private
Methods
Constructor __construct (line 81)

Constructor.

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

VLCServer __construct ([mixed $pEnigmaVersion = "enigma2"])
getEmbeddedPlayer (line 289)

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 ()
getStreamingUrl (line 269)

Get the streaming url.

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

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

Check if we are running on Linux.

Check if we are running on Linux.

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

Check if the server is still running.

Check if the server is still running.

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

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
setAudioCodec (line 136)

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 168)

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 126)

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 115)

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 95)

Set the Enigma type.

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

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

Set the VLC Server frames per second.

Set the VLC Server frames per second.

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

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 144)

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 177)

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 242)

Stop the VLC Server.

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

  • access: public
void stopServer ()

Documentation generated on Sat, 19 Jan 2008 12:56:21 +0100 by phpDocumentor 1.3.0RC3