Sound.HTagLib.Internal

Low-level interaction with underlying C API. You don't want to use this, see Sound.HTagLib instead.

Data types

data FileId

This is an abstraction representing opened file. Other modules can pass it around and treat it like a black box.

data FileType

Types of files TagLib can work with. This may be used to explicitly specify type of file rather than relying on TagLib ability to guess type of file from its extension.

Constructors

MPEG

OggVorbis

FLAC

MPC

OggFlac

WavPack

Speex

TrueAudio

MP4

ASF

Instances

Enum FileType

Eq FileType

Show FileType

data ID3v2Encoding

Encoding for ID3v2 frames that are written to tags.

Constructors

ID3v2Latin1

ID3v2UTF16

ID3v2UTF16BE

ID3v2UTF8

Instances

Enum ID3v2Encoding

Eq ID3v2Encoding

Show ID3v2Encoding

data HTagLibException

The data type represents exceptions specific to the library. The following constructors are defined:

• OpeningFailed means that attempt to open audio file to read its tags failed.
• InvalidFile means that file can be opened, but it doesn't contain any information that can be interpreted by the library.
• SavingFailed is thrown when well… saving failed.

Constructors

OpeningFailed FilePath

InvalidFile FilePath

SavingFailed FilePath

Instances

Eq HTagLibException

Show HTagLibException

Exception HTagLibException

File API

withFile

Arguments

:: FilePath

Path to audio file

-> Maybe FileType

Type of file (or it will be guessed)

-> (FileId -> IO a)

Computation depending of FileId

-> IO a

Result value

Open audio file located at specified path, execute some actions given its FileId and then free the file.

saveFile

Arguments

:: FilePath

File name to use in exceptions

-> FileId

File identifier

-> IO ()

Save file given its ID. Given FilePath just tells what to put into exception if the action fails, it doesn't specify where to save the file (it's determined by FileId).

Tag API

getTitle :: FileId -> IO Title

Get title tag associated with file.

getArtist :: FileId -> IO Artist

Get artist tag associated with file.

getAlbum :: FileId -> IO Album

Get album tag associated with file.

getComment :: FileId -> IO Comment

Get comment tag associated with file.

getGenre :: FileId -> IO Genre

Get genre tag associated with file.

getYear :: FileId -> IO (Maybe Year)

Get year tag associated with file.

getTrackNumber :: FileId -> IO (Maybe TrackNumber)

Get track number associated with file.

setTitle :: Title -> FileId -> IO ()

Set title of track associated with file.

setArtist :: Artist -> FileId -> IO ()

Set artist of track associated with file.

setAlbum :: Album -> FileId -> IO ()

Set album of track associated with file.

setComment :: Comment -> FileId -> IO ()

Set comment of track associated with file.

setGenre :: Genre -> FileId -> IO ()

Set genre of track associated with file.

setYear :: Maybe Year -> FileId -> IO ()

Set year of track associated with file.

setTrackNumber :: Maybe TrackNumber -> FileId -> IO ()

Set track number of track associated with file.

Audio properties API

getDuration :: FileId -> IO Duration

Get duration of track associated with file.

getBitRate :: FileId -> IO BitRate

Get bit rate of track associated with file.

getSampleRate :: FileId -> IO SampleRate

Get sample rate of track associated with file.

getChannels :: FileId -> IO Channels

Get number of channels in track associated with file.

Special convenience ID3v2 functions

id3v2SetEncoding :: ID3v2Encoding -> IO ()

Set the default encoding for ID3v2 frames that are written to tags.