API reference - Class QMediaPlaylist

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.

_const_cast

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

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.

emit_currentIndexChanged

Signature: void emit_currentIndexChanged (int index)

Description: Emitter for signal void QMediaPlaylist::currentIndexChanged(int index)

Call this method to emit this signal.

emit_currentMediaChanged

Signature: void emit_currentMediaChanged (const QMediaContent arg1)

Description: Emitter for signal void QMediaPlaylist::currentMediaChanged(const QMediaContent &)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_loadFailed

Signature: void emit_loadFailed

Description: Emitter for signal void QMediaPlaylist::loadFailed()

Call this method to emit this signal.

emit_loaded

Signature: void emit_loaded

Description: Emitter for signal void QMediaPlaylist::loaded()

Call this method to emit this signal.

emit_mediaAboutToBeInserted

Signature: void emit_mediaAboutToBeInserted (int start, int end)

Description: Emitter for signal void QMediaPlaylist::mediaAboutToBeInserted(int start, int end)

Call this method to emit this signal.

emit_mediaAboutToBeRemoved

Signature: void emit_mediaAboutToBeRemoved (int start, int end)

Description: Emitter for signal void QMediaPlaylist::mediaAboutToBeRemoved(int start, int end)

Call this method to emit this signal.

emit_mediaChanged

Signature: void emit_mediaChanged (int start, int end)

Description: Emitter for signal void QMediaPlaylist::mediaChanged(int start, int end)

Call this method to emit this signal.

emit_mediaInserted

Signature: void emit_mediaInserted (int start, int end)

Description: Emitter for signal void QMediaPlaylist::mediaInserted(int start, int end)

Call this method to emit this signal.

emit_mediaRemoved

Signature: void emit_mediaRemoved (int start, int end)

Description: Emitter for signal void QMediaPlaylist::mediaRemoved(int start, int end)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_playbackModeChanged

Signature: void emit_playbackModeChanged (const QMediaPlaylist_PlaybackMode mode)

Description: Emitter for signal void QMediaPlaylist::playbackModeChanged(QMediaPlaylist::PlaybackMode mode)

Call this method to emit this signal.

error

Signature: [const] QMediaPlaylist_Error error

Description: Method QMediaPlaylist::Error QMediaPlaylist::error()

errorString

Signature: [const] string errorString

Description: Method QString QMediaPlaylist::errorString()

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QMediaPlaylist::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 QMediaPlaylist::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

insertMedia

(1) Signature: bool insertMedia (int index, const QMediaContent content)

Description: Method bool QMediaPlaylist::insertMedia(int index, const QMediaContent &content)

(2) Signature: bool insertMedia (int index, QMediaContent[] items)

Description: Method bool QMediaPlaylist::insertMedia(int index, const QList<QMediaContent> &items)

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QMediaPlaylist::isEmpty()

isReadOnly?

Signature: [const] bool isReadOnly?

Description: Method bool QMediaPlaylist::isReadOnly()

isSignalConnected

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

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

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

load

(1) Signature: void load (const QNetworkRequest request, string format = nullptr)

Description: Method void QMediaPlaylist::load(const QNetworkRequest &request, const char *format)

(2) Signature: void load (const QUrl location, string format = nullptr)

Description: Method void QMediaPlaylist::load(const QUrl &location, const char *format)

(3) Signature: void load (QIODevice ptr device, string format = nullptr)

Description: Method void QMediaPlaylist::load(QIODevice *device, const char *format)

loadFailed

Signature: [signal] void loadFailed

Description: Signal declaration for QMediaPlaylist::loadFailed()

You can bind a procedure to this signal.

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

loaded

Signature: [signal] void loaded

Description: Signal declaration for QMediaPlaylist::loaded()

You can bind a procedure to this signal.

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

media

Signature: [const] QMediaContent media (int index)

Description: Method QMediaContent QMediaPlaylist::media(int index)

mediaAboutToBeInserted

Signature: [signal] void mediaAboutToBeInserted (int start, int end)

Description: Signal declaration for QMediaPlaylist::mediaAboutToBeInserted(int start, int end)

