Class AudioInfo<F>

Type Parameters

F extends object = any

Hierarchy (View Summary)

FileInfo<F>
- AudioInfo

Constructors

constructor

new AudioInfo<F extends object = any>(
    filename: string,
    type: string,
    size: number,
    sampleRate: number,
    durationSamples: number,
    channels: number,
    bitrate: number,
    audioBufferInfo?: { sampleRate: number; samples: number },
): AudioInfo<F>
Type Parameters
- F extends object = any
Parameters
- filename: string
- type: string
- size: number
- sampleRate: number
- durationSamples: number
- channels: number
- bitrate: number
- OptionalaudioBufferInfo: { sampleRate: number; samples: number }
Returns AudioInfo<F>
Overrides FileInfo.constructor
- Defined in audio/audio-info.ts:48

Properties

`Protected` `Optional`_attributes

_attributes?: F

`Protected` `Optional`_audioBufferInfo

_audioBufferInfo?: { sampleRate: number; samples: number }

`Protected` `Readonly`_createdAt

_createdAt: number = 0

`Protected`_extension

_extension: string

`Protected`_file

_file: undefined | File

`Protected` `Optional`_hash

_hash?: string

`Protected`_name

_name: string

`Protected`_online

_online: boolean = true

`Protected`_size

_size: number

`Protected`_type

_type: string

`Protected` `Optional`_url

_url?: string

Accessors

attributes

get attributes(): undefined | T
Returns undefined | T
Inherited from FileInfo.attributes
- Defined in data-info/data-info.ts:26
set attributes(value: undefined | T): void
Parameters
- value: undefined | T
Returns void
Inherited from FileInfo.attributes
- Defined in data-info/data-info.ts:30

audioBufferInfo

get audioBufferInfo(): undefined | { sampleRate: number; samples: number }
Returns undefined | { sampleRate: number; samples: number }
- Defined in audio/audio-info.ts:33
set audioBufferInfo(
value: undefined | { sampleRate: number; samples: number },
): void
Parameters
- value: undefined | { sampleRate: number; samples: number }
Returns void
- Defined in audio/audio-info.ts:37

available

get available(): boolean
returns if the file is ready for processing

Returns boolean
Inherited from FileInfo.available
- Defined in data-info/file-info.ts:8

bitrate

get bitrate(): number
Returns number
- Defined in audio/audio-info.ts:7

channels

get channels(): number
Returns number
- Defined in audio/audio-info.ts:13

createdAt

get createdAt(): number
Returns number
Inherited from FileInfo.createdAt
- Defined in data-info/file-info.ts:61

duration

get duration(): SampleUnit
Returns SampleUnit
- Defined in audio/audio-info.ts:19
set duration(value: SampleUnit): void
Parameters
- value: SampleUnit
Returns void
- Defined in audio/audio-info.ts:23

extension

get extension(): string
extension including the dot. (this must contain a dot!)

Returns string
Inherited from FileInfo.extension
- Defined in data-info/file-info.ts:17

file

get file(): undefined | File
Returns undefined | File
Inherited from FileInfo.file
- Defined in data-info/file-info.ts:23
set file(value: undefined | File): void
Parameters
- value: undefined | File
Returns void
Inherited from FileInfo.file
- Defined in data-info/file-info.ts:27

fullname

get fullname(): string
Returns string
Inherited from FileInfo.fullname
- Defined in data-info/file-info.ts:51
set fullname(value: string): void
Parameters
- value: string
Returns void
Inherited from FileInfo.fullname
- Defined in data-info/file-info.ts:55

hash

get hash(): undefined | string
Returns undefined | string
Inherited from FileInfo.hash
- Defined in data-info/data-info.ts:36
set hash(value: undefined | string): void
Parameters
- value: undefined | string
Returns void
Inherited from FileInfo.hash
- Defined in data-info/data-info.ts:40

name

get name(): string
Returns string
Inherited from FileInfo.name
- Defined in data-info/data-info.ts:10

online

