Alchemy 0.0.9999
Alchemy is a C++ library for multimedia file management.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Alchemy::FFMpeg Class Reference

The FFMpeg class. More...

#include <ffmpeg.hxx>

Public Member Functions

 FFMpeg (const FFMpeg &other)=default
 Copy constructor.
 
 FFMpeg (FFMpeg &&other) noexcept=default
 Move constructor.
 
FFMpegoperator= (const FFMpeg &other)=default
 Copy assignment operator.
 
FFMpegoperator= (FFMpeg &&other) noexcept=default
 Move assignment operator.
 
virtual ~FFMpeg () noexcept=default
 Default destructor.
 
Media::Streams & Streams () noexcept
 Gets the streams.
 
const Media::Streams & Streams () const noexcept
 Gets the streams.
 
const std::filesystem::path & Path () const noexcept
 Get the path to the file.
 
void test (const std::filesystem::path &path) const
 

Static Public Member Functions

static StormByte::Expected< FFMpeg, StreamErrorFromFile (const std::filesystem::path &path)
 Processes the file and creates a FFMpeg object.
 
static const std::string Version ()
 Get the version of the FFMpeg library.
 

Protected Member Functions

 FFMpeg (const std::filesystem::path &path) noexcept
 Default constructor.
 

Protected Attributes

std::filesystem::path m_path
 The path to the file.
 
Media::Streams m_streams
 The list of streams.
 

Friends

class FFProbe
 

Detailed Description

The FFMpeg class.

Constructor & Destructor Documentation

◆ FFMpeg() [1/2]

Alchemy::FFMpeg::FFMpeg ( const FFMpeg other)
default

Copy constructor.

Parameters
otherThe FFMpeg object to copy.

◆ FFMpeg() [2/2]

Alchemy::FFMpeg::FFMpeg ( FFMpeg &&  other)
defaultnoexcept

Move constructor.

Parameters
otherThe FFMpeg object to move.

Member Function Documentation

◆ FromFile()

static StormByte::Expected< FFMpeg, StreamError > Alchemy::FFMpeg::FromFile ( const std::filesystem::path &  path)
static

Processes the file and creates a FFMpeg object.

Parameters
pathThe path to the file.
Returns
The FFMpeg object.

◆ operator=() [1/2]

FFMpeg & Alchemy::FFMpeg::operator= ( const FFMpeg other)
default

Copy assignment operator.

Parameters
otherThe FFMpeg object to copy.
Returns
A reference to this object.

◆ operator=() [2/2]

FFMpeg & Alchemy::FFMpeg::operator= ( FFMpeg &&  other)
defaultnoexcept

Move assignment operator.

Parameters
otherThe FFMpeg object to move.
Returns
A reference to this object.

◆ Path()

const std::filesystem::path & Alchemy::FFMpeg::Path ( ) const
noexcept

Get the path to the file.

Returns
The path to the file.

◆ Streams() [1/2]

const Media::Streams & Alchemy::FFMpeg::Streams ( ) const
noexcept

Gets the streams.

Returns
The streams.

◆ Streams() [2/2]

Media::Streams & Alchemy::FFMpeg::Streams ( )
noexcept

Gets the streams.

Returns
The streams.

◆ Version()

static const std::string Alchemy::FFMpeg::Version ( )
static

Get the version of the FFMpeg library.

Returns
The version of the FFMpeg library.

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