Exports related to raw image files.
Classes
ClientRawImageInstanceClass
Extends ClientRawImageInstanceClass_base. Implements ClippedClientRawImage.
new ClientRawImageInstanceClass(
object):ClientRawImageInstanceClass
| Parameter | Type | Description |
|---|---|---|
object | InstanceArgs |
Returns ClientRawImageInstanceClass. Inherited from ClientRawImageInstanceClass_base.constructor.
| Property | Modifier | Type |
|---|---|---|
asset | public | Media |
assetId | public | string |
canBeMuted | public | boolean |
clientAsset | public readonly | ClientAsset |
clientClip | public readonly | ClientClip |
clip | public | ClientClip & Clip |
cropDirections | public | SideDirectionRecord |
hasIntrinsicTiming | public | boolean |
id | public | string |
instanceObject | public | InstanceObject |
intrinsicRect | public | Rect<number> |
isDefault | public | boolean |
mediaIds | public | string[] |
muted | public | boolean |
properties | public | Property[] |
sizeKey? | public | SizeKey |
targetId | public | string |
tweening | public | boolean |
visibleAsset | public | VisibleAsset |
Methods
assetTime(
mashTime):Time
| Parameter | Type | Description |
|---|---|---|
mashTime | Time |
Returns Time. Implementation of ClippedClientRawImage.assetTime, Inherited from ClientRawImageInstanceClass_base.assetTime.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedClientRawImage.boolean, Inherited from ClientRawImageInstanceClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClippedClientRawImage.changeObject, Inherited from ClientRawImageInstanceClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClippedClientRawImage.changeScalars, Inherited from ClientRawImageInstanceClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClippedClientRawImage.changesObject, Inherited from ClientRawImageInstanceClass_base.changesObject.
clippedElement(
content,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
content | VisibleContentInstance |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Implementation of ClippedClientRawImage.clippedElement, Inherited from ClientRawImageInstanceClass_base.clippedElement.
clippedElementPromise(
content,args):Promise<DataOrError<SvgItemsRecord>>
| Parameter | Type |
|---|---|
content | ClientVisibleInstance |
args | ContainerSvgItemArgs |
Returns Promise<DataOrError<SvgItemsRecord>>. Implementation of ClippedClientRawImage.clippedElementPromise, Inherited from ClientRawImageInstanceClass_base.clippedElementPromise.
commandFiles(
cacheArgs):CommandFile[]
| Parameter | Type | Description |
|---|---|---|
cacheArgs | CommandFileArgs |
Returns CommandFile[]. Implementation of ClippedClientRawImage.commandFiles, Inherited from ClientRawImageInstanceClass_base.commandFiles.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClippedClientRawImage.constrainedValue, Inherited from ClientRawImageInstanceClass_base.constrainedValue.
containedItem(
contentItem,containerItem,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
contentItem | MaybeComplexSvgItem |
containerItem | MaybeComplexSvgItem |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Implementation of ClippedClientRawImage.containedItem, Inherited from ClientRawImageInstanceClass_base.containedItem.
containerRects(
args,sizingSize):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContainerRectArgs |
sizingSize | Size<number> |
Returns RectTuple<number>. Implementation of ClippedClientRawImage.containerRects, Inherited from ClientRawImageInstanceClass_base.containerRects.
containerSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Implementation of ClippedClientRawImage.containerSvgItem, Inherited from ClientRawImageInstanceClass_base.containerSvgItem.
containerSvgItemPromise(
args):Promise<DataOrError<MaybeComplexSvgItem>>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns Promise<DataOrError<MaybeComplexSvgItem>>. Implementation of ClippedClientRawImage.containerSvgItemPromise, Inherited from ClientRawImageInstanceClass_base.containerSvgItemPromise.
contentRect(
time,containerRect,outputSize):Rect<number>
| Parameter | Type |
|---|---|
time | Time |
containerRect | Rect<number> |
outputSize | Size<number> |
Returns Rect<number>. Implementation of ClippedClientRawImage.contentRect, Inherited from ClientRawImageInstanceClass_base.contentRect.
contentRects(
args):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContentRectArgs |
Returns RectTuple<number>. Implementation of ClippedClientRawImage.contentRects, Inherited from ClientRawImageInstanceClass_base.contentRects.
contentSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Implementation of ClippedClientRawImage.contentSvgItem, Inherited from ClientRawImageInstanceClass_base.contentSvgItem.
contentSvgItemPromise(
args):Promise<DataOrError<MaybeComplexSvgItem>>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns Promise<DataOrError<MaybeComplexSvgItem>>. Implementation of ClippedClientRawImage.contentSvgItemPromise, Inherited from ClientRawImageInstanceClass_base.contentSvgItemPromise.
frames(
quantize):number
| Parameter | Type | Description |
|---|---|---|
quantize | number |
Returns number. Implementation of ClippedClientRawImage.frames, Inherited from ClientRawImageInstanceClass_base.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClippedClientRawImage.instanceCachePromise, Inherited from ClientRawImageInstanceClass_base.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type | Description |
|---|---|---|
options | IntrinsicOptions |
Returns boolean. Implementation of ClippedClientRawImage.intrinsicsKnown, Inherited from ClientRawImageInstanceClass_base.intrinsicsKnown.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClippedClientRawImage.number, Inherited from ClientRawImageInstanceClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClippedClientRawImage.propertiesOfTarget, Inherited from ClientRawImageInstanceClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClippedClientRawImage.propertyFind, Inherited from ClientRawImageInstanceClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClippedClientRawImage.propertyIds, Inherited from ClientRawImageInstanceClass_base.propertyIds.
scalarsById(targetId, time, timeIsStart)
scalarsById(
targetId,time?,timeIsStart?):SignalScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
time? | Time | |
timeIsStart? | boolean |
Returns SignalScalarRecord. Implementation of ClippedClientRawImage.scalarsById, Inherited from ClientRawImageInstanceClass_base.scalarsById.
scalarsById(targetId, time, timeIsStart, useNames)
scalarsById(
targetId,time?,timeIsStart?,useNames?):SignalScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
time? | Time |
timeIsStart? | boolean |
useNames? | boolean |
Returns SignalScalarRecord. Implementation of ClippedClientRawImage.scalarsById, Inherited from ClientRawImageInstanceClass_base.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClippedClientRawImage.scalarsRecord, Inherited from ClientRawImageInstanceClass_base.scalarsRecord.
scaleRects(
time,range):RectTuple<number>
| Parameter | Type |
|---|---|
time | Time |
range | TimeRange |
Returns RectTuple<number>. Implementation of ClippedClientRawImage.scaleRects, Inherited from ClientRawImageInstanceClass_base.scaleRects.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClippedClientRawImage.setValue, Inherited from ClientRawImageInstanceClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClippedClientRawImage.shouldSelectProperty, Inherited from ClientRawImageInstanceClass_base.shouldSelectProperty.
splitObject(
targetId,frame?,frameIsStart?):Partial<SignalScalarRecord>
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
frame? | number | |
frameIsStart? | boolean |
Returns Partial<SignalScalarRecord>. Implementation of ClippedClientRawImage.splitObject, Inherited from ClientRawImageInstanceClass_base.splitObject.
splitScalars(
targetId,frame?):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
frame? | number |
Returns ScalarRecord. Implementation of ClippedClientRawImage.splitScalars, Inherited from ClientRawImageInstanceClass_base.splitScalars.
string(
id):string
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns string if the value is a string, otherwise throws an assertion error. Implementation of ClippedClientRawImage.string, Inherited from ClientRawImageInstanceClass_base.string.
svgVector(
rect,forecolor?,opacity?):SvgVector
| Parameter | Type |
|---|---|
rect | Rect<number> |
forecolor? | string |
opacity? | Scalar |
Returns SvgVector. Implementation of ClippedClientRawImage.svgVector, Inherited from ClientRawImageInstanceClass_base.svgVector.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClippedClientRawImage.toJSON, Inherited from ClientRawImageInstanceClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClippedClientRawImage.tweenValues, Inherited from ClientRawImageInstanceClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedClientRawImage.tweens, Inherited from ClientRawImageInstanceClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClientRawImageInstanceClass_base.tweensProperty.
unload():
void
Returns void. Implementation of ClippedClientRawImage.unload, Inherited from ClientRawImageInstanceClass_base.unload.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClippedClientRawImage.value, Inherited from ClientRawImageInstanceClass_base.value.
visibleCommandFiles(
args,content?):CommandFile[]
| Parameter | Type |
|---|---|
args | VisibleCommandFileArgs |
content? | VisibleContentInstance |
Returns CommandFile[]. Implementation of ClippedClientRawImage.visibleCommandFiles, Inherited from ClientRawImageInstanceClass_base.visibleCommandFiles.
ClientRawImageMediaClass
Extends ClientRawImageMediaClass_base. Implements ClientRawImage.
new ClientRawImageMediaClass(
object):ClientRawImageMediaClass
| Parameter | Type | Description |
|---|---|---|
object | StorableMedia |
Returns ClientRawImageMediaClass. Inherited from ClientRawImageMediaClass_base.constructor.
| Property | Modifier | Type |
|---|---|---|
alpha? | public | boolean |
asData | public | StorableMedia |
canBeContainer? | public | boolean |
canBeContent? | public | boolean |
canBeFill? | public | boolean |
canBeMuted | public | undefined | boolean |
createdAt? | public | string |
decodings | public | Decoding[] |
hasIntrinsicSizing | public | undefined | boolean |
hasIntrinsicTiming | public | undefined | boolean |
id | public | string |
isVector? | public | boolean |
label? | public | string |
mediaIds | public | string[] |
probeSize? | public | Size<number> |
projectId | public | undefined | string |
properties | public | Property[] |
resources | public | Resource[] |
saveNeeded | public | boolean |
source | public | string |
targetId | public | string |
type | public | MediaType |
unsavedResources | public readonly | Resource[] |
updatedAt? | public | string |
Methods
addResource(
resource):void
| Parameter | Type | Description |
|---|---|---|
resource | Resource |
Returns void. Implementation of ClientRawImage.addResource, Inherited from ClientRawImageMediaClass_base.addResource.
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClientRawImage.assetCachePromise, Overrides ClientRawImageMediaClass_base.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of ClientRawImage.assetFiles, Inherited from ClientRawImageMediaClass_base.assetFiles.
assetIcon(
size,cover?,patch?):Promise<DataOrError<SVGSVGElement>>
| Parameter | Type | Description |
|---|---|---|
size | Size<number> | |
cover? | boolean | |
patch? | Element |
Returns Promise<DataOrError<SVGSVGElement>>. Implementation of ClientRawImage.assetIcon, Overrides ClientRawImageMediaClass_base.assetIcon.
assetIconPromise(resource, options, cover, patch)
assetIconPromise(
resource,options,cover?,patch?):Promise<DataOrError<SVGImageElement>>
| Parameter | Type | Description |
|---|---|---|
resource | Resource | |
options | Size<number> | Rect<number> | |
cover? | boolean | |
patch? | Element |
Returns Promise<DataOrError<SVGImageElement>>. Implementation of ClientRawImage.assetIconPromise, Inherited from ClientRawImageMediaClass_base.assetIconPromise.
assetIconPromise(resource, options, cover, patch)
assetIconPromise(
resource,options,cover?,patch?):Promise<DataOrError<SvgItem>>
| Parameter | Type |
|---|---|
resource | Resource |
options | Size<number> | Rect<number> |
cover? | boolean |
patch? | Element |
Returns Promise<DataOrError<SvgItem>>. Implementation of ClientRawImage.assetIconPromise, Inherited from ClientRawImageMediaClass_base.assetIconPromise.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClientRawImage.boolean, Inherited from ClientRawImageMediaClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClientRawImage.changeObject, Inherited from ClientRawImageMediaClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClientRawImage.changeScalars, Inherited from ClientRawImageMediaClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClientRawImage.changesObject, Inherited from ClientRawImageMediaClass_base.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of ClientRawImage.clipObject, Inherited from ClientRawImageMediaClass_base.clipObject.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of ClientRawImage.commandFilePromise, Inherited from ClientRawImageMediaClass_base.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClientRawImage.constrainedValue, Inherited from ClientRawImageMediaClass_base.constrainedValue.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from ClientRawImageMediaClass_base.decodingOfType.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of ClientRawImage.findResource, Inherited from ClientRawImageMediaClass_base.findResource.
imagePromise(
resource):Promise<DataOrError<ClientImage>>
| Parameter | Type | Description |
|---|---|---|
resource | Resource |
Returns Promise<DataOrError<ClientImage>>. Implementation of ClientRawImage.imagePromise, Inherited from ClientRawImageMediaClass_base.imagePromise.
instanceArgs(
object?):InstanceArgs
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns InstanceArgs. Implementation of ClientRawImage.instanceArgs, Inherited from ClientRawImageMediaClass_base.instanceArgs.
instanceFromObject(
object):ClippedRawImage
| Parameter | Type | Description |
|---|---|---|
object | undefined | ClippedRawImageObject |
Returns ClippedRawImage. Implementation of ClientRawImage.instanceFromObject, Overrides ClientRawImageMediaClass_base.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClientRawImage.number, Inherited from ClientRawImageMediaClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClientRawImage.propertiesOfTarget, Inherited from ClientRawImageMediaClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClientRawImage.propertyFind, Inherited from ClientRawImageMediaClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClientRawImage.propertyIds, Inherited from ClientRawImageMediaClass_base.propertyIds.
savePromise(
progress?):Promise<DataOrError<string>>
| Parameter | Type | Description |
|---|---|---|
progress? | ServerProgress |
Returns Promise<DataOrError<string>>. Implementation of ClientRawImage.savePromise, Inherited from ClientRawImageMediaClass_base.savePromise.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClientRawImage.scalarsRecord, Inherited from ClientRawImageMediaClass_base.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClientRawImage.setValue, Inherited from ClientRawImageMediaClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClientRawImage.shouldSelectProperty, Inherited from ClientRawImageMediaClass_base.shouldSelectProperty.
string(
id):string
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns string if the value is a string, otherwise throws an assertion error. Implementation of ClientRawImage.string, Inherited from ClientRawImageMediaClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClientRawImage.toJSON, Inherited from ClientRawImageMediaClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClientRawImage.tweenValues, Inherited from ClientRawImageMediaClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClientRawImage.tweens, Inherited from ClientRawImageMediaClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClientRawImageMediaClass_base.tweensProperty.
unload():
void
Returns void. Implementation of ClientRawImage.unload, Inherited from ClientRawImageMediaClass_base.unload.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClientRawImage.value, Inherited from ClientRawImageMediaClass_base.value.
ClippedRawImageClass
Extends ClippedRawImageClass_base. Implements ClippedRawImage.
new ClippedRawImageClass(
object):ClippedRawImageClass
| Parameter | Type | Description |
|---|---|---|
object | InstanceArgs |
Returns ClippedRawImageClass. Inherited from ClippedRawImageClass_base.constructor.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
canBeMuted | boolean |
clip | Clip |
cropDirections | SideDirectionRecord |
hasIntrinsicTiming | boolean |
id | string |
instanceObject | InstanceObject |
intrinsicRect | Rect<number> |
isDefault | boolean |
mediaIds | string[] |
muted | boolean |
properties | Property[] |
sizeKey? | SizeKey |
targetId | string |
tweening | boolean |
visibleAsset | VisibleAsset |
Methods
assetTime(
mashTime):Time
| Parameter | Type | Description |
|---|---|---|
mashTime | Time |
Returns Time. Implementation of ClippedRawImage.assetTime, Inherited from ClippedRawImageClass_base.assetTime.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedRawImage.boolean, Inherited from ClippedRawImageClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClippedRawImage.changeObject, Inherited from ClippedRawImageClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClippedRawImage.changeScalars, Inherited from ClippedRawImageClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClippedRawImage.changesObject, Inherited from ClippedRawImageClass_base.changesObject.
clippedElement(
content,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
content | VisibleContentInstance |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Implementation of ClippedRawImage.clippedElement, Inherited from ClippedRawImageClass_base.clippedElement.
commandFiles(
cacheArgs):CommandFile[]
| Parameter | Type | Description |
|---|---|---|
cacheArgs | CommandFileArgs |
Returns CommandFile[]. Implementation of ClippedRawImage.commandFiles, Inherited from ClippedRawImageClass_base.commandFiles.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClippedRawImage.constrainedValue, Inherited from ClippedRawImageClass_base.constrainedValue.
containedItem(
contentItem,containerItem,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
contentItem | MaybeComplexSvgItem |
containerItem | MaybeComplexSvgItem |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Implementation of ClippedRawImage.containedItem, Inherited from ClippedRawImageClass_base.containedItem.
containerRects(
args,sizingSize):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContainerRectArgs |
sizingSize | Size<number> |
Returns RectTuple<number>. Implementation of ClippedRawImage.containerRects, Inherited from ClippedRawImageClass_base.containerRects.
containerSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Implementation of ClippedRawImage.containerSvgItem, Inherited from ClippedRawImageClass_base.containerSvgItem.
contentRect(
time,containerRect,outputSize):Rect<number>
| Parameter | Type |
|---|---|
time | Time |
containerRect | Rect<number> |
outputSize | Size<number> |
Returns Rect<number>. Implementation of ClippedRawImage.contentRect, Inherited from ClippedRawImageClass_base.contentRect.
contentRects(
args):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContentRectArgs |
Returns RectTuple<number>. Implementation of ClippedRawImage.contentRects, Inherited from ClippedRawImageClass_base.contentRects.
contentSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Implementation of ClippedRawImage.contentSvgItem, Inherited from ClippedRawImageClass_base.contentSvgItem.
frames(
quantize):number
| Parameter | Type | Description |
|---|---|---|
quantize | number |
Returns number. Implementation of ClippedRawImage.frames, Inherited from ClippedRawImageClass_base.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClippedRawImage.instanceCachePromise, Inherited from ClippedRawImageClass_base.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type | Description |
|---|---|---|
options | IntrinsicOptions |
Returns boolean. Implementation of ClippedRawImage.intrinsicsKnown, Inherited from ClippedRawImageClass_base.intrinsicsKnown.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClippedRawImage.number, Inherited from ClippedRawImageClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClippedRawImage.propertiesOfTarget, Inherited from ClippedRawImageClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClippedRawImage.propertyFind, Inherited from ClippedRawImageClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClippedRawImage.propertyIds, Inherited from ClippedRawImageClass_base.propertyIds.
scalarsById(targetId, time, timeIsStart)
scalarsById(
targetId,time?,timeIsStart?):SignalScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
time? | Time | |
timeIsStart? | boolean |
Returns SignalScalarRecord. Implementation of ClippedRawImage.scalarsById, Inherited from ClippedRawImageClass_base.scalarsById.
scalarsById(targetId, time, timeIsStart, useNames)
scalarsById(
targetId,time?,timeIsStart?,useNames?):SignalScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
time? | Time |
timeIsStart? | boolean |
useNames? | boolean |
Returns SignalScalarRecord. Implementation of ClippedRawImage.scalarsById, Inherited from ClippedRawImageClass_base.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClippedRawImage.scalarsRecord, Inherited from ClippedRawImageClass_base.scalarsRecord.
scaleRects(
time,range):RectTuple<number>
| Parameter | Type |
|---|---|
time | Time |
range | TimeRange |
Returns RectTuple<number>. Implementation of ClippedRawImage.scaleRects, Inherited from ClippedRawImageClass_base.scaleRects.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClippedRawImage.setValue, Inherited from ClippedRawImageClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClippedRawImage.shouldSelectProperty, Inherited from ClippedRawImageClass_base.shouldSelectProperty.
string(
id):string
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns string if the value is a string, otherwise throws an assertion error. Implementation of ClippedRawImage.string, Inherited from ClippedRawImageClass_base.string.
svgVector(
rect,forecolor?,opacity?):SvgVector
| Parameter | Type |
|---|---|
rect | Rect<number> |
forecolor? | string |
opacity? | Scalar |
Returns SvgVector. Implementation of ClippedRawImage.svgVector, Inherited from ClippedRawImageClass_base.svgVector.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClippedRawImage.toJSON, Inherited from ClippedRawImageClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClippedRawImage.tweenValues, Inherited from ClippedRawImageClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedRawImage.tweens, Inherited from ClippedRawImageClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClippedRawImageClass_base.tweensProperty.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClippedRawImage.value, Inherited from ClippedRawImageClass_base.value.
visibleCommandFiles(
args,content?):CommandFile[]
| Parameter | Type |
|---|---|
args | VisibleCommandFileArgs |
content? | VisibleContentInstance |
Returns CommandFile[]. Implementation of ClippedRawImage.visibleCommandFiles, Inherited from ClippedRawImageClass_base.visibleCommandFiles.
RawImageClass
Extends RawImageClass_base. Implements RawImage.
new RawImageClass(
object):RawImageClass
| Parameter | Type | Description |
|---|---|---|
object | StorableMedia |
Returns RawImageClass. Inherited from RawImageClass_base.constructor.
| Property | Type |
|---|---|
alpha? | boolean |
asData | StorableMedia |
canBeContainer? | boolean |
canBeContent? | boolean |
canBeFill? | boolean |
createdAt? | string |
decodings | Decoding[] |
hasIntrinsicSizing | undefined | boolean |
hasIntrinsicTiming | undefined | boolean |
id | string |
isVector? | boolean |
label? | string |
mediaIds | string[] |
probeSize? | Size<number> |
projectId | undefined | string |
properties | Property[] |
resources | Resource[] |
source | string |
targetId | string |
type | MediaType |
updatedAt? | string |
Methods
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of RawImage.assetCachePromise, Inherited from RawImageClass_base.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of RawImage.assetFiles, Overrides RawImageClass_base.assetFiles.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of RawImage.boolean, Inherited from RawImageClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of RawImage.changeObject, Inherited from RawImageClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of RawImage.changeScalars, Inherited from RawImageClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of RawImage.changesObject, Inherited from RawImageClass_base.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of RawImage.clipObject, Inherited from RawImageClass_base.clipObject.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of RawImage.commandFilePromise, Overrides RawImageClass_base.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of RawImage.constrainedValue, Inherited from RawImageClass_base.constrainedValue.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from RawImageClass_base.decodingOfType.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of RawImage.findResource, Inherited from RawImageClass_base.findResource.
instanceArgs(
object?):InstanceArgs
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns InstanceArgs. Implementation of RawImage.instanceArgs, Inherited from RawImageClass_base.instanceArgs.
instanceFromObject(
object):ClippedRawImage
| Parameter | Type | Description |
|---|---|---|
object | ClippedRawImageObject |
Returns ClippedRawImage. Implementation of RawImage.instanceFromObject, Overrides RawImageClass_base.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of RawImage.number, Inherited from RawImageClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of RawImage.propertiesOfTarget, Inherited from RawImageClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of RawImage.propertyFind, Inherited from RawImageClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of RawImage.propertyIds, Inherited from RawImageClass_base.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of RawImage.scalarsRecord, Inherited from RawImageClass_base.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of RawImage.setValue, Inherited from RawImageClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of RawImage.shouldSelectProperty, Inherited from RawImageClass_base.shouldSelectProperty.
string(
id):string
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns string if the value is a string, otherwise throws an assertion error. Implementation of RawImage.string, Inherited from RawImageClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of RawImage.toJSON, Inherited from RawImageClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of RawImage.tweenValues, Inherited from RawImageClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of RawImage.tweens, Inherited from RawImageClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from RawImageClass_base.tweensProperty.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of RawImage.value, Inherited from RawImageClass_base.value.
Interfaces
ClientRawImage
Extends ImageMedia.ClientRawAsset.ClientVisibleAsset.
| 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[] |
saveNeeded | boolean |
source | string |
targetId | string |
type | MediaType |
updatedAt? | string |
Methods
addResource(
resource):void
| Parameter | Type |
|---|---|
resource | Resource |
Returns void. Inherited from ClientVisibleAsset.addResource.
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from ClientVisibleAsset.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from ClientVisibleAsset.assetFiles.
assetIcon(
size,cover?,patch?):Promise<DataOrError<SVGSVGElement>>
| Parameter | Type |
|---|---|
size | Size<number> |
cover? | boolean |
patch? | Element |
Returns Promise<DataOrError<SVGSVGElement>>. Inherited from ClientVisibleAsset.assetIcon.
assetIconPromise(
resource,options,cover?,patch?):Promise<DataOrError<SvgItem>>
| Parameter | Type |
|---|---|
resource | Resource |
options | Size<number> | Rect<number> |
cover? | boolean |
patch? | Element |
Returns Promise<DataOrError<SvgItem>>. Inherited from ClientVisibleAsset.assetIconPromise.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClientVisibleAsset.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ClientVisibleAsset.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ClientVisibleAsset.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ClientVisibleAsset.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from ClientVisibleAsset.clipObject.
Writes a command file, if it's not a raw asset.commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | ServerPromiseArgs |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Inherited from ClientVisibleAsset.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ClientVisibleAsset.constrainedValue.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from ClientVisibleAsset.findResource.
imagePromise(
resource):Promise<DataOrError<ClientImage>>
| Parameter | Type |
|---|---|
resource | Resource |
Returns Promise<DataOrError<ClientImage>>. Inherited from ClientVisibleAsset.imagePromise.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from ClientVisibleAsset.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from ClientVisibleAsset.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ClientVisibleAsset.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ClientVisibleAsset.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ClientVisibleAsset.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ClientVisibleAsset.propertyIds.
savePromise(
progress?):Promise<DataOrError<string>>
| Parameter | Type |
|---|---|
progress? | ServerProgress |
Returns Promise<DataOrError<string>>. Inherited from ClientVisibleAsset.savePromise.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ClientVisibleAsset.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ClientVisibleAsset.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ClientVisibleAsset.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ClientVisibleAsset.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ClientVisibleAsset.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ClientVisibleAsset.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClientVisibleAsset.tweens.
unload():
void
Returns void. Inherited from ClientVisibleAsset.unload.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ClientVisibleAsset.value.
ClippedClientRawImage
Extends ClippedRawImage.ClientVisibleInstance.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
canBeMuted | boolean |
clip | Clip |
cropDirections | SideDirectionRecord |
id | string |
instanceObject | InstanceObject |
intrinsicRect | Rect<number> |
isDefault | boolean |
mediaIds | string[] |
muted | boolean |
properties | Property[] |
sizeKey? | SizeKey |
targetId | string |
tweening | boolean |
visibleAsset | VisibleAsset |
Methods
assetTime(
masherTime):Time
| Parameter | Type |
|---|---|
masherTime | Time |
Returns Time. Inherited from ClientVisibleInstance.assetTime.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClientVisibleInstance.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ClientVisibleInstance.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ClientVisibleInstance.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ClientVisibleInstance.changesObject.
clippedElement(
content,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
content | VisibleContentInstance |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Inherited from ClientVisibleInstance.clippedElement.
clippedElementPromise(
content,args):Promise<DataOrError<SvgItemsRecord>>
| Parameter | Type |
|---|---|
content | ClientVisibleInstance |
args | ContainerSvgItemArgs |
Returns Promise<DataOrError<SvgItemsRecord>>. Inherited from ClientVisibleInstance.clippedElementPromise.
commandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | CommandFileArgs |
Returns CommandFile[]. Inherited from ClientVisibleInstance.commandFiles.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ClientVisibleInstance.constrainedValue.
containedItem(
contentItem,containerItem,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
contentItem | MaybeComplexSvgItem |
containerItem | MaybeComplexSvgItem |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Inherited from ClientVisibleInstance.containedItem.
containerRects(
args,sizingSize):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContainerRectArgs |
sizingSize | Size<number> |
Returns RectTuple<number>. Inherited from ClientVisibleInstance.containerRects.
containerSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Inherited from ClientVisibleInstance.containerSvgItem.
containerSvgItemPromise(
args):Promise<DataOrError<MaybeComplexSvgItem>>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns Promise<DataOrError<MaybeComplexSvgItem>>. Inherited from ClientVisibleInstance.containerSvgItemPromise.
contentRect(
time,containerRect,outputSize):Rect<number>
| Parameter | Type |
|---|---|
time | Time |
containerRect | Rect<number> |
outputSize | Size<number> |
Returns Rect<number>. Inherited from ClientVisibleInstance.contentRect.
contentRects(
args):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContentRectArgs |
Returns RectTuple<number>. Inherited from ClientVisibleInstance.contentRects.
contentSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Inherited from ClientVisibleInstance.contentSvgItem.
contentSvgItemPromise(
args):Promise<DataOrError<MaybeComplexSvgItem>>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns Promise<DataOrError<MaybeComplexSvgItem>>. Inherited from ClientVisibleInstance.contentSvgItemPromise.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from ClientVisibleInstance.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from ClientVisibleInstance.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type |
|---|---|
options | IntrinsicOptions |
Returns boolean. Inherited from ClientVisibleInstance.intrinsicsKnown.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ClientVisibleInstance.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ClientVisibleInstance.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ClientVisibleInstance.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ClientVisibleInstance.propertyIds.
scalarsById(
targetId,time?,timeIsStart?,useNames?):SignalScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
time? | Time |
timeIsStart? | boolean |
useNames? | boolean |
Returns SignalScalarRecord. Inherited from ClientVisibleInstance.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ClientVisibleInstance.scalarsRecord.
scaleRects(
time,range):RectTuple<number>
| Parameter | Type |
|---|---|
time | Time |
range | TimeRange |
Returns RectTuple<number>. Inherited from ClientVisibleInstance.scaleRects.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ClientVisibleInstance.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ClientVisibleInstance.shouldSelectProperty.
splitObject(
targetId,frame?,frameIsStart?):Partial<SignalScalarRecord>
| Parameter | Type |
|---|---|
targetId | string |
frame? | number |
frameIsStart? | boolean |
Returns Partial<SignalScalarRecord>. Inherited from ClientVisibleInstance.splitObject.
splitScalars(
targetId,frame?):ScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
frame? | number |
Returns ScalarRecord. Inherited from ClientVisibleInstance.splitScalars.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ClientVisibleInstance.string.
svgVector(
rect,forecolor?,opacity?):SvgVector
| Parameter | Type |
|---|---|
rect | Rect<number> |
forecolor? | string |
opacity? | Scalar |
Returns SvgVector. Inherited from ClientVisibleInstance.svgVector.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ClientVisibleInstance.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ClientVisibleInstance.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClientVisibleInstance.tweens.
unload():
void
Returns void. Inherited from ClientVisibleInstance.unload.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ClientVisibleInstance.value.
visibleCommandFiles(
args,content?):CommandFile[]
| Parameter | Type |
|---|---|
args | VisibleCommandFileArgs |
content? | VisibleContentInstance |
Returns CommandFile[]. Inherited from ClientVisibleInstance.visibleCommandFiles.
ClippedRawImage
Extends ClippedImage. Extended by MashImageInstance and ClippedClientRawImage.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
canBeMuted | boolean |
clip | Clip |
cropDirections | SideDirectionRecord |
id | string |
instanceObject | InstanceObject |
intrinsicRect | Rect<number> |
isDefault | boolean |
mediaIds | string[] |
muted | boolean |
properties | Property[] |
sizeKey? | SizeKey |
targetId | string |
tweening | boolean |
visibleAsset | VisibleAsset |
Methods
assetTime(
masherTime):Time
| Parameter | Type |
|---|---|
masherTime | Time |
Returns Time. Inherited from ClippedImage.assetTime.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClippedImage.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ClippedImage.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ClippedImage.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ClippedImage.changesObject.
clippedElement(
content,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
content | VisibleContentInstance |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Inherited from ClippedImage.clippedElement.
commandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | CommandFileArgs |
Returns CommandFile[]. Inherited from ClippedImage.commandFiles.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ClippedImage.constrainedValue.
containedItem(
contentItem,containerItem,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
contentItem | MaybeComplexSvgItem |
containerItem | MaybeComplexSvgItem |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Inherited from ClippedImage.containedItem.
containerRects(
args,sizingSize):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContainerRectArgs |
sizingSize | Size<number> |
Returns RectTuple<number>. Inherited from ClippedImage.containerRects.
containerSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Inherited from ClippedImage.containerSvgItem.
contentRect(
time,containerRect,outputSize):Rect<number>
| Parameter | Type |
|---|---|
time | Time |
containerRect | Rect<number> |
outputSize | Size<number> |
Returns Rect<number>. Inherited from ClippedImage.contentRect.
contentRects(
args):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContentRectArgs |
Returns RectTuple<number>. Inherited from ClippedImage.contentRects.
contentSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Inherited from ClippedImage.contentSvgItem.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from ClippedImage.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from ClippedImage.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type |
|---|---|
options | IntrinsicOptions |
Returns boolean. Inherited from ClippedImage.intrinsicsKnown.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ClippedImage.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ClippedImage.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ClippedImage.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ClippedImage.propertyIds.
scalarsById(
targetId,time?,timeIsStart?,useNames?):SignalScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
time? | Time |
timeIsStart? | boolean |
useNames? | boolean |
Returns SignalScalarRecord. Inherited from ClippedImage.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ClippedImage.scalarsRecord.
scaleRects(
time,range):RectTuple<number>
| Parameter | Type |
|---|---|
time | Time |
range | TimeRange |
Returns RectTuple<number>. Inherited from ClippedImage.scaleRects.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ClippedImage.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ClippedImage.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ClippedImage.string.
svgVector(
rect,forecolor?,opacity?):SvgVector
| Parameter | Type |
|---|---|
rect | Rect<number> |
forecolor? | string |
opacity? | Scalar |
Returns SvgVector. Inherited from ClippedImage.svgVector.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ClippedImage.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ClippedImage.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClippedImage.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ClippedImage.value.
visibleCommandFiles(
args,content?):CommandFile[]
| Parameter | Type |
|---|---|
args | VisibleCommandFileArgs |
content? | VisibleContentInstance |
Returns CommandFile[]. Inherited from ClippedImage.visibleCommandFiles.
ClippedRawImageArgs
Extends InstanceArgs.ClippedRawImageObject.
| Property | Type |
|---|---|
asset | Media |
container? | boolean |
height? | number |
heightEnd? | number |
lock? | string |
opacity? | number |
opacityEnd? | number |
pointAspect? | string |
sizeAspect? | string |
transparency? | string |
width? | number |
widthEnd? | number |
x? | number |
xEnd? | number |
y? | number |
yEnd? | number |
ClippedRawImageObject
Extends VisibleInstanceObject. Extended by ClippedColorObject and ClippedRawImageArgs.
| Property | Type |
|---|---|
container? | boolean |
height? | number |
heightEnd? | number |
lock? | string |
opacity? | number |
opacityEnd? | number |
pointAspect? | string |
sizeAspect? | string |
transparency? | string |
width? | number |
widthEnd? | number |
x? | number |
xEnd? | number |
y? | number |
yEnd? | number |
RawImage
Extends ImageMedia.
| 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 ImageMedia.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from ImageMedia.assetFiles.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ImageMedia.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ImageMedia.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ImageMedia.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ImageMedia.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from ImageMedia.clipObject.
Writes a command file, if it's not a raw asset.commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | ServerPromiseArgs |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Inherited from ImageMedia.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ImageMedia.constrainedValue.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from ImageMedia.findResource.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from ImageMedia.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from ImageMedia.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ImageMedia.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ImageMedia.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ImageMedia.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ImageMedia.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ImageMedia.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ImageMedia.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ImageMedia.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ImageMedia.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ImageMedia.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ImageMedia.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ImageMedia.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ImageMedia.value.
StorableRawImage
Extends StorableMedia.ImageProperties.
| Property | Type |
|---|---|
createdAt? | string |
id? | string |
label? | string |
projectId? | string |
resources? | StorableResource[] |
source | string |
type | MediaType |
updatedAt? | string |
StoredRawImage
Extends StoredMedia.ImageProperties.
| Property | Type |
|---|---|
createdAt? | string |
id | string |
label? | string |
projectId? | string |
resources? | StoredResource[] |
source | string |
type | MediaType |
updatedAt? | string |