API reference - Class QCameraControl

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QCameraControl

Class hierarchy: QCameraControl » QMediaControl » QObject

Sub-classes: PropertyChangeType, QFlags_PropertyChangeType

Public constructors

new QCameraControlnewConstructor QCameraControl::QCameraControl()

Public methods

[const]QCameraControl 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.
[const]boolcanChangeProperty(const QCameraControl_PropertyChangeType changeType,
const QCamera_Status status)
Virtual method bool QCameraControl::canChangeProperty(QCameraControl::PropertyChangeType changeType, QCamera::Status status)
[const]QCamera_QFlags_CaptureModecaptureModeVirtual method QFlags<QCamera::CaptureMode> QCameraControl::captureMode()
voidcaptureMode=(QCamera_QFlags_CaptureMode arg1)Method void QCameraControl::setCaptureMode(QFlags<QCamera::CaptureMode>)
[signal]voidcaptureModeChanged(QCamera_QFlags_CaptureMode mode)Signal declaration for QCameraControl::captureModeChanged(QFlags<QCamera::CaptureMode> mode)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QCameraControl::destroyed(QObject *)
voidemit_captureModeChanged(QCamera_QFlags_CaptureMode mode)Emitter for signal void QCameraControl::captureModeChanged(QFlags<QCamera::CaptureMode> mode)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QCameraControl::destroyed(QObject *)
voidemit_error(int error,
string errorString)
Emitter for signal void QCameraControl::error(int error, const QString &errorString)
voidemit_objectNameChanged(string objectName)Emitter for signal void QCameraControl::objectNameChanged(const QString &objectName)
voidemit_stateChanged(const QCamera_State arg1)Emitter for signal void QCameraControl::stateChanged(QCamera::State)
voidemit_statusChanged(const QCamera_Status arg1)Emitter for signal void QCameraControl::statusChanged(QCamera::Status)
[signal]voiderror(int error,
string errorString)
Signal declaration for QCameraControl::error(int error, const QString &errorString)
boolevent(QEvent ptr event)Virtual method bool QCameraControl::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QCameraControl::eventFilter(QObject *watched, QEvent *event)
[const]boolisCaptureModeSupported(QCamera_QFlags_CaptureMode mode)Virtual method bool QCameraControl::isCaptureModeSupported(QFlags<QCamera::CaptureMode> mode)
[const]boolisCaptureModeSupported?(QCamera_QFlags_CaptureMode mode)Method bool QCameraControl::isCaptureModeSupported(QFlags<QCamera::CaptureMode> mode)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QCameraControl::objectNameChanged(const QString &objectName)
voidsetCaptureMode(QCamera_QFlags_CaptureMode arg1)Virtual method void QCameraControl::setCaptureMode(QFlags<QCamera::CaptureMode>)
voidsetState(const QCamera_State state)Virtual method void QCameraControl::setState(QCamera::State state)
[const]QCamera_StatestateVirtual method QCamera::State QCameraControl::state()
voidstate=(const QCamera_State state)Method void QCameraControl::setState(QCamera::State state)
[signal]voidstateChanged(const QCamera_State arg1)Signal declaration for QCameraControl::stateChanged(QCamera::State)
[const]QCamera_StatusstatusVirtual method QCamera::Status QCameraControl::status()
[signal]voidstatusChanged(const QCamera_Status arg1)Signal declaration for QCameraControl::statusChanged(QCamera::Status)

Public static methods and constants

[static,const]QCameraControl_PropertyChangeTypeCaptureModeEnum constant QCameraControl::CaptureMode
[static,const]QCameraControl_PropertyChangeTypeImageEncodingSettingsEnum constant QCameraControl::ImageEncodingSettings
[static,const]QCameraControl_PropertyChangeTypeVideoEncodingSettingsEnum constant QCameraControl::VideoEncodingSettings
[static,const]QCameraControl_PropertyChangeTypeViewfinderEnum constant QCameraControl::Viewfinder
[static,const]QCameraControl_PropertyChangeTypeViewfinderSettingsEnum constant QCameraControl::ViewfinderSettings
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QCameraControl::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QCameraControl::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QCameraControl::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QCameraControl::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QCameraControl::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QCameraControl::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QCameraControl::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QCameraControl::sender()
[const]intsenderSignalIndexMethod int QCameraControl::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QCameraControl::timerEvent(QTimerEvent *event)

Detailed description

CaptureMode

Signature: [static,const] QCameraControl_PropertyChangeType CaptureMode

Description: Enum constant QCameraControl::CaptureMode

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

ImageEncodingSettings

Signature: [static,const] QCameraControl_PropertyChangeType ImageEncodingSettings

Description: Enum constant QCameraControl::ImageEncodingSettings

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

VideoEncodingSettings

Signature: [static,const] QCameraControl_PropertyChangeType VideoEncodingSettings

