Image

Exports related to image media.

Interfaces

ImageMedia

Extends ContainerAsset.VisibleContentAsset. Extended by RawImage and ClientRawImage.

Property	Type
`alpha?`	`boolean`
`asData`	`StorableMedia`
`canBeContainer?`	`boolean`
`canBeContent?`	`boolean`
`canBeFill?`	`boolean`
`createdAt?`	`string`
`decodings`	`Decoding`[]
`hasIntrinsicSizing?`	`boolean`
`hasIntrinsicTiming?`	`boolean`
`id`	`string`
`isVector?`	`boolean`
`label?`	`string`
`mediaIds`	`string`[]
`probeSize?`	`Size`<`number`>
`projectId?`	`string`
`properties`	`Property`[]
`resources`	`Resource`[]
`source`	`string`
`targetId`	`string`
`type`	`MediaType`
`updatedAt?`	`string`

Methods

assetCachePromise(args): Promise<DataOrError<number>>

Parameter	Type
`args`	`AssetCacheArgs`

Returns Promise<DataOrError<number>>. Inherited from VisibleContentAsset.assetCachePromise.

assetFiles(args): AssetFile[]

All files needed for audible and/or visible encode commands.

Parameter	Type
`args`	`CacheArgs`

Returns AssetFile[]. Inherited from VisibleContentAsset.assetFiles.

boolean(key): boolean

Parameter	Type
`key`	`string`

Returns boolean. Inherited from VisibleContentAsset.boolean.

changeObject(propertyId, scalar?): ChangeEditObject

Parameter	Type
`propertyId`	`${string}.${string}`
`scalar`?	`Scalar`

Returns ChangeEditObject. Inherited from VisibleContentAsset.changeObject.

changeScalars(scalars): void

Parameter	Type
`scalars`	`Partial`<`SignalScalarRecord`>

Returns void. Inherited from VisibleContentAsset.changeScalars.

changesObject(scalars): ChangePropertiesEditObject

Parameter	Type
`scalars`	`Partial`<`SignalScalarRecord`>

Returns ChangePropertiesEditObject. Inherited from VisibleContentAsset.changesObject.

clipObject(object?): ClipObject

Parameter	Type
`object`?	`InstanceObject`

Returns ClipObject. Inherited from VisibleContentAsset.clipObject.

commandFilePromise(args, commandFile): Promise<DataOrError<number>>

Writes a command file, if it's not a raw asset.

Parameter	Type
`args`	`ServerPromiseArgs`
`commandFile`	`CommandFile`

Returns Promise<DataOrError<number>>. Inherited from VisibleContentAsset.commandFilePromise.

constrainedValue(found, value?): undefined | Scalar

Parameter	Type
`found`	`Property`
`value`?	`Scalar`

Returns undefined | Scalar. Inherited from VisibleContentAsset.constrainedValue.

findResource(…types): undefined | Resource

Parameter	Type
…`types`	`string`[]

Returns undefined | Resource. Inherited from VisibleContentAsset.findResource.

instanceArgs(object?): InstanceArgs

Parameter	Type
`object`?	`InstanceObject`

Returns InstanceArgs. Inherited from VisibleContentAsset.instanceArgs.

instanceFromObject(object?): Instance

Parameter	Type
`object`?	`InstanceObject`

Returns Instance. Inherited from VisibleContentAsset.instanceFromObject.

number(key): number

Parameter	Type
`key`	`string`

Returns number. Inherited from VisibleContentAsset.number.

propertiesOfTarget(targetId): Property[]

Parameter	Type
`targetId`	`string`

Returns Property[]. Inherited from VisibleContentAsset.propertiesOfTarget.

propertyFind(name): undefined | Property

Parameter	Type
`name`	`string`

Returns undefined | Property. Inherited from VisibleContentAsset.propertyFind.

propertyIds(targetId): `${string}.${string}`[]

Parameter	Type
`targetId`	`string`

Returns `${string}.${string}`[]. Inherited from VisibleContentAsset.propertyIds.

scalarsRecord(idOrNames): ScalarRecord

Parameter	Type
`idOrNames`	`string`[]

Returns ScalarRecord. Inherited from VisibleContentAsset.scalarsRecord.

setValue(nameOrId, scalar?, dontConstrain?): void

Parameter	Type
`nameOrId`	`string`
`scalar`?	`Scalar`
`dontConstrain`?	`boolean`

Returns void. Inherited from VisibleContentAsset.setValue.

shouldSelectProperty(property): boolean

Parameter	Type
`property`	`Property`

Returns boolean. Inherited from VisibleContentAsset.shouldSelectProperty.

string(key): string

Parameter	Type
`key`	`string`

Returns string. Inherited from VisibleContentAsset.string.

toJSON(): UnknownRecord

Returns UnknownRecord. Inherited from VisibleContentAsset.toJSON.

tweenValues(key, time, range): Scalar[]

Parameter	Type
`key`	`string`
`time`	`Time`
`range`	`TimeRange`

Returns Scalar[]. Inherited from VisibleContentAsset.tweenValues.

tweens(key): boolean

Parameter	Type
`key`	`string`

Returns boolean. Inherited from VisibleContentAsset.tweens.

value(key): undefined | Scalar

Parameter	Type
`key`	`string`

Returns undefined | Scalar. Inherited from VisibleContentAsset.value.

StorableMashImage

Extends StorableMash.MashVisibleProperties.

Property	Type	Description
`assets?`	`StorableMedia`[]	-
`buffer?`	`number`	-
`color?`	`string`	Background color.
`createdAt?`	`string`	-
`height?`	`number`	-
`id?`	`string`	-
`label?`	`string`	-
`projectId?`	`string`	-
`resources?`	`StorableResource`[]	-
`shortest?`	`number`	-
`source`	`"mash"`	-
`tracks?`	`TrackObject`[]	-
`type`	`"image"`	-
`updatedAt?`	`string`	-
`width?`	`number`	-

StoredMashImage

Extends StoredMedia.MashVisibleProperties.

Property	Type	Description
`buffer?`	`number`	-
`color?`	`string`	Background color.
`createdAt?`	`string`	-
`height?`	`number`	-
`id`	`string`	-
`label?`	`string`	-
`projectId?`	`string`	-
`resources?`	`StoredResource`[]	-
`shortest?`	`number`	-
`source`	`string`	-
`tracks?`	`TrackObject`[]	-
`type`	`MediaType`	-
`updatedAt?`	`string`	-
`width?`	`number`	-

Functions

ImageMediaMixin

ImageMediaMixin<T>(Base): T & Constrained<ImageMedia>

Type Parameter	Description
`T` extends `Constrained`<`VisibleAsset`>

Parameter	Type	Description
`Base`	`T`

Returns T & Constrained<ImageMedia>.

isImageMedia

isImageMedia(value): value is ImageMedia

Parameter	Type
`value`	`any`

Returns value is ImageMedia.