libpromeki main
PROfessional MEdia toolKIt
 
Loading...
Searching...
No Matches
VideoDesc Class Reference

Describes a video format including frame rate, image layers, audio channels, and metadata. More...

#include <videodesc.h>

Public Types

using Ptr = SharedPtr< VideoDesc >
 Shared pointer type for VideoDesc.
 
using ImageDescList = List< ImageDesc >
 List of ImageDesc values describing each image layer.
 
using AudioDescList = List< AudioDesc >
 List of AudioDesc values describing each audio channel group.
 

Public Member Functions

 VideoDesc ()=default
 Constructs a default (invalid) video description.
 
bool isValid () const
 Returns true if the video description is valid (has a valid frame rate and at least one image or audio description).
 
const FrameRateframeRate () const
 Returns the frame rate.
 
void setFrameRate (const FrameRate &val)
 Sets the frame rate.
 
const ImageDescListimageList () const
 Returns a const reference to the list of image descriptions.
 
ImageDescListimageList ()
 Returns a mutable reference to the list of image descriptions.
 
const AudioDescListaudioList () const
 Returns a const reference to the list of audio descriptions.
 
AudioDescListaudioList ()
 Returns a mutable reference to the list of audio descriptions.
 
const Metadatametadata () const
 Returns a const reference to the metadata.
 
Metadatametadata ()
 Returns a mutable reference to the metadata.
 

Detailed Description

Describes a video format including frame rate, image layers, audio channels, and metadata.

Member Function Documentation

◆ setFrameRate()

void VideoDesc::setFrameRate ( const FrameRate val)
inline

Sets the frame rate.

Parameters
valThe new frame rate.

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