StormByte C++ Library: Multimedia module 0.0.9999
StormByte-Multimedia is a StormByte library module for parsing configuration files
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
StormByte::Multimedia::Metadata::File Class Reference

Container-level tags and header fields captured at Open. More...

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

Public Member Functions

 File (const File &)=default
 Copy constructor.
 
 File (File &&) noexcept=default
 Move constructor.
 
 ~File ()=default
 Destructor.
 
Fileoperator= (const File &)=default
 Copy assignment.
 
Fileoperator= (File &&) noexcept=default
 Move assignment.
 
const std::optional< std::string > & Title () const noexcept
 Work title.
 
const std::optional< std::string > & Artist () const noexcept
 Main artist.
 
const std::optional< std::string > & Album () const noexcept
 Album / set name.
 
const std::optional< std::string > & AlbumArtist () const noexcept
 Album artist if different from Artist.
 
const std::optional< std::string > & Composer () const noexcept
 Composer.
 
const std::optional< std::string > & Genre () const noexcept
 Genre.
 
const std::optional< std::string > & Comment () const noexcept
 Comment.
 
const std::optional< std::string > & Copyright () const noexcept
 Copyright notice.
 
const std::optional< std::string > & Encoder () const noexcept
 Encoder identification.
 
const std::optional< std::string > & Date () const noexcept
 Date / year tag.
 
std::optional< unsigned > Track () const noexcept
 Track number.
 
std::optional< unsigned > Disc () const noexcept
 Disc number.
 

Friends

class StormByte::Multimedia::File
 
class StormByte::Multimedia::Detail::Probe
 

Detailed Description

Container-level tags and header fields captured at Open.

Duration that requires a demux scan lives on Multimedia::File, not here.

Constructor & Destructor Documentation

◆ File() [1/2]

Copy constructor.

◆ File() [2/2]

Move constructor.

◆ ~File()

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

Destructor.

Member Function Documentation

◆ Album()

const std::optional< std::string > & StormByte::Multimedia::Metadata::File::Album ( ) const
noexcept

Album / set name.

Returns
Album, or empty.

◆ AlbumArtist()

const std::optional< std::string > & StormByte::Multimedia::Metadata::File::AlbumArtist ( ) const
noexcept

Album artist if different from Artist.

Returns
Album artist, or empty.

◆ Artist()

const std::optional< std::string > & StormByte::Multimedia::Metadata::File::Artist ( ) const
noexcept

Main artist.

Returns
Artist, or empty.

◆ Comment()

const std::optional< std::string > & StormByte::Multimedia::Metadata::File::Comment ( ) const
noexcept

Comment.

Returns
Comment, or empty.

◆ Composer()

const std::optional< std::string > & StormByte::Multimedia::Metadata::File::Composer ( ) const
noexcept

Composer.

Returns
Composer, or empty.

◆ Copyright()

const std::optional< std::string > & StormByte::Multimedia::Metadata::File::Copyright ( ) const
noexcept

Copyright notice.

Returns
Copyright, or empty.

◆ Date()

const std::optional< std::string > & StormByte::Multimedia::Metadata::File::Date ( ) const
noexcept

Date / year tag.

Returns
Date, or empty.

◆ Disc()

std::optional< unsigned > StormByte::Multimedia::Metadata::File::Disc ( ) const
noexcept

Disc number.

Returns
Disc, or empty.

◆ Encoder()

const std::optional< std::string > & StormByte::Multimedia::Metadata::File::Encoder ( ) const
noexcept

Encoder identification.

Returns
Encoder, or empty.

◆ Genre()

const std::optional< std::string > & StormByte::Multimedia::Metadata::File::Genre ( ) const
noexcept

Genre.

Returns
Genre, or empty.

◆ operator=() [1/2]

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

Copy assignment.

Returns
*this.

◆ operator=() [2/2]

File & StormByte::Multimedia::Metadata::File::operator= ( File &&  )
defaultnoexcept

Move assignment.

Returns
*this.

◆ Title()

const std::optional< std::string > & StormByte::Multimedia::Metadata::File::Title ( ) const
noexcept

Work title.

Returns
Title, or empty.

◆ Track()

std::optional< unsigned > StormByte::Multimedia::Metadata::File::Track ( ) const
noexcept

Track number.

Returns
Track, or empty.

Friends And Related Symbol Documentation

◆ StormByte::Multimedia::Detail::Probe

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

◆ StormByte::Multimedia::File

friend class StormByte::Multimedia::File
friend

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