QVideoFrame 类

成员函数文档

QVideoFrame::QVideoFrame()

构造一个空的视频帧。

QVideoFrame::QVideoFrame(const QVideoFrameFormat &format)

构建给定像素格式的视频帧。

QVideoFrame::QVideoFrame(const QVideoFrame &other)

构造其他的浅拷贝。由于QVideoFrame是显式共享的，这两个实例将反映相同的帧。

[noexcept] QVideoFrame::QVideoFrame(QVideoFrame &&other)

通过从其他移动来构造一个QVideoFrame。

[noexcept] QVideoFrame::~QVideoFrame()

销毁视频帧。

uchar *QVideoFrame::bits(int plane)

返回一个指向帧数据缓冲区开始的指针，对于plane。

此值仅在帧数据被映射时有效。

通过此指针对数据进行的更改（当以写入权限映射时）仅保证在调用unmap() 时和缓冲区已被映射用于写入时已持久化。

也见map、mappedBytes、bytesPerLine 和 planeCount。

const uchar *QVideoFrame::bits(int plane) const

返回一个指向帧数据缓冲区开始的指针，对于plane。

此值仅在帧数据被映射时有效。

如果没有以读取访问权限映射缓冲区，则此缓冲区的内容最初将未被初始化。

也见map、mappedBytes、bytesPerLine 和 planeCount。

int QVideoFrame::bytesPerLine(int plane) const

返回plane扫描线中的字节数。

此值仅在帧数据被映射时有效。

也见bits、map、mappedBytes 和 planeCount。

qint64 QVideoFrame::endTime() const

返回帧应停止显示时的呈现时间（微秒）。

无效的时间表示为 -1。

也见setEndTime。

QVideoFrame::HandleType QVideoFrame::handleType() const

返回视频帧句柄的类型。

句柄类型可以是 NoHandle，表示帧是内存基础的，或者 RHI 纹理。

int QVideoFrame::height() const

返回视频帧的高度。

bool QVideoFrame::isMapped() const

识别视频帧的内容是否目前映射到系统内存。

这是一个便利函数，用于检查帧的映射模式是否不等于QVideoFrame::NotMapped。

如果视频帧的内容已映射到系统内存，则返回 true，否则返回 false。

另请参阅mapMode() 和 QVideoFrame::MapMode。

bool QVideoFrame::isReadable() const

识别从映射的视频帧读取了映射的内容。

这是一个便利函数，用于检查 MapMode 是否包含 QVideoFrame::WriteOnly 标志。

如果映射内存的内容是从视频帧中读取的，则返回 true，否则返回 false。

另请参阅mapMode() 和 QVideoFrame::MapMode。

bool QVideoFrame::isValid() const

识别视频帧是否有效。

无效的帧没有与之关联的视频缓冲区。

如果帧是有效的，则返回 true，如果不是则返回 false。

bool QVideoFrame::isWritable() const

识别视频帧的映射内容是否在取消映射时保留。

这是一个便利函数，用于检查 MapMode 是否包含 QVideoFrame::WriteOnly 标志。

如果视频帧在取消映射时会更新，则返回 true，否则返回 false。

另请参阅mapMode() 和 QVideoFrame::MapMode。

bool QVideoFrame::map(QVideoFrame::MapMode mode)

将视频帧的内容映射到系统（CPU可访问）内存。

在某些情况下，视频帧数据可能存储在视频内存或其他无法访问的内存中，因此在访问像素数据之前必须映射一个帧。这可能涉及到内容复制，因此除非需要，否则请避免映射和取消映射。

映射模式 mode 指示映射内存的内容是否应该从/或写入帧。如果映射模式包括 QVideoFrame::ReadOnly 标志，则初始映射时将使用视频帧的内容填充映射内存。如果映射模式包括 QVideoFrame::WriteOnly 标志，则可能更改的映射内存的内容在取消映射时将写回帧。

在映射期间，可以通过由 bits() 函数返回的指针直接访问视频帧的内存内容。