Description: Enum constant QCameraControl::VideoEncodingSettings

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

Viewfinder

Signature: [static,const] QCameraControl_PropertyChangeType Viewfinder

Description: Enum constant QCameraControl::Viewfinder

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

ViewfinderSettings

Signature: [static,const] QCameraControl_PropertyChangeType ViewfinderSettings

Description: Enum constant QCameraControl::ViewfinderSettings

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

_const_cast

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

canChangeProperty

Signature: [const] bool canChangeProperty (const QCameraControl_PropertyChangeType changeType, const QCamera_Status status)

Description: Virtual method bool QCameraControl::canChangeProperty(QCameraControl::PropertyChangeType changeType, QCamera::Status status)

This method can be reimplemented in a derived class.

captureMode

Signature: [const] QCamera_QFlags_CaptureMode captureMode

Description: Virtual method QFlags<QCamera::CaptureMode> QCameraControl::captureMode()

This method can be reimplemented in a derived class.

captureMode=

Signature: void captureMode= (QCamera_QFlags_CaptureMode arg1)

Description: Method void QCameraControl::setCaptureMode(QFlags<QCamera::CaptureMode>)

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

captureModeChanged

Signature: [signal] void captureModeChanged (QCamera_QFlags_CaptureMode mode)

Description: Signal declaration for QCameraControl::captureModeChanged(QFlags<QCamera::CaptureMode> mode)

You can bind a procedure to this signal.

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QCameraControl::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QCameraControl::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QCameraControl::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QCameraControl::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_captureModeChanged

Signature: void emit_captureModeChanged (QCamera_QFlags_CaptureMode mode)

Description: Emitter for signal void QCameraControl::captureModeChanged(QFlags<QCamera::CaptureMode> mode)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QCameraControl::destroyed(QObject *)

Call this method to emit this signal.

emit_error

Signature: void emit_error (int error, string errorString)

Description: Emitter for signal void QCameraControl::error(int error, const QString &errorString)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QCameraControl::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_stateChanged

Signature: void emit_stateChanged (const QCamera_State arg1)

Description: Emitter for signal void QCameraControl::stateChanged(QCamera::State)

Call this method to emit this signal.

emit_statusChanged

Signature: void emit_statusChanged (const QCamera_Status arg1)

Description: Emitter for signal void QCameraControl::statusChanged(QCamera::Status)

Call this method to emit this signal.

error

Signature: [signal] void error (int error, string errorString)

Description: Signal declaration for QCameraControl::error(int error, const QString &errorString)

You can bind a procedure to this signal.

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

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QCameraControl::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QCameraControl::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

isCaptureModeSupported

Signature: [const] bool isCaptureModeSupported (QCamera_QFlags_CaptureMode mode)

Description: Virtual method bool QCameraControl::isCaptureModeSupported(QFlags<QCamera::CaptureMode> mode)

This method can be reimplemented in a derived class.

isCaptureModeSupported?

Signature: [const] bool isCaptureModeSupported? (QCamera_QFlags_CaptureMode mode)

Description: Method bool QCameraControl::isCaptureModeSupported(QFlags<QCamera::CaptureMode> mode)

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QCameraControl::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

new

Signature: [static] new QCameraControl new

Description: Constructor QCameraControl::QCameraControl()

This method creates an object of class QCameraControl.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QCameraControl::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QCameraControl::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QCameraControl::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QCameraControl::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setCaptureMode

Signature: void setCaptureMode (QCamera_QFlags_CaptureMode arg1)

Description: Virtual method void QCameraControl::setCaptureMode(QFlags<QCamera::CaptureMode>)

This method can be reimplemented in a derived class.

setState

Signature: void setState (const QCamera_State state)

Description: Virtual method void QCameraControl::setState(QCamera::State state)

This method can be reimplemented in a derived class.

state

Signature: [const] QCamera_State state

Description: Virtual method QCamera::State QCameraControl::state()

This method can be reimplemented in a derived class.

state=

Signature: void state= (const QCamera_State state)

Description: Method void QCameraControl::setState(QCamera::State state)

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

stateChanged

Signature: [signal] void stateChanged (const QCamera_State arg1)

Description: Signal declaration for QCameraControl::stateChanged(QCamera::State)

You can bind a procedure to this signal.

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

status

Signature: [const] QCamera_Status status

Description: Virtual method QCamera::Status QCameraControl::status()

This method can be reimplemented in a derived class.

statusChanged

Signature: [signal] void statusChanged (const QCamera_Status arg1)

Description: Signal declaration for QCameraControl::statusChanged(QCamera::Status)

You can bind a procedure to this signal.

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QCameraControl::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QCameraControl::tr(const char *s, const char *c, int n)

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

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QCameraControl::trUtf8(const char *s, const char *c, int n)

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