Member Function Documentation

QVideoSurfaceFormat::QVideoSurfaceFormat()

Constructs a null video stream format.

QVideoSurfaceFormat::QVideoSurfaceFormat(const QSize &size, QVideoFrame::PixelFormat format, QAbstractVideoBuffer::HandleType type = QAbstractVideoBuffer::NoHandle)

Contructs a description of stream which receives stream of type buffers with given frame size and pixel format.

QVideoSurfaceFormat::QVideoSurfaceFormat(const QVideoSurfaceFormat &other)

Constructs a copy of other.

QVideoSurfaceFormat::~QVideoSurfaceFormat()

Destroys a video stream description.

int QVideoSurfaceFormat::frameHeight() const

Returns the height of frame in a video stream.

qreal QVideoSurfaceFormat::frameRate() const

Returns the frame rate of a video stream in frames per second.

See also setFrameRate().

QSize QVideoSurfaceFormat::frameSize() const

Returns the dimensions of frames in a video stream.

See also setFrameSize(), frameWidth(), and frameHeight().

int QVideoSurfaceFormat::frameWidth() const

Returns the width of frames in a video stream.

See also frameSize() and frameHeight().

QAbstractVideoBuffer::HandleType QVideoSurfaceFormat::handleType() const

Returns the type of handle the surface uses to present the frame data.

If the handle type is QAbstractVideoBuffer::NoHandle, buffers with any handle type are valid provided they can be mapped with the QAbstractVideoBuffer::ReadOnly flag. If the handleType() is not QAbstractVideoBuffer::NoHandle then the handle type of the buffer must be the same as that of the surface format.

bool QVideoSurfaceFormat::isMirrored() const

Returns true if the surface is mirrored around its vertical axis. This is typically needed for video frames coming from a front camera of a mobile device.

Note: The mirroring here differs from QImage::mirrored, as a vertically mirrored QImage will be mirrored around its x-axis.

This function was introduced in Qt 5.11.

bool QVideoSurfaceFormat::isValid() const

Identifies if a video surface format has a valid pixel format and frame size.

Returns true if the format is valid, and false otherwise.

QSize QVideoSurfaceFormat::pixelAspectRatio() const

Returns a video stream's pixel aspect ratio.

See also setPixelAspectRatio().

QVideoFrame::PixelFormat QVideoSurfaceFormat::pixelFormat() const

Returns the pixel format of frames in a video stream.

QVariant QVideoSurfaceFormat::property(const char *name) const

Returns the value of the video format's name property.

See also setProperty().

QList<QByteArray> QVideoSurfaceFormat::propertyNames() const

Returns a list of video format dynamic property names.

QVideoSurfaceFormat::Direction QVideoSurfaceFormat::scanLineDirection() const

Returns the direction of scan lines.

See also setScanLineDirection().

void QVideoSurfaceFormat::setFrameRate(qreal rate)

Sets the frame rate of a video stream in frames per second.

See also frameRate().

void QVideoSurfaceFormat::setFrameSize(const QSize &size)

Sets the size of frames in a video stream to size.

This will reset the viewport() to fill the entire frame.

See also frameSize().

void QVideoSurfaceFormat::setFrameSize(int width, int height)

This is an overloaded function.

Sets the width and height of frames in a video stream.

This will reset the viewport() to fill the entire frame.

void QVideoSurfaceFormat::setMirrored(bool mirrored)

Sets if the surface is mirrored around its vertical axis. This is typically needed for video frames coming from a front camera of a mobile device. Default value is false.

Note: The mirroring here differs from QImage::mirrored, as a vertically mirrored QImage will be mirrored around its x-axis.

This function was introduced in Qt 5.11.

See also isMirrored().

void QVideoSurfaceFormat::setPixelAspectRatio(const QSize &ratio)

Sets a video stream's pixel aspect ratio.

See also pixelAspectRatio().

void QVideoSurfaceFormat::setPixelAspectRatio(int horizontal, int vertical)

This is an overloaded function.

Sets the horizontal and vertical elements of a video stream's pixel aspect ratio.

void QVideoSurfaceFormat::setProperty(const char *name, const QVariant &value)

Sets the video format's name property to value.

Trying to set a read only property will be ignored.

See also property().

void QVideoSurfaceFormat::setScanLineDirection(QVideoSurfaceFormat::Direction direction)

Sets the direction of scan lines.

See also scanLineDirection().

void QVideoSurfaceFormat::setViewport(const QRect &viewport)

Sets the viewport of a video stream to viewport.

See also viewport().

void QVideoSurfaceFormat::setYCbCrColorSpace(QVideoSurfaceFormat::YCbCrColorSpace space)

Sets the Y'CbCr color space of a video stream. It is only used with raw YUV frame types.

See also yCbCrColorSpace().

QSize QVideoSurfaceFormat::sizeHint() const

Returns a suggested size in pixels for the video stream.

This is the size of the viewport scaled according to the pixel aspect ratio.

QRect QVideoSurfaceFormat::viewport() const

Returns the viewport of a video stream.

The viewport is the region of a video frame that is actually displayed.

By default the viewport covers an entire frame.

See also setViewport().

QVideoSurfaceFormat::YCbCrColorSpace QVideoSurfaceFormat::yCbCrColorSpace() const

Returns the Y'CbCr color space of a video stream.

See also setYCbCrColorSpace().

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

Returns true if other is different to this video format, and false if they are the same.

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

Assigns the values of other to this object.

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

Returns true if other is the same as this video format, and false if they are different.