Public Member Functions | List of all members
WindowsMediaAudioFormat Class Reference

Audio format which uses the Windows Media codecs (Windows only). More...

Inheritance diagram for WindowsMediaAudioFormat:

Public Member Functions

 WindowsMediaAudioFormat ()
 
 ~WindowsMediaAudioFormat ()
 
Array< int > getPossibleSampleRates () override
 Returns a set of sample rates that the format can read and write. More...
 
Array< int > getPossibleBitDepths () override
 Returns a set of bit depths that the format can read and write. More...
 
bool canDoStereo () override
 Returns true if the format can do 2-channel audio. More...
 
bool canDoMono () override
 Returns true if the format can do 1-channel audio. More...
 
bool isCompressed () override
 Returns true if the format uses compressed data. More...
 
AudioFormatReadercreateReaderFor (InputStream *, bool deleteStreamIfOpeningFails) override
 Tries to create an object that can read from a stream containing audio data in this format. More...
 
AudioFormatWritercreateWriterFor (OutputStream *, double sampleRateToUse, unsigned int numberOfChannels, int bitsPerSample, const StringPairArray &metadataValues, int qualityOptionIndex) override
 Tries to create an object that can write to a stream with this audio format. More...
 
- Public Member Functions inherited from AudioFormat
virtual ~AudioFormat ()
 Destructor. More...
 
const StringgetFormatName () const
 Returns the name of this format. More...
 
virtual StringArray getFileExtensions () const
 Returns all the file extensions that might apply to a file of this format. More...
 
virtual bool canHandleFile (const File &fileToTest)
 Returns true if this the given file can be read by this format. More...
 
virtual bool isChannelLayoutSupported (const AudioChannelSet &channelSet)
 Returns true if the channel layout is supported by this format. More...
 
virtual StringArray getQualityOptions ()
 Returns a list of different qualities that can be used when writing. More...
 
virtual MemoryMappedAudioFormatReadercreateMemoryMappedReader (const File &file)
 Attempts to create a MemoryMappedAudioFormatReader, if possible for this format. More...
 
virtual MemoryMappedAudioFormatReadercreateMemoryMappedReader (FileInputStream *fin)
 
virtual AudioFormatWritercreateWriterFor (OutputStream *streamToWriteTo, double sampleRateToUse, const AudioChannelSet &channelLayout, int bitsPerSample, const StringPairArray &metadataValues, int qualityOptionIndex)
 Tries to create an object that can write to a stream with this audio format. More...
 

Additional Inherited Members

- Protected Member Functions inherited from AudioFormat
 AudioFormat (String formatName, StringArray fileExtensions)
 Creates an AudioFormat object. More...
 
 AudioFormat (StringRef formatName, StringRef fileExtensions)
 Creates an AudioFormat object. More...
 

Detailed Description

Audio format which uses the Windows Media codecs (Windows only).

Constructor & Destructor Documentation

◆ WindowsMediaAudioFormat()

WindowsMediaAudioFormat::WindowsMediaAudioFormat ( )

◆ ~WindowsMediaAudioFormat()

WindowsMediaAudioFormat::~WindowsMediaAudioFormat ( )

Member Function Documentation

◆ getPossibleSampleRates()

Array<int> WindowsMediaAudioFormat::getPossibleSampleRates ( )
overridevirtual

Returns a set of sample rates that the format can read and write.

Implements AudioFormat.

◆ getPossibleBitDepths()

Array<int> WindowsMediaAudioFormat::getPossibleBitDepths ( )
overridevirtual

Returns a set of bit depths that the format can read and write.

Implements AudioFormat.

◆ canDoStereo()

bool WindowsMediaAudioFormat::canDoStereo ( )
overridevirtual

Returns true if the format can do 2-channel audio.

Implements AudioFormat.

◆ canDoMono()

bool WindowsMediaAudioFormat::canDoMono ( )
overridevirtual

Returns true if the format can do 1-channel audio.

Implements AudioFormat.

◆ isCompressed()

bool WindowsMediaAudioFormat::isCompressed ( )
overridevirtual

Returns true if the format uses compressed data.

Reimplemented from AudioFormat.

◆ createReaderFor()

AudioFormatReader* WindowsMediaAudioFormat::createReaderFor ( InputStream sourceStream,
bool  deleteStreamIfOpeningFails 
)
overridevirtual

Tries to create an object that can read from a stream containing audio data in this format.

The reader object that is returned can be used to read from the stream, and should then be deleted by the caller.

Parameters
sourceStreamthe stream to read from - the AudioFormatReader object that is returned will delete this stream when it no longer needs it.
deleteStreamIfOpeningFailsif no reader can be created, this determines whether this method should delete the stream object that was passed-in. (If a valid reader is returned, it will always be in charge of deleting the stream, so this parameter is ignored)
See also
AudioFormatReader

Implements AudioFormat.

◆ createWriterFor()

AudioFormatWriter* WindowsMediaAudioFormat::createWriterFor ( OutputStream streamToWriteTo,
double  sampleRateToUse,
unsigned int  numberOfChannels,
int  bitsPerSample,
const StringPairArray metadataValues,
int  qualityOptionIndex 
)
overridevirtual

Tries to create an object that can write to a stream with this audio format.

The writer object that is returned can be used to write to the stream, and should then be deleted by the caller.

If the stream can't be created for some reason (e.g. the parameters passed in here aren't suitable), this will return nullptr.

Parameters
streamToWriteTothe stream that the data will go to - this will be deleted by the AudioFormatWriter object when it's no longer needed. If no AudioFormatWriter can be created by this method, the stream will NOT be deleted, so that the caller can re-use it to try to open a different format, etc
sampleRateToUsethe sample rate for the file, which must be one of the ones returned by getPossibleSampleRates()
numberOfChannelsthe number of channels - this must be either 1 or 2, and the choice will depend on the results of canDoMono() and canDoStereo()
bitsPerSamplethe bits per sample to use - this must be one of the values returned by getPossibleBitDepths()
metadataValuesa set of metadata values that the writer should try to write to the stream. Exactly what these are depends on the format, and the subclass doesn't actually have to do anything with them if it doesn't want to. Have a look at the specific format implementation classes to see possible values that can be used
qualityOptionIndexthe index of one of compression qualities returned by the getQualityOptions() method. If there aren't any quality options for this format, just pass 0 in this parameter, as it'll be ignored
See also
AudioFormatWriter

Implements AudioFormat.


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