progress

Fraction of files read

Syntax

fractionRead = progress(ADS)

Description

fractionRead = progress(ADS) returns the fraction of files read in the datastore as a normalized value in the range [0,1].

Examples

Return Fraction of Files Read

Create an audioDatastore object ADS. Read a file from the datastore and then call progress to return the fraction of files read.

ADS = audioDatastore(fullfile(matlabroot,'toolbox','audio','samples'))

ADS = 
  audioDatastore with properties:

                       Files: {
                              ' .../build/matlab/toolbox/audio/samples/Ambiance-16-44p1-mono-12secs.wav';
                              ' .../matlab/toolbox/audio/samples/AudioArray-16-16-4channels-20secs.wav';
                              ' .../toolbox/audio/samples/ChurchImpulseResponse-16-44p1-mono-5secs.wav'
                               ... and 26 more
                              }
                     Folders: {
                              '/mathworks/devel/bat/Bdoc20a/build/matlab/toolbox/audio/samples'
                              }
    AlternateFileSystemRoots: {}
              OutputDataType: 'double'
                      Labels: {}
      SupportedOutputFormats: ["wav"    "flac"    "ogg"    "mp4"    "m4a"]
         DefaultOutputFormat: "wav"

fractionOfFilesRead = progress(ADS)

fractionOfFilesRead = 0

data = read(ADS);
fractionOfFilesRead = progress(ADS)

fractionOfFilesRead = 0.0345

Input Arguments

ADS — Audio datastore

audioDatastore object

Specify ADS as an audioDatastore object.

Output Arguments

fractionRead — Fraction of files read

normalized value in the range [0,1]

Fraction of files read, returned as a normalized value in the range [0,1].

Data Types: double