KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QMediaTimeRange

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QMediaTimeRange

Public constructors

new QMediaTimeRangenewConstructor QMediaTimeRange::QMediaTimeRange()
new QMediaTimeRangenew(long long start,
long long end)
Constructor QMediaTimeRange::QMediaTimeRange(qint64 start, qint64 end)
new QMediaTimeRangenew(const QMediaTimeInterval arg1)Constructor QMediaTimeRange::QMediaTimeRange(const QMediaTimeInterval &)
new QMediaTimeRangenew(const QMediaTimeRange range)Constructor QMediaTimeRange::QMediaTimeRange(const QMediaTimeRange &range)

Public methods

[const]bool!=(const QMediaTimeRange arg2)Operator bool ::operator!=(const QMediaTimeRange &, const QMediaTimeRange &)
[const]QMediaTimeRange+(const QMediaTimeRange arg2)Operator QMediaTimeRange ::operator+(const QMediaTimeRange &, const QMediaTimeRange &)
QMediaTimeRange+=(const QMediaTimeRange arg1)Method QMediaTimeRange &QMediaTimeRange::operator+=(const QMediaTimeRange &)
QMediaTimeRange+=(const QMediaTimeInterval arg1)Method QMediaTimeRange &QMediaTimeRange::operator+=(const QMediaTimeInterval &)
[const]QMediaTimeRange-(const QMediaTimeRange arg2)Operator QMediaTimeRange ::operator-(const QMediaTimeRange &, const QMediaTimeRange &)
QMediaTimeRange-=(const QMediaTimeRange arg1)Method QMediaTimeRange &QMediaTimeRange::operator-=(const QMediaTimeRange &)
QMediaTimeRange-=(const QMediaTimeInterval arg1)Method QMediaTimeRange &QMediaTimeRange::operator-=(const QMediaTimeInterval &)
[const]bool==(const QMediaTimeRange arg2)Operator bool ::operator==(const QMediaTimeRange &, const QMediaTimeRange &)
void_assign(const QMediaTimeRange other)Assigns another object to self
[const]QMediaTimeRange 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.
voidaddInterval(long long start,
long long end)
Method void QMediaTimeRange::addInterval(qint64 start, qint64 end)
voidaddInterval(const QMediaTimeInterval interval)Method void QMediaTimeRange::addInterval(const QMediaTimeInterval &interval)
voidaddTimeRange(const QMediaTimeRange arg1)Method void QMediaTimeRange::addTimeRange(const QMediaTimeRange &)
QMediaTimeRangeassign(const QMediaTimeRange arg1)Method QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeRange &)
QMediaTimeRangeassign(const QMediaTimeInterval arg1)Method QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeInterval &)
voidclearMethod void QMediaTimeRange::clear()
[const]boolcontains(long long time)Method bool QMediaTimeRange::contains(qint64 time)
[const]new QMediaTimeRange ptrdupCreates a copy of self
[const]long longearliestTimeMethod qint64 QMediaTimeRange::earliestTime()
[const]QMediaTimeInterval[]intervalsMethod QList<QMediaTimeInterval> QMediaTimeRange::intervals()
[const]boolisContinuous?Method bool QMediaTimeRange::isContinuous()
[const]boolisEmpty?Method bool QMediaTimeRange::isEmpty()
[const]long longlatestTimeMethod qint64 QMediaTimeRange::latestTime()
voidremoveInterval(long long start,
long long end)
Method void QMediaTimeRange::removeInterval(qint64 start, qint64 end)
voidremoveInterval(const QMediaTimeInterval interval)Method void QMediaTimeRange::removeInterval(const QMediaTimeInterval &interval)
voidremoveTimeRange(const QMediaTimeRange arg1)Method void QMediaTimeRange::removeTimeRange(const QMediaTimeRange &)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QMediaTimeRange arg2)

Description: Operator bool ::operator!=(const QMediaTimeRange &, const QMediaTimeRange &)

This is the mapping of the global operator to the instance method.

+

Signature: [const] QMediaTimeRange + (const QMediaTimeRange arg2)

Description: Operator QMediaTimeRange ::operator+(const QMediaTimeRange &, const QMediaTimeRange &)

This is the mapping of the global operator to the instance method.

+=

