VideoStreamInfo describes an elementary video stream. More...

#include <av.h>

Inheritance diagram for VideoStreamInfo:

Public Member Functions
virtual VideoStreamInfo *	clone () const =0
	Creates a copy of this object.

virtual ColorFormat::Enum	colorFormat () const =0
	Returns the video color format.

virtual bool_t	copyTo (VideoStreamInfo *destination) const =0
	Copies the state of the current object to a destination object of the same type.

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 bool_t	frameBottomUp () const =0
	Returns whether internally the video frame is stored upside down.

virtual int32_t	frameHeight () const =0
	Returns the video frame height.

virtual double	frameRate () const =0
	Returns the video frame rate.

virtual int32_t	frameWidth () const =0
	Returns the video frame width.

virtual ScanType::Enum	scanType () const =0
	Returns the scan type of the video frame.

virtual bool_t	setColorFormat (ColorFormat::Enum colorFormat)=0
	Sets the video color format.

virtual bool_t	setDisplayRatioHeight (int32_t displayHeight)=0
	Sets the vertical dimension of the display aspect ratio.

virtual bool_t	setDisplayRatioWidth (int32_t displayWidth)=0
	Sets the horizontal dimension of the display aspect ratio.

virtual bool_t	setFrameBottomUp (bool_t bottomUp)=0
	Sets whether internally the video frame is stored upside down.

virtual bool_t	setFrameHeight (int32_t frameHeight)=0
	Sets the video frame height.

virtual bool_t	setFrameRate (double frameRate)=0
	Sets the video frame rate.

virtual bool_t	setFrameWidth (int32_t frameWidth)=0
	Sets the video frame width.

virtual bool_t	setScanType (ScanType::Enum scanType)=0
	Sets the scan type of the video frame.

virtual bool_t	setStride (int32_t stride)=0
	Sets the video image stride.

virtual int32_t	stride () const =0
	Returns the video image stride.

Public Member Functions inherited from StreamInfo
virtual int32_t	bitrate () const =0
	Returns the stream bitrate.

virtual int32_t	bitrateMode () const =0
	Returns the stream bitrate mode.

virtual StreamInfo *	clone () const =0
	Creates a copy of this object.

virtual bool_t	copyTo (StreamInfo *destination) const =0
	Copies the state of the current object to a destination object of the same type.

virtual double	duration () const =0
	Returns the stream duration.

virtual int32_t	ID () const =0
	Returns the ID of the elementary stream.

virtual bool_t	immutable () const =0
	Returns whether the object is immutable.

virtual MediaType::Enum	mediaType () const =0
	Returns the stream media type.

virtual int32_t	programNumber () const =0
	Returns the number of the program to which the elementary stream belongs.

virtual bool_t	reset ()=0
	Resets the stream information to its default state.

virtual bool_t	setBitrate (int32_t bitrate)=0
	Sets the stream bitrate.

virtual bool_t	setBitrateMode (int32_t bitrateMode)=0
	Sets the stream bitrate mode.

virtual bool_t	setDuration (double duration)=0
	Sets the stream duration in seconds.

virtual bool_t	setID (int32_t id)=0
	Sets the ID of the elementary stream.

virtual bool_t	setProgramNumber (int32_t programNumber)=0
	Sets the program to which the elementary stream belongs.

virtual bool_t	setStreamSubType (StreamSubType::Enum type)=0
	Sets the stream subtype.

virtual bool_t	setStreamType (StreamType::Enum type)=0
	Sets the stream type.

virtual StreamSubType::Enum	streamSubType () const =0
	Returns the stream subtype.

virtual StreamType::Enum	streamType () const =0
	Returns the stream type.

Public Member Functions inherited from Reference
virtual int32_t	release () const =0
	Releases the instance.

virtual int32_t	retain () const =0
	Retains the instance.

virtual int32_t	retainCount () const =0
	Returns the current reference count.

Protected Member Functions
	~VideoStreamInfo ()
	This object can be destroyed only by its implementation.

