API reference - Class QCameraInfo

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QCameraInfo

Public constructors

new QCameraInfonew(bytes name = QByteArray())Constructor QCameraInfo::QCameraInfo(const QByteArray &name)
new QCameraInfonew(const QCamera camera)Constructor QCameraInfo::QCameraInfo(const QCamera &camera)
new QCameraInfonew(const QCameraInfo other)Constructor QCameraInfo::QCameraInfo(const QCameraInfo &other)

Public methods

[const]bool!=(const QCameraInfo other)Method bool QCameraInfo::operator!=(const QCameraInfo &other)
[const]bool==(const QCameraInfo other)Method bool QCameraInfo::operator==(const QCameraInfo &other)
void_assign(const QCameraInfo other)Assigns another object to self
[const]QCameraInfo 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.
QCameraInfoassign(const QCameraInfo other)Method QCameraInfo &QCameraInfo::operator=(const QCameraInfo &other)
[const]stringdescriptionMethod QString QCameraInfo::description()
[const]stringdeviceNameMethod QString QCameraInfo::deviceName()
[const]new QCameraInfo ptrdupCreates a copy of self
[const]boolisNull?Method bool QCameraInfo::isNull()
[const]intorientationMethod int QCameraInfo::orientation()
[const]QCamera_PositionpositionMethod QCamera::Position QCameraInfo::position()

Public static methods and constants

QCameraInfo[]availableCameras(const QCamera_Position position = QCamera::UnspecifiedPosition)Static method QList<QCameraInfo> QCameraInfo::availableCameras(QCamera::Position position)
QCameraInfodefaultCameraStatic method QCameraInfo QCameraInfo::defaultCamera()

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 QCameraInfo other)

Description: Method bool QCameraInfo::operator!=(const QCameraInfo &other)

==

Signature: [const] bool == (const QCameraInfo other)

Description: Method bool QCameraInfo::operator==(const QCameraInfo &other)

_assign

Signature: void _assign (const QCameraInfo other)

Description: Assigns another object to self

_const_cast

Signature: [const] QCameraInfo 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: QCameraInfo assign (const QCameraInfo other)

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

availableCameras

Signature: [static] QCameraInfo[] availableCameras (const QCamera_Position position = QCamera::UnspecifiedPosition)

Description: Static method QList<QCameraInfo> QCameraInfo::availableCameras(QCamera::Position position)

This method is static and can be called without an instance.

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.

defaultCamera

Signature: [static] QCameraInfo defaultCamera

Description: Static method QCameraInfo QCameraInfo::defaultCamera()

This method is static and can be called without an instance.

description

Signature: [const] string description

Description: Method QString QCameraInfo::description()

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.

deviceName

Signature: [const] string deviceName

Description: Method QString QCameraInfo::deviceName()

dup

Signature: [const] new QCameraInfo 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 QCameraInfo::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.

new

(1) Signature: [static] new QCameraInfo new (bytes name = QByteArray())

Description: Constructor QCameraInfo::QCameraInfo(const QByteArray &name)

This method creates an object of class QCameraInfo.

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

(2) Signature: [static] new QCameraInfo new (const QCamera camera)

Description: Constructor QCameraInfo::QCameraInfo(const QCamera &camera)

This method creates an object of class QCameraInfo.

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

(3) Signature: [static] new QCameraInfo new (const QCameraInfo other)

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

This method creates an object of class QCameraInfo.

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

orientation

Signature: [const] int orientation

Description: Method int QCameraInfo::orientation()

position

Signature: [const] QCamera_Position position

Description: Method QCamera::Position QCameraInfo::position()