(1) Signature: QMediaTimeRange += (const QMediaTimeRange arg1)

Description: Method QMediaTimeRange &QMediaTimeRange::operator+=(const QMediaTimeRange &)

(2) Signature: QMediaTimeRange += (const QMediaTimeInterval arg1)

Description: Method QMediaTimeRange &QMediaTimeRange::operator+=(const QMediaTimeInterval &)

-

Signature: [const] QMediaTimeRange - (const QMediaTimeRange arg2)

Description: Operator QMediaTimeRange ::operator-(const QMediaTimeRange &, const QMediaTimeRange &)

This is the mapping of the global operator to the instance method.

-=

(1) Signature: QMediaTimeRange -= (const QMediaTimeRange arg1)

Description: Method QMediaTimeRange &QMediaTimeRange::operator-=(const QMediaTimeRange &)

(2) Signature: QMediaTimeRange -= (const QMediaTimeInterval arg1)

Description: Method QMediaTimeRange &QMediaTimeRange::operator-=(const QMediaTimeInterval &)

==

Signature: [const] bool == (const QMediaTimeRange arg2)

Description: Operator bool ::operator==(const QMediaTimeRange &, const QMediaTimeRange &)

This is the mapping of the global operator to the instance method.

_assign

Signature: void _assign (const QMediaTimeRange other)

Description: Assigns another object to self

_const_cast

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

addInterval

(1) Signature: void addInterval (long long start, long long end)

Description: Method void QMediaTimeRange::addInterval(qint64 start, qint64 end)

(2) Signature: void addInterval (const QMediaTimeInterval interval)

Description: Method void QMediaTimeRange::addInterval(const QMediaTimeInterval &interval)

addTimeRange

Signature: void addTimeRange (const QMediaTimeRange arg1)

Description: Method void QMediaTimeRange::addTimeRange(const QMediaTimeRange &)

assign

(1) Signature: QMediaTimeRange assign (const QMediaTimeRange arg1)

Description: Method QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeRange &)

(2) Signature: QMediaTimeRange assign (const QMediaTimeInterval arg1)

Description: Method QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeInterval &)

clear

Signature: void clear

Description: Method void QMediaTimeRange::clear()

contains

Signature: [const] bool contains (long long time)

Description: Method bool QMediaTimeRange::contains(qint64 time)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QMediaTimeRange ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

earliestTime

Signature: [const] long long earliestTime

Description: Method qint64 QMediaTimeRange::earliestTime()

intervals

Signature: [const] QMediaTimeInterval[] intervals

Description: Method QList<QMediaTimeInterval> QMediaTimeRange::intervals()

isContinuous?

Signature: [const] bool isContinuous?

Description: Method bool QMediaTimeRange::isContinuous()

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QMediaTimeRange::isEmpty()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

latestTime

Signature: [const] long long latestTime

Description: Method qint64 QMediaTimeRange::latestTime()

new

(1) Signature: [static] new QMediaTimeRange new

Description: Constructor QMediaTimeRange::QMediaTimeRange()

This method creates an object of class QMediaTimeRange.

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

(2) Signature: [static] new QMediaTimeRange new (long long start, long long end)

Description: Constructor QMediaTimeRange::QMediaTimeRange(qint64 start, qint64 end)

This method creates an object of class QMediaTimeRange.

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

(3) Signature: [static] new QMediaTimeRange new (const QMediaTimeInterval arg1)

Description: Constructor QMediaTimeRange::QMediaTimeRange(const QMediaTimeInterval &)

This method creates an object of class QMediaTimeRange.

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

(4) Signature: [static] new QMediaTimeRange new (const QMediaTimeRange range)

Description: Constructor QMediaTimeRange::QMediaTimeRange(const QMediaTimeRange &range)

This method creates an object of class QMediaTimeRange.

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

removeInterval

(1) Signature: void removeInterval (long long start, long long end)

Description: Method void QMediaTimeRange::removeInterval(qint64 start, qint64 end)

(2) Signature: void removeInterval (const QMediaTimeInterval interval)

Description: Method void QMediaTimeRange::removeInterval(const QMediaTimeInterval &interval)

removeTimeRange

Signature: void removeTimeRange (const QMediaTimeRange arg1)

Description: Method void QMediaTimeRange::removeTimeRange(const QMediaTimeRange &)