Class MediaData

Constructors

constructor

new MediaData(id?: string): MediaData
Parameters
- Optionalid: string
Returns MediaData

Properties

`Optional`audioSplit

audioSplit?: string

`Optional`blobUrl

blobUrl?: string

`Optional`customData

customData?: Map<string, unknown>

`Optional`duration

duration?: number

filename

filename: string

`Optional`filmstrip

filmstrip?: string

This is an url for a filmstrip placeholder

`Optional`hash

hash?: string

`Optional`height

height?: number

`Optional`mediaSource

mediaSource?: File | Blob

Media payload used by previews, playback, object URLs, and FFmpeg mounts. Preserves File instances when available.

`Optional`metadata

metadata?: MediaInfo

`Optional`mimeType

mimeType?: string

`Optional`permanentUrl

permanentUrl?: string

placeholderClipIds

placeholderClipIds: string[] = []

size

size: number = 0

status

status: MediaDataStatus

`Optional`storePath

storePath?: string

`Optional`thumbnail

thumbnail?: string

type

type: string

`Optional`width

width?: number

Methods

addFilmstripFrame

addFilmstripFrame(filmstripData: null | IFilmstripData): void
Parameters
- filmstripData: null | IFilmstripData
Returns void

addPlaceholderClip

addPlaceholderClip(clipId: string): Promise<void>
Parameters
- clipId: string
Returns Promise<void>

checkForSvgThumbnail

checkForSvgThumbnail(): Promise<boolean>
Returns Promise<boolean>

clearAllCustomData

clearAllCustomData(): void
Returns void

destroy

destroy(): Promise<void>
Returns Promise<void>

getAllCustomData

getAllCustomData(): undefined | Map<string, unknown>
Returns undefined | Map<string, unknown>

getAudioSamples

getAudioSamples(
startTime: number,
duration?: number,
): null | Float32Array<ArrayBufferLike>[]
Parameters
- startTime: number
- Optionalduration: number
Returns null | Float32Array<ArrayBufferLike>[]

getCustomData

getCustomData(key: string): unknown
Parameters
- key: string
Returns unknown

getFilmstripData

getFilmstripData(): IFilmstripData[]
Returns IFilmstripData[]

getFilmstripDataRange

getFilmstripDataRange(start: number, end: number): IFilmstripData[]
Parameters
- start: number
- end: number
Returns IFilmstripData[]

getFilmstripState

getFilmstripState(): MediaProcessStatusEnum
Returns MediaProcessStatusEnum

getHash

getHash(): undefined | string
Returns undefined | string

getId

getId(): string
Returns string

getMediaSource

getMediaSource(): undefined | File | Blob
Returns the media payload, preserving File identity when available.

Returns undefined | File | Blob

getName

getName(): string
Returns string

getPlaceholderClips

getPlaceholderClips(): readonly string[]
Returns readonly string[]

getStorageMediaData

getStorageMediaData(): Promise<null | StorageMediaData>
Returns Promise<null | StorageMediaData>

hasCustomData

hasCustomData(key: string): boolean
Parameters
- key: string
Returns boolean

hasName

hasName(): boolean
Returns boolean

hookM3U8

hookM3U8(
    file: string | Uint8Array<ArrayBufferLike> | File,
    mimeType: undefined | string,
): Promise<
    | {
        data?: undefined;
        filePath?: undefined;
        mimeType?: undefined;
        status: boolean;
    }
    | {
        data: Uint8Array<ArrayBufferLike>;
        filePath: string;
        mimeType: string;
        status: boolean;
    },
>
Parameters
- file: string | Uint8Array<ArrayBufferLike> | File
- mimeType: undefined | string
Returns Promise<
    | {
        data?: undefined;
        filePath?: undefined;
        mimeType?: undefined;
        status: boolean;
    }
    | {
        data: Uint8Array<ArrayBufferLike>;
        filePath: string;
        mimeType: string;
        status: boolean;
    },
>

hookMKV

hookMKV(
    file: string | Uint8Array<ArrayBufferLike> | File,
    mimeType: undefined | string,
): Promise<
    | {
        data?: undefined;
        filePath?: undefined;
        mimeType?: undefined;
        status: boolean;
    }
    | {
        data: Uint8Array<ArrayBufferLike>;
        filePath: string;
        mimeType: string;
        status: boolean;
    },
>
Parameters
- file: string | Uint8Array<ArrayBufferLike> | File
- mimeType: undefined | string
Returns Promise<
    | {
        data?: undefined;
        filePath?: undefined;
        mimeType?: undefined;
        status: boolean;
    }
    | {
        data: Uint8Array<ArrayBufferLike>;
        filePath: string;
        mimeType: string;
        status: boolean;
    },
>

hookRawData

hookRawData(
    file: string | Uint8Array<ArrayBufferLike> | File,
    mimeType: undefined | string,
): Promise<
    | {
        data?: undefined;
        filePath?: undefined;
        mimeType?: undefined;
        status: boolean;
    }
    | {
        data: Uint8Array<ArrayBufferLike>;
        filePath: string;
        mimeType: string;
        status: boolean;
    },
>
Parameters
- file: string | Uint8Array<ArrayBufferLike> | File
- mimeType: undefined | string
Returns Promise<
    | {
        data?: undefined;
        filePath?: undefined;
        mimeType?: undefined;
        status: boolean;
    }
    | {
        data: Uint8Array<ArrayBufferLike>;
        filePath: string;
        mimeType: string;
        status: boolean;
    },
>

init

init(): Promise<void>
Returns Promise<void>

load

