Rovio.API.Other Class Reference

Manage camera settings, get audio and video streams, etc. More...

Inheritance diagram for Rovio.API.Other:

Classes
class	StatusComponent
	Return the run-time status of Rovio including camera settings, true track sensor settings, etc. Part of the Other command. Call Update() before accessing individual parameters of the report. This solution reduces the data traffic when accessing multiple parameters at the same time. More...

Public Member Functions
	Other (Robot _robot)
	The constructor.
void	SetCameraName (string name)
	Set camera's name.
string	GetCameraName ()
	Get camera's name.
string	GetLog ()
	Get Rovio’s system logs information.
string	GetVer ()
	Get Rovio’s base firmware version. Rovio also has a UI version and a NS2 version this function only get the base OS version.
void	SetFactoryDefault ()
	Change all settings to factory-default.
void	Reboot ()
	Reboot Rovio.
string	GetData (bool status)
	Get images/status with "multipart/x-mixed-replace" mime-type.
string	GetAudio ()
	Send audio to server and playback at server side.
void	SetMediaFormat (string audio, string video)
	Set the media format.
string	GetMediaFormat ()
	Get the media format.
void	Upload ()
	Upload new firmware image.
void	Cmd (string value)
	Use this command to combine several commands to a single http request, that is, user can call two or more commands through Cmd.cgi.
Public Member Functions inherited from Rovio.Component
	Component (Robot _robot)
	The constructor.
virtual void	Update ()
	The Update function that manually refreshes the state of a given component (e.g. when AutoUpdate = false)

Public Attributes
StatusComponent	Status
	Status.
Public Attributes inherited from Rovio.Component
bool	AutoUpdate = true
	Automatic update option for methods requesting more than one piece of information.

Additional Inherited Members
Protected Attributes inherited from Rovio.Component
Robot	robot
	The robot class, accessible by all dervied classes.

Detailed Description

Manage camera settings, get audio and video streams, etc.

Todo:

Partially implemented: GetStatus command only.

Constructor & Destructor Documentation

Rovio.API.Other.Other

(

Robot

_robot

)

The constructor.

Member Function Documentation

void Rovio.API.Other.Cmd

(

string

value

)

Use this command to combine several commands to a single http request, that is, user can call two or more commands through Cmd.cgi.

Some commands may use the same parameter's name, so the parameter's position should be in correct order. If you place parameters of sCommandName1 after sCommandName2, the behaviors of IP Camera is unexpected. If there are sub-commands that get information from Rovio, (such as GetUser.cgi, PPPoE.cgi?Action=GetInfo), "RedirectUrl" should not be specified, otherwise the browser will be redirected to the address specified by "RedirectUrl", and certainly not what you want.

string Rovio.API.Other.GetAudio

(

)

Send audio to server and playback at server side.

The data flow is from client to IPCam, which is different from GetData.cgi. The audio data must be send with HTTP POST method. Audio format: 16bit PCM, 8000Hz

string Rovio.API.Other.GetCameraName

(

)

Get camera's name.

string Rovio.API.Other.GetData

(

bool

status

)

Get images/status with "multipart/x-mixed-replace" mime-type.

GetData.cgi is designed for "server-push". "Server-push" means that user need not always detect camera's state, and the camera server transfers the camera data on its own.

string Rovio.API.Other.GetLog

(

)

Get Rovio’s system logs information.

string Rovio.API.Other.GetMediaFormat

(

)

Get the media format.

Audio 0 – AMR 1 – PCM 2 – IMAADPCM 3 – ULAW 4 – ALAW

Video 1 – H263 2 – MPEG4

string Rovio.API.Other.GetVer

(

)

Get Rovio’s base firmware version. Rovio also has a UI version and a NS2 version this function only get the base OS version.

void Rovio.API.Other.Reboot

(

)

Reboot Rovio.

void Rovio.API.Other.SetCameraName

(

string

name

)

Set camera's name.

void Rovio.API.Other.SetFactoryDefault

(

)

Change all settings to factory-default.

void Rovio.API.Other.SetMediaFormat	(	string	audio,
		string	video
	)

Set the media format.

Audio = 0 – 4 Video = 0 – 1

void Rovio.API.Other.Upload

(

)

Upload new firmware image.

Member Data Documentation

StatusComponent Rovio.API.Other.Status

Status.

---

The documentation for this class was generated from the following file:

• C:/Users/Greg/Documents/GitHub/RoboLib/src/Rovio.cs