You can bind a procedure to this signal.

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

mediaAboutToBeRemoved

Signature: [signal] void mediaAboutToBeRemoved (int start, int end)

Description: Signal declaration for QMediaPlaylist::mediaAboutToBeRemoved(int start, int end)

You can bind a procedure to this signal.

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

mediaChanged

Signature: [signal] void mediaChanged (int start, int end)

Description: Signal declaration for QMediaPlaylist::mediaChanged(int start, int end)

You can bind a procedure to this signal.

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

mediaCount

Signature: [const] int mediaCount

Description: Method int QMediaPlaylist::mediaCount()

mediaInserted

Signature: [signal] void mediaInserted (int start, int end)

Description: Signal declaration for QMediaPlaylist::mediaInserted(int start, int end)

You can bind a procedure to this signal.

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

mediaObject

Signature: [const] QMediaObject ptr mediaObject

Description: Virtual method QMediaObject *QMediaPlaylist::mediaObject()

This method can be reimplemented in a derived class.

mediaRemoved

Signature: [signal] void mediaRemoved (int start, int end)

Description: Signal declaration for QMediaPlaylist::mediaRemoved(int start, int end)

You can bind a procedure to this signal.

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

moveMedia

Signature: bool moveMedia (int from, int to)

Description: Method bool QMediaPlaylist::moveMedia(int from, int to)

new

Signature: [static] new QMediaPlaylist new (QObject ptr parent = nullptr)

Description: Constructor QMediaPlaylist::QMediaPlaylist(QObject *parent)

This method creates an object of class QMediaPlaylist.

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

next

Signature: void next

Description: Method void QMediaPlaylist::next()

nextIndex

Signature: [const] int nextIndex (int steps = 1)

Description: Method int QMediaPlaylist::nextIndex(int steps)

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QMediaPlaylist::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.

playbackMode

Signature: [const] QMediaPlaylist_PlaybackMode playbackMode

Description: Method QMediaPlaylist::PlaybackMode QMediaPlaylist::playbackMode()

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

playbackMode=

Signature: void playbackMode= (const QMediaPlaylist_PlaybackMode mode)

Description: Method void QMediaPlaylist::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)

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

playbackModeChanged

Signature: [signal] void playbackModeChanged (const QMediaPlaylist_PlaybackMode mode)

Description: Signal declaration for QMediaPlaylist::playbackModeChanged(QMediaPlaylist::PlaybackMode mode)

You can bind a procedure to this signal.

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

previous

Signature: void previous

Description: Method void QMediaPlaylist::previous()

previousIndex

Signature: [const] int previousIndex (int steps = 1)

Description: Method int QMediaPlaylist::previousIndex(int steps)

receivers

Signature: [const] int receivers (string signal)

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

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

removeMedia

(1) Signature: bool removeMedia (int pos)

Description: Method bool QMediaPlaylist::removeMedia(int pos)

(2) Signature: bool removeMedia (int start, int end)

Description: Method bool QMediaPlaylist::removeMedia(int start, int end)

save

(1) Signature: bool save (const QUrl location, string format = nullptr)

Description: Method bool QMediaPlaylist::save(const QUrl &location, const char *format)

(2) Signature: bool save (QIODevice ptr device, string format)

Description: Method bool QMediaPlaylist::save(QIODevice *device, const char *format)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QMediaPlaylist::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QMediaPlaylist::senderSignalIndex()

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

setCurrentIndex

Signature: void setCurrentIndex (int index)

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

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

setMediaObject

Signature: bool setMediaObject (QMediaObject ptr object)

Description: Virtual method bool QMediaPlaylist::setMediaObject(QMediaObject *object)

This method can be reimplemented in a derived class.

setPlaybackMode

Signature: void setPlaybackMode (const QMediaPlaylist_PlaybackMode mode)

Description: Method void QMediaPlaylist::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)

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

shuffle

Signature: void shuffle

Description: Method void QMediaPlaylist::shuffle()

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QMediaPlaylist::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 QMediaPlaylist::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 QMediaPlaylist::trUtf8(const char *s, const char *c, int n)

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