StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Metadata::File Class Reference

File tags and header fields captured at Open. More...

#include <StormByte/multimedia/metadata/file.hxx>

Public Member Functions

 File (const File &other)
 Copy constructor.
 File (File &&other) noexcept
 Move constructor.
 ~File () noexcept
 Destructor.
File & operator= (const File &other)
 Copy assignment.
File & operator= (File &&other) noexcept
 Move assignment.
const Safe::Optional< Safe::String > & Title () const noexcept
 Work title.
const Safe::Optional< Safe::String > & Artist () const noexcept
 Main artist.
const Safe::Optional< Safe::String > & Album () const noexcept
 Album / set name.
const Safe::Optional< Safe::String > & AlbumArtist () const noexcept
 Album artist if different from Artist.
const Safe::Optional< Safe::String > & Composer () const noexcept
 Composer.
const Safe::Optional< Safe::String > & Genre () const noexcept
 Genre.
const Safe::Optional< Safe::String > & Comment () const noexcept
 Comment.
const Safe::Optional< Safe::String > & Copyright () const noexcept
 Copyright notice.
const Safe::Optional< Safe::String > & Encoder () const noexcept
 Encoder identification.
const Safe::Optional< Safe::String > & Date () const noexcept
 Date / year tag.
Safe::Optional< unsigned > Track () const
 Track number.
Safe::Optional< unsigned > Disc () const
 Disc number.
Safe::Optional< Safe::String > Tag (FileTag tag) const
 One file tag as text, for generic tag editors.
const Safe::Vector< Chapter > & Chapters () const noexcept
 Chapter list in source order.
std::chrono::nanoseconds StartTime () const noexcept
 Start of the source timeline.

Friends

class StormByte::Multimedia::File
 Public media file snapshot.
class StormByte::Multimedia::Detail::Probe
 Private metadata probe.

Detailed Description

File tags and header fields captured at Open.

Container tags take precedence over single-audio stream comments. Duration that requires a demux scan lives on Multimedia::File, not here.

Constructor & Destructor Documentation

◆ File() [1/2]

Copy constructor.

Parameters
otherMetadata to copy.

◆ File() [2/2]

Move constructor.

Parameters
otherMetadata to transfer.

◆ ~File()

StormByte::Multimedia::Metadata::File::~File ( )
noexcept

Destructor.

Member Function Documentation

◆ Album()

const Safe::Optional< Safe::String > & StormByte::Multimedia::Metadata::File::Album ( ) const
noexcept

Album / set name.

Returns
Album, or empty.

◆ AlbumArtist()

const Safe::Optional< Safe::String > & StormByte::Multimedia::Metadata::File::AlbumArtist ( ) const
noexcept

Album artist if different from Artist.

Returns
Album artist, or empty.

◆ Artist()

const Safe::Optional< Safe::String > & StormByte::Multimedia::Metadata::File::Artist ( ) const
noexcept

Main artist.

Returns
Artist, or empty.

◆ Chapters()

const Safe::Vector< Chapter > & StormByte::Multimedia::Metadata::File::Chapters ( ) const
noexcept

Chapter list in source order.

Returns
Chapters, empty when the container has none.

◆ Comment()

const Safe::Optional< Safe::String > & StormByte::Multimedia::Metadata::File::Comment ( ) const
noexcept

Comment.

Returns
Comment, or empty.

◆ Composer()

const Safe::Optional< Safe::String > & StormByte::Multimedia::Metadata::File::Composer ( ) const
noexcept

Composer.

Returns
Composer, or empty.

◆ Copyright()

const Safe::Optional< Safe::String > & StormByte::Multimedia::Metadata::File::Copyright ( ) const
noexcept

Copyright notice.

Returns
Copyright, or empty.

◆ Date()

const Safe::Optional< Safe::String > & StormByte::Multimedia::Metadata::File::Date ( ) const
noexcept

Date / year tag.

Returns
Date, or empty.

◆ Disc()

Safe::Optional< unsigned > StormByte::Multimedia::Metadata::File::Disc ( ) const

Disc number.

Returns
Disc, or empty.

◆ Encoder()

const Safe::Optional< Safe::String > & StormByte::Multimedia::Metadata::File::Encoder ( ) const
noexcept

Encoder identification.

Returns
Encoder, or empty.

◆ Genre()

const Safe::Optional< Safe::String > & StormByte::Multimedia::Metadata::File::Genre ( ) const
noexcept

Genre.

Returns
Genre, or empty.

◆ operator=() [1/2]

File & StormByte::Multimedia::Metadata::File::operator= ( const File & other)

Copy assignment.

Parameters
otherMetadata to copy.
Returns
*this.

◆ operator=() [2/2]

File & StormByte::Multimedia::Metadata::File::operator= ( File && other)
noexcept

Move assignment.

Parameters
otherMetadata to transfer.
Returns
*this.

◆ StartTime()

std::chrono::nanoseconds StormByte::Multimedia::Metadata::File::StartTime ( ) const
noexcept

Start of the source timeline.

Returns
Earliest stream start, or zero when unknown.

Stream and chapter times are on this timeline; formats that start at zero report zero.

◆ Tag()

Safe::Optional< Safe::String > StormByte::Multimedia::Metadata::File::Tag ( FileTag tag) const

One file tag as text, for generic tag editors.

Parameters
tagTag to read.
Returns
Value, with Track and Disc as decimal text, or empty.

◆ Title()

const Safe::Optional< Safe::String > & StormByte::Multimedia::Metadata::File::Title ( ) const
noexcept

Work title.

Returns
Title, or empty.

◆ Track()

Safe::Optional< unsigned > StormByte::Multimedia::Metadata::File::Track ( ) const

Track number.

Returns
Track, or empty.

◆ StormByte::Multimedia::Detail::Probe

friend class StormByte::Multimedia::Detail::Probe
friend

Private metadata probe.

◆ StormByte::Multimedia::File

friend class StormByte::Multimedia::File
friend

Public media file snapshot.


The documentation for this class was generated from the following file:
  • lib/public/StormByte/multimedia/metadata/file.hxx