Package org.apache.tika.metadata

Interface Audio

public interface Audio
Audio metadata properties that have no XMPDM equivalent. XMPDM defines XMPDM.TRACK_NUMBER and XMPDM.DISC_NUMBER but no properties for the totals, although the common audio containers all carry them. See TIKA-4779.
Since:
Apache Tika 4.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Property
    BITRATE
    Average or nominal bitrate in bits per second (averaged over the MP3 frames, the Vorbis nominal bitrate, or the MP4 'esds' average bitrate).
    static final Property
    BITS_PER_SAMPLE
    Audio sample size in bits (e.g. 16).
    static final Property
    CHANNELS
    Number of audio channels (e.g. 2 for stereo).
    static final Property
    DISC_COUNT
    Total number of discs in the set (MP4 'disk' second value, ID3 TPOS "n/total", Vorbis DISCTOTAL).
    static final Property
    ENCODING
    The raw javax.sound encoding name (e.g.
    static final Property
    HAS_DRM
    True if the container declares DRM protection through a protected sample entry format such as 'drms' or 'enca'.
    static final Property
    IS_VARIABLE_BITRATE
    True if the stream is variable bitrate: the MP3 frames declare differing bitrates, or the Vorbis identification header does not declare one fixed rate for upper, nominal and lower.
    static final Property
    RAW_DISC_NUMBER
    The disc value exactly as tagged, see RAW_TRACK_NUMBER.
    static final Property
    RAW_TRACK_NUMBER
    The track value exactly as tagged (e.g. "3/12" or a non-numeric form like vinyl "A1").
    static final Property
    SPI_AUTHOR
    Stock "author": name of the file's author.
    static final Property
    SPI_COMMENT
    Stock "comment": arbitrary text.
    static final Property
    SPI_COPYRIGHT
    Stock "copyright": copyright message.
    static final Property
    SPI_DATE
    Stock "date": date of the recording or release (java.util.Date#toString() form).
    static final Property
    SPI_DURATION
    Stock "duration": playback duration in microseconds (java.lang.Long).
    static final Property
    SPI_QUALITY
    Stock "quality": encoding/conversion quality, 1..100.
    static final Property
    SPI_TITLE
    Stock "title": title of the file.
    static final Property
    TRACK_COUNT
    Total number of tracks on the album / in the set (MP4 'trkn' second value, ID3 TRCK "n/total", Vorbis TRACKTOTAL).

  • Field Details

    • TRACK_COUNT

      static final Property TRACK_COUNT
      Total number of tracks on the album / in the set (MP4 'trkn' second value, ID3 TRCK "n/total", Vorbis TRACKTOTAL).

    • DISC_COUNT

      static final Property DISC_COUNT
      Total number of discs in the set (MP4 'disk' second value, ID3 TPOS "n/total", Vorbis DISCTOTAL).

    • RAW_TRACK_NUMBER

      static final Property RAW_TRACK_NUMBER
      The track value exactly as tagged (e.g. "3/12" or a non-numeric form like vinyl "A1"). XMPDM.TRACK_NUMBER only receives clean integers, so nothing is lost.

    • RAW_DISC_NUMBER

      static final Property RAW_DISC_NUMBER
      The disc value exactly as tagged, see RAW_TRACK_NUMBER.

    • BITRATE

      static final Property BITRATE
      Average or nominal bitrate in bits per second (averaged over the MP3 frames, the Vorbis nominal bitrate, or the MP4 'esds' average bitrate). A per-stream value: in a file with several audio tracks it reflects the last sound track's sample description.

    • IS_VARIABLE_BITRATE

      static final Property IS_VARIABLE_BITRATE
      True if the stream is variable bitrate: the MP3 frames declare differing bitrates, or the Vorbis identification header does not declare one fixed rate for upper, nominal and lower.

    • HAS_DRM

      static final Property HAS_DRM
      True if the container declares DRM protection through a protected sample entry format such as 'drms' or 'enca'. A file-level flag: any protected audio track sets it. Only set when protection is detected.

    • CHANNELS

      static final Property CHANNELS
      Number of audio channels (e.g. 2 for stereo). XMPDM.AUDIO_CHANNEL_TYPE only distinguishes Mono from Stereo and cannot represent more than two channels. A per-stream value, see BITRATE.

    • BITS_PER_SAMPLE

      static final Property BITS_PER_SAMPLE
      Audio sample size in bits (e.g. 16). A per-stream value, see BITRATE.

    • ENCODING

      static final Property ENCODING
      The raw javax.sound encoding name (e.g. "PCM_SIGNED"), as reported by AudioFormat#getEncoding() (AudioParser). Distinct from XMPDM.AUDIO_SAMPLE_TYPE (bit depth) and XMPDM.AUDIO_COMPRESSOR (codec name).

    • SPI_DURATION

      static final Property SPI_DURATION
      Stock "duration": playback duration in microseconds (java.lang.Long).

    • SPI_AUTHOR

      static final Property SPI_AUTHOR
      Stock "author": name of the file's author.

    • SPI_TITLE

      static final Property SPI_TITLE
      Stock "title": title of the file.

    • SPI_DATE

      static final Property SPI_DATE
      Stock "date": date of the recording or release (java.util.Date#toString() form).

    • SPI_COMMENT

      static final Property SPI_COMMENT
      Stock "comment": arbitrary text.

    • SPI_QUALITY

      static final Property SPI_QUALITY
      Stock "quality": encoding/conversion quality, 1..100.