CopperSpice API  1.7.2
QMediaTimeInterval Class Reference

The QMediaTimeInterval class represents a time interval with integer precision. More...

Public Methods

 QMediaTimeInterval ()
 
 QMediaTimeInterval (const QMediaTimeInterval &other)
 
 QMediaTimeInterval (qint64 start, qint64 end)
 
bool contains (qint64 time) const
 
qint64 end () const
 
bool isNormal () const
 
QMediaTimeInterval normalized () const
 
qint64 start () const
 
QMediaTimeInterval translated (qint64 offset) const
 

Friends

class QMediaTimeRange
 

Detailed Description

An interval is specified by an inclusive start() and end() time. These must be set in the constructor, as this is an immutable class. The specific units of time represented by the class have not been defined - it is suitable for any times which can be represented by a signed 64 bit integer.

The isNormal() method determines if a time interval is normal (a normal time interval has start() <= end()). A normal interval can be received from an abnormal interval by calling the normalized() method.

The contains() method determines if a specified time lies within the time interval. The method translated() returns a time interval which has been translated forwards or backwards through time by a specified offset.

See also
QMediaTimeRange

Constructor & Destructor Documentation

QMediaTimeInterval::QMediaTimeInterval ( )

Constructs an empty interval.

QMediaTimeInterval::QMediaTimeInterval ( qint64  start,
qint64  end 
)

Constructs an interval with the specified start and end times.

QMediaTimeInterval::QMediaTimeInterval ( const QMediaTimeInterval &  other)

Constructs an interval by taking a copy of other.

Method Documentation

bool QMediaTimeInterval::contains ( qint64  time) const

Returns true if the time interval contains the specified time. This means start() <= time <= end().

qint64 QMediaTimeInterval::end ( ) const

Returns the end time of the interval.

See also
start()
bool QMediaTimeInterval::isNormal ( ) const

Returns true if this time interval is normal. A normal time interval has start() <= end().

See also
normalized()
QMediaTimeInterval QMediaTimeInterval::normalized ( ) const

Returns a normalized version of this interval. If the start() time of the interval is greater than the end() time, then the returned interval has the start and end times swapped.

qint64 QMediaTimeInterval::start ( ) const

Returns the start time of the interval.

See also
end()
QMediaTimeInterval QMediaTimeInterval::translated ( qint64  offset) const

Returns a copy of this time interval, translated by a value of offset. An interval can be moved forward through time with a positive offset, or backward through time with a negative offset.