KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QCameraViewfinderSettings

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QCameraViewfinderSettings

Public constructors

new QCameraViewfinderSettingsnewConstructor QCameraViewfinderSettings::QCameraViewfinderSettings()
new QCameraViewfinderSettingsnew(const QCameraViewfinderSettings other)Constructor QCameraViewfinderSettings::QCameraViewfinderSettings(const QCameraViewfinderSettings &other)

Public methods

[const]bool!=(const QCameraViewfinderSettings rhs)Operator bool ::operator!=(const QCameraViewfinderSettings &lhs, const QCameraViewfinderSettings &rhs)
void_assign(const QCameraViewfinderSettings other)Assigns another object to self
[const]QCameraViewfinderSettings ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
QCameraViewfinderSettingsassign(const QCameraViewfinderSettings other)Method QCameraViewfinderSettings &QCameraViewfinderSettings::operator=(const QCameraViewfinderSettings &other)
[const]new QCameraViewfinderSettings ptrdupCreates a copy of self
[const]boolisNull?Method bool QCameraViewfinderSettings::isNull()
[const]doublemaximumFrameRateMethod double QCameraViewfinderSettings::maximumFrameRate()
voidmaximumFrameRate=(double rate)Method void QCameraViewfinderSettings::setMaximumFrameRate(double rate)
[const]doubleminimumFrameRateMethod double QCameraViewfinderSettings::minimumFrameRate()
voidminimumFrameRate=(double rate)Method void QCameraViewfinderSettings::setMinimumFrameRate(double rate)
[const]QSizepixelAspectRatioMethod QSize QCameraViewfinderSettings::pixelAspectRatio()
voidpixelAspectRatio=(const QSize ratio)Method void QCameraViewfinderSettings::setPixelAspectRatio(const QSize &ratio)
[const]QVideoFrame_PixelFormatpixelFormatMethod QVideoFrame::PixelFormat QCameraViewfinderSettings::pixelFormat()
voidpixelFormat=(const QVideoFrame_PixelFormat format)Method void QCameraViewfinderSettings::setPixelFormat(QVideoFrame::PixelFormat format)
[const]QSizeresolutionMethod QSize QCameraViewfinderSettings::resolution()
voidresolution=(const QSize arg1)Method void QCameraViewfinderSettings::setResolution(const QSize &)
voidsetMaximumFrameRate(double rate)Method void QCameraViewfinderSettings::setMaximumFrameRate(double rate)
voidsetMinimumFrameRate(double rate)Method void QCameraViewfinderSettings::setMinimumFrameRate(double rate)
voidsetPixelAspectRatio(const QSize ratio)Method void QCameraViewfinderSettings::setPixelAspectRatio(const QSize &ratio)
voidsetPixelAspectRatio(int horizontal,
int vertical)
Method void QCameraViewfinderSettings::setPixelAspectRatio(int horizontal, int vertical)
voidsetPixelFormat(const QVideoFrame_PixelFormat format)Method void QCameraViewfinderSettings::setPixelFormat(QVideoFrame::PixelFormat format)
voidsetResolution(const QSize arg1)Method void QCameraViewfinderSettings::setResolution(const QSize &)
voidsetResolution(int width,
int height)
Method void QCameraViewfinderSettings::setResolution(int width, int height)
voidswap(QCameraViewfinderSettings other)Method void QCameraViewfinderSettings::swap(QCameraViewfinderSettings &other)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QCameraViewfinderSettings rhs)

Description: Operator bool ::operator!=(const QCameraViewfinderSettings &lhs, const QCameraViewfinderSettings &rhs)

This is the mapping of the global operator to the instance method.

_assign

Signature: void _assign (const QCameraViewfinderSettings other)

Description: Assigns another object to self

_const_cast

Signature: [const] QCameraViewfinderSettings ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: QCameraViewfinderSettings assign (const QCameraViewfinderSettings other)

Description: Method QCameraViewfinderSettings &QCameraViewfinderSettings::operator=(const QCameraViewfinderSettings &other)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QCameraViewfinderSettings ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

isNull?

Signature: [const] bool isNull?

Description: Method bool QCameraViewfinderSettings::isNull()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

maximumFrameRate

Signature: [const] double maximumFrameRate

Description: Method double QCameraViewfinderSettings::maximumFrameRate()

Python specific notes:
The object exposes a readable attribute 'maximumFrameRate'. This is the getter.

maximumFrameRate=

Signature: void maximumFrameRate= (double rate)

Description: Method void QCameraViewfinderSettings::setMaximumFrameRate(double rate)