Protected Member Functions inherited from StreamInfo
	~StreamInfo ()
	This object can be destroyed only by its implementation.

Detailed Description

VideoStreamInfo describes an elementary video stream.

Constructor & Destructor Documentation

◆ ~VideoStreamInfo()

~VideoStreamInfo ( )

protected

This object can be destroyed only by its implementation.

The caller must use Reference::release.

See also: Object Management

Member Function Documentation

◆ clone()

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.

Remarks: When cloned an immutable object becomes mutable.

See also: Object Management

Implements StreamInfo.

◆ colorFormat()

virtual ColorFormat::Enum colorFormat ( ) const

pure virtual

Returns the video color format.

Returns: A ColorFormat::Enum constant.

◆ copyTo()

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.

◆ displayRatioHeight()

virtual int32_t displayRatioHeight ( ) const

pure virtual

Returns the vertical dimension of the display aspect ratio.

Returns: vertical display ratio.

◆ displayRatioWidth()

virtual int32_t displayRatioWidth ( ) const

pure virtual

Returns the horizontal dimension of the display aspect ratio.

Returns: horizontal display ratio.

◆ frameBottomUp()

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.

◆ frameHeight()

virtual int32_t frameHeight ( ) const

pure virtual

Returns the video frame height.

Returns: video frame height in pixels.

◆ frameRate()

virtual double frameRate ( ) const

pure virtual

Returns the video frame rate.

Returns: video frame rate in frames per second.

◆ frameWidth()

virtual int32_t frameWidth ( ) const

pure virtual

Returns the video frame width.

Returns: video frame width in pixels.

◆ scanType()

virtual ScanType::Enum scanType ( ) const

pure virtual

Returns the scan type of the video frame.

Returns: Scan type

◆ setColorFormat()

virtual bool_t setColorFormat ( ColorFormat::Enum colorFormat )

pure virtual

Sets the video color format.

Parameters

colorFormat color format

Returns: TRUE if the color format is successfully set, otherwise FALSE.

◆ setDisplayRatioHeight()

virtual bool_t 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: TRUE if the display height is successfully set, otherwise FALSE.

◆ setDisplayRatioWidth()

virtual bool_t 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: TRUE if the display width is successfully set, otherwise FALSE.

◆ setFrameBottomUp()

virtual bool_t 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

Returns: TRUE if the bottom-up flag is successfully set, otherwise FALSE.

◆ setFrameHeight()

virtual bool_t setFrameHeight ( int32_t frameHeight )

pure virtual

Sets the video frame height.

Parameters

frameHeight in pixels

Returns: TRUE if the frame height is successfully set, otherwise FALSE.

◆ setFrameRate()

virtual bool_t setFrameRate ( double frameRate )

pure virtual

Sets the video frame rate.

Parameters

frameRate in frames per second.

Returns: TRUE if the frame rate is successfully set, otherwise FALSE.

◆ setFrameWidth()

virtual bool_t setFrameWidth ( int32_t frameWidth )

pure virtual

Sets the video frame width.

Parameters

frameWidth in pixels.

Returns: TRUE if the frame width is successfully set, otherwise FALSE.

◆ setScanType()

virtual bool_t 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.

◆ setStride()

virtual bool_t 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.

Returns: TRUE if the stride is successfully set, otherwise FALSE.

◆ stride()

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.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~VideoStreamInfo()

Member Function Documentation

◆ clone()

◆ colorFormat()

◆ copyTo()

◆ displayRatioHeight()

◆ displayRatioWidth()

◆ frameBottomUp()

◆ frameHeight()

◆ frameRate()

◆ frameWidth()

◆ scanType()

◆ setColorFormat()

◆ setDisplayRatioHeight()

◆ setDisplayRatioWidth()

◆ setFrameBottomUp()

◆ setFrameHeight()

◆ setFrameRate()

◆ setFrameWidth()

◆ setScanType()

◆ setStride()

◆ stride()