Class default

constructor

• new default(): default

• Returns default

Static BytesPerMegaByte

Static supportedMediaMimeTypes

Static supportedMimeTypes

Static supportedPackageMimeTypes

Static supportedPdfMimeTypes

Static supportedTextMimeTypes

Static supportedXmlMimeTypes

Static AsMegabytes

• AsMegabytes(sizeInBytes): null | number

• Get the size in MB, rounded to one decimal place

  Parameters

  • sizeInBytes: null | number

  Returns null | number

Static FileExtensionMatch

• FileExtensionMatch(fileName, extensions): boolean

• Whether the given filename's extionsion matches any of the provided extensions

  Parameters

  • fileName: undefined | string

    the filename to test
  • extensions: string[]

    a set of extensions to compare against. Expected to be lower case.

  Returns boolean

  Remarks

  The lower case variant of the file extension is compared.

Static ReadAsText

• ReadAsText(content): Promise<String>

• Reads the blob content as text.

  Parameters

  • content: Blob

  Returns Promise<String>

  Devdoc

  This does intentionally not use Blob.text() because there is no polyfill readily available in vite. At least some iPadOS devices do not have Blob.text() method implmented

Static compareZipEntries

• compareZipEntries(zipEntryA, zipEntryB): number

• A comparison function for ordered file extraction from a ZIP package/archive

  Parameters

  • zipEntryA: JSZipObject
  • zipEntryB: JSZipObject

  Returns number

  Remarks

  This is intended to produce the compilation first, then by guessed ascending file size

Static extractTrackMetadataFromUrl

• extractTrackMetadataFromUrl(url): {
      album: string;
      artist: string;
      name: string;
  }

• Tries to infer useful track metadata from the URL, by splitting the URL into parts, if possible.

  Parameters

  • url: URL

  Returns {
      album: string;
      artist: string;
      name: string;
  }

  • album: string

  • artist: string

  • name: string

  Remarks

  The artist is not guessed, it's always empty.

Static extractTrackNameFromFileName

• extractTrackNameFromFileName(fileName): string

• Tries to infer a useful track name from the file name.

  Parameters

  • fileName: string

  Returns string

  Remarks

  can be used to get a human readable name for a Track, which originates from a file name

Static getAllAfterLastSlash

• getAllAfterLastSlash(pathName): string

• Returns the last part, after the last slash

  Parameters

  • pathName: string

  Returns string

  Remarks

  For a complete typical path, this effectively returns the file name

Static getFileExtension

• getFileExtension(fileName): undefined | string

• Gets the file extension (part after the last dot) of a filename, in lower case

  Parameters

  • fileName: string

  Returns undefined | string

Static getFileMimeType

• getFileMimeType(fileName): null | string

• Gets a guessed MIME type from a filename, using an expected extension

  Parameters

  • fileName: string

  Returns null | string

  Remarks

  Applies some educated guess

Static getFileWithProgress

• getFileWithProgress(response, update): Promise<File>

• Returns the response content as a promise that resolves with a file

  Parameters

  • response: Response

    the response to read the content from. The body and headers, especially the content length, are expected to be available
  • update: ((progress) => void)

    the callback function to use for periodic update. The progress is reported as percentage.

    • • (progress): void

      • Parameters

        • progress: number

        Returns void

  Returns Promise<File>

  Remarks

  This works similar to the the Response.blob() function, but returns a file and additionally provides some progress information.

Static getLocalResourceName

• getLocalResourceName(url): string

• Maps a URL to a locally usable file name

  Parameters

  • url: URL

  Returns string

  Remarks

  can be used to match a track URL to a stored media file

  Devdoc

  Just removes the protocol

  Devdoc

  Full URL's (with protocol) are not usable for Replayer here as file names because they will be invalid as path insided a ZIP archive.

Static getResponseMimeType

• getResponseMimeType(url, response): null | string

• Gets the content MIME type from a fetch response

  Parameters

  • url: URL
  • response: Response

  Returns null | string

  Remarks

  Applies some educated guess in case the content type is not available from the response headers

