AVBlocks for C++  2.1
Audio and Video Software Development Kit
VideoStreamInfo Class Referenceabstract

VideoStreamInfo describes an elementary video stream. More...

Inheritance diagram for VideoStreamInfo:
StreamInfo Reference

Public Member Functions

virtual VideoStreamInfoclone () const =0
 Creates a copy of this object. More...
 
virtual ColorFormat::Enum colorFormat () const =0
 Returns the video color format. More...
 
virtual bool_t copyTo (VideoStreamInfo *destination) const =0
 Copies the state of the current object to a destination object of the same type. More...
 
virtual int32_t displayRatioHeight () const =0
 Returns the vertical dimension of the display aspect ratio. More...
 
virtual int32_t displayRatioWidth () const =0
 Returns the horizontal dimension of the display aspect ratio. More...
 
virtual bool_t frameBottomUp () const =0
 Returns whether internally the video frame is stored upside down. More...
 
virtual int32_t frameHeight () const =0
 Returns the video frame height. More...
 
virtual double frameRate () const =0
 Returns the video frame rate. More...
 
virtual int32_t frameWidth () const =0
 Returns the video frame width. More...
 
virtual ScanType::Enum scanType () const =0
 Returns the scan type of the video frame. More...
 
virtual bool_t setColorFormat (ColorFormat::Enum colorFormat)=0
 Sets the video color format. More...
 
virtual bool_t setDisplayRatioHeight (int32_t displayHeight)=0
 Sets the vertical dimension of the display aspect ratio. More...
 
virtual bool_t setDisplayRatioWidth (int32_t displayWidth)=0
 Sets the horizontal dimension of the display aspect ratio. More...
 
virtual bool_t setFrameBottomUp (bool_t bottomUp)=0
 Sets whether internally the video frame is stored upside down. More...
 
virtual bool_t setFrameHeight (int32_t frameHeight)=0
 Sets the video frame height. More...
 
virtual bool_t setFrameRate (double frameRate)=0
 Sets the video frame rate. More...
 
virtual bool_t setFrameWidth (int32_t frameWidth)=0
 Sets the video frame width. More...
 
virtual bool_t setScanType (ScanType::Enum scanType)=0
 Sets the scan type of the video frame. More...
 
virtual bool_t setStride (int32_t stride)=0
 Sets the video image stride. More...
 
virtual int32_t stride () const =0
 Returns the video image stride. More...
 
- Public Member Functions inherited from StreamInfo
virtual int32_t bitrate () const =0
 Returns the stream bitrate. More...
 
virtual int32_t bitrateMode () const =0
 Returns the stream bitrate mode. More...
 
virtual bool_t copyTo (StreamInfo *destination) const =0
 Copies the state of the current object to a destination object of the same type. More...
 
virtual double duration () const =0
 Returns the stream duration. More...
 
virtual int32_t ID () const =0
 Returns the ID of the elementary stream. More...
 
virtual bool_t immutable () const =0
 Returns whether the object is immutable. More...
 
virtual MediaType::Enum mediaType () const =0
 Returns the stream media type. More...
 
virtual int32_t programNumber () const =0
 Returns the number of the program to which the elementary stream belongs. More...
 
virtual bool_t reset ()=0
 Resets the stream information to its default state. More...
 
virtual bool_t setBitrate (int32_t bitrate)=0
 Sets the stream bitrate. More...
 
virtual bool_t setBitrateMode (int32_t bitrateMode)=0
 Sets the stream bitrate mode. More...
 
virtual bool_t setDuration (double duration)=0
 Sets the stream duration in seconds. More...
 
virtual bool_t setID (int32_t id)=0
 Sets the ID of the elementary stream. More...
 
virtual bool_t setProgramNumber (int32_t programNumber)=0
 Sets the program to which the elementary stream belongs. More...
 
virtual bool_t setStreamSubType (StreamSubType::Enum type)=0
 Sets the stream subtype. More...
 
virtual bool_t setStreamType (StreamType::Enum type)=0
 Sets the stream type. More...
 
virtual StreamSubType::Enum streamSubType () const =0
 Returns the stream subtype. More...
 
virtual StreamType::Enum streamType () const =0
 Returns the stream type. More...
 
- Public Member Functions inherited from Reference
virtual int32_t release () const =0
 Releases the instance. More...
 
virtual int32_t retain () const =0
 Retains the instance. More...
 
virtual int32_t retainCount () const =0
 Returns the current reference count. More...
 

Protected Member Functions

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

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.
Remarks
When cloned an immutable object becomes mutable.
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 bool_t setColorFormat ( ColorFormat::Enum  colorFormat)
pure virtual

Sets the video color format.

Parameters
colorFormatcolor format
Returns
TRUE if the color format is successfully set, otherwise FALSE.
virtual bool_t setDisplayRatioHeight ( int32_t  displayHeight)
pure virtual

Sets the vertical dimension of the display aspect ratio.

Parameters
displayHeightThe 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.
virtual bool_t setDisplayRatioWidth ( int32_t  displayWidth)
pure virtual

Sets the horizontal dimension of the display aspect ratio.

Parameters
displayWidthThe 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.
virtual bool_t setFrameBottomUp ( bool_t  bottomUp)
pure virtual

Sets whether internally the video frame is stored upside down.

Parameters
bottomUpTRUE the frame is stored upside down, FALSE the frame is stored normally
Returns
TRUE if the bottom-up flag is successfully set, otherwise FALSE.
virtual bool_t setFrameHeight ( int32_t  frameHeight)
pure virtual

Sets the video frame height.

Parameters
frameHeightin pixels
Returns
TRUE if the frame height is successfully set, otherwise FALSE.
virtual bool_t setFrameRate ( double  frameRate)
pure virtual

Sets the video frame rate.

Parameters
frameRatein frames per second.
Returns
TRUE if the frame rate is successfully set, otherwise FALSE.
virtual bool_t setFrameWidth ( int32_t  frameWidth)
pure virtual

Sets the video frame width.

Parameters
frameWidthin pixels.
Returns
TRUE if the frame width is successfully set, otherwise FALSE.
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.
virtual bool_t setStride ( int32_t  stride)
pure virtual

Sets the video image stride.

Parameters
strideImage 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.
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.