MediaMasher

MediaMasher component.

Classes

MediaMasherElement

Extends MediaMasherElement_base. Implements Framework.

new MediaMasherElement(): MediaMasherElement

Returns MediaMasherElement. Inherited from MediaMasherElement_base.constructor.

Property	Modifier	Type	Description
`_mashingAssetObject`	`public`	`undefined` \| `StorableMedia`	-
`apiEndpoint`	`public`	`string`	Attr api-endpoint - URL prefix for API endpoints
`assetObjectsPromises`	`public`	`Map`<`string`, `Promise`<`ClientAsset`[]>>	-
`assets`	`public readonly`	`ClientAsset`[]	-
`assetsById`	`public`	`Map`<`string`, `ClientAsset`>	-
`canSave`	`public readonly`	`boolean`	-
`connected`	`public`	`boolean`	-
`cssBorderBoxSizing`	`static`	`CSSResult`	-
`cssHostDropping`	`static`	`CSSResult`	-
`cssHostFlex`	`static`	`CSSResult`	-
`cssProperties`	`public`	`Property`[]	-
`defaultContent`	`public readonly`	`OptionalContent`	-
`displayedAssetIds`	`public`	`string`[]	-
`exportParts`	`public`	`undefined` \| `string`	-
`handleIdSignal`	`public`	(`signal`: `Signal`) => `void`	Triggered when mash or selected asset/clip changes.
`icons`	`public`	`string`	Attr icons - URL for icons endpoint
`idsByTarget`	`public`	`Record`<`string`, `${string}.${string}`[]>	Signal id arrays by target, will be empty if signals[target].id undefined.
`importingAssets`	`public`	`ClientAsset`[]	-
`importPromise`	`public`	`Promise`<`DataOrError`<`StringTuple`[]>>	-
`loadedPlugins`	`public`	`boolean`	-
`masher`	`public readonly`	`Masher`	-
`masherOrNot`	`public`	`undefined` \| `Masher`	-
`masherPromise`	`public`	`Promise`<`Masher`>	-
`mashingAssetObject`	`public`	`undefined` \| `StorableMedia`	-
`mashMedia`	`public`	`ClientMash`	-
`mashOrNot`	`public`	`undefined` \| `ClientMash`	-
`mediaMash`	`public`	`string`	Attr media-mash - URL for asset object endpoint
`mediaSelect`	`public`	`string`	Attr media-select - URL for media select endpoint
`mediaSelectCaching`	`public`	`undefined` \| `Caching`	-
`parts`	`public`	`string`	-
`partSeparator`	`static`	`string`	-
`pluginsPromise`	`public`	`Promise`<`void`>	-
`signals`	`public readonly`	`SignalsRecord`	-
`signalsById`	`public`	`Partial`<`Record`<`${string}.${string}`, `Signal`>>	Holds each defined signal by its signal id.
`strings`	`public`	`string`	Attr icons - URL for icons endpoint
`svgContainer`	`public`	`undefined` \| `SVGSVGElement`	-
`target`	`public readonly`	`string`	-
`timeout`	`public`	`undefined` \| `Timeout`	-

Methods

addAssets(asset, location?): DataOrError<ClientAsset[]>

Parameter	Type	Description
`asset`	`ClientAsset` \| `ClientAsset`[]
`location`?	`ClipLocation`

Returns DataOrError<ClientAsset[]>. Implementation of Framework.addAssets.

clipIndex(frameOrIndex, clips, dense?): number

Parameter	Type	Description
`frameOrIndex`	`number`
`clips`	`ClientClip`[]
`dense`?	`boolean`

Returns number.

clipMove(editorIndex?, clipId?): void

Parameter	Type	Description
`editorIndex`?	`ClipLocation`
`clipId`?	`string`

Returns void. Implementation of Framework.clipMove.

define(…identified): Promise<DataOrError<Media[]>>

Parameter	Type	Description
…`identified`	(`Identified` \| `StorableMedia`)[]

Returns Promise<DataOrError<Media[]>>.

dispatchCustom(event): boolean

Parameter	Type	Description
`event`	`CustomEvent`<`any`> \| `Event`

Returns boolean. Implementation of Framework.dispatchCustom.

encode(progressId?): Promise<void>

Parameter	Type	Description
`progressId`?	`string`

Returns Promise<void>.

findMedia(id?): undefined | ClientAsset

Parameter	Type	Description
`id`?	`string`

Returns undefined | ClientAsset. Implementation of Framework.findMedia.

fromId(id?): Promise<undefined | Media>

Parameter	Type	Description
`id`?	`string`

Returns Promise<undefined | Media>.

get(id): Promise<DataOrError<Media>>

Parameter	Type	Description
`id`	`string`

Returns Promise<DataOrError<Media>>.

handleAddTrack(): void

Returns void.

handleAssetsPromise(assets): ClientAsset[]

Parameter	Type	Description
`assets`	`ClientAsset`[]

Returns ClientAsset[].

handleCreate(event): void

Parameter	Type	Description
`event`	`Event`

Returns void.

handleEncode(event): void

Parameter	Type	Description
`event`	`Event`

Returns void.

handleFlip(): void

Returns void.

handleInsert(event): void

Parameter	Type	Description
`event`	`Event`

Returns void.

