Exports related to raw video files.
Classes
ClientRawVideoClass
Extends ClientRawVideoClass_base. Implements ClientRawVideo.
new ClientRawVideoClass(
object):ClientRawVideoClass
| Parameter | Type | Description |
|---|---|---|
object | StorableMedia |
Returns ClientRawVideoClass. Inherited from ClientRawVideoClass_base.constructor.
| Property | Modifier | Type |
|---|---|---|
_loader | public | undefined | PreviewLoader |
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[] |
duration | public | number |
hasIntrinsicSizing | public | undefined | boolean |
hasIntrinsicTiming | public | undefined | boolean |
id | public | string |
isVector? | public | boolean |
label? | public | string |
loader | public readonly | undefined | PreviewLoader |
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 ClientRawVideo.addResource, Inherited from ClientRawVideoClass_base.addResource.
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClientRawVideo.assetCachePromise, Overrides ClientRawVideoClass_base.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of ClientRawVideo.assetFiles, Inherited from ClientRawVideoClass_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 ClientRawVideo.assetIcon, Overrides ClientRawVideoClass_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 ClientRawVideo.assetIconPromise, Inherited from ClientRawVideoClass_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 ClientRawVideo.assetIconPromise, Inherited from ClientRawVideoClass_base.assetIconPromise.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClientRawVideo.boolean, Inherited from ClientRawVideoClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClientRawVideo.changeObject, Inherited from ClientRawVideoClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClientRawVideo.changeScalars, Inherited from ClientRawVideoClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClientRawVideo.changesObject, Inherited from ClientRawVideoClass_base.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of ClientRawVideo.clipObject, Inherited from ClientRawVideoClass_base.clipObject.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of ClientRawVideo.commandFilePromise, Inherited from ClientRawVideoClass_base.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClientRawVideo.constrainedValue, Inherited from ClientRawVideoClass_base.constrainedValue.
Only called by clipped videodataUrl(
assetTime,size?):DataOrError<string>
| Parameter | Type | Description |
|---|---|---|
assetTime | Time | |
size? | Size<number> |
Returns DataOrError<string>. Implementation of ClientRawVideo.dataUrl.
Only called by clipped videodataUrlPromise(
time,size?):Promise<DataOrError<string>>
| Parameter | Type | Description |
|---|---|---|
time | Time | |
size? | Size<number> |
Returns Promise<DataOrError<string>>. Implementation of ClientRawVideo.dataUrlPromise.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from ClientRawVideoClass_base.decodingOfType.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of ClientRawVideo.findResource, Inherited from ClientRawVideoClass_base.findResource.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Implementation of ClientRawVideo.frames, Inherited from ClientRawVideoClass_base.frames.
imagePromise(
resource):Promise<DataOrError<ClientImage>>
| Parameter | Type | Description |
|---|---|---|
resource | Resource |
Returns Promise<DataOrError<ClientImage>>. Implementation of ClientRawVideo.imagePromise, Inherited from ClientRawVideoClass_base.imagePromise.
instanceArgs(
object?):InstanceArgs
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns InstanceArgs. Implementation of ClientRawVideo.instanceArgs, Inherited from ClientRawVideoClass_base.instanceArgs.
instanceFromObject(
object):ClippedVideo
| Parameter | Type | Description |
|---|---|---|
object | undefined | ClippedRawVideoObject |
Returns ClippedVideo. Implementation of ClientRawVideo.instanceFromObject, Overrides ClientRawVideoClass_base.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClientRawVideo.number, Inherited from ClientRawVideoClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClientRawVideo.propertiesOfTarget, Inherited from ClientRawVideoClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClientRawVideo.propertyFind, Inherited from ClientRawVideoClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClientRawVideo.propertyIds, Inherited from ClientRawVideoClass_base.propertyIds.
savePromise(
progress?):Promise<DataOrError<string>>
| Parameter | Type | Description |
|---|---|---|
progress? | ServerProgress |
Returns Promise<DataOrError<string>>. Implementation of ClientRawVideo.savePromise, Inherited from ClientRawVideoClass_base.savePromise.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClientRawVideo.scalarsRecord, Inherited from ClientRawVideoClass_base.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClientRawVideo.setValue, Inherited from ClientRawVideoClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClientRawVideo.shouldSelectProperty, Inherited from ClientRawVideoClass_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 ClientRawVideo.string, Inherited from ClientRawVideoClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClientRawVideo.toJSON, Inherited from ClientRawVideoClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClientRawVideo.tweenValues, Inherited from ClientRawVideoClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClientRawVideo.tweens, Inherited from ClientRawVideoClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClientRawVideoClass_base.tweensProperty.
unload():
void
Returns void. Implementation of ClientRawVideo.unload, Inherited from ClientRawVideoClass_base.unload.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClientRawVideo.value, Inherited from ClientRawVideoClass_base.value.
ClippedClientRawVideoClass
Extends ClippedClientRawVideoClass_base. Implements ClippedClientRawVideo.
new ClippedClientRawVideoClass(
object):ClippedClientRawVideoClass
| Parameter | Type | Description |
|---|---|---|
object | InstanceArgs |
Returns ClippedClientRawVideoClass. Inherited from ClippedClientRawVideoClass_base.constructor.
| Property | Modifier | Type |
|---|---|---|
asset | public | Media |
assetId | public | string |
audibleAsset | public | AudibleAsset |
canBeMuted | public | boolean |
clientAsset | public readonly | ClientAsset |
clientAudibleAsset | public | ClientAudibleAsset |
clientClip | public readonly | ClientClip |
clientRawVideoMedia | public readonly | ClientRawVideo |
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
assetFrames(
quantize):number[]
| Parameter | Type |
|---|---|
quantize | number |
Returns number[] containing duration, start trim, and end trim in frames.. Implementation of ClippedClientRawVideo.assetFrames, Inherited from ClippedClientRawVideoClass_base.assetFrames.
assetTime(
mashTime):Time
| Parameter | Type | Description |
|---|---|---|
mashTime | Time |
Returns Time. Implementation of ClippedClientRawVideo.assetTime, Inherited from ClippedClientRawVideoClass_base.assetTime.
audibleCommandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | AudioCommandFileArgs |
Returns CommandFile[]. Implementation of ClippedClientRawVideo.audibleCommandFiles, Inherited from ClippedClientRawVideoClass_base.audibleCommandFiles.
audiblePreviewPromise(
outputSize,scale?):Promise<DataOrError<SvgItem>>
| Parameter | Type |
|---|---|
outputSize | Size<number> |
scale? | number |
Returns Promise<DataOrError<SvgItem>>. Implementation of ClippedClientRawVideo.audiblePreviewPromise, Inherited from ClippedClientRawVideoClass_base.audiblePreviewPromise.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedClientRawVideo.boolean, Inherited from ClippedClientRawVideoClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClippedClientRawVideo.changeObject, Inherited from ClippedClientRawVideoClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClippedClientRawVideo.changeScalars, Inherited from ClippedClientRawVideoClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClippedClientRawVideo.changesObject, Inherited from ClippedClientRawVideoClass_base.changesObject.
clippedElement(
content,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
content | VisibleContentInstance |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Implementation of ClippedClientRawVideo.clippedElement, Inherited from ClippedClientRawVideoClass_base.clippedElement.
clippedElementPromise(
content,args):Promise<DataOrError<SvgItemsRecord>>
| Parameter | Type |
|---|---|
content | ClientVisibleInstance |
args | ContainerSvgItemArgs |
Returns Promise<DataOrError<SvgItemsRecord>>. Inherited from ClippedClientRawVideoClass_base.clippedElementPromise.
commandFiles(
cacheArgs):CommandFile[]
| Parameter | Type | Description |
|---|---|---|
cacheArgs | CommandFileArgs |
Returns CommandFile[]. Implementation of ClippedClientRawVideo.commandFiles, Inherited from ClippedClientRawVideoClass_base.commandFiles.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClippedClientRawVideo.constrainedValue, Inherited from ClippedClientRawVideoClass_base.constrainedValue.
containedItem(
contentItem,containerItem,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
contentItem | MaybeComplexSvgItem |
containerItem | MaybeComplexSvgItem |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Implementation of ClippedClientRawVideo.containedItem, Inherited from ClippedClientRawVideoClass_base.containedItem.
containerRects(
args,sizingSize):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContainerRectArgs |
sizingSize | Size<number> |
Returns RectTuple<number>. Implementation of ClippedClientRawVideo.containerRects, Inherited from ClippedClientRawVideoClass_base.containerRects.
containerSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Implementation of ClippedClientRawVideo.containerSvgItem, Inherited from ClippedClientRawVideoClass_base.containerSvgItem.
containerSvgItemPromise(
args):Promise<DataOrError<MaybeComplexSvgItem>>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns Promise<DataOrError<MaybeComplexSvgItem>>. Inherited from ClippedClientRawVideoClass_base.containerSvgItemPromise.
contentRect(
time,containerRect,outputSize):Rect<number>
| Parameter | Type |
|---|---|
time | Time |
containerRect | Rect<number> |
outputSize | Size<number> |
Returns Rect<number>. Implementation of ClippedClientRawVideo.contentRect, Inherited from ClippedClientRawVideoClass_base.contentRect.
contentRects(
args):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContentRectArgs |
Returns RectTuple<number>. Implementation of ClippedClientRawVideo.contentRects, Inherited from ClippedClientRawVideoClass_base.contentRects.
contentSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Implementation of ClippedClientRawVideo.contentSvgItem, Inherited from ClippedClientRawVideoClass_base.contentSvgItem.
contentSvgItemPromise(
args):Promise<DataOrError<MaybeComplexSvgItem>>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns Promise<DataOrError<MaybeComplexSvgItem>>. Inherited from ClippedClientRawVideoClass_base.contentSvgItemPromise.
frames(
quantize):number
| Parameter | Type | Description |
|---|---|---|
quantize | number |
Returns number. Implementation of ClippedClientRawVideo.frames, Inherited from ClippedClientRawVideoClass_base.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClippedClientRawVideo.instanceCachePromise, Inherited from ClippedClientRawVideoClass_base.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type | Description |
|---|---|---|
options | IntrinsicOptions |
Returns boolean. Implementation of ClippedClientRawVideo.intrinsicsKnown, Inherited from ClippedClientRawVideoClass_base.intrinsicsKnown.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClippedClientRawVideo.number, Inherited from ClippedClientRawVideoClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClippedClientRawVideo.propertiesOfTarget, Inherited from ClippedClientRawVideoClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClippedClientRawVideo.propertyFind, Inherited from ClippedClientRawVideoClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClippedClientRawVideo.propertyIds, Inherited from ClippedClientRawVideoClass_base.propertyIds.
scalarsById(targetId, time, timeIsStart)
scalarsById(
targetId,time?,timeIsStart?):SignalScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
time? | Time | |
timeIsStart? | boolean |
Returns SignalScalarRecord. Implementation of ClippedClientRawVideo.scalarsById, Inherited from ClippedClientRawVideoClass_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 ClippedClientRawVideo.scalarsById, Inherited from ClippedClientRawVideoClass_base.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClippedClientRawVideo.scalarsRecord, Inherited from ClippedClientRawVideoClass_base.scalarsRecord.
scaleRects(
time,range):RectTuple<number>
| Parameter | Type |
|---|---|
time | Time |
range | TimeRange |
Returns RectTuple<number>. Implementation of ClippedClientRawVideo.scaleRects, Inherited from ClippedClientRawVideoClass_base.scaleRects.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClippedClientRawVideo.setValue, Inherited from ClippedClientRawVideoClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClippedClientRawVideo.shouldSelectProperty, Inherited from ClippedClientRawVideoClass_base.shouldSelectProperty.
splitObject(
targetId,frame?,frameIsStart?):Partial<SignalScalarRecord>
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
frame? | number | |
frameIsStart? | boolean |
Returns Partial<SignalScalarRecord>. Implementation of ClippedClientRawVideo.splitObject, Inherited from ClippedClientRawVideoClass_base.splitObject.
splitScalars(
targetId,frame?):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
frame? | number |
Returns ScalarRecord. Implementation of ClippedClientRawVideo.splitScalars, Inherited from ClippedClientRawVideoClass_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 ClippedClientRawVideo.string, Inherited from ClippedClientRawVideoClass_base.string.
svgVector(
rect,forecolor?,opacity?):SvgVector
| Parameter | Type |
|---|---|
rect | Rect<number> |
forecolor? | string |
opacity? | Scalar |
Returns SvgVector. Implementation of ClippedClientRawVideo.svgVector, Inherited from ClippedClientRawVideoClass_base.svgVector.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClippedClientRawVideo.toJSON, Inherited from ClippedClientRawVideoClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClippedClientRawVideo.tweenValues, Inherited from ClippedClientRawVideoClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedClientRawVideo.tweens, Inherited from ClippedClientRawVideoClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClippedClientRawVideoClass_base.tweensProperty.
unload():
void
Returns void. Implementation of ClippedClientRawVideo.unload, Inherited from ClippedClientRawVideoClass_base.unload.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClippedClientRawVideo.value, Inherited from ClippedClientRawVideoClass_base.value.
visibleCommandFiles(
args,content?):CommandFile[]
| Parameter | Type |
|---|---|
args | VisibleCommandFileArgs |
content? | VisibleContentInstance |
Returns CommandFile[]. Implementation of ClippedClientRawVideo.visibleCommandFiles, Inherited from ClippedClientRawVideoClass_base.visibleCommandFiles.
ClippedRawVideoClass
Extends ClippedRawVideoClass_base. Implements ClippedRawVideo.
new ClippedRawVideoClass(
object):ClippedRawVideoClass
| Parameter | Type | Description |
|---|---|---|
object | InstanceArgs |
Returns ClippedRawVideoClass. Inherited from ClippedRawVideoClass_base.constructor.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
audibleAsset | AudibleAsset |
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
assetFrames(
quantize):number[]
| Parameter | Type |
|---|---|
quantize | number |
Returns number[] containing duration, start trim, and end trim in frames.. Implementation of ClippedRawVideo.assetFrames, Inherited from ClippedRawVideoClass_base.assetFrames.
assetTime(
mashTime):Time
| Parameter | Type | Description |
|---|---|---|
mashTime | Time |
Returns Time. Implementation of ClippedRawVideo.assetTime, Inherited from ClippedRawVideoClass_base.assetTime.
audibleCommandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | AudioCommandFileArgs |
Returns CommandFile[]. Implementation of ClippedRawVideo.audibleCommandFiles, Inherited from ClippedRawVideoClass_base.audibleCommandFiles.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedRawVideo.boolean, Inherited from ClippedRawVideoClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClippedRawVideo.changeObject, Inherited from ClippedRawVideoClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClippedRawVideo.changeScalars, Inherited from ClippedRawVideoClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClippedRawVideo.changesObject, Inherited from ClippedRawVideoClass_base.changesObject.
clippedElement(
content,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
content | VisibleContentInstance |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Implementation of ClippedRawVideo.clippedElement, Inherited from ClippedRawVideoClass_base.clippedElement.
commandFiles(
cacheArgs):CommandFile[]
| Parameter | Type | Description |
|---|---|---|
cacheArgs | CommandFileArgs |
Returns CommandFile[]. Implementation of ClippedRawVideo.commandFiles, Inherited from ClippedRawVideoClass_base.commandFiles.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClippedRawVideo.constrainedValue, Inherited from ClippedRawVideoClass_base.constrainedValue.
containedItem(
contentItem,containerItem,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
contentItem | MaybeComplexSvgItem |
containerItem | MaybeComplexSvgItem |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Implementation of ClippedRawVideo.containedItem, Inherited from ClippedRawVideoClass_base.containedItem.
containerRects(
args,sizingSize):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContainerRectArgs |
sizingSize | Size<number> |
Returns RectTuple<number>. Implementation of ClippedRawVideo.containerRects, Inherited from ClippedRawVideoClass_base.containerRects.
containerSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Implementation of ClippedRawVideo.containerSvgItem, Inherited from ClippedRawVideoClass_base.containerSvgItem.
contentRect(
time,containerRect,outputSize):Rect<number>
| Parameter | Type |
|---|---|
time | Time |
containerRect | Rect<number> |
outputSize | Size<number> |
Returns Rect<number>. Implementation of ClippedRawVideo.contentRect, Inherited from ClippedRawVideoClass_base.contentRect.
contentRects(
args):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContentRectArgs |
Returns RectTuple<number>. Implementation of ClippedRawVideo.contentRects, Inherited from ClippedRawVideoClass_base.contentRects.
contentSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Implementation of ClippedRawVideo.contentSvgItem, Inherited from ClippedRawVideoClass_base.contentSvgItem.
frames(
quantize):number
| Parameter | Type | Description |
|---|---|---|
quantize | number |
Returns number. Implementation of ClippedRawVideo.frames, Inherited from ClippedRawVideoClass_base.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClippedRawVideo.instanceCachePromise, Inherited from ClippedRawVideoClass_base.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type | Description |
|---|---|---|
options | IntrinsicOptions |
Returns boolean. Implementation of ClippedRawVideo.intrinsicsKnown, Inherited from ClippedRawVideoClass_base.intrinsicsKnown.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClippedRawVideo.number, Inherited from ClippedRawVideoClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClippedRawVideo.propertiesOfTarget, Inherited from ClippedRawVideoClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClippedRawVideo.propertyFind, Inherited from ClippedRawVideoClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClippedRawVideo.propertyIds, Inherited from ClippedRawVideoClass_base.propertyIds.
scalarsById(targetId, time, timeIsStart)
scalarsById(
targetId,time?,timeIsStart?):SignalScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
time? | Time | |
timeIsStart? | boolean |
Returns SignalScalarRecord. Implementation of ClippedRawVideo.scalarsById, Inherited from ClippedRawVideoClass_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 ClippedRawVideo.scalarsById, Inherited from ClippedRawVideoClass_base.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClippedRawVideo.scalarsRecord, Inherited from ClippedRawVideoClass_base.scalarsRecord.
scaleRects(
time,range):RectTuple<number>
| Parameter | Type |
|---|---|
time | Time |
range | TimeRange |
Returns RectTuple<number>. Implementation of ClippedRawVideo.scaleRects, Inherited from ClippedRawVideoClass_base.scaleRects.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClippedRawVideo.setValue, Inherited from ClippedRawVideoClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClippedRawVideo.shouldSelectProperty, Inherited from ClippedRawVideoClass_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 ClippedRawVideo.string, Inherited from ClippedRawVideoClass_base.string.
svgVector(
rect,forecolor?,opacity?):SvgVector
| Parameter | Type |
|---|---|
rect | Rect<number> |
forecolor? | string |
opacity? | Scalar |
Returns SvgVector. Implementation of ClippedRawVideo.svgVector, Inherited from ClippedRawVideoClass_base.svgVector.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClippedRawVideo.toJSON, Inherited from ClippedRawVideoClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClippedRawVideo.tweenValues, Inherited from ClippedRawVideoClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedRawVideo.tweens, Inherited from ClippedRawVideoClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClippedRawVideoClass_base.tweensProperty.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClippedRawVideo.value, Inherited from ClippedRawVideoClass_base.value.
visibleCommandFiles(
args,content?):CommandFile[]
| Parameter | Type |
|---|---|
args | VisibleCommandFileArgs |
content? | VisibleContentInstance |
Returns CommandFile[]. Implementation of ClippedRawVideo.visibleCommandFiles, Inherited from ClippedRawVideoClass_base.visibleCommandFiles.
RawVideoClass
Extends RawVideoClass_base. Implements RawVideo.
new RawVideoClass(
object):RawVideoClass
| Parameter | Type | Description |
|---|---|---|
object | StorableMedia |
Returns RawVideoClass. Inherited from RawVideoClass_base.constructor.
| Property | Type |
|---|---|
alpha? | boolean |
asData | StorableMedia |
canBeContainer? | boolean |
canBeContent? | boolean |
canBeFill? | boolean |
canBeMuted? | boolean |
createdAt? | string |
decodings | Decoding[] |
duration | number |
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 RawVideo.assetCachePromise, Inherited from RawVideoClass_base.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of RawVideo.assetFiles, Overrides RawVideoClass_base.assetFiles.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of RawVideo.boolean, Inherited from RawVideoClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of RawVideo.changeObject, Inherited from RawVideoClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of RawVideo.changeScalars, Inherited from RawVideoClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of RawVideo.changesObject, Inherited from RawVideoClass_base.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of RawVideo.clipObject, Inherited from RawVideoClass_base.clipObject.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of RawVideo.commandFilePromise, Inherited from RawVideoClass_base.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of RawVideo.constrainedValue, Inherited from RawVideoClass_base.constrainedValue.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from RawVideoClass_base.decodingOfType.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of RawVideo.findResource, Inherited from RawVideoClass_base.findResource.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Implementation of RawVideo.frames, Inherited from RawVideoClass_base.frames.
instanceArgs(
object?):InstanceArgs
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns InstanceArgs. Implementation of RawVideo.instanceArgs, Inherited from RawVideoClass_base.instanceArgs.
instanceFromObject(
object?):ClippedRawVideo
| Parameter | Type | Description |
|---|---|---|
object? | ClippedRawVideoObject |
Returns ClippedRawVideo. Implementation of RawVideo.instanceFromObject, Overrides RawVideoClass_base.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of RawVideo.number, Inherited from RawVideoClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of RawVideo.propertiesOfTarget, Inherited from RawVideoClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of RawVideo.propertyFind, Inherited from RawVideoClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of RawVideo.propertyIds, Inherited from RawVideoClass_base.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of RawVideo.scalarsRecord, Inherited from RawVideoClass_base.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of RawVideo.setValue, Inherited from RawVideoClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of RawVideo.shouldSelectProperty, Inherited from RawVideoClass_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 RawVideo.string, Inherited from RawVideoClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of RawVideo.toJSON, Inherited from RawVideoClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of RawVideo.tweenValues, Inherited from RawVideoClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of RawVideo.tweens, Inherited from RawVideoClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from RawVideoClass_base.tweensProperty.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of RawVideo.value, Inherited from RawVideoClass_base.value.
Interfaces
ClientRawVideo
Extends VideoMedia.ClientRawAsset.ClientAudibleAsset.ClientVisibleAsset.
| Property | Type |
|---|---|
alpha? | boolean |
asData | StorableMedia |
canBeContainer? | boolean |
canBeContent? | boolean |
canBeFill? | boolean |
canBeMuted? | boolean |
createdAt? | string |
decodings | Decoding[] |
duration | number |
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.
dataUrl(
assetTime,size?):DataOrError<string>
| Parameter | Type |
|---|---|
assetTime | Time |
size? | Size<number> |
Returns DataOrError<string>.
dataUrlPromise(
assetTime,size?):Promise<DataOrError<string>>
| Parameter | Type |
|---|---|
assetTime | Time |
size? | Size<number> |
Returns Promise<DataOrError<string>>.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from ClientVisibleAsset.findResource.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from ClientAudibleAsset.frames.
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.
ClippedClientRawVideo
Extends ClippedVideo.ClientAudibleInstance.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
audibleAsset | AudibleAsset |
canBeMuted | boolean |
clientAudibleAsset | ClientAudibleAsset |
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
assetFrames(
quantize):number[]
| Parameter | Type |
|---|---|
quantize | number |
Returns number[] containing duration, start trim, and end trim in frames.. Inherited from ClientAudibleInstance.assetFrames.
assetTime(
masherTime):Time
| Parameter | Type |
|---|---|
masherTime | Time |
Returns Time. Inherited from ClientAudibleInstance.assetTime.
audibleCommandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | AudioCommandFileArgs |
Returns CommandFile[]. Inherited from ClientAudibleInstance.audibleCommandFiles.
audiblePreviewPromise(
outputSize,scale?):Promise<DataOrError<SvgItem>>
| Parameter | Type |
|---|---|
outputSize | Size<number> |
scale? | number |
Returns Promise<DataOrError<SvgItem>>. Inherited from ClientAudibleInstance.audiblePreviewPromise.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClientAudibleInstance.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ClientAudibleInstance.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ClientAudibleInstance.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ClientAudibleInstance.changesObject.
clippedElement(
content,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
content | VisibleContentInstance |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Inherited from ClippedVideo.clippedElement.
commandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | CommandFileArgs |
Returns CommandFile[]. Inherited from ClientAudibleInstance.commandFiles.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ClientAudibleInstance.constrainedValue.
containedItem(
contentItem,containerItem,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
contentItem | MaybeComplexSvgItem |
containerItem | MaybeComplexSvgItem |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Inherited from ClippedVideo.containedItem.
containerRects(
args,sizingSize):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContainerRectArgs |
sizingSize | Size<number> |
Returns RectTuple<number>. Inherited from ClippedVideo.containerRects.
containerSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Inherited from ClippedVideo.containerSvgItem.
contentRect(
time,containerRect,outputSize):Rect<number>
| Parameter | Type |
|---|---|
time | Time |
containerRect | Rect<number> |
outputSize | Size<number> |
Returns Rect<number>. Inherited from ClippedVideo.contentRect.
contentRects(
args):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContentRectArgs |
Returns RectTuple<number>. Inherited from ClippedVideo.contentRects.
contentSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Inherited from ClippedVideo.contentSvgItem.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from ClientAudibleInstance.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from ClientAudibleInstance.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type |
|---|---|
options | IntrinsicOptions |
Returns boolean. Inherited from ClientAudibleInstance.intrinsicsKnown.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ClientAudibleInstance.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ClientAudibleInstance.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ClientAudibleInstance.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ClientAudibleInstance.propertyIds.
scalarsById(
targetId,time?,timeIsStart?,useNames?):SignalScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
time? | Time |
timeIsStart? | boolean |
useNames? | boolean |
Returns SignalScalarRecord. Inherited from ClientAudibleInstance.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ClientAudibleInstance.scalarsRecord.
scaleRects(
time,range):RectTuple<number>
| Parameter | Type |
|---|---|
time | Time |
range | TimeRange |
Returns RectTuple<number>. Inherited from ClippedVideo.scaleRects.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ClientAudibleInstance.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ClientAudibleInstance.shouldSelectProperty.
splitObject(
targetId,frame?,frameIsStart?):Partial<SignalScalarRecord>
| Parameter | Type |
|---|---|
targetId | string |
frame? | number |
frameIsStart? | boolean |
Returns Partial<SignalScalarRecord>. Inherited from ClientAudibleInstance.splitObject.
splitScalars(
targetId,frame?):ScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
frame? | number |
Returns ScalarRecord. Inherited from ClientAudibleInstance.splitScalars.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ClientAudibleInstance.string.
svgVector(
rect,forecolor?,opacity?):SvgVector
| Parameter | Type |
|---|---|
rect | Rect<number> |
forecolor? | string |
opacity? | Scalar |
Returns SvgVector. Inherited from ClippedVideo.svgVector.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ClientAudibleInstance.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ClientAudibleInstance.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClientAudibleInstance.tweens.
unload():
void
Returns void. Inherited from ClientAudibleInstance.unload.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ClientAudibleInstance.value.
visibleCommandFiles(
args,content?):CommandFile[]
| Parameter | Type |
|---|---|
args | VisibleCommandFileArgs |
content? | VisibleContentInstance |
Returns CommandFile[]. Inherited from ClippedVideo.visibleCommandFiles.
ClippedRawVideo
Extends ClippedVideo.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
audibleAsset | AudibleAsset |
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
assetFrames(
quantize):number[]
| Parameter | Type |
|---|---|
quantize | number |
Returns number[] containing duration, start trim, and end trim in frames.. Inherited from ClippedVideo.assetFrames.
assetTime(
masherTime):Time
| Parameter | Type |
|---|---|
masherTime | Time |
Returns Time. Inherited from ClippedVideo.assetTime.
audibleCommandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | AudioCommandFileArgs |
Returns CommandFile[]. Inherited from ClippedVideo.audibleCommandFiles.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClippedVideo.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ClippedVideo.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ClippedVideo.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ClippedVideo.changesObject.
clippedElement(
content,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
content | VisibleContentInstance |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Inherited from ClippedVideo.clippedElement.
commandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | CommandFileArgs |
Returns CommandFile[]. Inherited from ClippedVideo.commandFiles.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ClippedVideo.constrainedValue.
containedItem(
contentItem,containerItem,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
contentItem | MaybeComplexSvgItem |
containerItem | MaybeComplexSvgItem |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Inherited from ClippedVideo.containedItem.
containerRects(
args,sizingSize):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContainerRectArgs |
sizingSize | Size<number> |
Returns RectTuple<number>. Inherited from ClippedVideo.containerRects.
containerSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Inherited from ClippedVideo.containerSvgItem.
contentRect(
time,containerRect,outputSize):Rect<number>
| Parameter | Type |
|---|---|
time | Time |
containerRect | Rect<number> |
outputSize | Size<number> |
Returns Rect<number>. Inherited from ClippedVideo.contentRect.
contentRects(
args):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContentRectArgs |
Returns RectTuple<number>. Inherited from ClippedVideo.contentRects.
contentSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Inherited from ClippedVideo.contentSvgItem.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from ClippedVideo.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from ClippedVideo.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type |
|---|---|
options | IntrinsicOptions |
Returns boolean. Inherited from ClippedVideo.intrinsicsKnown.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ClippedVideo.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ClippedVideo.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ClippedVideo.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ClippedVideo.propertyIds.
scalarsById(
targetId,time?,timeIsStart?,useNames?):SignalScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
time? | Time |
timeIsStart? | boolean |
useNames? | boolean |
Returns SignalScalarRecord. Inherited from ClippedVideo.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ClippedVideo.scalarsRecord.
scaleRects(
time,range):RectTuple<number>
| Parameter | Type |
|---|---|
time | Time |
range | TimeRange |
Returns RectTuple<number>. Inherited from ClippedVideo.scaleRects.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ClippedVideo.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ClippedVideo.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ClippedVideo.string.
svgVector(
rect,forecolor?,opacity?):SvgVector
| Parameter | Type |
|---|---|
rect | Rect<number> |
forecolor? | string |
opacity? | Scalar |
Returns SvgVector. Inherited from ClippedVideo.svgVector.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ClippedVideo.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ClippedVideo.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClippedVideo.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ClippedVideo.value.
visibleCommandFiles(
args,content?):CommandFile[]
| Parameter | Type |
|---|---|
args | VisibleCommandFileArgs |
content? | VisibleContentInstance |
Returns CommandFile[]. Inherited from ClippedVideo.visibleCommandFiles.
ClippedRawVideoObject
Extends VisibleInstanceObject.AudibleInstanceObject.
| Property | Type |
|---|---|
container? | boolean |
endTrim? | number |
gain? | number |
height? | number |
heightEnd? | number |
lock? | string |
loops? | number |
muted? | boolean |
opacity? | number |
opacityEnd? | number |
pointAspect? | string |
sizeAspect? | string |
speed? | number |
startTrim? | number |
transparency? | string |
width? | number |
widthEnd? | number |
x? | number |
xEnd? | number |
y? | number |
yEnd? | number |
RawVideo
Extends VideoMedia.AudibleAsset.VisibleAsset.
| Property | Type |
|---|---|
alpha? | boolean |
asData | StorableMedia |
canBeContainer? | boolean |
canBeContent? | boolean |
canBeFill? | boolean |
canBeMuted? | boolean |
createdAt? | string |
decodings | Decoding[] |
duration | number |
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 VisibleAsset.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from VisibleAsset.assetFiles.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from VisibleAsset.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from VisibleAsset.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from VisibleAsset.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from VisibleAsset.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from VisibleAsset.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 VisibleAsset.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from VisibleAsset.constrainedValue.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from VisibleAsset.findResource.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from AudibleAsset.frames.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from VisibleAsset.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from VisibleAsset.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from VisibleAsset.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from VisibleAsset.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from VisibleAsset.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from VisibleAsset.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from VisibleAsset.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from VisibleAsset.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from VisibleAsset.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from VisibleAsset.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from VisibleAsset.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from VisibleAsset.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from VisibleAsset.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from VisibleAsset.value.
StorableRawVideo
Extends StorableMedia.VideoProperties.
| Property | Type |
|---|---|
createdAt? | string |
id? | string |
label? | string |
projectId? | string |
resources? | StorableResource[] |
source | string |
type | MediaType |
updatedAt? | string |
StoredRawVideo
Extends StorableMedia.VideoProperties.
| Property | Type |
|---|---|
createdAt? | string |
id? | string |
label? | string |
projectId? | string |
resources? | StorableResource[] |
source | "raw" |
type | "video" |
updatedAt? | string |