Exports related to raw video files.
Classes
ClientRawMediaClass
Extends ClientMediaClass. Implements ClientRawAsset.
new ClientRawMediaClass(
object):ClientRawMediaClass
| Parameter | Type | Description |
|---|---|---|
object | StorableMedia |
Returns ClientRawMediaClass. Inherited from ClientMediaClass.constructor.
| Property | Modifier | Type |
|---|---|---|
asData | public readonly | StorableMedia |
canBeMuted | public | undefined | boolean |
decodings | public readonly | Decoding[] |
hasIntrinsicSizing | public | undefined | boolean |
hasIntrinsicTiming | public | undefined | boolean |
id | public | string |
mediaIds | public readonly | string[] |
projectId | public | undefined | string |
properties | public | Property[] |
resources | public | Resource[] |
saveNeeded | public readonly | boolean |
source | public | string |
targetId | public | string |
type | public | MediaType |
unsavedResources | public readonly | Resource[] |
Methods
addResource(
resource):void
| Parameter | Type | Description |
|---|---|---|
resource | Resource |
Returns void. Implementation of ClientRawAsset.addResource, Inherited from ClientMediaClass.addResource.
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClientRawAsset.assetCachePromise, Inherited from ClientMediaClass.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of ClientRawAsset.assetFiles, Inherited from ClientMediaClass.assetFiles.
assetIcon(
size,cover?,patch?):Promise<DataOrError<SVGSVGElement>>
| Parameter | Type | Description |
|---|---|---|
size | Size<number> | |
cover? | boolean | |
patch? | Element |
Returns Promise<DataOrError<SVGSVGElement>>. Implementation of ClientRawAsset.assetIcon, Inherited from ClientMediaClass.assetIcon.
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 ClientRawAsset.assetIconPromise, Inherited from ClientMediaClass.assetIconPromise.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClientRawAsset.boolean, Inherited from ClientMediaClass.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClientRawAsset.changeObject, Inherited from ClientMediaClass.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClientRawAsset.changeScalars, Inherited from ClientMediaClass.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClientRawAsset.changesObject, Inherited from ClientMediaClass.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of ClientRawAsset.clipObject, Inherited from ClientMediaClass.clipObject.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of ClientRawAsset.commandFilePromise, Inherited from ClientMediaClass.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClientRawAsset.constrainedValue, Inherited from ClientMediaClass.constrainedValue.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from ClientMediaClass.decodingOfType.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of ClientRawAsset.findResource, Inherited from ClientMediaClass.findResource.
imagePromise(
resource):Promise<DataOrError<ClientImage>>
| Parameter | Type | Description |
|---|---|---|
resource | Resource |
Returns Promise<DataOrError<ClientImage>>. Implementation of ClientRawAsset.imagePromise, Inherited from ClientMediaClass.imagePromise.
instanceArgs(
object?):InstanceArgs
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns InstanceArgs. Implementation of ClientRawAsset.instanceArgs, Inherited from ClientMediaClass.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns Instance. Implementation of ClientRawAsset.instanceFromObject, Inherited from ClientMediaClass.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClientRawAsset.number, Inherited from ClientMediaClass.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClientRawAsset.propertiesOfTarget, Inherited from ClientMediaClass.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClientRawAsset.propertyFind, Inherited from ClientMediaClass.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClientRawAsset.propertyIds, Inherited from ClientMediaClass.propertyIds.
savePromise(
progress?):Promise<DataOrError<string>>
| Parameter | Type | Description |
|---|---|---|
progress? | ServerProgress |
Returns Promise<DataOrError<string>>. Implementation of ClientRawAsset.savePromise, Inherited from ClientMediaClass.savePromise.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClientRawAsset.scalarsRecord, Inherited from ClientMediaClass.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClientRawAsset.setValue, Inherited from ClientMediaClass.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClientRawAsset.shouldSelectProperty, Inherited from ClientMediaClass.shouldSelectProperty.
string(
id):string
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns string if the value is a string, otherwise throws an assertion error. Implementation of ClientRawAsset.string, Inherited from ClientMediaClass.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClientRawAsset.toJSON, Inherited from ClientMediaClass.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClientRawAsset.tweenValues, Inherited from ClientMediaClass.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClientRawAsset.tweens, Inherited from ClientMediaClass.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClientMediaClass.tweensProperty.
unload():
void
Returns void. Implementation of ClientRawAsset.unload, Inherited from ClientMediaClass.unload.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClientRawAsset.value, Inherited from ClientMediaClass.value.
RawMediaClass
Extends MediaClass. Implements RawAsset.
new RawMediaClass(
object):RawMediaClass
| Parameter | Type | Description |
|---|---|---|
object | StorableMedia |
Returns RawMediaClass. Inherited from MediaClass.constructor.
| Property | Modifier | Type |
|---|---|---|
asData | public readonly | StorableMedia |
decodings | public readonly | Decoding[] |
hasIntrinsicSizing | public | undefined | boolean |
hasIntrinsicTiming | public | undefined | boolean |
id | public | string |
mediaIds | public readonly | string[] |
projectId | public | undefined | string |
properties | public | Property[] |
resources | public | Resource[] |
source | public | string |
targetId | public | string |
type | public | MediaType |
Methods
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of RawAsset.assetCachePromise, Inherited from MediaClass.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of RawAsset.assetFiles, Inherited from MediaClass.assetFiles.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of RawAsset.boolean, Inherited from MediaClass.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of RawAsset.changeObject, Inherited from MediaClass.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of RawAsset.changeScalars, Inherited from MediaClass.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of RawAsset.changesObject, Inherited from MediaClass.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of RawAsset.clipObject, Inherited from MediaClass.clipObject.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of RawAsset.commandFilePromise, Inherited from MediaClass.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of RawAsset.constrainedValue, Inherited from MediaClass.constrainedValue.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from MediaClass.decodingOfType.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of RawAsset.findResource, Inherited from MediaClass.findResource.
instanceArgs(
object?):InstanceArgs
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns InstanceArgs. Implementation of RawAsset.instanceArgs, Inherited from MediaClass.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns Instance. Implementation of RawAsset.instanceFromObject, Inherited from MediaClass.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of RawAsset.number, Inherited from MediaClass.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of RawAsset.propertiesOfTarget, Inherited from MediaClass.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of RawAsset.propertyFind, Inherited from MediaClass.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of RawAsset.propertyIds, Inherited from MediaClass.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of RawAsset.scalarsRecord, Inherited from MediaClass.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of RawAsset.setValue, Inherited from MediaClass.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of RawAsset.shouldSelectProperty, Inherited from MediaClass.shouldSelectProperty.
string(
id):string
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns string if the value is a string, otherwise throws an assertion error. Implementation of RawAsset.string, Inherited from MediaClass.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of RawAsset.toJSON, Inherited from MediaClass.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of RawAsset.tweenValues, Inherited from MediaClass.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of RawAsset.tweens, Inherited from MediaClass.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from MediaClass.tweensProperty.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of RawAsset.value, Inherited from MediaClass.value.
Interfaces
ClientRawAsset
Extends ClientAsset.RawAsset. Extended by ClientRawAudio, ClientRawVideo, and ClientRawImage.
| Property | Type |
|---|---|
asData | StorableMedia |
createdAt? | string |
decodings | Decoding[] |
hasIntrinsicSizing? | boolean |
hasIntrinsicTiming? | boolean |
id | string |
label? | string |
mediaIds | string[] |
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 ClientAsset.addResource.
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from RawAsset.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from RawAsset.assetFiles.
assetIcon(
size,cover?,patch?):Promise<DataOrError<SVGSVGElement>>
| Parameter | Type |
|---|---|
size | Size<number> |
cover? | boolean |
patch? | Element |
Returns Promise<DataOrError<SVGSVGElement>>. Inherited from ClientAsset.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 ClientAsset.assetIconPromise.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from RawAsset.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from RawAsset.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from RawAsset.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from RawAsset.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from RawAsset.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 RawAsset.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from RawAsset.constrainedValue.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from RawAsset.findResource.
imagePromise(
resource):Promise<DataOrError<ClientImage>>
| Parameter | Type |
|---|---|
resource | Resource |
Returns Promise<DataOrError<ClientImage>>. Inherited from ClientAsset.imagePromise.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from RawAsset.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from RawAsset.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from RawAsset.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from RawAsset.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from RawAsset.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from RawAsset.propertyIds.
savePromise(
progress?):Promise<DataOrError<string>>
| Parameter | Type |
|---|---|
progress? | ServerProgress |
Returns Promise<DataOrError<string>>. Inherited from ClientAsset.savePromise.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from RawAsset.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from RawAsset.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from RawAsset.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from RawAsset.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from RawAsset.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from RawAsset.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from RawAsset.tweens.
unload():
void
Returns void. Inherited from ClientAsset.unload.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from RawAsset.value.
RawAsset
Extends Media. Extended by ClientRawAsset.
| Property | Type |
|---|---|
asData | StorableMedia |
createdAt? | string |
decodings | Decoding[] |
hasIntrinsicSizing? | boolean |
hasIntrinsicTiming? | boolean |
id | string |
label? | string |
mediaIds | string[] |
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 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.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from Media.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 Media.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from Media.constrainedValue.
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. Inherited from Media.toJSON.
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.
Type Aliases
RawSource
Functions
isRawAsset
isRawAsset(
value):value is RawAsset
| Parameter | Type |
|---|---|
value | any |
Returns value is RawAsset.