handleMashColor(signal): void

Triggered when mash color changes.

Parameter	Type	Description
`signal`	`Signal`

Returns void.

handleMasher(event): void

Respond to event from child components requesting the masher.

Parameter	Type	Description
`event`	`Event`

Returns void.

handleMediaMasher(event): void

Respond to event from child components requesting me.

Parameter	Type	Description
`event`	`Event`

Returns void.

handlePartsChanged(event): void

Respond to event from child components connecting/disconnecting from DOM.

Parameter	Type	Description
`event`	`Event`

Returns void.

handlePlaying(signal): void

Triggered when mash color changes.

Parameter	Type	Description
`signal`	`Signal`

Returns void.

handleRedo(): void

Returns void.

handleRemove(event): void

Parameter	Type	Description
`event`	`Event`

Returns void.

handleSave(event): void

Parameter	Type	Description
`event`	`Event`

Returns void.

handleScalarProperty(event): void

Parameter	Type
`event`	`Event`

Returns void. Inherited from MediaMasherElement_base.handleScalarProperty.

handleSignalIds(event): void

Parameter	Type
`event`	`Event`

Returns void. Inherited from MediaMasherElement_base.handleSignalIds.

handleUndo(): void

Returns void.

handleView(): void

Returns void.

icon(identified): Promise<DataOrError<Element>>

Parameter	Type	Description
`identified`	`Identified`

Returns Promise<DataOrError<Element>>. Implementation of Framework.icon.

importAsset(…objects): Promise<DataOrError<ClientAsset[]>>

Parameter	Type	Description
…`objects`	`StorableMedia`[]

Returns Promise<DataOrError<ClientAsset[]>>. Implementation of Framework.importAsset.

listenersAdd(record): void

Parameter	Type	Description
`record`	`EventListeners`

Returns void. Implementation of Framework.listenersAdd.

listenersRemove(record): void

Parameter	Type	Description
`record`	`EventListeners`

Returns void. Implementation of Framework.listenersRemove.

load(assetObject): Promise<DataOrError<ClientMash>>

Parameter	Type	Description
`assetObject`	`StorableMedia`

Returns Promise<DataOrError<ClientMash>>.

managedAssetPromise(assetObject): Promise<DataOrError<Media>>

Parameter	Type	Description
`assetObject`	`StorableMedia`

Returns Promise<DataOrError<Media>>. Implementation of Framework.managedAssetPromise.

mediaSearchPromise(detail, manageTypes?): Promise<DataOrError<Media[]>>

Parameter	Type	Description
`detail`	`MediaSearchRequest`
`manageTypes`?	`ManageType`[]

Returns Promise<DataOrError<Media[]>>.

partContent(part, slots): OptionalContent

Parameter	Type	Description
`part`	`string`
`slots`	`Element`[]

Returns OptionalContent. Inherited from MediaMasherElement_base.partContent.

propertiedForTarget(target): undefined | Propertied

Parameter	Type	Description
`target`	`string`

Returns undefined | Propertied.

refreshFrames(): void

Returns void.

refreshParts(): string

Returns string. Inherited from MediaMasherElement_base.refreshParts.

save(progressId?): Promise<void>

Parameter	Type	Description
`progressId`?	`string`

Returns Promise<void>.

set(…assets): void

Parameter	Type	Description
…`assets`	`Media`[]

Returns void.

setNested(assets): void

Parameter	Type	Description
`assets`	`Media`[]

Returns void.

signal(arg, nameOrTarget?, type?): Signal

Parameter	Type	Description
`arg`	`string` \| `PropertyObject`
`nameOrTarget`?	`string`
`type`?	`string`

Returns Signal.

signalCreate(id, property): Signal

Parameter	Type	Description
`id`	`${string}.${string}`
`property`	`Property`

Returns Signal.

signalId(arg, nameOrTarget?, type?): `${string}.${string}`

Parameter	Type	Description
`arg`	`string` \| `PropertyObject`
`nameOrTarget`?	`string`
`type`?	`string`

Returns `${string}.${string}`.

signalsDebug(limit?): void

Parameter	Type
`limit`?	`string`

Returns void.

string(args): Promise<DataOrError<string>>

Parameter	Type	Description
`args`	`TranslateArgs`

Returns Promise<DataOrError<string>>. Implementation of Framework.string.

templateContent(contents): TemplateContent

Parameter	Type	Description
`contents`	`TemplateContents`

Returns TemplateContent. Inherited from MediaMasherElement_base.templateContent.

uncache(ids): void

Parameter	Type	Description
`ids`	`OrArray`<`string`>

Returns void. Implementation of Framework.uncache.

undefine(idsOrAll?): void

Parameter	Type	Description
`idsOrAll`?	`OrArray`<`string`>

Returns void. Implementation of Framework.undefine.

unload(): void

Returns void.

unsubscribe(arg, name?, type?): void

Parameter	Type	Description
`arg`	`string` \| `PropertyObject`
`name`?	`string`
`type`?	`string`

Returns void. Inherited from MediaMasherElement_base.unsubscribe.

updateMediaId(oldId, newId): void

Parameter	Type	Description
`oldId`	`string`
`newId`	`string`

Returns void.

Variables

MediaMasherTag

const MediaMasherTag: "media-masher"