get online(): boolean
Returns boolean
Inherited from FileInfo.online
- Defined in data-info/file-info.ts:43
set online(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FileInfo.online
- Defined in data-info/file-info.ts:47

sampleRate

get sampleRate(): number
Returns number
- Defined in audio/audio-info.ts:29

size

get size(): number
Returns number
Inherited from FileInfo.size
- Defined in data-info/data-info.ts:16
set size(value: number): void
Parameters
- value: number
Returns void
Inherited from FileInfo.size
- Defined in data-info/data-info.ts:20

type

get type(): string
Returns string
Inherited from FileInfo.type
- Defined in data-info/data-info.ts:4

url

get url(): undefined | string
Returns undefined | string
Inherited from FileInfo.url
- Defined in data-info/file-info.ts:33
set url(value: undefined | string): void
Parameters
- value: undefined | string
Returns void
Inherited from FileInfo.url
- Defined in data-info/file-info.ts:37

Methods

clone

clone(): AudioInfo<F>
Returns AudioInfo<F>
Overrides FileInfo.clone
- Defined in audio/audio-info.ts:69

getBase64

getBase64(file: File): Promise<string>
Parameters
- file: File
Returns Promise<string>
Inherited from FileInfo.getBase64
- Defined in data-info/file-info.ts:327

isMediaFile

isMediaFile(): boolean
Returns boolean
Inherited from FileInfo.isMediaFile
- Defined in data-info/file-info.ts:181

toAny

toAny(): Promise<AudioFileInfoSerialized>
Returns Promise<AudioFileInfoSerialized>
Overrides FileInfo.toAny
- Defined in audio/audio-info.ts:91

updateContentFromURL

updateContentFromURL(httpClient: any): Promise<string>
Parameters
- httpClient: any
Returns Promise<string>
Inherited from FileInfo.updateContentFromURL
- Defined in data-info/file-info.ts:306

`Static`escapeFileName

escapeFileName(name: string): string
Parameters
- name: string
Returns string
Inherited from FileInfo.escapeFileName
- Defined in data-info/file-info.ts:140

`Static`extractFileName

extractFileName(fullname: string): { extension: string; name: string }
Parameters
- fullname: string
Returns { extension: string; name: string }
Inherited from FileInfo.extractFileName
- Defined in data-info/file-info.ts:189

`Static`fromAny

fromAny<F extends object>(object: AudioFileInfoSerialized): AudioInfo<F>
Type Parameters
- F extends object
Parameters
- object: AudioFileInfoSerialized
Returns AudioInfo<F>
Overrides FileInfo.fromAny
- Defined in audio/audio-info.ts:124

`Static`fromFileObject

fromFileObject<F extends object = any>(file: File): FileInfo<F>
Type Parameters
- F extends object = any
Parameters
- file: File
Returns FileInfo<F>
Inherited from FileInfo.fromFileObject
- Defined in data-info/file-info.ts:81

`Static`fromURL

fromURL<F extends object = any>(
    url: string,
    type?: string,
    name?: string,
    createdAt?: number,
    size?: number,
): FileInfo<F>
creates a FileInfo instance form a URL. It doesn't contain the file itself.
Type Parameters
- F extends object = any
Parameters
- url: string
- Optionaltype: string
- Optionalname: string
- createdAt: number = 0
- Optionalsize: number
Returns FileInfo<F>
Inherited from FileInfo.fromURL
- Defined in data-info/file-info.ts:93

`Static`getFileContent

getFileContent(file: File, encoding?: string): Promise<string>
Parameters
- file: File
- Optionalencoding: string
Returns Promise<string>
Inherited from FileInfo.getFileContent
- Defined in data-info/file-info.ts:249

`Static`getFileFromContent

getFileFromContent(content: string, filename: string, type?: string): File
Parameters
- content: string
- filename: string
- Optionaltype: string
Returns File
Inherited from FileInfo.getFileFromContent
- Defined in data-info/file-info.ts:258

`Static`getMimeTypeByExtension

getMimeTypeByExtension(
    extension: string,
):
    | "audio/wav"
    | "audio/mpeg"
    | "audio/ogg"
    | "audio/opus"
    | "video/mp4"
    | "image/png"
    | "image/jpg"
    | "application/pdf"
    | "application/json"
    | "text/plain"
Parameters
- extension: string
Returns
    | "audio/wav"
    | "audio/mpeg"
    | "audio/ogg"
    | "audio/opus"
    | "video/mp4"
    | "image/png"
    | "image/jpg"
    | "application/pdf"
    | "application/json"
    | "text/plain"
Inherited from FileInfo.getMimeTypeByExtension
- Defined in data-info/file-info.ts:113

`Static`renameFile

renameFile(file: File, newName: string, attributes: any): Promise<File>
Parameters
- file: File
- newName: string
- attributes: any
Returns Promise<File>
Inherited from FileInfo.renameFile
- Defined in data-info/file-info.ts:162

Class AudioInfo<F>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AudioInfo<F>

Properties

Protected Optional_attributes

Protected Optional_audioBufferInfo

Protected Readonly_createdAt

Protected_extension

Protected_file

Protected Optional_hash

Protected_name

Protected_online

Protected_size

Protected_type

Protected Optional_url

Accessors

attributes

Returns undefined | T

Parameters

Returns void

audioBufferInfo

Returns undefined | { sampleRate: number; samples: number }

Parameters

Returns void

available

Returns boolean

bitrate

Returns number

channels

Returns number

createdAt

Returns number

duration

Returns SampleUnit

Parameters

Returns void

extension

Returns string

file

Returns undefined | File

Parameters

Returns void

fullname

Returns string

Parameters

Returns void

hash

Returns undefined | string

Parameters

Returns void

name

Returns string

online

Returns boolean

Parameters

Returns void

sampleRate

Returns number

size

Returns number

Parameters

Returns void

type

Returns string

url

Returns undefined | string

Parameters

Returns void

Methods

clone

`Protected` `Optional`_attributes

`Protected` `Optional`_audioBufferInfo

`Protected` `Readonly`_createdAt

`Protected`_extension

`Protected`_file

`Protected` `Optional`_hash

`Protected`_name

`Protected`_online

`Protected`_size

`Protected`_type

`Protected` `Optional`_url

`Static`escapeFileName

`Static`extractFileName

`Static`fromAny

`Static`fromFileObject

`Static`fromURL

`Static`getFileContent

`Static`getFileFromContent

`Static`getMimeTypeByExtension

Returns
| "audio/wav"
| "audio/mpeg"
| "audio/ogg"
| "audio/opus"
| "video/mp4"
| "image/png"
| "image/jpg"
| "application/pdf"
| "application/json"
| "text/plain"

`Static`renameFile