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

Per-stream audio properties. More...

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

Public Member Functions

 Audio ()
 Constructs unknown audio properties with no codec profile.
 Audio (ChannelLayout layout, std::uint32_t sample_rate, std::uint8_t channels, std::uint64_t bitrate=0, StormByte::Safe::Optional< StormByte::Safe::String > profile=std::nullopt) noexcept
 Constructs audio properties.
 Audio (const Audio &other)
 Copy constructor.
 Audio (Audio &&other) noexcept
 Move constructor.
 ~Audio () noexcept
 Destructor.
Audio & operator= (const Audio &other)
 Copy assignment.
Audio & operator= (Audio &&other) noexcept
 Move assignment.
ChannelLayout Layout () const noexcept
 Speaker layout.
std::uint32_t SampleRate () const noexcept
 Sample rate in Hz.
std::uint8_t Channels () const noexcept
 Channel count.
std::uint64_t BitRate () const noexcept
 Bitrate in bits per second.
const StormByte::Safe::Optional< StormByte::Safe::String > & Profile () const noexcept
 Codec profile name, if present.

Detailed Description

Per-stream audio properties.

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

◆ Audio() [1/4]

StormByte::Multimedia::Property::Audio::Audio ( )

Constructs unknown audio properties with no codec profile.

Exceptions
StormByte::ExceptionSafe storage initialization failed.

◆ Audio() [2/4]

StormByte::Multimedia::Property::Audio::Audio ( ChannelLayout layout,
std::uint32_t sample_rate,
std::uint8_t channels,
std::uint64_t bitrate = 0,
StormByte::Safe::Optional< StormByte::Safe::String > profile = std::nullopt )
noexcept

Constructs audio properties.

Parameters
layoutSpeaker layout.
sample_rateSample rate in Hz.
channelsChannel count.
bitrateBitrate in bits per second (0 if unknown).
profileOptional codec profile name.

◆ Audio() [3/4]

StormByte::Multimedia::Property::Audio::Audio ( const Audio & other)

Copy constructor.

Parameters
otherProperties to copy.
Exceptions
StormByte::ExceptionSafe storage copying failed.

◆ Audio() [4/4]

StormByte::Multimedia::Property::Audio::Audio ( Audio && other)
noexcept

Move constructor.

Parameters
otherProperties to move.

◆ ~Audio()

StormByte::Multimedia::Property::Audio::~Audio ( )
noexcept

Destructor.

Member Function Documentation

◆ BitRate()

std::uint64_t StormByte::Multimedia::Property::Audio::BitRate ( ) const
noexcept

Bitrate in bits per second.

Returns
Bitrate, or 0 if unknown.

◆ Channels()

std::uint8_t StormByte::Multimedia::Property::Audio::Channels ( ) const
noexcept

Channel count.

Returns
Channel count.

◆ Layout()

ChannelLayout StormByte::Multimedia::Property::Audio::Layout ( ) const
noexcept

Speaker layout.

Returns
Layout.

◆ operator=() [1/2]

Audio & StormByte::Multimedia::Property::Audio::operator= ( Audio && other)
noexcept

Move assignment.

Parameters
otherProperties to move.
Returns
*this.

◆ operator=() [2/2]

Audio & StormByte::Multimedia::Property::Audio::operator= ( const Audio & other)

Copy assignment.

Parameters
otherProperties to copy.
Returns
*this.
Exceptions
StormByte::ExceptionSafe storage copying failed.

◆ Profile()

const StormByte::Safe::Optional< StormByte::Safe::String > & StormByte::Multimedia::Property::Audio::Profile ( ) const
noexcept

Codec profile name, if present.

Returns
Borrowed optional profile, valid while this object is alive.

◆ SampleRate()

std::uint32_t StormByte::Multimedia::Property::Audio::SampleRate ( ) const
noexcept

Sample rate in Hz.

Returns
Sample rate.

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