当不再需要访问数据时，务必调用 unmap() 函数来释放映射内存并可能更新视频帧内容。

如果视频帧是以只读模式映射的，则可以多次以只读模式将其映射（并相应地取消映射）。在所有其他情况下，在第二次映射之前必须首先取消映射。

如果帧在给定的 mode 下映射到内存，则返回 true，否则返回 false。

另请参阅 unmap()，mapMode() 和 bits()。

QVideoFrame::MapMode QVideoFrame::mapMode() const

返回视频帧映射到系统内存的模式。

另请参阅 map() 和 QVideoFrame::MapMode。

int QVideoFrame::mappedBytes(int plane) const

返回映射帧数据中平面 plane 占用的字节数。

此值仅在帧数据被映射时有效。

另请参阅 map。

bool QVideoFrame::mirrored() const

返回是否在显示之前应对帧进行镜像。

另请参阅 setMirrored。

void QVideoFrame::paint(QPainter *painter, const QRectF &rect, const QVideoFrame::PaintOptions &options)

使用 QPainter，painter，将此 QVideoFrame 渲染到 rect 中。PaintOptions options 可用于指定背景颜色以及如何填充 rect 的视频。

QVideoFrameFormat::PixelFormat QVideoFrame::pixelFormat() const

返回此视频帧的像素格式。

int QVideoFrame::planeCount() const

返回视频帧中平面的数量。

另请参阅 map。

QtVideo::Rotation QVideoFrame::rotation() const

返回在显示之前应将帧按顺时针方向旋转的角度。

另请参阅 setRotation。

void QVideoFrame::setEndTime(qint64 time)

设置帧应停止显示的显示时间 time（以微秒为单位）。

无效的时间表示为 -1。

另请参阅 endTime。

void QVideoFrame::setMirrored(bool mirrored)

设置帧的 mirrored 标志并将该标志设置为底层的 surfaceFormat。

另请参阅 mirrored。

void QVideoFrame::setRotation(QtVideo::Rotation angle)

设置在显示之前帧应按顺时针方向旋转的角度 angle。

另请参阅 rotation。

void QVideoFrame::setStartTime(qint64 time)

设置帧应最初显示的显示时间 time（以微秒为单位）。

无效的时间表示为 -1。

另请参阅 startTime。

void QVideoFrame::setSubtitleText(const QString &text)

将与此视频帧一起渲染的字幕文本设置为text。

另请参阅subtitleText()。

QSize QVideoFrame::size() const

返回视频帧的尺寸。

qint64 QVideoFrame::startTime() const

返回帧应显示时的呈现时间（以微秒为单位）。

无效的时间表示为 -1。

另请参阅setStartTime()。

QString QVideoFrame::subtitleText() const

返回与此视频帧一起渲染的字幕文本。

另请参阅setSubtitleText()。

QVideoFrameFormat QVideoFrame::surfaceFormat() const

返回此视频帧的表面格式。

[noexcept] void QVideoFrame::swap(QVideoFrame &other)

交换当前视频帧与other。

QImage QVideoFrame::toImage() const

根据像素格式将当前视频帧转换为图像。

void QVideoFrame::unmap()

释放由函数map()映像的内存。

如果映射模式包含QVideoFrame::WriteOnly标志，这将持久化映射内存的当前内容到视频帧。

如果失败，不要调用unmap()函数。

另请参阅 map。

int QVideoFrame::width() const

返回视频帧的宽度。

bool QVideoFrame::operator!=(const QVideoFrame &other) const

如果此QVideoFrame和other不反映相同的帧，则返回true。

[noexcept] QVideoFrame &QVideoFrame::operator=(QVideoFrame &&other)

将other移动到此QVideoFrame。

QVideoFrame &QVideoFrame::operator=(const QVideoFrame &other)

将other的内容分配给此视频帧。由于QVideoFrame是显式共享的，这两个实例将反映相同的帧。

bool QVideoFrame::operator==(const QVideoFrame &other) const

如果此QVideoFrame和other反映相同的帧，则返回true。