KLayout Documentation (Qt 5): Main Index » Class Index » API reference - Class QMediaPlaylist

API reference - Class QMediaPlaylist

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QMediaPlaylist

Class hierarchy: QMediaPlaylist » QObject

Sub-classes: , Error, QFlags_Error, PlaybackMode, QFlags_PlaybackMode

Public constructors
Public methods
Public static methods and constants
Protected methods (static, non-static and constructors)
Detailed description

Public constructors

new QMediaPlaylist

new

(QObject ptr parent = nullptr)

Constructor QMediaPlaylist::QMediaPlaylist(QObject *parent)

Public methods

	void	_create		Ensures the C++ object is created
	void	_destroy		Explicitly 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	_manage		Marks the object as managed by the script side.
	void	_unmanage		Marks the object as no longer owned by the script side.
	bool	addMedia	(const QMediaContent content)	Method bool QMediaPlaylist::addMedia(const QMediaContent &content)
	bool	addMedia	(QMediaContent[] items)	Method bool QMediaPlaylist::addMedia(const QList<QMediaContent> &items)
[const]	const QMediaBindableInterface ptr	asConstQMediaBindableInterface		Delivers the base class interface QMediaBindableInterface of QMediaPlaylist
[const]	const QObject ptr	asConstQObject		Delivers the base class interface QObject of QMediaPlaylist
	QMediaBindableInterface ptr	asQMediaBindableInterface		Delivers the base class interface QMediaBindableInterface of QMediaPlaylist
	QObject ptr	asQObject		Delivers the base class interface QObject of QMediaPlaylist
	bool	clear		Method bool QMediaPlaylist::clear()
[const]	int	currentIndex		Method int QMediaPlaylist::currentIndex()
	void	currentIndex=	(int index)	Method void QMediaPlaylist::setCurrentIndex(int index)
[signal]	void	currentIndexChanged	(int index)	Signal declaration for QMediaPlaylist::currentIndexChanged(int index)
[const]	QMediaContent	currentMedia		Method QMediaContent QMediaPlaylist::currentMedia()
[signal]	void	currentMediaChanged	(const QMediaContent arg1)	Signal declaration for QMediaPlaylist::currentMediaChanged(const QMediaContent &)
[signal]	void	destroyed	(QObject ptr arg1)	Signal declaration for QMediaPlaylist::destroyed(QObject *)
	void	emit_currentIndexChanged	(int index)	Emitter for signal void QMediaPlaylist::currentIndexChanged(int index)
	void	emit_currentMediaChanged	(const QMediaContent arg1)	Emitter for signal void QMediaPlaylist::currentMediaChanged(const QMediaContent &)
	void	emit_destroyed	(QObject ptr arg1 = nullptr)	Emitter for signal void QMediaPlaylist::destroyed(QObject *)
	void	emit_loadFailed		Emitter for signal void QMediaPlaylist::loadFailed()
	void	emit_loaded		Emitter for signal void QMediaPlaylist::loaded()
	void	emit_mediaAboutToBeInserted	(int start, int end)	Emitter for signal void QMediaPlaylist::mediaAboutToBeInserted(int start, int end)
	void	emit_mediaAboutToBeRemoved	(int start, int end)	Emitter for signal void QMediaPlaylist::mediaAboutToBeRemoved(int start, int end)
	void	emit_mediaChanged	(int start, int end)	Emitter for signal void QMediaPlaylist::mediaChanged(int start, int end)
	void	emit_mediaInserted	(int start, int end)	Emitter for signal void QMediaPlaylist::mediaInserted(int start, int end)
	void	emit_mediaRemoved	(int start, int end)	Emitter for signal void QMediaPlaylist::mediaRemoved(int start, int end)
	void	emit_objectNameChanged	(string objectName)	Emitter for signal void QMediaPlaylist::objectNameChanged(const QString &objectName)
	void	emit_playbackModeChanged	(const QMediaPlaylist_PlaybackMode mode)	Emitter for signal void QMediaPlaylist::playbackModeChanged(QMediaPlaylist::PlaybackMode mode)
[const]	QMediaPlaylist_Error	error		Method QMediaPlaylist::Error QMediaPlaylist::error()
[const]	string	errorString		Method QString QMediaPlaylist::errorString()
	bool	event	(QEvent ptr event)	Virtual method bool QMediaPlaylist::event(QEvent *event)
	bool	eventFilter	(QObject ptr watched, QEvent ptr event)	Virtual method bool QMediaPlaylist::eventFilter(QObject watched, QEvent event)
	bool	insertMedia	(int index, const QMediaContent content)	Method bool QMediaPlaylist::insertMedia(int index, const QMediaContent &content)
	bool	insertMedia	(int index, QMediaContent[] items)	Method bool QMediaPlaylist::insertMedia(int index, const QList<QMediaContent> &items)
[const]	bool	isEmpty?		Method bool QMediaPlaylist::isEmpty()
[const]	bool	isReadOnly?		Method bool QMediaPlaylist::isReadOnly()
	void	load	(const QNetworkRequest request, string format = nullptr)	Method void QMediaPlaylist::load(const QNetworkRequest &request, const char *format)
	void	load	(const QUrl location, string format = nullptr)	Method void QMediaPlaylist::load(const QUrl &location, const char *format)
	void	load	(QIODevice ptr device, string format = nullptr)	Method void QMediaPlaylist::load(QIODevice device, const char format)
