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

new QMediaPlaylistnew(QObject ptr parent = 0)Constructor QMediaPlaylist::QMediaPlaylist(QObject *parent)

Public methods

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.
booladdMedia(const QMediaContent content)Method bool QMediaPlaylist::addMedia(const QMediaContent &content)
booladdMedia(QMediaContent[] items)Method bool QMediaPlaylist::addMedia(const QList<QMediaContent> &items)
[const]const QMediaBindableInterface ptrasConstQMediaBindableInterfaceDelivers the base class interface QMediaBindableInterface of QMediaPlaylist
[const]const QObject ptrasConstQObjectDelivers the base class interface QObject of QMediaPlaylist
QMediaBindableInterface ptrasQMediaBindableInterfaceDelivers the base class interface QMediaBindableInterface of QMediaPlaylist
QObject ptrasQObjectDelivers the base class interface QObject of QMediaPlaylist
boolclearMethod bool QMediaPlaylist::clear()
[const]intcurrentIndexMethod int QMediaPlaylist::currentIndex()
voidcurrentIndex=(int index)Method void QMediaPlaylist::setCurrentIndex(int index)
voidcurrentIndexChanged(int index)Method void QMediaPlaylist::currentIndexChanged(int index)
[const]QMediaContentcurrentMediaMethod QMediaContent QMediaPlaylist::currentMedia()
voidcurrentMediaChanged(const QMediaContent arg1)Method void QMediaPlaylist::currentMediaChanged(const QMediaContent &)
[const]QMediaPlaylist_ErrorerrorMethod QMediaPlaylist::Error QMediaPlaylist::error()
[const]stringerrorStringMethod QString QMediaPlaylist::errorString()
boolevent(QEvent ptr arg1)Virtual method bool QMediaPlaylist::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QMediaPlaylist::eventFilter(QObject *, QEvent *)
boolinsertMedia(int index,
const QMediaContent content)
Method bool QMediaPlaylist::insertMedia(int index, const QMediaContent &content)
boolinsertMedia(int index,
QMediaContent[] items)
Method bool QMediaPlaylist::insertMedia(int index, const QList<QMediaContent> &items)
[const]boolisEmpty?Method bool QMediaPlaylist::isEmpty()
[const]boolisReadOnly?Method bool QMediaPlaylist::isReadOnly()
voidload(const QNetworkRequest request,
string format = 0)
Method void QMediaPlaylist::load(const QNetworkRequest &request, const char *format)
voidload(const QUrl location,
string format = 0)
Method void QMediaPlaylist::load(const QUrl &location, const char *format)
voidload(QIODevice ptr device,
string format = 0)
Method void QMediaPlaylist::load(QIODevice *device, const char *format)
voidloadFailedMethod void QMediaPlaylist::loadFailed()
voidloadedMethod void QMediaPlaylist::loaded()
[const]QMediaContentmedia(int index)Method QMediaContent QMediaPlaylist::media(int index)
voidmediaAboutToBeInserted(int start,
int end)
Method void QMediaPlaylist::mediaAboutToBeInserted(int start, int end)
voidmediaAboutToBeRemoved(int start,
int end)
Method void QMediaPlaylist::mediaAboutToBeRemoved(int start, int end)
voidmediaChanged(int start,
int end)
Method void QMediaPlaylist::mediaChanged(int start, int end)
[const]intmediaCountMethod int QMediaPlaylist::mediaCount()
voidmediaInserted(int start,
int end)
Method void QMediaPlaylist::mediaInserted(int start, int end)
[const]QMediaObject ptrmediaObjectVirtual method QMediaObject *QMediaPlaylist::mediaObject()
voidmediaRemoved(int start,
int end)
Method void QMediaPlaylist::mediaRemoved(int start, int end)
voidnextMethod void QMediaPlaylist::next()
[const]intnextIndex(int steps = 1)Method int QMediaPlaylist::nextIndex(int steps)
[const]QMediaPlaylist_PlaybackModeplaybackModeMethod QMediaPlaylist::PlaybackMode QMediaPlaylist::playbackMode()
voidplaybackMode=(const QMediaPlaylist_PlaybackMode mode)Method void QMediaPlaylist::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)
voidplaybackModeChanged(const QMediaPlaylist_PlaybackMode mode)Method void QMediaPlaylist::playbackModeChanged(QMediaPlaylist::PlaybackMode mode)
voidpreviousMethod void QMediaPlaylist::previous()
[const]intpreviousIndex(int steps = 1)Method int QMediaPlaylist::previousIndex(int steps)
boolremoveMedia(int pos)Method bool QMediaPlaylist::removeMedia(int pos)
boolremoveMedia(int start,
int end)
Method bool QMediaPlaylist::removeMedia(int start, int end)
boolsave(const QUrl location,
string format = 0)
Method bool QMediaPlaylist::save(const QUrl &location, const char *format)
boolsave(QIODevice ptr device,
string format)
Method bool QMediaPlaylist::save(QIODevice *device, const char *format)
voidsetCurrentIndex(int index)Method void QMediaPlaylist::setCurrentIndex(int index)
voidsetPlaybackMode(const QMediaPlaylist_PlaybackMode mode)Method void QMediaPlaylist::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)
voidshuffleMethod void QMediaPlaylist::shuffle()