Static handleAsMediaContent

• handleAsMediaContent(mediaFileName, content): MediaBlob

• Handles the given filename and blob as having media content and converts it into a MediaBlob

  Parameters

  • mediaFileName: string
  • content: Blob

  Returns MediaBlob

  Remarks

  Guesses the MIME type from the file name extension

  Devdoc

  This is used when a file is read from the ZIP package and not yet available as blob

Static hasNoFileEnding

• hasNoFileEnding(urlPath): boolean

• Returns whether the given path/filename has no file extension

  Parameters

  • urlPath: string

  Returns boolean

Static isAudioFileName

• isAudioFileName(fileName): boolean

• Returns whether the given file name (by prefix/suffix) is a supported audio file name by Replayer

  Parameters

  • fileName: string

    the filename to test, which also can be a full URL

  Returns boolean

  Devdoc

  track types should later be determined by MIME type. For this, the MIME type should become part of the (readonly) track information, determined when the track URL is evaluated.

Static isDownloadableMediaFileName

• isDownloadableMediaFileName(fileName): boolean

• Returns whether the given file name (by it's extension) is a downloadable media file name by Replayer

  Parameters

  • fileName: undefined | string

  Returns boolean

  Remarks

  Downloadable are all online media files except YouTube URL's.

Static isMacOsxMetadataFile

• isMacOsxMetadataFile(fileName): boolean

• Returns whether the given file name represents a Mac OS X metadata file.

  Parameters

  • fileName: string

  Returns boolean

  Remarks

  Mac OS X metadata files are not processed by Replayer.

Static isMacOsxResourceFork

• isMacOsxResourceFork(path): boolean

• Returns whether the given path represents a Mac OS X resource fork.

  Parameters

  • path: string

  Returns boolean

  Remarks

  Mac OS X resource forks are not processed by Replayer.

Static isPath

• isPath(input): boolean

• Returns whether the given string is a path

  Parameters

  • input: string

  Returns boolean

  Remarks

  When ending with a slash, it's considered a path.

Static isPdfFileName

• isPdfFileName(fileName): boolean

• Returns whether the given file name (by prefix/suffix) is a supported PDF file name by Replayer

  Parameters

  • fileName: string

    the filename to test, which also can be a full URL

  Returns boolean

  Devdoc

  track types should later be determined by MIME type. For this, the MIME type should become part of the (readonly) track information, determined when the track URL is evaluated.

Static isPdfMimeType

• isPdfMimeType(type): boolean

• Returns whether the given MIME type is a supported PDF file MIME type by Replayer

  Parameters

  • type: undefined | null | string

  Returns boolean

Static isProcessableFileName

• isProcessableFileName(fileName): boolean

• Returns whether the given file name (by prefix/suffix) is a processable file by Replayer

  Parameters

  • fileName: undefined | string

  Returns boolean

  Remarks

  Processable are all supported files of any type (compilations, media, including text)

Static isSupportedCompilationFileName

• isSupportedCompilationFileName(fileName): boolean

• Returns whether the given file name (by it's extension) is a supported compilation file name by Replayer

  Parameters

  • fileName: undefined | string

  Returns boolean

  Remarks

  XML (.xml) data is always considered a Compilation in this context

Static isSupportedCompilationMimeType

• isSupportedCompilationMimeType(type): boolean

• Returns whether the given MIME type is a supported compilation MIME type by Replayer

  Parameters

  • type: undefined | null | string

  Returns boolean

  Remarks

  XML data is always considered a Compilation in this context

Static isSupportedFile

• isSupportedFile(file): boolean

• Returns whether this file is supported by Replayer, either by MIME type or the file name (by prefix/suffix)

  Parameters

  • file: File

  Returns boolean

Static isSupportedFileName

• isSupportedFileName(fileName): boolean

• Returns whether the given file name (by it's extension) is any of the supported types by Replayer

  Parameters

  • fileName: undefined | string

    the filename to test; for media files this also can be a full URL

  Returns boolean

Static isSupportedMediaFile

• isSupportedMediaFile(file): boolean

• Asserts whether the file represents a media file

  Parameters

  • file: File

  Returns boolean

  Remarks

  Currently, mp3, wav, flac, ogg, aiff, plus text are supported

Static isSupportedMediaFileName

• isSupportedMediaFileName(fileName): boolean

• Returns whether the given file name (by prefix/suffix) is a supported media file name by Replayer

  Parameters

  • fileName: undefined | string

    the filename to test, which also can be a full URL

  Returns boolean

  Remarks

  Currently, some audio, video, youtube plus txt, pdf, with name variations, are supported

Static isSupportedMediaMimeType

• isSupportedMediaMimeType(type): boolean

• Returns whether the given MIME type is a supported media MIME type by Replayer

  Parameters

  • type: undefined | null | string

  Returns boolean

  Remarks

  Currently, MIME types for various audio, video, plus plain text and PDF, are supported.

Static isSupportedMimeType

• isSupportedMimeType(type): boolean

• Returns whether the given MIME type is any of the supported types by Replayer

  Parameters

  • type: undefined | null | string

  Returns boolean

Static isSupportedPackageFile

• isSupportedPackageFile(file): boolean

• Asserts whether the file represents a package file

  Parameters

  • file: File

  Returns boolean

Static isSupportedPackageFileName

• isSupportedPackageFileName(fileName): boolean

• Returns whether the given file name (by it's extension) is a supported package file name by Replayer

  Parameters

  • fileName: undefined | string

  Returns boolean

Static isSupportedPackageMimeType

• isSupportedPackageMimeType(type): boolean

• Returns whether the given MIME type is a supported package MIME type by Replayer

  Parameters

  • type: undefined | null | string

  Returns boolean

  Devdoc

  See https://stackoverflow.com/a/72232884/79485 about mime types

Static isTextFileName

• isTextFileName(fileName): boolean

• Returns whether the given file name (by prefix/suffix) is a supported text file name by Replayer

  Parameters

  • fileName: string

    the filename to test, which also can be a full URL

  Returns boolean

  Devdoc

  track types should later be determined by MIME type. For this, the MIME type should become part of the (readonly) track information, determined when the track URL is evaluated.

Static isTextMimeType

• isTextMimeType(type): boolean

• Returns whether the given MIME type is a supported text file MIME type by Replayer

  Parameters

  • type: undefined | null | string

  Returns boolean

Static isValidHttpUrl

• isValidHttpUrl(url): boolean

• Determines whether the string contains a valid URL, starting with the http|https protocol.

  Parameters

  • url: string

  Returns boolean

  true, when the URL is valid, false otherwise.

Static isVideoFileName

• isVideoFileName(fileName): boolean

• Returns whether the given file name (by prefix/suffix) is a supported video file name by Replayer

  Parameters

  • fileName: string

    the filename to test, which also can be a full URL

  Returns boolean

  Devdoc

  track types should later be determined by MIME type. For this, the MIME type should become part of the (readonly) track information, determined when the track URL is evaluated.

Static isXmlFile

• isXmlFile(file): boolean

• Asserts whether the file represents an XML compilation file

  Parameters

  • file: File

  Returns boolean

Static isXmlFileName

• isXmlFileName(fileName): boolean

• Asserts whether the file name represents an XML compilation file

  Parameters

  • fileName: string

  Returns boolean

  Remarks

  (rex is supported for historical reasons)

Static isXmlMimeType

• isXmlMimeType(type): boolean

• Returns whether the given MIME type is a supported XML compilation MIME type by Replayer

  Parameters

  • type: undefined | null | string

  Returns boolean

Static isYouTubeUrl

• isYouTubeUrl(url): boolean

• Returns whether the given URL is for a YouTube video

  Parameters

  • url: string

  Returns boolean

Static removeExtension

• removeExtension(filename): string

• Parameters

  • filename: string

  Returns string