[signal]	void	loadFailed		Signal declaration for QMediaPlaylist::loadFailed()
[signal]	void	loaded		Signal declaration for QMediaPlaylist::loaded()
[const]	QMediaContent	media	(int index)	Method QMediaContent QMediaPlaylist::media(int index)
[signal]	void	mediaAboutToBeInserted	(int start, int end)	Signal declaration for QMediaPlaylist::mediaAboutToBeInserted(int start, int end)
[signal]	void	mediaAboutToBeRemoved	(int start, int end)	Signal declaration for QMediaPlaylist::mediaAboutToBeRemoved(int start, int end)
[signal]	void	mediaChanged	(int start, int end)	Signal declaration for QMediaPlaylist::mediaChanged(int start, int end)
[const]	int	mediaCount		Method int QMediaPlaylist::mediaCount()
[signal]	void	mediaInserted	(int start, int end)	Signal declaration for QMediaPlaylist::mediaInserted(int start, int end)
[const]	QMediaObject ptr	mediaObject		Virtual method QMediaObject *QMediaPlaylist::mediaObject()
[signal]	void	mediaRemoved	(int start, int end)	Signal declaration for QMediaPlaylist::mediaRemoved(int start, int end)
	bool	moveMedia	(int from, int to)	Method bool QMediaPlaylist::moveMedia(int from, int to)
	void	next		Method void QMediaPlaylist::next()
[const]	int	nextIndex	(int steps = 1)	Method int QMediaPlaylist::nextIndex(int steps)
[signal]	void	objectNameChanged	(string objectName)	Signal declaration for QMediaPlaylist::objectNameChanged(const QString &objectName)
[const]	QMediaPlaylist_PlaybackMode	playbackMode		Method QMediaPlaylist::PlaybackMode QMediaPlaylist::playbackMode()
	void	playbackMode=	(const QMediaPlaylist_PlaybackMode mode)	Method void QMediaPlaylist::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)
[signal]	void	playbackModeChanged	(const QMediaPlaylist_PlaybackMode mode)	Signal declaration for QMediaPlaylist::playbackModeChanged(QMediaPlaylist::PlaybackMode mode)
	void	previous		Method void QMediaPlaylist::previous()
[const]	int	previousIndex	(int steps = 1)	Method int QMediaPlaylist::previousIndex(int steps)
	bool	removeMedia	(int pos)	Method bool QMediaPlaylist::removeMedia(int pos)
	bool	removeMedia	(int start, int end)	Method bool QMediaPlaylist::removeMedia(int start, int end)
	bool	save	(const QUrl location, string format = nullptr)	Method bool QMediaPlaylist::save(const QUrl &location, const char *format)
	bool	save	(QIODevice ptr device, string format)	Method bool QMediaPlaylist::save(QIODevice device, const char format)
	void	setCurrentIndex	(int index)	Method void QMediaPlaylist::setCurrentIndex(int index)
	void	setPlaybackMode	(const QMediaPlaylist_PlaybackMode mode)	Method void QMediaPlaylist::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)
	void	shuffle		Method void QMediaPlaylist::shuffle()

Public static methods and constants

[static,const]	QMediaPlaylist_Error	AccessDeniedError		Enum constant QMediaPlaylist::AccessDeniedError
[static,const]	QMediaPlaylist_PlaybackMode	CurrentItemInLoop		Enum constant QMediaPlaylist::CurrentItemInLoop
[static,const]	QMediaPlaylist_PlaybackMode	CurrentItemOnce		Enum constant QMediaPlaylist::CurrentItemOnce
[static,const]	QMediaPlaylist_Error	FormatError		Enum constant QMediaPlaylist::FormatError
[static,const]	QMediaPlaylist_Error	FormatNotSupportedError		Enum constant QMediaPlaylist::FormatNotSupportedError
[static,const]	QMediaPlaylist_PlaybackMode	Loop		Enum constant QMediaPlaylist::Loop
[static,const]	QMediaPlaylist_Error	NetworkError		Enum constant QMediaPlaylist::NetworkError
[static,const]	QMediaPlaylist_Error	NoError		Enum constant QMediaPlaylist::NoError
[static,const]	QMediaPlaylist_PlaybackMode	Random		Enum constant QMediaPlaylist::Random
[static,const]	QMediaPlaylist_PlaybackMode	Sequential		Enum constant QMediaPlaylist::Sequential
	QMetaObject	staticMetaObject		Obtains the static MetaObject for this class.
	string	tr	(string s, string c = nullptr, int n = -1)	Static method QString QMediaPlaylist::tr(const char s, const char c, int n)
	string	trUtf8	(string s, string c = nullptr, int n = -1)	Static method QString QMediaPlaylist::trUtf8(const char s, const char c, int n)