Public static methods and constants

[static,const]QMediaPlaylist_ErrorAccessDeniedErrorEnum constant QMediaPlaylist::AccessDeniedError
[static,const]QMediaPlaylist_PlaybackModeCurrentItemInLoopEnum constant QMediaPlaylist::CurrentItemInLoop
[static,const]QMediaPlaylist_PlaybackModeCurrentItemOnceEnum constant QMediaPlaylist::CurrentItemOnce
[static,const]QMediaPlaylist_ErrorFormatErrorEnum constant QMediaPlaylist::FormatError
[static,const]QMediaPlaylist_ErrorFormatNotSupportedErrorEnum constant QMediaPlaylist::FormatNotSupportedError
[static,const]QMediaPlaylist_PlaybackModeLoopEnum constant QMediaPlaylist::Loop
[static,const]QMediaPlaylist_ErrorNetworkErrorEnum constant QMediaPlaylist::NetworkError
[static,const]QMediaPlaylist_ErrorNoErrorEnum constant QMediaPlaylist::NoError
[static,const]QMediaPlaylist_PlaybackModeRandomEnum constant QMediaPlaylist::Random
[static,const]QMediaPlaylist_PlaybackModeSequentialEnum constant QMediaPlaylist::Sequential
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QMediaPlaylist::tr(const char *s, const char *c, int n)
stringtrUtf8(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)

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

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 arg1)

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

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: void currentIndexChanged (int index)

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

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: void currentMediaChanged (const QMediaContent arg1)

Description: Method void QMediaPlaylist::currentMediaChanged(const QMediaContent &)

customEvent

Signature: void customEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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.

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 arg1)

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

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QMediaPlaylist::eventFilter(QObject *, QEvent *)

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 = 0)

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

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

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

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

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

loadFailed

Signature: void loadFailed

Description: Method void QMediaPlaylist::loadFailed()

loaded

Signature: void loaded

Description: Method void QMediaPlaylist::loaded()

media

Signature: [const] QMediaContent media (int index)

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

mediaAboutToBeInserted

Signature: void mediaAboutToBeInserted (int start, int end)

Description: Method void QMediaPlaylist::mediaAboutToBeInserted(int start, int end)

mediaAboutToBeRemoved

Signature: void mediaAboutToBeRemoved (int start, int end)

Description: Method void QMediaPlaylist::mediaAboutToBeRemoved(int start, int end)

mediaChanged

Signature: void mediaChanged (int start, int end)

Description: Method void QMediaPlaylist::mediaChanged(int start, int end)

mediaCount

Signature: [const] int mediaCount

Description: Method int QMediaPlaylist::mediaCount()

mediaInserted

Signature: void mediaInserted (int start, int end)

Description: Method void QMediaPlaylist::mediaInserted(int start, int end)

mediaObject

Signature: [const] QMediaObject ptr mediaObject

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

This method can be reimplemented in a derived class.

mediaRemoved

Signature: void mediaRemoved (int start, int end)

Description: Method void QMediaPlaylist::mediaRemoved(int start, int end)

new

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

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)

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: void playbackModeChanged (const QMediaPlaylist_PlaybackMode mode)

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

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 = 0)

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 arg1)

Description: Virtual method void QMediaPlaylist::timerEvent(QTimerEvent *)

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.