gnash::media::ffmpeg::VideoInputFfmpeg Class Reference

#include <VideoInputFfmpeg.h>

Inheritance diagram for gnash::media::ffmpeg::VideoInputFfmpeg:

List of all members.

Public Member Functions
	VideoInputFfmpeg ()
	Constructor for the VideoInputFfmpeg class.
virtual	~VideoInputFfmpeg ()
	Destructor for the VideoInputFfmpeg 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::ffmpeg::VideoInputFfmpeg::VideoInputFfmpeg

(

)

Constructor for the VideoInputFfmpeg class.

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

gnash::media::ffmpeg::VideoInputFfmpeg::~VideoInputFfmpeg

(

)

[virtual]

Destructor for the VideoInputFfmpeg class.

---

Member Function Documentation

double gnash::media::ffmpeg::VideoInputFfmpeg::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::ffmpeg::VideoInputFfmpeg::bandwidth

(

)

const [inline, virtual]

The maximum available bandwidth for outgoing connections.

TODO: see if this should really be here.

Implements gnash::media::VideoInput.

Referenced by setBandwidth().

double gnash::media::ffmpeg::VideoInputFfmpeg::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::ffmpeg::VideoInputFfmpeg::fps

(

)

const [inline, virtual]

The maximum FPS rate of the webcam.

Returns:

A double specifying the webcam's maximum FPS

Implements gnash::media::VideoInput.

Referenced by requestMode().

static void gnash::media::ffmpeg::VideoInputFfmpeg::getNames

(

std::vector< std::string > &

)

[inline, static]

size_t gnash::media::ffmpeg::VideoInputFfmpeg::height

(

)

const [inline, virtual]

Return the height of the webcam's frame.

Implements gnash::media::VideoInput.

Referenced by requestMode().

size_t gnash::media::ffmpeg::VideoInputFfmpeg::index

(

)

const [inline, virtual]

The index of the camera.

Implements gnash::media::VideoInput.

int gnash::media::ffmpeg::VideoInputFfmpeg::motionLevel

(

)

const [inline, virtual]

Return the current motionLevel setting.

Implements gnash::media::VideoInput.

int gnash::media::ffmpeg::VideoInputFfmpeg::motionTimeout

(

)

const [inline, virtual]

Return the current motionTimeout setting.

Implements gnash::media::VideoInput.

void gnash::media::ffmpeg::VideoInputFfmpeg::mute

(

bool

m

)

[inline, virtual]

Implements gnash::media::VideoInput.

References gnash::key::m.

bool gnash::media::ffmpeg::VideoInputFfmpeg::muted

(

)

const [inline, virtual]

Implements gnash::media::VideoInput.

const std::string& gnash::media::ffmpeg::VideoInputFfmpeg::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::ffmpeg::VideoInputFfmpeg::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::ffmpeg::VideoInputFfmpeg::quality

(

)

const [inline, virtual]

Return the current quality of the webcam.

Implements gnash::media::VideoInput.

void gnash::media::ffmpeg::VideoInputFfmpeg::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.

References fps(), height(), and width().

void gnash::media::ffmpeg::VideoInputFfmpeg::setBandwidth

(

size_t

bandwidth

)

[inline, virtual]

Set the bandwidth for outgoing connections.

Implements gnash::media::VideoInput.

References bandwidth().

void gnash::media::ffmpeg::VideoInputFfmpeg::setMotionLevel

(

int

m

)

[inline, virtual]

Set the amount of motion required before notifying the core.

Implements gnash::media::VideoInput.

References gnash::key::m.

void gnash::media::ffmpeg::VideoInputFfmpeg::setMotionTimeout

(

int

m

)

[inline, virtual]

Set time without motion in milliseconds before core is notified.

Implements gnash::media::VideoInput.

References gnash::key::m.

void gnash::media::ffmpeg::VideoInputFfmpeg::setQuality

(

int

q

)

[inline, virtual]

Set the quality of the webcam.

Implements gnash::media::VideoInput.

References gnash::key::q.

bool gnash::media::ffmpeg::VideoInputFfmpeg::stop

(

)

Function stops the pipeline designed earlier in code execution.

Returns:

True if the pipeline was stopped correctly, false otherwise.

size_t gnash::media::ffmpeg::VideoInputFfmpeg::width

(

)

const [inline, virtual]

Return the width of the webcam's frame.

Implements gnash::media::VideoInput.

Referenced by requestMode().

---

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

• VideoInputFfmpeg.h
• VideoInputFfmpeg.cpp