Phonon::Experimental::AvCapture Class Reference

#include <avcapture.h>

Inheritance diagram for Phonon::Experimental::AvCapture:

Properties
Phonon::AudioCaptureDevice	audioCaptureDevice
Phonon::VideoCaptureDevice	videoCaptureDevice
Properties inherited from QObject
	objectName

Signals
void	stateChanged (Phonon::State newstate, Phonon::State oldstate)

Public Slots
void	pause ()
void	start ()
void	stop ()

Public Member Functions
	AvCapture (Phonon::CaptureCategory category, QObject *parent=nullptr)
Phonon::AudioCaptureDevice	audioCaptureDevice () const
void	setAudioCaptureDevice (const Phonon::AudioCaptureDevice &source)
void	setAudioCaptureDevice (Phonon::CaptureCategory category)
PHONON_DEPRECATED void	setAudioCaptureDevice (Phonon::Category category)
void	setCaptureDevices (Phonon::CaptureCategory category)
PHONON_DEPRECATED void	setVideoCaptureDevice (const Phonon::Experimental::VideoCaptureDevice &source)
void	setVideoCaptureDevice (const Phonon::VideoCaptureDevice &source)
void	setVideoCaptureDevice (Phonon::CaptureCategory category)
PHONON_DEPRECATED void	setVideoCaptureDevice (Phonon::Category category)
State	state () const
Phonon::VideoCaptureDevice	videoCaptureDevice () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Media data from a soundcard, soundserver, camera or any other hardware device supported by the backend.

This class gives you access to the capture capabilities of the backend. There might be more than only one possible capture source, for audio, as well as for video. A preferable device may easily be obtained by providing a capture category.

Author

Matthias Kretz kretz.nosp@m.@kde.nosp@m..org

See also

BackendCapabilities::availableAudioCaptureDevices

BackendCapabilities::availableVideoCaptureDevices

Definition at line 61 of file avcapture.h.

Property Documentation

audioCaptureDevice

Phonon::AudioCaptureDevice Phonon::Experimental::AvCapture::audioCaptureDevice

readwrite

Definition at line 66 of file avcapture.h.

videoCaptureDevice

Phonon::VideoCaptureDevice Phonon::Experimental::AvCapture::videoCaptureDevice

readwrite

Definition at line 67 of file avcapture.h.

Constructor & Destructor Documentation

AvCapture()

PHONON_OBJECT_IMPL Phonon::Experimental::AvCapture::AvCapture	(	Phonon::CaptureCategory	category,
		QObject *	parent = nullptr )

Constructs an AvCapture with the devices preferred for the specified capture category.

Parameters

category

Used to determine what devices are most suited for the AvCapture.

See also

CaptureCategory

Definition at line 47 of file avcapture.cpp.

Member Function Documentation

audioCaptureDevice()

Phonon::AudioCaptureDevice Phonon::Experimental::AvCapture::audioCaptureDevice

(

)

const

Returns the currently used capture source for the audio signal.

Definition at line 92 of file avcapture.cpp.

pause

void Phonon::Experimental::AvCapture::pause ( )

slot

Pause capture.

Definition at line 70 of file avcapture.cpp.

setAudioCaptureDevice() [1/3]

void Phonon::Experimental::AvCapture::setAudioCaptureDevice

(

const Phonon::AudioCaptureDevice &

source

)

Sets the audio capture source to use.

Parameters

source

An object of class AudioCaptureDevice.

Definition at line 101 of file avcapture.cpp.

setAudioCaptureDevice() [2/3]

void Phonon::Experimental::AvCapture::setAudioCaptureDevice

(

Phonon::CaptureCategory

category

)

Sets the audio capture device by using a capture category to get the appropriate device.

Parameters

category

Capture category to use for getting a device

Definition at line 110 of file avcapture.cpp.

setAudioCaptureDevice() [3/3]

PHONON_DEPRECATED void Phonon::Experimental::AvCapture::setAudioCaptureDevice

(

Phonon::Category

category

)

Definition at line 119 of file avcapture.cpp.

setCaptureDevices()

void Phonon::Experimental::AvCapture::setCaptureDevices

(

Phonon::CaptureCategory

category

)

Sets both the video and audio devices to the ones most suited for the specified category.

Parameters

category

Used to determine what devices are most suited for the AvCapture.

Definition at line 86 of file avcapture.cpp.

setVideoCaptureDevice() [1/4]

void Phonon::Experimental::AvCapture::setVideoCaptureDevice

(

const Phonon::Experimental::VideoCaptureDevice &

source

)

Deprecated

since 4.4.3, use setVideoCaptureDevice(const Phonon::VideoCaptureDevice &source) instead

Definition at line 133 of file avcapture.cpp.

setVideoCaptureDevice() [2/4]

void Phonon::Experimental::AvCapture::setVideoCaptureDevice

(

const Phonon::VideoCaptureDevice &

source

)

Sets the video capture source to use.

Parameters

source

An object of class VideoCaptureDevice.

See also

videoCaptureDevice

setVideoCaptureDevice(int)

Definition at line 138 of file avcapture.cpp.

setVideoCaptureDevice() [3/4]

void Phonon::Experimental::AvCapture::setVideoCaptureDevice

(

Phonon::CaptureCategory

category

)

Sets the audio capture device by using a capture category to get the appropriate device.

Parameters

category

Capture category to use for getting a device

Definition at line 147 of file avcapture.cpp.

setVideoCaptureDevice() [4/4]

void Phonon::Experimental::AvCapture::setVideoCaptureDevice

(

Phonon::Category

category

)

Definition at line 156 of file avcapture.cpp.

start

void Phonon::Experimental::AvCapture::start ( )

slot

Start capture.

Definition at line 62 of file avcapture.cpp.

state()

Phonon::State Phonon::Experimental::AvCapture::state

(

)

const

Returns the current state of the capture.

• If only the audio capture device is valid, it returns the audio capture state.
• If only the video capture device is valid, it returns the video capture state.
• If both the audio and video capture devices are valid, it only returns the video capture state.

Definition at line 53 of file avcapture.cpp.

stateChanged

void Phonon::Experimental::AvCapture::stateChanged ( Phonon::State newstate, Phonon::State oldstate )

signal

Emitted when the state of the video or audio capture device has been changed.

• If only the audio capture device is valid, it notifies about the audio capture state.
• If only the video capture device is valid, it notifies about the video capture state.
• If both the audio and video capture devices are valid, it only notifies about the video capture state.

stop

void Phonon::Experimental::AvCapture::stop ( )

slot

Stop capture.

Definition at line 78 of file avcapture.cpp.

videoCaptureDevice()

Phonon::VideoCaptureDevice Phonon::Experimental::AvCapture::videoCaptureDevice

(

)

const

Returns the currently used capture source for the video signal.

Definition at line 124 of file avcapture.cpp.

---

The documentation for this class was generated from the following files:

• avcapture.h
• avcapture.cpp