load(
    file: string | Uint8Array<ArrayBufferLike> | File,
    mimeType?: string,
    filename?: string,
): Promise<void>
Parameters
- file: string | Uint8Array<ArrayBufferLike> | File
- OptionalmimeType: string
- Optionalfilename: string
Returns Promise<void>

prepareFilmstrip

prepareFilmstrip(): void
Returns void

removeAllPlaceholderClips

removeAllPlaceholderClips(): void
Returns void

removeCustomData

removeCustomData(key: string): boolean
Parameters
- key: string
Returns boolean

removePlaceholderClip

removePlaceholderClip(clipId: string): void
Parameters
- clipId: string
Returns void

restore

restore(): Promise<boolean>
Returns Promise<boolean>

serialize

serialize(): {
    customData?: [string, unknown][];
    filename: string;
    hash?: string;
    id: string;
    mimeType?: string;
    name?: string;
    permanentUrl?: string;
    placeholderClipIds?: string[];
    type: string;
}
Returns {
    customData?: [string, unknown][];
    filename: string;
    hash?: string;
    id: string;
    mimeType?: string;
    name?: string;
    permanentUrl?: string;
    placeholderClipIds?: string[];
    type: string;
}

setAllCustomData

setAllCustomData(data: Map<string, unknown>): void
Parameters
- data: Map<string, unknown>
Returns void

setCustomData

setCustomData(key: string, value: unknown, overwrite?: boolean): boolean
Parameters
- key: string
- value: unknown
- overwrite: boolean = true
Returns boolean

setFilmstripState

setFilmstripState(state: MediaProcessStatusEnum): void
Parameters
- state: MediaProcessStatusEnum
Returns void

setName

setName(name: string): void
Parameters
- name: string
Returns void

setPermanentUrl

setPermanentUrl(url: null | string): void
Parameters
- url: null | string
Returns void

store

store(): Promise<void>
Returns Promise<void>

waitForStatus

waitForStatus(
    status: MediaDataStatus,
    checkIntervalMS?: number,
    timeoutMS?: number,
): Promise<boolean>
Parameters
- status: MediaDataStatus
- checkIntervalMS: number = 0
- timeoutMS: number = 0
Returns Promise<boolean>

`Static`deserialize

deserialize(data: object): MediaData
Parameters
- data: object
Returns MediaData

`Static`unlockMediaInfo

unlockMediaInfo(): void
Returns void

Class MediaData

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MediaData

Properties

OptionalaudioSplit

OptionalblobUrl

OptionalcustomData

Optionalduration

filename

Optionalfilmstrip

Optionalhash

Optionalheight

OptionalmediaSource

Optionalmetadata

OptionalmimeType

OptionalpermanentUrl

placeholderClipIds

size

status

OptionalstorePath

Optionalthumbnail

type

Optionalwidth

Methods

addFilmstripFrame

Parameters

Returns void

addPlaceholderClip

Parameters

Returns Promise<void>

checkForSvgThumbnail

Returns Promise<boolean>

clearAllCustomData

Returns void

destroy

Returns Promise<void>

getAllCustomData

Returns undefined | Map<string, unknown>

getAudioSamples

Parameters

Returns null | Float32Array<ArrayBufferLike>[]

getCustomData

Parameters

Returns unknown

getFilmstripData

Returns IFilmstripData[]

getFilmstripDataRange

Parameters

Returns IFilmstripData[]

getFilmstripState

Returns MediaProcessStatusEnum

getHash

Returns undefined | string

getId

Returns string

getMediaSource

Returns undefined | File | Blob

getName

Returns string

getPlaceholderClips

Returns readonly string[]

getStorageMediaData

Returns Promise<null | StorageMediaData>

hasCustomData

Parameters

Returns boolean

hasName

Returns boolean

hookM3U8

Parameters

Returns Promise< | { data?: undefined; filePath?: undefined; mimeType?: undefined; status: boolean; } | { data: Uint8Array<ArrayBufferLike>; filePath: string; mimeType: string; status: boolean; },>

hookMKV

Parameters

Returns Promise< | { data?: undefined; filePath?: undefined; mimeType?: undefined; status: boolean; } | { data: Uint8Array<ArrayBufferLike>; filePath: string; mimeType: string; status: boolean; },>

`Optional`audioSplit

`Optional`blobUrl

`Optional`customData

`Optional`duration

`Optional`filmstrip

`Optional`hash

`Optional`height

`Optional`mediaSource

`Optional`metadata

`Optional`mimeType

`Optional`permanentUrl

`Optional`storePath

`Optional`thumbnail

`Optional`width

Returns Promise<
| {
data?: undefined;
filePath?: undefined;
mimeType?: undefined;
status: boolean;
}
| {
data: Uint8Array<ArrayBufferLike>;
filePath: string;
mimeType: string;
status: boolean;
},
>

Returns Promise<
| {
data?: undefined;
filePath?: undefined;
mimeType?: undefined;
status: boolean;
}
| {
data: Uint8Array<ArrayBufferLike>;
filePath: string;
mimeType: string;
status: boolean;
},
>

Returns Promise<
| {
data?: undefined;
filePath?: undefined;
mimeType?: undefined;
status: boolean;
}
| {
data: Uint8Array<ArrayBufferLike>;
filePath: string;
mimeType: string;
status: boolean;
},
>

Returns {
customData?: [string, unknown][];
filename: string;
hash?: string;
id: string;
mimeType?: string;
name?: string;
permanentUrl?: string;
placeholderClipIds?: string[];
type: string;
}

`Static`deserialize

`Static`unlockMediaInfo