Exports related to mash video media.
Classes
ClientMashVideoClass
Extends ClientMashVideoClass_base. Implements ClientMash.
new ClientMashVideoClass(
object):ClientMashVideoClass
| Parameter | Type | Description |
|---|---|---|
object | MashVideoArgs |
Returns ClientMashVideoClass. Inherited from ClientMashVideoClass_base.constructor.
| Property | Modifier | Type | Description |
|---|---|---|---|
alpha? | public | boolean | - |
asData | public | StorableMedia | - |
assets | public | Media[] | - |
buffer | public | number | - |
canBeContainer? | public | boolean | - |
canBeContent? | public | boolean | - |
canBeFill? | public | boolean | - |
canBeMuted? | public | boolean | - |
clips | public readonly | ClientClip[] | - |
createdAt? | public | string | - |
decodings | public | Decoding[] | - |
drawnTime | public | undefined | Time | The last time that was broadcast to the framework. |
duration | public | number | - |
edits | public readonly | UndoableEdits | - |
encoding | public readonly | undefined | Resource | - |
endTime | public | Time | - |
frame | public readonly | number | - |
framework | public | Framework | - |
hasIntrinsicSizing | public | undefined | boolean | - |
hasIntrinsicTiming | public | undefined | boolean | - |
id | public | string | - |
isVector? | public | boolean | - |
label? | public | string | - |
loading | public readonly | boolean | - |
loop | public | boolean | - |
masher | public | Masher | - |
mashIndex | public | MashIndex | - |
mediaIds | public | string[] | - |
paused | public | boolean | - |
probeSize? | public | Size<number> | - |
projectId | public | undefined | string | - |
properties | public | Property[] | - |
resources | public | Resource[] | - |
saveNeeded | public | boolean | - |
size | public | Size<number> | - |
source | public | string | - |
targetId | public | string | - |
time | public readonly | Time | The last time the target was seeked to. |
timeRange | public readonly | TimeRange | - |
timeToBuffer | public readonly | Time | - |
totalFrames | public | number | - |
tracks | public readonly | ClientTrack[] | - |
type | public | MediaType | - |
unsavedResources | public readonly | Resource[] | - |
updatedAt? | public | string | - |
Methods
addClipToTrack(
clip,trackIndex?,insertIndex?,frame?):void
| Parameter | Type | Description |
|---|---|---|
clip | ClientClip | ClientClip[] | |
trackIndex? | number | |
insertIndex? | number | |
frame? | number |
Returns void. Implementation of ClientMash.addClipToTrack, Inherited from ClientMashVideoClass_base.addClipToTrack.
addResource(
resource):void
| Parameter | Type | Description |
|---|---|---|
resource | Resource |
Returns void. Implementation of ClientMash.addResource, Inherited from ClientMashVideoClass_base.addResource.
addTrack(
options?):ClientTrack
| Parameter | Type | Description |
|---|---|---|
options? | TrackObject |
Returns ClientTrack. Implementation of ClientMash.addTrack, Inherited from ClientMashVideoClass_base.addTrack.
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClientMash.assetCachePromise, Inherited from ClientMashVideoClass_base.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of ClientMash.assetFiles, Inherited from ClientMashVideoClass_base.assetFiles.
assetIcon(size, cover)
assetIcon(
size,cover?):Promise<DataOrError<SVGSVGElement>>
| Parameter | Type | Description |
|---|---|---|
size | Size<number> | |
cover? | boolean |
Returns Promise<DataOrError<SVGSVGElement>>. Implementation of ClientMash.assetIcon, Inherited from ClientMashVideoClass_base.assetIcon.
assetIcon(size, cover, patch)
assetIcon(
size,cover?,patch?):Promise<DataOrError<SVGSVGElement>>
| Parameter | Type |
|---|---|
size | Size<number> |
cover? | boolean |
patch? | Element |
Returns Promise<DataOrError<SVGSVGElement>>. Implementation of ClientMash.assetIcon, Inherited from ClientMashVideoClass_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 ClientMash.assetIconPromise, Inherited from ClientMashVideoClass_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 ClientMash.assetIconPromise, Inherited from ClientMashVideoClass_base.assetIconPromise.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClientMash.boolean, Inherited from ClientMashVideoClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClientMash.changeObject, Inherited from ClientMashVideoClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClientMash.changeScalars, Inherited from ClientMashVideoClass_base.changeScalars.
changeTiming(
propertied,property,value):void
| Parameter | Type | Description |
|---|---|---|
propertied | Propertied | |
property | string | |
value | number |
Returns void. Implementation of ClientMash.changeTiming, Inherited from ClientMashVideoClass_base.changeTiming.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClientMash.changesObject, Inherited from ClientMashVideoClass_base.changesObject.
clipInstance(
object):ClientClip
| Parameter | Type | Description |
|---|---|---|
object | ClipObject |
Returns ClientClip. Implementation of ClientMash.clipInstance, Inherited from ClientMashVideoClass_base.clipInstance.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of ClientMash.clipObject, Inherited from ClientMashVideoClass_base.clipObject.
clipsAudibleInTime(
time):Clip[]
| Parameter | Type |
|---|---|
time | Time |
Returns Clip[]. Implementation of ClientMash.clipsAudibleInTime, Inherited from ClientMashVideoClass_base.clipsAudibleInTime.
clipsInTimeOfType(
time,avType?):ClientClip[]
| Parameter | Type | Description |
|---|---|---|
time | Time | |
avType? | AVType |
Returns ClientClip[]. Implementation of ClientMash.clipsInTimeOfType, Inherited from ClientMashVideoClass_base.clipsInTimeOfType.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of ClientMash.commandFilePromise, Inherited from ClientMashVideoClass_base.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClientMash.constrainedValue, Inherited from ClientMashVideoClass_base.constrainedValue.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from ClientMashVideoClass_base.decodingOfType.
dispatchChanged(
edit):void
| Parameter | Type | Description |
|---|---|---|
edit | UndoableEdit |
Returns void. Implementation of ClientMash.dispatchChanged, Inherited from ClientMashVideoClass_base.dispatchChanged.
draw():
void
Returns void. Implementation of ClientMash.draw, Inherited from ClientMashVideoClass_base.draw.
Returns svg items for player.
| Parameter | Type | Description |
|---|---|---|
rect? | Rect<number> |
Returns Promise<SvgItem[]>. Implementation of ClientMash.elementsPromise, Inherited from ClientMashVideoClass_base.elementsPromise.
findClip(
clipId?):undefined|ClientClip
| Parameter | Type | Description |
|---|---|---|
clipId? | string |
Returns undefined | ClientClip. Implementation of ClientMash.findClip, Inherited from ClientMashVideoClass_base.findClip.
findMedia(
assetId?):undefined|ClientAsset
| Parameter | Type | Description |
|---|---|---|
assetId? | string |
Returns undefined | ClientAsset. Implementation of ClientMash.findMedia, Inherited from ClientMashVideoClass_base.findMedia.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of ClientMash.findResource, Inherited from ClientMashVideoClass_base.findResource.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from ClientMashVideoClass_base.frames.
framesHaveChanged(
frames?):void
| Parameter | Type | Description |
|---|---|---|
frames? | number |
Returns void. Implementation of ClientMash.framesHaveChanged, Inherited from ClientMashVideoClass_base.framesHaveChanged.
imagePromise(
resource):Promise<DataOrError<ClientImage>>
| Parameter | Type | Description |
|---|---|---|
resource | Resource |
Returns Promise<DataOrError<ClientImage>>. Implementation of ClientMash.imagePromise, Inherited from ClientMashVideoClass_base.imagePromise.
instanceArgs(
object?):InstanceArgs
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns InstanceArgs. Implementation of ClientMash.instanceArgs, Inherited from ClientMashVideoClass_base.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns Instance. Implementation of ClientMash.instanceFromObject, Inherited from ClientMashVideoClass_base.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClientMash.number, Inherited from ClientMashVideoClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClientMash.propertiesOfTarget, Inherited from ClientMashVideoClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClientMash.propertyFind, Inherited from ClientMashVideoClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClientMash.propertyIds, Inherited from ClientMashVideoClass_base.propertyIds.
reload():
undefined|Promise<void>
Returns undefined | Promise<void>. Implementation of ClientMash.reload, Inherited from ClientMashVideoClass_base.reload.
removeClipFromTrack(
clip):void
| Parameter | Type | Description |
|---|---|---|
clip | ClientClip | ClientClip[] |
Returns void. Implementation of ClientMash.removeClipFromTrack, Inherited from ClientMashVideoClass_base.removeClipFromTrack.
removeTrack(
index?):void
| Parameter | Type | Description |
|---|---|---|
index? | number |
Returns void. Implementation of ClientMash.removeTrack, Inherited from ClientMashVideoClass_base.removeTrack.
savePromise(
progress?):Promise<DataOrError<string>>
| Parameter | Type | Description |
|---|---|---|
progress? | ServerProgress |
Returns Promise<DataOrError<string>>. Implementation of ClientMash.savePromise, Inherited from ClientMashVideoClass_base.savePromise.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClientMash.scalarsRecord, Inherited from ClientMashVideoClass_base.scalarsRecord.
seekToTime(
time):undefined|Promise<void>
| Parameter | Type | Description |
|---|---|---|
time | Time |
Returns undefined | Promise<void>. Implementation of ClientMash.seekToTime, Inherited from ClientMashVideoClass_base.seekToTime.
setValue(
id,scalar?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
scalar? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClientMash.setValue, Inherited from ClientMashVideoClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClientMash.shouldSelectProperty, Inherited from ClientMashVideoClass_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 ClientMash.string, Inherited from ClientMashVideoClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClientMash.toJSON, Inherited from ClientMashVideoClass_base.toJSON.
trackInstance(
args):ClientTrack
| Parameter | Type | Description |
|---|---|---|
args | TrackArgs |
Returns ClientTrack. Implementation of ClientMash.trackInstance, Inherited from ClientMashVideoClass_base.trackInstance.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClientMash.tweenValues, Inherited from ClientMashVideoClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClientMash.tweens, Inherited from ClientMashVideoClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClientMashVideoClass_base.tweensProperty.
unload():
void
Returns void. Implementation of ClientMash.unload, Inherited from ClientMashVideoClass_base.unload.
updateAssetId(
oldId,newId):void
| Parameter | Type | Description |
|---|---|---|
oldId | string | |
newId | string |
Returns void. Implementation of ClientMash.updateAssetId, Inherited from ClientMashVideoClass_base.updateAssetId.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClientMash.value, Inherited from ClientMashVideoClass_base.value.
ClippedClientMashVideoClass
Extends ClippedClientMashVideoClass_base. Implements ClippedClientMashVideo.
new ClippedClientMashVideoClass(
object):ClippedClientMashVideoClass
| Parameter | Type | Description |
|---|---|---|
object | InstanceArgs |
Returns ClippedClientMashVideoClass. Inherited from ClippedClientMashVideoClass_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 |
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.. Inherited from ClippedClientMashVideoClass_base.assetFrames.
assetTime(
mashTime):Time
| Parameter | Type | Description |
|---|---|---|
mashTime | Time |
Returns Time. Implementation of ClippedClientMashVideo.assetTime, Inherited from ClippedClientMashVideoClass_base.assetTime.
audibleCommandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | AudioCommandFileArgs |
Returns CommandFile[]. Inherited from ClippedClientMashVideoClass_base.audibleCommandFiles.
audiblePreviewPromise(
outputSize,scale?):Promise<DataOrError<SvgItem>>
| Parameter | Type |
|---|---|
outputSize | Size<number> |
scale? | number |
Returns Promise<DataOrError<SvgItem>>. Inherited from ClippedClientMashVideoClass_base.audiblePreviewPromise.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedClientMashVideo.boolean, Inherited from ClippedClientMashVideoClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClippedClientMashVideo.changeObject, Inherited from ClippedClientMashVideoClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClippedClientMashVideo.changeScalars, Inherited from ClippedClientMashVideoClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClippedClientMashVideo.changesObject, Inherited from ClippedClientMashVideoClass_base.changesObject.
clippedElement(
content,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
content | VisibleContentInstance |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Inherited from ClippedClientMashVideoClass_base.clippedElement.
clippedElementPromise(
content,args):Promise<DataOrError<SvgItemsRecord>>
| Parameter | Type |
|---|---|
content | ClientVisibleInstance |
args | ContainerSvgItemArgs |
Returns Promise<DataOrError<SvgItemsRecord>>. Inherited from ClippedClientMashVideoClass_base.clippedElementPromise.
commandFiles(
cacheArgs):CommandFile[]
| Parameter | Type | Description |
|---|---|---|
cacheArgs | CommandFileArgs |
Returns CommandFile[]. Implementation of ClippedClientMashVideo.commandFiles, Inherited from ClippedClientMashVideoClass_base.commandFiles.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClippedClientMashVideo.constrainedValue, Inherited from ClippedClientMashVideoClass_base.constrainedValue.
containedItem(
contentItem,containerItem,args):DataOrError<SvgItemsRecord>
| Parameter | Type |
|---|---|
contentItem | MaybeComplexSvgItem |
containerItem | MaybeComplexSvgItem |
args | ContainerSvgItemArgs |
Returns DataOrError<SvgItemsRecord>. Inherited from ClippedClientMashVideoClass_base.containedItem.
containerRects(
args,sizingSize):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContainerRectArgs |
sizingSize | Size<number> |
Returns RectTuple<number>. Inherited from ClippedClientMashVideoClass_base.containerRects.
containerSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Inherited from ClippedClientMashVideoClass_base.containerSvgItem.
containerSvgItemPromise(
args):Promise<DataOrError<MaybeComplexSvgItem>>
| Parameter | Type |
|---|---|
args | ContainerSvgItemArgs |
Returns Promise<DataOrError<MaybeComplexSvgItem>>. Inherited from ClippedClientMashVideoClass_base.containerSvgItemPromise.
contentRect(
time,containerRect,outputSize):Rect<number>
| Parameter | Type |
|---|---|
time | Time |
containerRect | Rect<number> |
outputSize | Size<number> |
Returns Rect<number>. Inherited from ClippedClientMashVideoClass_base.contentRect.
contentRects(
args):RectTuple<number>
| Parameter | Type |
|---|---|
args | ContentRectArgs |
Returns RectTuple<number>. Inherited from ClippedClientMashVideoClass_base.contentRects.
contentSvgItem(
args):DataOrError<MaybeComplexSvgItem>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns DataOrError<MaybeComplexSvgItem>. Inherited from ClippedClientMashVideoClass_base.contentSvgItem.
contentSvgItemPromise(
args):Promise<DataOrError<MaybeComplexSvgItem>>
| Parameter | Type |
|---|---|
args | ContentSvgItemArgs |
Returns Promise<DataOrError<MaybeComplexSvgItem>>. Inherited from ClippedClientMashVideoClass_base.contentSvgItemPromise.
frames(
quantize):number
| Parameter | Type | Description |
|---|---|---|
quantize | number |
Returns number. Implementation of ClippedClientMashVideo.frames, Inherited from ClippedClientMashVideoClass_base.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClippedClientMashVideo.instanceCachePromise, Inherited from ClippedClientMashVideoClass_base.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type | Description |
|---|---|---|
options | IntrinsicOptions |
Returns boolean. Implementation of ClippedClientMashVideo.intrinsicsKnown, Inherited from ClippedClientMashVideoClass_base.intrinsicsKnown.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClippedClientMashVideo.number, Inherited from ClippedClientMashVideoClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClippedClientMashVideo.propertiesOfTarget, Inherited from ClippedClientMashVideoClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClippedClientMashVideo.propertyFind, Inherited from ClippedClientMashVideoClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClippedClientMashVideo.propertyIds, Inherited from ClippedClientMashVideoClass_base.propertyIds.
scalarsById(targetId, time, timeIsStart)
scalarsById(
targetId,time?,timeIsStart?):SignalScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
time? | Time | |
timeIsStart? | boolean |
Returns SignalScalarRecord. Implementation of ClippedClientMashVideo.scalarsById, Inherited from ClippedClientMashVideoClass_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 ClippedClientMashVideo.scalarsById, Inherited from ClippedClientMashVideoClass_base.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClippedClientMashVideo.scalarsRecord, Inherited from ClippedClientMashVideoClass_base.scalarsRecord.
scaleRects(
time,range):RectTuple<number>
| Parameter | Type |
|---|---|
time | Time |
range | TimeRange |
Returns RectTuple<number>. Inherited from ClippedClientMashVideoClass_base.scaleRects.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClippedClientMashVideo.setValue, Inherited from ClippedClientMashVideoClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClippedClientMashVideo.shouldSelectProperty, Inherited from ClippedClientMashVideoClass_base.shouldSelectProperty.
splitObject(
targetId,frame?,frameIsStart?):Partial<SignalScalarRecord>
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
frame? | number | |
frameIsStart? | boolean |
Returns Partial<SignalScalarRecord>. Inherited from ClippedClientMashVideoClass_base.splitObject.
splitScalars(
targetId,frame?):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
frame? | number |
Returns ScalarRecord. Inherited from ClippedClientMashVideoClass_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 ClippedClientMashVideo.string, Inherited from ClippedClientMashVideoClass_base.string.
svgVector(
rect,forecolor?,opacity?):SvgVector
| Parameter | Type |
|---|---|
rect | Rect<number> |
forecolor? | string |
opacity? | Scalar |
Returns SvgVector. Inherited from ClippedClientMashVideoClass_base.svgVector.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClippedClientMashVideo.toJSON, Inherited from ClippedClientMashVideoClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClippedClientMashVideo.tweenValues, Inherited from ClippedClientMashVideoClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedClientMashVideo.tweens, Inherited from ClippedClientMashVideoClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClippedClientMashVideoClass_base.tweensProperty.
unload():
void
Returns void. Inherited from ClippedClientMashVideoClass_base.unload.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClippedClientMashVideo.value, Inherited from ClippedClientMashVideoClass_base.value.
visibleCommandFiles(
args,content?):CommandFile[]
| Parameter | Type |
|---|---|
args | VisibleCommandFileArgs |
content? | VisibleContentInstance |
Returns CommandFile[]. Inherited from ClippedClientMashVideoClass_base.visibleCommandFiles.
ClippedMashVideoClass
Extends ClippedMashVideoClass_base. Implements ClippedMashVideo.
new ClippedMashVideoClass(
object):ClippedMashVideoClass
| Parameter | Type | Description |
|---|---|---|
object | InstanceArgs |
Returns ClippedMashVideoClass. Inherited from ClippedMashVideoClass_base.constructor.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
canBeMuted | boolean |
clip | Clip |
hasIntrinsicTiming | boolean |
id | string |
instanceObject | InstanceObject |
isDefault | boolean |
mediaIds | string[] |
muted | boolean |
properties | Property[] |
targetId | string |
Methods
assetTime(
mashTime):Time
| Parameter | Type | Description |
|---|---|---|
mashTime | Time |
Returns Time. Implementation of ClippedMashVideo.assetTime, Inherited from ClippedMashVideoClass_base.assetTime.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedMashVideo.boolean, Inherited from ClippedMashVideoClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClippedMashVideo.changeObject, Inherited from ClippedMashVideoClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClippedMashVideo.changeScalars, Inherited from ClippedMashVideoClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClippedMashVideo.changesObject, Inherited from ClippedMashVideoClass_base.changesObject.
commandFiles(
cacheArgs):CommandFile[]
| Parameter | Type | Description |
|---|---|---|
cacheArgs | CommandFileArgs |
Returns CommandFile[]. Implementation of ClippedMashVideo.commandFiles, Inherited from ClippedMashVideoClass_base.commandFiles.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClippedMashVideo.constrainedValue, Inherited from ClippedMashVideoClass_base.constrainedValue.
frames(
quantize):number
| Parameter | Type | Description |
|---|---|---|
quantize | number |
Returns number. Implementation of ClippedMashVideo.frames, Inherited from ClippedMashVideoClass_base.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClippedMashVideo.instanceCachePromise, Inherited from ClippedMashVideoClass_base.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type | Description |
|---|---|---|
options | IntrinsicOptions |
Returns boolean. Implementation of ClippedMashVideo.intrinsicsKnown, Inherited from ClippedMashVideoClass_base.intrinsicsKnown.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClippedMashVideo.number, Inherited from ClippedMashVideoClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClippedMashVideo.propertiesOfTarget, Inherited from ClippedMashVideoClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClippedMashVideo.propertyFind, Inherited from ClippedMashVideoClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClippedMashVideo.propertyIds, Inherited from ClippedMashVideoClass_base.propertyIds.
scalarsById(targetId, time, timeIsStart)
scalarsById(
targetId,time?,timeIsStart?):SignalScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
time? | Time | |
timeIsStart? | boolean |
Returns SignalScalarRecord. Implementation of ClippedMashVideo.scalarsById, Inherited from ClippedMashVideoClass_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 ClippedMashVideo.scalarsById, Inherited from ClippedMashVideoClass_base.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClippedMashVideo.scalarsRecord, Inherited from ClippedMashVideoClass_base.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClippedMashVideo.setValue, Inherited from ClippedMashVideoClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClippedMashVideo.shouldSelectProperty, Inherited from ClippedMashVideoClass_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 ClippedMashVideo.string, Inherited from ClippedMashVideoClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClippedMashVideo.toJSON, Inherited from ClippedMashVideoClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClippedMashVideo.tweenValues, Inherited from ClippedMashVideoClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedMashVideo.tweens, Inherited from ClippedMashVideoClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClippedMashVideoClass_base.tweensProperty.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClippedMashVideo.value, Inherited from ClippedMashVideoClass_base.value.
MashVideoClass
Extends ServerMashMediaClass. Implements MashVideo.
new MashVideoClass(
object):MashVideoClass
| Parameter | Type | Description |
|---|---|---|
object | StorableMedia |
Returns MashVideoClass. Inherited from ServerMashMediaClass.constructor.
| Property | Type |
|---|---|
asData | StorableMedia |
assets | Media[] |
clips | Clip[] |
createdAt? | string |
decodings | Decoding[] |
duration | number |
endTime | Time |
hasIntrinsicSizing | undefined | boolean |
hasIntrinsicTiming | undefined | boolean |
id | string |
label? | string |
mashIndex | MashIndex |
mediaIds | string[] |
projectId | undefined | string |
properties | Property[] |
resources | Resource[] |
size | Size<number> |
source | string |
targetId | string |
totalFrames | number |
tracks | Track[] |
type | MediaType |
updatedAt? | string |
Methods
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of MashVideo.assetCachePromise, Inherited from ServerMashMediaClass.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of MashVideo.assetFiles, Overrides ServerMashMediaClass.assetFiles.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of MashVideo.boolean, Inherited from ServerMashMediaClass.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of MashVideo.changeObject, Inherited from ServerMashMediaClass.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of MashVideo.changeScalars, Inherited from ServerMashMediaClass.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of MashVideo.changesObject, Inherited from ServerMashMediaClass.changesObject.
clipInstance(
object):Clip
| Parameter | Type |
|---|---|
object | ClipObject |
Returns Clip. Implementation of MashVideo.clipInstance, Inherited from ServerMashMediaClass.clipInstance.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of MashVideo.clipObject, Inherited from ServerMashMediaClass.clipObject.
clipsAudibleInTime(
time):Clip[]
| Parameter | Type |
|---|---|
time | Time |
Returns Clip[]. Implementation of MashVideo.clipsAudibleInTime, Inherited from ServerMashMediaClass.clipsAudibleInTime.
clipsInTimeOfType(
time,avType?):Clip[]
| Parameter | Type |
|---|---|
time | Time |
avType? | AVType |
Returns Clip[]. Implementation of MashVideo.clipsInTimeOfType, Inherited from ServerMashMediaClass.clipsInTimeOfType.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of MashVideo.commandFilePromise, Inherited from ServerMashMediaClass.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of MashVideo.constrainedValue, Inherited from ServerMashMediaClass.constrainedValue.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from ServerMashMediaClass.decodingOfType.
findMedia(
assetId?):undefined|Media
| Parameter | Type |
|---|---|
assetId? | string |
Returns undefined | Media. Implementation of MashVideo.findMedia, Inherited from ServerMashMediaClass.findMedia.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of MashVideo.findResource, Inherited from ServerMashMediaClass.findResource.
instanceArgs(
object?):InstanceArgs
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns InstanceArgs. Implementation of MashVideo.instanceArgs, Inherited from ServerMashMediaClass.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns Instance. Implementation of MashVideo.instanceFromObject, Inherited from ServerMashMediaClass.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of MashVideo.number, Inherited from ServerMashMediaClass.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of MashVideo.propertiesOfTarget, Inherited from ServerMashMediaClass.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of MashVideo.propertyFind, Inherited from ServerMashMediaClass.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of MashVideo.propertyIds, Inherited from ServerMashMediaClass.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of MashVideo.scalarsRecord, Inherited from ServerMashMediaClass.scalarsRecord.
serverMashDescription(
options):MashCommands
| Parameter | Type | Description |
|---|---|---|
options | MashCommandsOptions |
Returns MashCommands. Inherited from ServerMashMediaClass.serverMashDescription.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of MashVideo.setValue, Inherited from ServerMashMediaClass.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of MashVideo.shouldSelectProperty, Inherited from ServerMashMediaClass.shouldSelectProperty.
string(
id):string
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns string if the value is a string, otherwise throws an assertion error. Implementation of MashVideo.string, Inherited from ServerMashMediaClass.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of MashVideo.toJSON, Inherited from ServerMashMediaClass.toJSON.
trackInstance(
args):Track
| Parameter | Type |
|---|---|
args | TrackArgs |
Returns Track. Implementation of MashVideo.trackInstance, Inherited from ServerMashMediaClass.trackInstance.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of MashVideo.tweenValues, Inherited from ServerMashMediaClass.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of MashVideo.tweens, Inherited from ServerMashMediaClass.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ServerMashMediaClass.tweensProperty.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of MashVideo.value, Inherited from ServerMashMediaClass.value.
ServerMashMediaClass
Extends ServerMashMediaClass_base. Extended by MashVideoClass. Implements ServerMashMedia.
new ServerMashMediaClass(
object):ServerMashMediaClass
| Parameter | Type | Description |
|---|---|---|
object | StorableMedia |
Returns ServerMashMediaClass. Inherited from ServerMashMediaClass_base.constructor.
| Property | Type |
|---|---|
asData | StorableMedia |
assets | Media[] |
clips | Clip[] |
createdAt? | string |
decodings | Decoding[] |
duration | number |
endTime | Time |
hasIntrinsicSizing | undefined | boolean |
hasIntrinsicTiming | undefined | boolean |
id | string |
label? | string |
mashIndex | MashIndex |
mediaIds | string[] |
projectId | undefined | string |
properties | Property[] |
resources | Resource[] |
size | Size<number> |
source | string |
targetId | string |
totalFrames | number |
tracks | Track[] |
type | MediaType |
updatedAt? | string |
Methods
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ServerMashMedia.assetCachePromise, Inherited from ServerMashMediaClass_base.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of ServerMashMedia.assetFiles, Inherited from ServerMashMediaClass_base.assetFiles.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ServerMashMedia.boolean, Inherited from ServerMashMediaClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ServerMashMedia.changeObject, Inherited from ServerMashMediaClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ServerMashMedia.changeScalars, Inherited from ServerMashMediaClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ServerMashMedia.changesObject, Inherited from ServerMashMediaClass_base.changesObject.
clipInstance(
object):Clip
| Parameter | Type |
|---|---|
object | ClipObject |
Returns Clip. Implementation of ServerMashMedia.clipInstance, Inherited from ServerMashMediaClass_base.clipInstance.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of ServerMashMedia.clipObject, Inherited from ServerMashMediaClass_base.clipObject.
clipsAudibleInTime(
time):Clip[]
| Parameter | Type |
|---|---|
time | Time |
Returns Clip[]. Implementation of ServerMashMedia.clipsAudibleInTime, Inherited from ServerMashMediaClass_base.clipsAudibleInTime.
clipsInTimeOfType(
time,avType?):Clip[]
| Parameter | Type |
|---|---|
time | Time |
avType? | AVType |
Returns Clip[]. Implementation of ServerMashMedia.clipsInTimeOfType, Inherited from ServerMashMediaClass_base.clipsInTimeOfType.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of ServerMashMedia.commandFilePromise, Inherited from ServerMashMediaClass_base.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ServerMashMedia.constrainedValue, Inherited from ServerMashMediaClass_base.constrainedValue.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from ServerMashMediaClass_base.decodingOfType.
findMedia(
assetId?):undefined|Media
| Parameter | Type |
|---|---|
assetId? | string |
Returns undefined | Media. Implementation of ServerMashMedia.findMedia, Inherited from ServerMashMediaClass_base.findMedia.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of ServerMashMedia.findResource, Inherited from ServerMashMediaClass_base.findResource.
instanceArgs(
object?):InstanceArgs
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns InstanceArgs. Implementation of ServerMashMedia.instanceArgs, Inherited from ServerMashMediaClass_base.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns Instance. Implementation of ServerMashMedia.instanceFromObject, Inherited from ServerMashMediaClass_base.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ServerMashMedia.number, Inherited from ServerMashMediaClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ServerMashMedia.propertiesOfTarget, Inherited from ServerMashMediaClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ServerMashMedia.propertyFind, Inherited from ServerMashMediaClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ServerMashMedia.propertyIds, Inherited from ServerMashMediaClass_base.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ServerMashMedia.scalarsRecord, Inherited from ServerMashMediaClass_base.scalarsRecord.
serverMashDescription(
options):MashCommands
| Parameter | Type | Description |
|---|---|---|
options | MashCommandsOptions |
Returns MashCommands. Implementation of ServerMashMedia.serverMashDescription.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ServerMashMedia.setValue, Inherited from ServerMashMediaClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ServerMashMedia.shouldSelectProperty, Inherited from ServerMashMediaClass_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 ServerMashMedia.string, Inherited from ServerMashMediaClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ServerMashMedia.toJSON, Inherited from ServerMashMediaClass_base.toJSON.
trackInstance(
args):Track
| Parameter | Type |
|---|---|
args | TrackArgs |
Returns Track. Implementation of ServerMashMedia.trackInstance, Inherited from ServerMashMediaClass_base.trackInstance.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ServerMashMedia.tweenValues, Inherited from ServerMashMediaClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ServerMashMedia.tweens, Inherited from ServerMashMediaClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ServerMashMediaClass_base.tweensProperty.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ServerMashMedia.value, Inherited from ServerMashMediaClass_base.value.
Interfaces
ClientMashVideo
Extends ClientMash.
| Property | Type |
|---|---|
asData | StorableMedia |
assets | Media[] |
buffer | number |
clips | ClientClip[] |
createdAt? | string |
decodings | Decoding[] |
drawnTime? | Time |
duration | number |
edits | UndoableEdits |
encoding? | Resource |
endTime | Time |
frame | number |
framework | Framework |
hasIntrinsicSizing? | boolean |
hasIntrinsicTiming? | boolean |
id | string |
label? | string |
loading | boolean |
loop | boolean |
masher | Masher |
mashIndex | MashIndex |
mediaIds | string[] |
paused | boolean |
projectId? | string |
properties | Property[] |
resources | Resource[] |
saveNeeded | boolean |
size | Size<number> |
source | string |
targetId | string |
time | Time |
timeRange | TimeRange |
timeToBuffer | Time |
totalFrames | number |
tracks | ClientTrack[] |
type | MediaType |
updatedAt? | string |
Methods
addClipToTrack(
clip,trackIndex?,insertIndex?,frame?):void
| Parameter | Type |
|---|---|
clip | OrArray<ClientClip> |
trackIndex? | number |
insertIndex? | number |
frame? | number |
Returns void. Inherited from ClientMash.addClipToTrack.
addResource(
resource):void
| Parameter | Type |
|---|---|
resource | Resource |
Returns void. Inherited from ClientMash.addResource.
addTrack(
object?):ClientTrack
| Parameter | Type |
|---|---|
object? | TrackObject |
Returns ClientTrack. Inherited from ClientMash.addTrack.
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from ClientMash.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from ClientMash.assetFiles.
assetIcon(
size,cover?,patch?):Promise<DataOrError<SVGSVGElement>>
| Parameter | Type |
|---|---|
size | Size<number> |
cover? | boolean |
patch? | Element |
Returns Promise<DataOrError<SVGSVGElement>>. Inherited from ClientMash.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 ClientMash.assetIconPromise.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClientMash.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ClientMash.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ClientMash.changeScalars.
changeTiming(
propertied,property,value):void
| Parameter | Type |
|---|---|
propertied | Propertied |
property | string |
value | number |
Returns void. Inherited from ClientMash.changeTiming.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ClientMash.changesObject.
clipInstance(
object):ClientClip
| Parameter | Type |
|---|---|
object | ClipObject |
Returns ClientClip. Inherited from ClientMash.clipInstance.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from ClientMash.clipObject.
clipsAudibleInTime(
time):Clip[]
| Parameter | Type |
|---|---|
time | Time |
Returns Clip[]. Inherited from ClientMash.clipsAudibleInTime.
clipsInTimeOfType(
time,avType?):Clip[]
| Parameter | Type |
|---|---|
time | Time |
avType? | AVType |
Returns Clip[]. Inherited from ClientMash.clipsInTimeOfType.
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 ClientMash.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ClientMash.constrainedValue.
dispatchChanged(
action):void
| Parameter | Type |
|---|---|
action | UndoableEdit |
Returns void. Inherited from ClientMash.dispatchChanged.
draw():
void
Returns void. Inherited from ClientMash.draw.
| Parameter | Type |
|---|---|
rect? | Rect<number> |
Returns Promise<SvgItem[]>. Inherited from ClientMash.elementsPromise.
findClip(
id?):undefined|ClientClip
| Parameter | Type |
|---|---|
id? | string |
Returns undefined | ClientClip. Inherited from ClientMash.findClip.
findMedia(
assetId?):undefined|ClientAsset
| Parameter | Type |
|---|---|
assetId? | string |
Returns undefined | ClientAsset. Inherited from ClientMash.findMedia.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from ClientMash.findResource.
framesHaveChanged(
frames?):void
| Parameter | Type |
|---|---|
frames? | number |
Returns void. Inherited from ClientMash.framesHaveChanged.
imagePromise(
resource):Promise<DataOrError<ClientImage>>
| Parameter | Type |
|---|---|
resource | Resource |
Returns Promise<DataOrError<ClientImage>>. Inherited from ClientMash.imagePromise.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from ClientMash.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from ClientMash.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ClientMash.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ClientMash.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ClientMash.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ClientMash.propertyIds.
reload():
undefined|Promise<void>
Returns undefined | Promise<void>. Inherited from ClientMash.reload.
removeClipFromTrack(
clip):void
| Parameter | Type |
|---|---|
clip | OrArray<ClientClip> |
Returns void. Inherited from ClientMash.removeClipFromTrack.
removeTrack(
index?):void
| Parameter | Type |
|---|---|
index? | number |
Returns void. Inherited from ClientMash.removeTrack.
savePromise(
progress?):Promise<DataOrError<string>>
| Parameter | Type |
|---|---|
progress? | ServerProgress |
Returns Promise<DataOrError<string>>. Inherited from ClientMash.savePromise.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ClientMash.scalarsRecord.
seekToTime(
time):undefined|Promise<void>
| Parameter | Type |
|---|---|
time | Time |
Returns undefined | Promise<void>. Inherited from ClientMash.seekToTime.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ClientMash.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ClientMash.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ClientMash.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ClientMash.toJSON.
trackInstance(
args):Track
| Parameter | Type |
|---|---|
args | TrackArgs |
Returns Track. Inherited from ClientMash.trackInstance.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ClientMash.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClientMash.tweens.
unload():
void
Returns void. Inherited from ClientMash.unload.
updateAssetId(
oldId,newId):void
| Parameter | Type |
|---|---|
oldId | string |
newId | string |
Returns void. Inherited from ClientMash.updateAssetId.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ClientMash.value.
ClippedClientMashVideo
Extends MashInstance.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
canBeMuted | boolean |
clip | Clip |
id | string |
instanceObject | InstanceObject |
isDefault | boolean |
mediaIds | string[] |
muted | boolean |
properties | Property[] |
targetId | string |
Methods
assetTime(
masherTime):Time
| Parameter | Type |
|---|---|
masherTime | Time |
Returns Time. Inherited from MashInstance.assetTime.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from MashInstance.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from MashInstance.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from MashInstance.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from MashInstance.changesObject.
commandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | CommandFileArgs |
Returns CommandFile[]. Inherited from MashInstance.commandFiles.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from MashInstance.constrainedValue.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from MashInstance.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from MashInstance.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type |
|---|---|
options | IntrinsicOptions |
Returns boolean. Inherited from MashInstance.intrinsicsKnown.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from MashInstance.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from MashInstance.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from MashInstance.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from MashInstance.propertyIds.
scalarsById(
targetId,time?,timeIsStart?,useNames?):SignalScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
time? | Time |
timeIsStart? | boolean |
useNames? | boolean |
Returns SignalScalarRecord. Inherited from MashInstance.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from MashInstance.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from MashInstance.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from MashInstance.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from MashInstance.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from MashInstance.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from MashInstance.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from MashInstance.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from MashInstance.value.
ClippedMashVideo
Extends MashInstance.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
canBeMuted | boolean |
clip | Clip |
id | string |
instanceObject | InstanceObject |
isDefault | boolean |
mediaIds | string[] |
muted | boolean |
properties | Property[] |
targetId | string |
Methods
assetTime(
masherTime):Time
| Parameter | Type |
|---|---|
masherTime | Time |
Returns Time. Inherited from MashInstance.assetTime.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from MashInstance.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from MashInstance.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from MashInstance.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from MashInstance.changesObject.
commandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | CommandFileArgs |
Returns CommandFile[]. Inherited from MashInstance.commandFiles.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from MashInstance.constrainedValue.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from MashInstance.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from MashInstance.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type |
|---|---|
options | IntrinsicOptions |
Returns boolean. Inherited from MashInstance.intrinsicsKnown.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from MashInstance.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from MashInstance.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from MashInstance.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from MashInstance.propertyIds.
scalarsById(
targetId,time?,timeIsStart?,useNames?):SignalScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
time? | Time |
timeIsStart? | boolean |
useNames? | boolean |
Returns SignalScalarRecord. Inherited from MashInstance.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from MashInstance.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from MashInstance.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from MashInstance.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from MashInstance.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from MashInstance.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from MashInstance.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from MashInstance.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from MashInstance.value.
MashMedia
Extends Media. Extended by MashVideo, MashAudio, MashImage, ClientMash, and ServerMashMedia.
| Property | Type |
|---|---|
asData | StorableMedia |
assets | Media[] |
clips | Clip[] |
createdAt? | string |
decodings | Decoding[] |
duration | number |
endTime | Time |
hasIntrinsicSizing? | boolean |
hasIntrinsicTiming? | boolean |
id | string |
label? | string |
mashIndex | MashIndex |
mediaIds | string[] |
projectId? | string |
properties | Property[] |
resources | Resource[] |
size | Size<number> |
source | string |
targetId | string |
totalFrames | number |
tracks | Track[] |
type | MediaType |
updatedAt? | string |
Methods
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from Media.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from Media.assetFiles.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from Media.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from Media.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from Media.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from Media.changesObject.
clipInstance(
object):Clip
| Parameter | Type |
|---|---|
object | ClipObject |
Returns Clip.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from Media.clipObject.
clipsAudibleInTime(
time):Clip[]
| Parameter | Type |
|---|---|
time | Time |
Returns Clip[].
clipsInTimeOfType(
time,avType?):Clip[]
| Parameter | Type |
|---|---|
time | Time |
avType? | AVType |
Returns Clip[].
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 Media.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from Media.constrainedValue.
findMedia(
assetId?):undefined|Media
| Parameter | Type |
|---|---|
assetId? | string |
Returns undefined | Media.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from Media.findResource.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from Media.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from Media.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from Media.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from Media.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from Media.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from Media.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from Media.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from Media.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from Media.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from Media.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Overrides Media.toJSON.
trackInstance(
args):Track
| Parameter | Type |
|---|---|
args | TrackArgs |
Returns Track.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from Media.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from Media.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from Media.value.
MashVideo
Extends MashMedia.
| Property | Type |
|---|---|
asData | StorableMedia |
assets | Media[] |
clips | Clip[] |
createdAt? | string |
decodings | Decoding[] |
duration | number |
endTime | Time |
hasIntrinsicSizing? | boolean |
hasIntrinsicTiming? | boolean |
id | string |
label? | string |
mashIndex | MashIndex |
mediaIds | string[] |
projectId? | string |
properties | Property[] |
resources | Resource[] |
size | Size<number> |
source | string |
targetId | string |
totalFrames | number |
tracks | Track[] |
type | MediaType |
updatedAt? | string |
Methods
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from MashMedia.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from MashMedia.assetFiles.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from MashMedia.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from MashMedia.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from MashMedia.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from MashMedia.changesObject.
clipInstance(
object):Clip
| Parameter | Type |
|---|---|
object | ClipObject |
Returns Clip. Inherited from MashMedia.clipInstance.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from MashMedia.clipObject.
clipsAudibleInTime(
time):Clip[]
| Parameter | Type |
|---|---|
time | Time |
Returns Clip[]. Inherited from MashMedia.clipsAudibleInTime.
clipsInTimeOfType(
time,avType?):Clip[]
| Parameter | Type |
|---|---|
time | Time |
avType? | AVType |
Returns Clip[]. Inherited from MashMedia.clipsInTimeOfType.
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 MashMedia.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from MashMedia.constrainedValue.
findMedia(
assetId?):undefined|Media
| Parameter | Type |
|---|---|
assetId? | string |
Returns undefined | Media. Inherited from MashMedia.findMedia.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from MashMedia.findResource.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from MashMedia.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from MashMedia.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from MashMedia.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from MashMedia.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from MashMedia.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from MashMedia.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from MashMedia.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from MashMedia.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from MashMedia.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from MashMedia.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from MashMedia.toJSON.
trackInstance(
args):Track
| Parameter | Type |
|---|---|
args | TrackArgs |
Returns Track. Inherited from MashMedia.trackInstance.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from MashMedia.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from MashMedia.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from MashMedia.value.
MashVideoArgs
Extends StorableMedia.MashVisibleProperties.MashAudibleProperties.
| Property | Type | Description |
|---|---|---|
buffer? | number | - |
color? | string | Background color. |
createdAt? | string | - |
height? | number | - |
id? | string | - |
label? | string | - |
loop? | boolean | - |
projectId? | string | - |
quantize? | number | Determines duration of clip frames. |
resources? | StorableResource[] | - |
shortest? | number | - |
source | string | - |
tracks? | TrackObject[] | - |
type | MediaType | - |
updatedAt? | string | - |
width? | number | - |
ServerMashMedia
Extends MashMedia. Extended by ServerMashVideo, ServerMashImage, and ServerMashAudio.
| Property | Type |
|---|---|
asData | StorableMedia |
assets | Media[] |
clips | ServerClip[] |
createdAt? | string |
decodings | Decoding[] |
duration | number |
endTime | Time |
hasIntrinsicSizing? | boolean |
hasIntrinsicTiming? | boolean |
id | string |
label? | string |
mashIndex | MashIndex |
mediaIds | string[] |
projectId? | string |
properties | Property[] |
resources | Resource[] |
size | Size<number> |
source | string |
targetId | string |
totalFrames | number |
tracks | ServerTrack[] |
type | MediaType |
updatedAt? | string |
Methods
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from MashMedia.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from MashMedia.assetFiles.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from MashMedia.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from MashMedia.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from MashMedia.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from MashMedia.changesObject.
clipInstance(
object):ServerClip
| Parameter | Type |
|---|---|
object | ClipObject |
Returns ServerClip. Overrides MashMedia.clipInstance.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from MashMedia.clipObject.
clipsAudibleInTime(
time):Clip[]
| Parameter | Type |
|---|---|
time | Time |
Returns Clip[]. Inherited from MashMedia.clipsAudibleInTime.
clipsInTimeOfType(
time,avType?):Clip[]
| Parameter | Type |
|---|---|
time | Time |
avType? | AVType |
Returns Clip[]. Inherited from MashMedia.clipsInTimeOfType.
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 MashMedia.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from MashMedia.constrainedValue.
findMedia(
assetId?):undefined|Media
| Parameter | Type |
|---|---|
assetId? | string |
Returns undefined | Media. Inherited from MashMedia.findMedia.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from MashMedia.findResource.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from MashMedia.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from MashMedia.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from MashMedia.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from MashMedia.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from MashMedia.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from MashMedia.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from MashMedia.scalarsRecord.
serverMashDescription(
options):MashCommands
| Parameter | Type |
|---|---|
options | MashCommandsOptions |
Returns MashCommands.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from MashMedia.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from MashMedia.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from MashMedia.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from MashMedia.toJSON.
trackInstance(
args):Track
| Parameter | Type |
|---|---|
args | TrackArgs |
Returns Track. Inherited from MashMedia.trackInstance.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from MashMedia.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from MashMedia.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from MashMedia.value.
ServerMashVideo
Extends ServerMashMedia.
| Property | Type |
|---|---|
asData | StorableMedia |
assets | Media[] |
clips | ServerClip[] |
createdAt? | string |
decodings | Decoding[] |
duration | number |
endTime | Time |
hasIntrinsicSizing? | boolean |
hasIntrinsicTiming? | boolean |
id | string |
label? | string |
mashIndex | MashIndex |
mediaIds | string[] |
projectId? | string |
properties | Property[] |
resources | Resource[] |
size | Size<number> |
source | string |
targetId | string |
totalFrames | number |
tracks | ServerTrack[] |
type | MediaType |
updatedAt? | string |
Methods
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from ServerMashMedia.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from ServerMashMedia.assetFiles.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ServerMashMedia.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ServerMashMedia.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ServerMashMedia.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ServerMashMedia.changesObject.
clipInstance(
object):ServerClip
| Parameter | Type |
|---|---|
object | ClipObject |
Returns ServerClip. Inherited from ServerMashMedia.clipInstance.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from ServerMashMedia.clipObject.
clipsAudibleInTime(
time):Clip[]
| Parameter | Type |
|---|---|
time | Time |
Returns Clip[]. Inherited from ServerMashMedia.clipsAudibleInTime.
clipsInTimeOfType(
time,avType?):Clip[]
| Parameter | Type |
|---|---|
time | Time |
avType? | AVType |
Returns Clip[]. Inherited from ServerMashMedia.clipsInTimeOfType.
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 ServerMashMedia.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ServerMashMedia.constrainedValue.
findMedia(
assetId?):undefined|Media
| Parameter | Type |
|---|---|
assetId? | string |
Returns undefined | Media. Inherited from ServerMashMedia.findMedia.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from ServerMashMedia.findResource.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from ServerMashMedia.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from ServerMashMedia.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ServerMashMedia.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ServerMashMedia.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ServerMashMedia.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ServerMashMedia.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ServerMashMedia.scalarsRecord.
serverMashDescription(
options):MashCommands
| Parameter | Type |
|---|---|
options | MashCommandsOptions |
Returns MashCommands. Inherited from ServerMashMedia.serverMashDescription.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ServerMashMedia.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ServerMashMedia.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ServerMashMedia.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ServerMashMedia.toJSON.
trackInstance(
args):Track
| Parameter | Type |
|---|---|
args | TrackArgs |
Returns Track. Inherited from ServerMashMedia.trackInstance.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ServerMashMedia.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ServerMashMedia.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ServerMashMedia.value.
StorableMashVideo
Extends StorableMash.MashVisibleProperties.MashAudibleProperties.
| Property | Type | Description |
|---|---|---|
assets? | StorableMedia[] | - |
buffer? | number | - |
color? | string | Background color. |
createdAt? | string | - |
height? | number | - |
id? | string | - |
label? | string | - |
loop? | boolean | - |
projectId? | string | - |
quantize? | number | Determines duration of clip frames. |
resources? | StorableResource[] | - |
shortest? | number | - |
source | string | - |
tracks? | TrackObject[] | - |
type | MediaType | - |
updatedAt? | string | - |
width? | number | - |
StoredMashVideo
Extends StoredMedia.MashVisibleProperties.MashAudibleProperties.
| Property | Type | Description |
|---|---|---|
buffer? | number | - |
color? | string | Background color. |
createdAt? | string | - |
height? | number | - |
id | string | - |
label? | string | - |
loop? | boolean | - |
projectId? | string | - |
quantize? | number | Determines duration of clip frames. |
resources? | StoredResource[] | - |
shortest? | number | - |
source | string | - |
tracks? | TrackObject[] | - |
type | MediaType | - |
updatedAt? | string | - |
width? | number | - |
Functions
MashMediaMixin
MashMediaMixin<
T>(Base):T&Constrained<MashMedia>
| Type Parameter | Description |
|---|---|
T extends Constrained<Media> |
| Parameter | Type | Description |
|---|---|---|
Base | T |
Returns T & Constrained<MashMedia>.
isMashMedia
isMashMedia(
value):value is MashMedia
| Parameter | Type |
|---|---|
value | any |
Returns value is MashMedia.