The VideoFrame class used to described a VideoFrame.
More...
#include <frames.h>
|
| | VideoFrame ()=default |
| |
| | ~VideoFrame ()=default |
| |
| | VideoFrame (const VideoFrame &)=delete |
| |
| | VideoFrame (VideoFrame &&)=delete |
| |
| virtual int | width () const =0 |
| | Get the width of the video frame.
|
| |
| virtual int | height () const =0 |
| | Get the height of the video frame.
|
| |
| virtual VideoType | frame_type () const =0 |
| | Get the type (ex.: I420) of the video frame.
|
| |
| virtual uint32_t | timestamp () const |
| | Get the current timestamp of the videoframe. The current system clock should be enough. This is used to make certain RTC stats available.
|
| |
| virtual PrimaryID | primaries () const =0 |
| | Get the standard (ex.: BT709) used for image parameters of the video frame.
|
| |
| virtual TransferID | transfer () const =0 |
| | Get the transfer function used for the video frame.
|
| |
| virtual MatrixID | matrix () const =0 |
| | Get the color matrix to use for conversion between color spaces.
|
| |
| virtual RangeID | range () const =0 |
| | Get the color range values of the video frame.
|
| |
| virtual uint32_t | size (VideoType type) const =0 |
| | Get the buffer size for the specified video type.
|
| |
| virtual void | get_buffer (VideoType type, uint8_t *buffer) const =0 |
| | Get the video frame buffer as the video type specified in parameter.
|
| |
The VideoFrame class used to described a VideoFrame.
◆ VideoFrame() [1/3]
| millicast::VideoFrame::VideoFrame |
( |
| ) |
|
|
default |
◆ ~VideoFrame()
| millicast::VideoFrame::~VideoFrame |
( |
| ) |
|
|
default |
◆ VideoFrame() [2/3]
| millicast::VideoFrame::VideoFrame |
( |
const VideoFrame & |
| ) |
|
|
delete |
◆ VideoFrame() [3/3]
| millicast::VideoFrame::VideoFrame |
( |
VideoFrame && |
| ) |
|
|
delete |
◆ frame_type()
| virtual VideoType millicast::VideoFrame::frame_type |
( |
| ) |
const |
|
pure virtual |
Get the type (ex.: I420) of the video frame.
- Returns
- The type
◆ get_buffer()
| virtual void millicast::VideoFrame::get_buffer |
( |
VideoType |
type, |
|
|
uint8_t * |
buffer |
|
) |
| const |
|
pure virtual |
Get the video frame buffer as the video type specified in parameter.
- Parameters
-
| type | The VideoType. |
| buffer | The video frame buffer. It must be allocated before calling this. |
◆ height()
| virtual int millicast::VideoFrame::height |
( |
| ) |
const |
|
pure virtual |
Get the height of the video frame.
- Returns
- The height
◆ matrix()
| virtual MatrixID millicast::VideoFrame::matrix |
( |
| ) |
const |
|
pure virtual |
Get the color matrix to use for conversion between color spaces.
- Returns
- The color matrix ID
◆ primaries()
| virtual PrimaryID millicast::VideoFrame::primaries |
( |
| ) |
const |
|
pure virtual |
Get the standard (ex.: BT709) used for image parameters of the video frame.
- Returns
- The primary ID
◆ range()
| virtual RangeID millicast::VideoFrame::range |
( |
| ) |
const |
|
pure virtual |
Get the color range values of the video frame.
- Returns
- The color range ID
◆ size()
| virtual uint32_t millicast::VideoFrame::size |
( |
VideoType |
type | ) |
const |
|
pure virtual |
Get the buffer size for the specified video type.
- Parameters
-
◆ timestamp()
| virtual uint32_t millicast::VideoFrame::timestamp |
( |
| ) |
const |
|
inlinevirtual |
Get the current timestamp of the videoframe. The current system clock should be enough. This is used to make certain RTC stats available.
- Returns
- The timestamp
◆ transfer()
| virtual TransferID millicast::VideoFrame::transfer |
( |
| ) |
const |
|
pure virtual |
Get the transfer function used for the video frame.
- Returns
- The transfer function ID
◆ width()
| virtual int millicast::VideoFrame::width |
( |
| ) |
const |
|
pure virtual |
Get the width of the video frame.
- Returns
- The width
The documentation for this class was generated from the following file:
