QMediaTimeRange Class
The QMediaTimeRange class represents a set of zero or more disjoint time intervals. More...
| Header: | #include <QMediaTimeRange> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Multimedia) target_link_libraries(mytarget PRIVATE Qt6::Multimedia) |
| qmake: | QT += multimedia |
Note: All functions in this class are reentrant.
Public Types
| struct | Interval |
Public Functions
| QMediaTimeRange() | |
| QMediaTimeRange(qint64 start, qint64 end) | |
| QMediaTimeRange(const QMediaTimeRange::Interval &interval) | |
| QMediaTimeRange(const QMediaTimeRange &range) | |
| QMediaTimeRange(QMediaTimeRange &&other) | |
| ~QMediaTimeRange() | |
| void | addInterval(const QMediaTimeRange::Interval &interval) |
| void | addInterval(qint64 start, qint64 end) |
| void | addTimeRange(const QMediaTimeRange &range) |
| void | clear() |
| bool | contains(qint64 time) const |
| qint64 | earliestTime() const |
| QList<QMediaTimeRange::Interval> | intervals() const |
| bool | isContinuous() const |
| bool | isEmpty() const |
| qint64 | latestTime() const |
| void | removeInterval(const QMediaTimeRange::Interval &interval) |
| void | removeInterval(qint64 start, qint64 end) |
| void | removeTimeRange(const QMediaTimeRange &range) |
| void | swap(QMediaTimeRange &other) |
| QMediaTimeRange & | operator+=(const QMediaTimeRange &other) |
| QMediaTimeRange & | operator+=(const QMediaTimeRange::Interval &interval) |
| QMediaTimeRange & | operator-=(const QMediaTimeRange &other) |
| QMediaTimeRange & | operator-=(const QMediaTimeRange::Interval &interval) |
| QMediaTimeRange & | operator=(const QMediaTimeRange &other) |
| QMediaTimeRange & | operator=(QMediaTimeRange &&other) |
| QMediaTimeRange & | operator=(const QMediaTimeRange::Interval &interval) |
Related Non-Members
| bool | operator!=(const QMediaTimeRange &lhs, const QMediaTimeRange &rhs) |
| QMediaTimeRange | operator+(const QMediaTimeRange &r1, const QMediaTimeRange &r2) |
| QMediaTimeRange | operator-(const QMediaTimeRange &r1, const QMediaTimeRange &r2) |
| bool | operator==(const QMediaTimeRange &lhs, const QMediaTimeRange &rhs) |
Detailed Description
The earliestTime(), latestTime(), intervals() and isEmpty() methods are used to get information about the current time range.
The addInterval(), removeInterval() and clear() methods are used to modify the current time range.
When adding or removing intervals from the time range, existing intervals within the range may be expanded, trimmed, deleted, merged or split to ensure that all intervals within the time range remain distinct and disjoint. As a consequence, all intervals added or removed from a time range must be normal.
See also QMediaTimeRange::Interval.
Member Function Documentation
QMediaTimeRange::QMediaTimeRange()
Constructs an empty time range.
[explicit] QMediaTimeRange::QMediaTimeRange(qint64 start, qint64 end)
Constructs a time range that contains an initial interval from start to end inclusive.
If the interval is not normal, the resulting time range will be empty.
See also addInterval().
QMediaTimeRange::QMediaTimeRange(const QMediaTimeRange::Interval &interval)
Constructs a time range that contains an initial interval, interval.
If interval is not normal, the resulting time range will be empty.
See also addInterval().
[noexcept] QMediaTimeRange::QMediaTimeRange(const QMediaTimeRange &range)
Constructs a time range by copying another time range.
[noexcept] QMediaTimeRange::QMediaTimeRange(QMediaTimeRange &&other)
Constructs a time range by moving from other.
[noexcept] QMediaTimeRange::~QMediaTimeRange()
Destructor.
void QMediaTimeRange::addInterval(const QMediaTimeRange::Interval &interval)
Adds the specified interval to the time range.
Adding intervals which are not normal is invalid, and will be ignored.
If the specified interval is adjacent to, or overlaps existing intervals within the time range, these intervals will be merged.
This operation takes linear time.
See also removeInterval().
void QMediaTimeRange::addInterval(qint64 start, qint64 end)
This is an overloaded function.
Adds the interval specified by start and end to the time range.
See also addInterval().
void QMediaTimeRange::addTimeRange(const QMediaTimeRange &range)
Adds each of the intervals in range to this time range.
Equivalent to calling addInterval() for each interval in range.
void QMediaTimeRange::clear()
Removes all intervals from the time range.
See also removeInterval().
bool QMediaTimeRange::contains(qint64 time) const
Returns true if the specified time lies within the time range.
qint64 QMediaTimeRange::earliestTime() const
Returns the earliest time within the time range.
For empty time ranges, this value is equal to zero.
See also latestTime().
QList<QMediaTimeRange::Interval> QMediaTimeRange::intervals() const
Returns the list of intervals covered by this time range.
bool QMediaTimeRange::isContinuous() const
Returns true if the time range consists of a continuous interval. That is, there is one or fewer disjoint intervals within the time range.
bool QMediaTimeRange::isEmpty() const
Returns true if there are no intervals within the time range.
See also intervals().
qint64 QMediaTimeRange::latestTime() const
Returns the latest time within the time range.
For empty time ranges, this value is equal to zero.
See also earliestTime().
void QMediaTimeRange::removeInterval(const QMediaTimeRange::Interval &interval)
Removes the specified interval from the time range.
Removing intervals which are not normal is invalid, and will be ignored.
Intervals within the time range will be trimmed, split or deleted such that no intervals within the time range include any part of the target interval.
This operation takes linear time.
See also addInterval().
void QMediaTimeRange::removeInterval(qint64 start, qint64 end)
This is an overloaded function.
Removes the interval specified by start and end from the time range.
See also removeInterval().
void QMediaTimeRange::removeTimeRange(const QMediaTimeRange &range)
Removes each of the intervals in range from this time range.
Equivalent to calling removeInterval() for each interval in range.
[noexcept] void QMediaTimeRange::swap(QMediaTimeRange &other)
Swaps the current instance with the other.
QMediaTimeRange &QMediaTimeRange::operator+=(const QMediaTimeRange &other)
Adds each interval in other to the time range and returns the result.
QMediaTimeRange &QMediaTimeRange::operator+=(const QMediaTimeRange::Interval &interval)
Adds the specified interval to the time range and returns the result.
QMediaTimeRange &QMediaTimeRange::operator-=(const QMediaTimeRange &other)
Removes each interval in other from the time range and returns the result.
QMediaTimeRange &QMediaTimeRange::operator-=(const QMediaTimeRange::Interval &interval)
Removes the specified interval from the time range and returns the result.
[noexcept] QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeRange &other)
Takes a copy of the other time range and returns itself.
[noexcept] QMediaTimeRange &QMediaTimeRange::operator=(QMediaTimeRange &&other)
Moves other into this time range.
QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeRange::Interval &interval)
Sets the time range to a single continuous interval, interval.
Related Non-Members
bool operator!=(const QMediaTimeRange &lhs, const QMediaTimeRange &rhs)
Returns true if one or more intervals in lhs are not present in rhs.
QMediaTimeRange operator+(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
Returns a time range containing the union between r1 and r2.
QMediaTimeRange operator-(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
Returns a time range containing r2 subtracted from r1.
bool operator==(const QMediaTimeRange &lhs, const QMediaTimeRange &rhs)
Returns true if all intervals in lhs are present in rhs.