Skip to content

Latest commit

 

History

History
342 lines (268 loc) · 13.3 KB

modules.md

File metadata and controls

342 lines (268 loc) · 13.3 KB
Raw

node-taglib-sharp / Exports

node-taglib-sharp

Table of contents

References

Enumerations

Classes

Interfaces

Type Aliases

Variables

References

MpegContainerFileSettings

Renames and re-exports MpegAudioFileSettings

Type Aliases

AsfDescriptorValue

Ƭ AsfDescriptorValue: bigint | boolean | ByteVector | number | string | UuidWrapper

Type shortcut for all the types a descriptor can contain

FileTypeConstructor

Ƭ FileTypeConstructor: (abstraction: IFileAbstraction, style: ReadStyle) => File

Type declaration

• (abstraction, style)

Parameters
Name Type
abstraction IFileAbstraction
style ReadStyle

FileTypeResolver

Ƭ FileTypeResolver: (abstraction: IFileAbstraction, mimetype: string, style: ReadStyle) => File

Type declaration

▸ (abstraction, mimetype, style): File

Delegate is used for intervening in createFromPath by resolving the filetype before any standard resolution operations.

Remarks

A FileTypeResolver is one way of altering the behavior of createFromPath When createFromPath is called, the registered resolvers are invoked in reverse order in which they were registered. The resolver may then perform any operations necessary, including other type-finding methods. If the resolver returns a new File it will instantly be returned, by createFromPath. If it returns undefined, createFromPath will continue to process. If the resolver throws an exception, it will be uncaught. To register a resolver, use addFileTypeResolver.

Parameters
Name Type Description
abstraction IFileAbstraction File to be read.
mimetype string -
style ReadStyle How to read media properties from the file
Returns

File

New instance of File or undefined if the resolver could not be matched

Id3v2FrameCreator

Ƭ Id3v2FrameCreator: (data: ByteVector, offset: number, header: Id3v2FrameHeader, version: number) => Id3v2Frame

Type declaration

▸ (data, offset, header, version): Id3v2Frame

Type shortcut for a method that returns a Frame.

Parameters
Name Type Description
data ByteVector Byte vector that contains the frame
offset number Position into the byte vector where the frame begins
header Id3v2FrameHeader The header that describes the frame
version number ID3v2 version the frame is encoded with. Must be unsigned 8-bit int
Returns

Id3v2Frame

OggCodecProvider

Ƭ OggCodecProvider: (firstPacket: ByteVector) => IOggCodec | undefined

Type declaration

▸ (firstPacket): IOggCodec | undefined

Type shortcut for a method that can generate a codec object based on the first packet of the bit stream.

Parameters
Name Type Description
firstPacket ByteVector First packet in the bit stream
Returns

IOggCodec | undefined

Generated IOggCodec is returned if a codec could be constructed from the first packet, otherwise undefined is returned.

Variables

Id3v2FrameFactory

• Id3v2FrameFactory: Object

Performs the necessary operations to determine and create the correct child classes of Frame for a given raw ID3v2 frame. By default, this will only load frames contained in the library. To add additional frames to the process, register a frame creator with addFrameCreator.

Type declaration

Name Type
addFrameCreator (creator: Id3v2FrameCreator) => void
clearFrameCreators () => void
createFrame (data: ByteVector, file: File, offset: number, version: number, alreadyUnsynced: boolean) => { frame: Id3v2Frame ; offset: number }

Id3v2FrameIdentifiers

• Const Id3v2FrameIdentifiers: Object

Collection of all well-known frame identifiers.

Index signature

▪ [key: string]: Id3v2FrameIdentifier