VideoStreamInfo Class Reference

VideoStreamInfo describes an elementary video stream. More...

Inherits StreamInfo.

List of all members.

Public Member Functions
virtual int32_t	frameWidth () const =0
	Returns the video frame width.
virtual void	setFrameWidth (int32_t frameWidth)=0
	Sets the video frame width.
virtual int32_t	frameHeight () const =0
	Returns the video frame height.
virtual void	setFrameHeight (int32_t frameHeight)=0
	Sets the video frame height.
virtual int32_t	displayRatioHeight () const =0
	Returns the vertical dimension of the display aspect ratio.
virtual int32_t	displayRatioWidth () const =0
	Returns the horizontal dimension of the display aspect ratio.
virtual void	setDisplayRatioHeight (int32_t displayHeight)=0
	Sets the vertical dimension of the display aspect ratio.
virtual void	setDisplayRatioWidth (int32_t displayWidth)=0
	Sets the horizontal dimension of the display aspect ratio.
virtual double	frameRate () const =0
	Returns the video frame rate.
virtual void	setFrameRate (double frameRate)=0
	Sets the video frame rate.
virtual ColorFormat::Enum	colorFormat () const =0
	Returns the video color format.
virtual void	setColorFormat (ColorFormat::Enum colorFormat)=0
	Sets the video color format.
virtual int32_t	stride () const =0
	Returns the video image stride.
virtual void	setStride (int32_t stride)=0
	Sets the video image stride.
virtual ScanType::Enum	scanType () const =0
	Returns the scan type of the video frame.
virtual void	setScanType (ScanType::Enum scanType)=0
	Sets the scan type of the video frame.
virtual bool_t	frameBottomUp () const =0
	Returns whether internally the video frame is stored upside down.
virtual void	setFrameBottomUp (bool_t bottomUp)=0
	Sets whether internally the video frame is stored upside down.
virtual bool_t	copyTo (VideoStreamInfo *destination) const =0
	Copies the state of the current object to a destination object of the same type.
virtual VideoStreamInfo *	clone () const =0
	Creates a copy of this object.
Protected Member Functions
	~VideoStreamInfo ()
	This object can be destroyed only by its implementation.

---

Detailed Description

VideoStreamInfo describes an elementary video stream.

---

Constructor & Destructor Documentation

~VideoStreamInfo

(

)

[protected]

This object can be destroyed only by its implementation.

The caller must use Reference::release.

See also:

Object Management

---

Member Function Documentation

virtual VideoStreamInfo* clone

(

)

const [pure virtual]

Creates a copy of this object.

Returns:

A new VideoStreamInfo. The caller is responsible for releasing the new object when it is not needed anymore.

See also:

Object Management

Implements StreamInfo.

virtual ColorFormat::Enum colorFormat

(

)

const [pure virtual]

Returns the video color format.

Returns:

A ColorFormat::Enum constant.

virtual bool_t copyTo

(

VideoStreamInfo *

destination

)

const [pure virtual]

Copies the state of the current object to a destination object of the same type.

The reference count of the source and the destination is not modified.

Parameters:

destination

[out] A pointer to the destination object

Returns:

TRUE The object state is copied, FALSE otherwise.

virtual int32_t displayRatioHeight

(

)

const [pure virtual]

Returns the vertical dimension of the display aspect ratio.

Returns:

vertical display ratio.

virtual int32_t displayRatioWidth

(

)

const [pure virtual]

Returns the horizontal dimension of the display aspect ratio.

Returns:

horizontal display ratio.

virtual bool_t frameBottomUp

(

)

const [pure virtual]

Returns whether internally the video frame is stored upside down.

Returns:

TRUE The frame is stored upside down (vertically flipped) but logically it should be displayed normally. This is typical for bitmaps. FALSE The frame is displayed as it is stored - top row is first in memory, bottom row is last.

virtual int32_t frameHeight

(

)

const [pure virtual]

Returns the video frame height.

Returns:

video frame height in pixels.

virtual double frameRate

(

)

const [pure virtual]

Returns the video frame rate.

Returns:

video frame rate in frames per second.

virtual int32_t frameWidth

(

)

const [pure virtual]

Returns the video frame width.

Returns:

video frame width in pixels.

virtual ScanType::Enum scanType

(

)

const [pure virtual]

Returns the scan type of the video frame.

Returns:

Scan type

virtual void setColorFormat

(

ColorFormat::Enum

colorFormat

)

[pure virtual]

Sets the video color format.

Parameters:

colorFormat

color format

virtual void setDisplayRatioHeight

(

int32_t

displayHeight

)

[pure virtual]

Sets the vertical dimension of the display aspect ratio.

Parameters:

displayHeight

The value has no meaning on its own. It serves only to express the display aspect ratio.

Returns:

vertical display ratio.

virtual void setDisplayRatioWidth

(

int32_t

displayWidth

)

[pure virtual]

Sets the horizontal dimension of the display aspect ratio.

Parameters:

displayWidth

The value has no meaning on its own. It serves only to express the display aspect ratio.

Returns:

horizontal display ratio.

virtual void setFrameBottomUp

(

bool_t

bottomUp

)

[pure virtual]

Sets whether internally the video frame is stored upside down.

Parameters:

bottomUp

TRUE the frame is stored upside down, FALSE the frame is stored normally

virtual void setFrameHeight

(

int32_t

frameHeight

)

[pure virtual]

Sets the video frame height.

Parameters:

frameHeight

in pixels

virtual void setFrameRate

(

double

frameRate

)

[pure virtual]

Sets the video frame rate.

Parameters:

frameRate

in frames per second.

virtual void setFrameWidth

(

int32_t

frameWidth

)

[pure virtual]

Sets the video frame width.

Parameters:

frameWidth

in pixels.

virtual void setScanType

(

ScanType::Enum

scanType

)

[pure virtual]

Sets the scan type of the video frame.

Parameters:

scanType

Returns:

TRUE The scan type is set, FALSE otherwise.

virtual void setStride

(

int32_t

stride

)

[pure virtual]

Sets the video image stride.

Parameters:

stride

Image stride in bytes.

Stride is the distance in bytes from the start of one row of pixels in memory to the start of the next row of pixels. It is also called a pitch.

virtual int32_t stride

(

)

const [pure virtual]

Returns the video image stride.

Returns:

Image stride in bytes.

Stride is the distance in bytes from the start of one row of pixels in memory to the start of the next row of pixels. It is also called a pitch.