StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Property::Duration Class Referencefinal

Media duration stored as nanoseconds. More...

#include <StormByte/multimedia/property/duration.hxx>

Public Member Functions

 Duration () noexcept=default
 Constructs a zero duration for Safe value storage.
 Duration (std::chrono::nanoseconds value) noexcept
 Constructs from nanoseconds.
 Duration (const Duration &)=default
 Copy constructor.
 Duration (Duration &&) noexcept=default
 Move constructor.
 ~Duration () noexcept=default
 Destructor.
Duration & operator= (const Duration &)=default
 Copy assignment.
Duration & operator= (Duration &&) noexcept=default
 Move assignment.
auto operator<=> (const Duration &) const noexcept=default
 Three-way compare.
std::chrono::nanoseconds Nanoseconds () const noexcept
 Duration in nanoseconds.
StormByte::Safe::String ToString () const
 [HH:][MM:]SS.mmm (hours/minutes omitted when zero).

Detailed Description

Media duration stored as nanoseconds.

Note
DLL exchange requires compatible C++ ABIs. Base and Multimedia must remain loaded while their values and provider callbacks are in use.

Constructor & Destructor Documentation

◆ Duration() [1/4]

StormByte::Multimedia::Property::Duration::Duration ( )
defaultnoexcept

Constructs a zero duration for Safe value storage.

◆ Duration() [2/4]

StormByte::Multimedia::Property::Duration::Duration ( std::chrono::nanoseconds value)
explicitnoexcept

Constructs from nanoseconds.

Parameters
valueDuration.

◆ Duration() [3/4]

StormByte::Multimedia::Property::Duration::Duration ( const Duration & )
default

Copy constructor.

◆ Duration() [4/4]

StormByte::Multimedia::Property::Duration::Duration ( Duration && )
defaultnoexcept

Move constructor.

◆ ~Duration()

StormByte::Multimedia::Property::Duration::~Duration ( )
defaultnoexcept

Destructor.

Member Function Documentation

◆ Nanoseconds()

std::chrono::nanoseconds StormByte::Multimedia::Property::Duration::Nanoseconds ( ) const
noexcept

Duration in nanoseconds.

Returns
Stored value.

◆ operator<=>()

auto StormByte::Multimedia::Property::Duration::operator<=> ( const Duration & ) const
defaultnoexcept

Three-way compare.

Returns
Ordering of the stored nanosecond values.

◆ operator=() [1/2]

Duration & StormByte::Multimedia::Property::Duration::operator= ( const Duration & )
default

Copy assignment.

Returns
*this.

◆ operator=() [2/2]

Duration & StormByte::Multimedia::Property::Duration::operator= ( Duration && )
defaultnoexcept

Move assignment.

Returns
*this.

◆ ToString()

StormByte::Safe::String StormByte::Multimedia::Property::Duration::ToString ( ) const

[HH:][MM:]SS.mmm (hours/minutes omitted when zero).

Returns
Human-readable text.
Exceptions
StormByte::ExceptionIf Base-owned text cannot be allocated.
std::bad_allocIf temporary formatting storage cannot be allocated.

The documentation for this class was generated from the following file: