Public Member Functions | Static Public Member Functions

gnash::media::haiku::VideoInputHaiku Class Reference

#include <VideoInputHaiku.h>

Inheritance diagram for gnash::media::haiku::VideoInputHaiku:
Inheritance graph
[legend]
Collaboration diagram for gnash::media::haiku::VideoInputHaiku:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 VideoInputHaiku ()
 Constructor for the VideoInputHaiku class.
virtual ~VideoInputHaiku ()
 Destructor for the VideoInputGst class.
double activityLevel () const
 Return the current activity level of the webcam.
size_t bandwidth () const
 The maximum available bandwidth for outgoing connections.
void setBandwidth (size_t bandwidth)
 Set the bandwidth for outgoing connections.
double currentFPS () const
 The current frame rate of the webcam.
double fps () const
 The maximum FPS rate of the webcam.
size_t height () const
 Return the height of the webcam's frame.
size_t width () const
 Return the width of the webcam's frame.
size_t index () const
 The index of the camera.
void requestMode (size_t width, size_t height, double fps, bool favorArea)
 Request a native mode most closely matching the passed variables.
void setMotionLevel (int m)
 Set the amount of motion required before notifying the core.
int motionLevel () const
 Return the current motionLevel setting.
void setMotionTimeout (int m)
 Set time without motion in milliseconds before core is notified.
int motionTimeout () const
 Return the current motionTimeout setting.
void mute (bool m)
bool muted () const
const std::string & name () const
 Return the name of this webcam.
void setQuality (int q)
 Set the quality of the webcam.
int quality () const
 Return the current quality of the webcam.
bool play ()
 Function starts up the pipeline designed earlier in code execution. This puts everything into motion.
bool stop ()
 Function stops the pipeline designed earlier in code execution.

Static Public Member Functions

static void getNames (std::vector< std::string > &)

Constructor & Destructor Documentation

gnash::media::haiku::VideoInputHaiku::VideoInputHaiku (  ) 

Constructor for the VideoInputHaiku class.

TODO: most of these properties need not be stored, but should rather be queried from the input device.

gnash::media::haiku::VideoInputHaiku::~VideoInputHaiku (  )  [virtual]

Destructor for the VideoInputGst class.


Member Function Documentation

double gnash::media::haiku::VideoInputHaiku::activityLevel (  )  const [inline, virtual]

Return the current activity level of the webcam.

Returns:
A double specifying the amount of motion currently detected by the camera.

Implements gnash::media::VideoInput.

size_t gnash::media::haiku::VideoInputHaiku::bandwidth (  )  const [inline, virtual]

The maximum available bandwidth for outgoing connections.

TODO: see if this should really be here.

Implements gnash::media::VideoInput.

double gnash::media::haiku::VideoInputHaiku::currentFPS (  )  const [inline, virtual]

The current frame rate of the webcam.

Returns:
A double specifying the webcam's current FPS

Implements gnash::media::VideoInput.

double gnash::media::haiku::VideoInputHaiku::fps (  )  const [inline, virtual]

The maximum FPS rate of the webcam.

Returns:
A double specifying the webcam's maximum FPS

Implements gnash::media::VideoInput.

static void gnash::media::haiku::VideoInputHaiku::getNames ( std::vector< std::string > &   )  [inline, static]
size_t gnash::media::haiku::VideoInputHaiku::height (  )  const [inline, virtual]

Return the height of the webcam's frame.

Implements gnash::media::VideoInput.

size_t gnash::media::haiku::VideoInputHaiku::index (  )  const [inline, virtual]

The index of the camera.

Implements gnash::media::VideoInput.

int gnash::media::haiku::VideoInputHaiku::motionLevel (  )  const [inline, virtual]

Return the current motionLevel setting.

Implements gnash::media::VideoInput.

int gnash::media::haiku::VideoInputHaiku::motionTimeout (  )  const [inline, virtual]

Return the current motionTimeout setting.

Implements gnash::media::VideoInput.

void gnash::media::haiku::VideoInputHaiku::mute ( bool  m  )  [inline, virtual]
bool gnash::media::haiku::VideoInputHaiku::muted (  )  const [inline, virtual]
const std::string& gnash::media::haiku::VideoInputHaiku::name (  )  const [inline, virtual]

Return the name of this webcam.

Returns:
a string specifying the name of the webcam.

Implements gnash::media::VideoInput.

bool gnash::media::haiku::VideoInputHaiku::play (  ) 

Function starts up the pipeline designed earlier in code execution. This puts everything into motion.

Returns:
True if the pipeline was started correctly, false otherwise.
int gnash::media::haiku::VideoInputHaiku::quality (  )  const [inline, virtual]

Return the current quality of the webcam.

Implements gnash::media::VideoInput.

void gnash::media::haiku::VideoInputHaiku::requestMode ( size_t  width,
size_t  height,
double  fps,
bool  favorArea 
) [virtual]

Request a native mode most closely matching the passed variables.

Parameters:
width The required width
height The required height
fps The required frame rate
favorArea How to match the requested mode.

Implements gnash::media::VideoInput.

void gnash::media::haiku::VideoInputHaiku::setBandwidth ( size_t  bandwidth  )  [inline, virtual]

Set the bandwidth for outgoing connections.

Implements gnash::media::VideoInput.

void gnash::media::haiku::VideoInputHaiku::setMotionLevel ( int  m  )  [inline, virtual]

Set the amount of motion required before notifying the core.

Implements gnash::media::VideoInput.

void gnash::media::haiku::VideoInputHaiku::setMotionTimeout ( int  m  )  [inline, virtual]

Set time without motion in milliseconds before core is notified.

Implements gnash::media::VideoInput.

void gnash::media::haiku::VideoInputHaiku::setQuality ( int  q  )  [inline, virtual]

Set the quality of the webcam.

Implements gnash::media::VideoInput.

bool gnash::media::haiku::VideoInputHaiku::stop (  ) 

Function stops the pipeline designed earlier in code execution.

Returns:
True if the pipeline was stopped correctly, false otherwise.
size_t gnash::media::haiku::VideoInputHaiku::width (  )  const [inline, virtual]

Return the width of the webcam's frame.

Implements gnash::media::VideoInput.


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