Protected methods (static, non-static and constructors)

	void	childEvent	(QChildEvent ptr event)	Virtual method void QMediaPlaylist::childEvent(QChildEvent *event)
	void	customEvent	(QEvent ptr event)	Virtual method void QMediaPlaylist::customEvent(QEvent *event)
	void	disconnectNotify	(const QMetaMethod signal)	Virtual method void QMediaPlaylist::disconnectNotify(const QMetaMethod &signal)
[const]	bool	isSignalConnected	(const QMetaMethod signal)	Method bool QMediaPlaylist::isSignalConnected(const QMetaMethod &signal)
[const]	int	receivers	(string signal)	Method int QMediaPlaylist::receivers(const char *signal)
[const]	QObject ptr	sender		Method QObject *QMediaPlaylist::sender()
[const]	int	senderSignalIndex		Method int QMediaPlaylist::senderSignalIndex()
	bool	setMediaObject	(QMediaObject ptr object)	Virtual method bool QMediaPlaylist::setMediaObject(QMediaObject *object)
	void	timerEvent	(QTimerEvent ptr event)	Virtual method void QMediaPlaylist::timerEvent(QTimerEvent *event)

Detailed description

AccessDeniedError

Signature: [static,const] QMediaPlaylist_Error AccessDeniedError

Description: Enum constant QMediaPlaylist::AccessDeniedError

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

CurrentItemInLoop

Signature: [static,const] QMediaPlaylist_PlaybackMode CurrentItemInLoop

Description: Enum constant QMediaPlaylist::CurrentItemInLoop

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

CurrentItemOnce

Signature: [static,const] QMediaPlaylist_PlaybackMode CurrentItemOnce

Description: Enum constant QMediaPlaylist::CurrentItemOnce

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

FormatError

Signature: [static,const] QMediaPlaylist_Error FormatError

Description: Enum constant QMediaPlaylist::FormatError

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

FormatNotSupportedError

Signature: [static,const] QMediaPlaylist_Error FormatNotSupportedError

Description: Enum constant QMediaPlaylist::FormatNotSupportedError

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

Loop

Signature: [static,const] QMediaPlaylist_PlaybackMode Loop

Description: Enum constant QMediaPlaylist::Loop

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

NetworkError

Signature: [static,const] QMediaPlaylist_Error NetworkError

Description: Enum constant QMediaPlaylist::NetworkError

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

NoError

Signature: [static,const] QMediaPlaylist_Error NoError

Description: Enum constant QMediaPlaylist::NoError

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

Random

Signature: [static,const] QMediaPlaylist_PlaybackMode Random

Description: Enum constant QMediaPlaylist::Random

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

Sequential

Signature: [static,const] QMediaPlaylist_PlaybackMode Sequential

Description: Enum constant QMediaPlaylist::Sequential

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

_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.

addMedia

(1) Signature: bool addMedia (const QMediaContent content)

Description: Method bool QMediaPlaylist::addMedia(const QMediaContent &content)

(2) Signature: bool addMedia (QMediaContent[] items)

Description: Method bool QMediaPlaylist::addMedia(const QList<QMediaContent> &items)

asConstQMediaBindableInterface

Signature: [const] const QMediaBindableInterface ptr asConstQMediaBindableInterface

Description: Delivers the base class interface QMediaBindableInterface of QMediaPlaylist

Class QMediaPlaylist is derived from multiple base classes. This method delivers the QMediaBindableInterface base class aspect.

Use this version if you have a const reference.

asConstQObject

Signature: [const] const QObject ptr asConstQObject

Description: Delivers the base class interface QObject of QMediaPlaylist

Class QMediaPlaylist is derived from multiple base classes. This method delivers the QObject base class aspect.

Use this version if you have a const reference.

asQMediaBindableInterface

Signature: QMediaBindableInterface ptr asQMediaBindableInterface

Description: Delivers the base class interface QMediaBindableInterface of QMediaPlaylist

Class QMediaPlaylist is derived from multiple base classes. This method delivers the QMediaBindableInterface base class aspect.

asQObject

Signature: QObject ptr asQObject

Description: Delivers the base class interface QObject of QMediaPlaylist

Class QMediaPlaylist is derived from multiple base classes. This method delivers the QObject base class aspect.

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

clear

Signature: bool clear

Description: Method bool QMediaPlaylist::clear()

currentIndex

Signature: [const] int currentIndex

Description: Method int QMediaPlaylist::currentIndex()

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

currentIndex=

Signature: void currentIndex= (int index)

Description: Method void QMediaPlaylist::setCurrentIndex(int index)

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

currentIndexChanged

Signature: [signal] void currentIndexChanged (int index)

Description: Signal declaration for QMediaPlaylist::currentIndexChanged(int index)

You can bind a procedure to this signal.

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

currentMedia

Signature: [const] QMediaContent currentMedia

Description: Method QMediaContent QMediaPlaylist::currentMedia()

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

currentMediaChanged

Signature: [signal] void currentMediaChanged (const QMediaContent arg1)

Description: Signal declaration for QMediaPlaylist::currentMediaChanged(const QMediaContent &)

You can bind a procedure to this signal.

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QMediaPlaylist::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 QMediaPlaylist::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.