arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
AudioPlayerMimeSourceFromFile< FileT > Class Template Reference

MimeSource that determines the mime type from the file name extension of the file that an AudioPlayer is currently playing. More...

#include <AudioPlayerMimeSourceFromFile.h>

Inheritance diagram for AudioPlayerMimeSourceFromFile< FileT >:
MimeSource

Public Member Functions

 AudioPlayerMimeSourceFromFile (AudioPlayer &player)
 
const char * mime () override
 
MimeResolvermimeResolver ()
 

Protected Attributes

AudioPlayerp_player = nullptr
 
MimeResolver resolver
 

Detailed Description

template<typename FileT>
class audio_tools::AudioPlayerMimeSourceFromFile< FileT >

MimeSource that determines the mime type from the file name extension of the file that an AudioPlayer is currently playing.

Intended to be used together with a MultiDecoder (via MultiDecoder::setMimeSource()) whenever the AudioPlayer's AudioSource is disk based (e.g. AudioSourceSDMMC, AudioSourceSD, AudioSourceSDFAT, AudioSourceSPIFFS, AudioSourceLittleFS, AudioSourceVFS, ...). The decoder is then selected from the file name extension instead of relying on (potentially ambiguous or slower) content sniffing.

AudioSourceSDMMC source(...);
MultiDecoder multiDecoder;
AudioPlayer player(source, out, multiDecoder);
multiDecoder.setMimeSource(mimeFromFile);
High-level audio playback pipeline and controller.
Definition AudioPlayer.h:51
MimeSource that determines the mime type from the file name extension of the file that an AudioPlayer...
Definition AudioPlayerMimeSourceFromFile.h:36
ESP32 AudioSource for AudioPlayer using an SD card as data source. This class is based on the Arduino...
Definition AudioSourceSDMMC.h:33
Manage multiple AudioDecoders with automatic format detection.
Definition MultiDecoder.h:43
void setMimeSource(MimeSource &mimeSource)
Sets an external MIME source for format detection.
Definition MultiDecoder.h:162
Template Parameters
FileTthe File type returned by the AudioSource in use (e.g. fs::File for AudioSourceSD/AudioSourceSDMMC). The type must provide a name() method that returns the (base) file name.
Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ AudioPlayerMimeSourceFromFile()

template<typename FileT >
AudioPlayerMimeSourceFromFile ( AudioPlayer player)
inline

Member Function Documentation

◆ mime()

template<typename FileT >
const char * mime ( )
inlineoverridevirtual

Determines the mime type from the extension of the currently playing file. Returns nullptr if no file is active or the extension is unknown.

Implements MimeSource.

◆ mimeResolver()

template<typename FileT >
MimeResolver & mimeResolver ( )
inline

Provides access to the mime resolver, e.g. to register additional extension -> mime mappings via addMimeEntry().

Member Data Documentation

◆ p_player

template<typename FileT >
AudioPlayer* p_player = nullptr
protected

◆ resolver

template<typename FileT >
MimeResolver resolver
protected

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