Options
All
  • Public
  • Public/Protected
  • All
Menu

Project id3-rw - v1.0.9

Index

Functions

createTagControllerFrom

  • createTagControllerFrom(streamOrBuffer: ReadableStream<Uint8Array> | Uint8Array): Promise<TagController>
  • Creates a tag controller from the tag of the specified buffer or stream. The function will read the whole tag, but probably not the whole stream, so performance-wise it's favorable to send the stream and not the whole file's buffer if possible. Additionally, if there is no tag there or you call the function without arguments, the function returns an empty tag.

    Parameters

    • streamOrBuffer: ReadableStream<Uint8Array> | Uint8Array

    Returns Promise<TagController>

getMetadataFrom

  • getMetadataFrom(streamOrBuffer: ReadableStream<Uint8Array> | Uint8Array): Promise<Metadata>
  • Gets the ID3 metadata from the specified buffer or stream. Basically calls create_tag_controller, gets the metadata and frees up the TagController.

    Parameters

    • streamOrBuffer: ReadableStream<Uint8Array> | Uint8Array

    Returns Promise<Metadata>

Generated using TypeDoc