Python specific notes:
The object exposes a writable attribute 'maximumFrameRate'. This is the setter.

minimumFrameRate

Signature: [const] double minimumFrameRate

Description: Method double QCameraViewfinderSettings::minimumFrameRate()

Python specific notes:
The object exposes a readable attribute 'minimumFrameRate'. This is the getter.

minimumFrameRate=

Signature: void minimumFrameRate= (double rate)

Description: Method void QCameraViewfinderSettings::setMinimumFrameRate(double rate)

Python specific notes:
The object exposes a writable attribute 'minimumFrameRate'. This is the setter.

new

(1) Signature: [static] new QCameraViewfinderSettings new

Description: Constructor QCameraViewfinderSettings::QCameraViewfinderSettings()

This method creates an object of class QCameraViewfinderSettings.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QCameraViewfinderSettings new (const QCameraViewfinderSettings other)

Description: Constructor QCameraViewfinderSettings::QCameraViewfinderSettings(const QCameraViewfinderSettings &other)

This method creates an object of class QCameraViewfinderSettings.

Python specific notes:
This method is the default initializer of the object.

pixelAspectRatio

Signature: [const] QSize pixelAspectRatio

Description: Method QSize QCameraViewfinderSettings::pixelAspectRatio()

Python specific notes:
The object exposes a readable attribute 'pixelAspectRatio'. This is the getter.

pixelAspectRatio=

Signature: void pixelAspectRatio= (const QSize ratio)

Description: Method void QCameraViewfinderSettings::setPixelAspectRatio(const QSize &ratio)

Python specific notes:
The object exposes a writable attribute 'pixelAspectRatio'. This is the setter.

pixelFormat

Signature: [const] QVideoFrame_PixelFormat pixelFormat

Description: Method QVideoFrame::PixelFormat QCameraViewfinderSettings::pixelFormat()

Python specific notes:
The object exposes a readable attribute 'pixelFormat'. This is the getter.

pixelFormat=

Signature: void pixelFormat= (const QVideoFrame_PixelFormat format)

Description: Method void QCameraViewfinderSettings::setPixelFormat(QVideoFrame::PixelFormat format)

Python specific notes:
The object exposes a writable attribute 'pixelFormat'. This is the setter.

resolution

Signature: [const] QSize resolution

Description: Method QSize QCameraViewfinderSettings::resolution()

Python specific notes:
The object exposes a readable attribute 'resolution'. This is the getter.

resolution=

Signature: void resolution= (const QSize arg1)

Description: Method void QCameraViewfinderSettings::setResolution(const QSize &)

Python specific notes:
The object exposes a writable attribute 'resolution'. This is the setter.

setMaximumFrameRate

Signature: void setMaximumFrameRate (double rate)

Description: Method void QCameraViewfinderSettings::setMaximumFrameRate(double rate)

Python specific notes:
The object exposes a writable attribute 'maximumFrameRate'. This is the setter.

setMinimumFrameRate

Signature: void setMinimumFrameRate (double rate)

Description: Method void QCameraViewfinderSettings::setMinimumFrameRate(double rate)

Python specific notes:
The object exposes a writable attribute 'minimumFrameRate'. This is the setter.

setPixelAspectRatio

(1) Signature: void setPixelAspectRatio (const QSize ratio)

Description: Method void QCameraViewfinderSettings::setPixelAspectRatio(const QSize &ratio)

Python specific notes:
The object exposes a writable attribute 'pixelAspectRatio'. This is the setter.

(2) Signature: void setPixelAspectRatio (int horizontal, int vertical)

Description: Method void QCameraViewfinderSettings::setPixelAspectRatio(int horizontal, int vertical)

setPixelFormat

Signature: void setPixelFormat (const QVideoFrame_PixelFormat format)

Description: Method void QCameraViewfinderSettings::setPixelFormat(QVideoFrame::PixelFormat format)

Python specific notes:
The object exposes a writable attribute 'pixelFormat'. This is the setter.

setResolution

(1) Signature: void setResolution (const QSize arg1)

Description: Method void QCameraViewfinderSettings::setResolution(const QSize &)

Python specific notes:
The object exposes a writable attribute 'resolution'. This is the setter.

(2) Signature: void setResolution (int width, int height)

Description: Method void QCameraViewfinderSettings::setResolution(int width, int height)

swap

Signature: void swap (QCameraViewfinderSettings other)

Description: Method void QCameraViewfinderSettings::swap(QCameraViewfinderSettings &other)