Exports related to raw video files.

Classes

ClientRawMediaClass

Extends ClientMediaClass. Implements ClientRawAsset.

new ClientRawMediaClass(object): ClientRawMediaClass

ParameterTypeDescription
objectStorableMedia

Returns ClientRawMediaClass. Inherited from ClientMediaClass.constructor.

PropertyModifierType
asDatapublic readonlyStorableMedia
canBeMutedpublicundefined | boolean
decodingspublic readonlyDecoding[]
hasIntrinsicSizingpublicundefined | boolean
hasIntrinsicTimingpublicundefined | boolean
idpublicstring
mediaIdspublic readonlystring[]
projectIdpublicundefined | string
propertiespublicProperty[]
resourcespublicResource[]
saveNeededpublic readonlyboolean
sourcepublicstring
targetIdpublicstring
typepublicMediaType
unsavedResourcespublic readonlyResource[]

Methods

addResource(resource): void

ParameterTypeDescription
resourceResource

Returns void. Implementation of ClientRawAsset.addResource, Inherited from ClientMediaClass.addResource.

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

ParameterTypeDescription
argsAssetCacheArgs

Returns Promise<DataOrError<number>>. Implementation of ClientRawAsset.assetCachePromise, Inherited from ClientMediaClass.assetCachePromise.

assetFiles(args): AssetFile[]

ParameterTypeDescription
argsCacheArgs

Returns AssetFile[]. Implementation of ClientRawAsset.assetFiles, Inherited from ClientMediaClass.assetFiles.

assetIcon(size, cover?, patch?): Promise<DataOrError<SVGSVGElement>>

ParameterTypeDescription
sizeSize<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>>

ParameterTypeDescription
resourceResource
optionsSize<number> | Rect<number>
cover?boolean
patch?Element

Returns Promise<DataOrError<SVGImageElement>>. Implementation of ClientRawAsset.assetIconPromise, Inherited from ClientMediaClass.assetIconPromise.

boolean(key): boolean

ParameterTypeDescription
keystring

Returns boolean. Implementation of ClientRawAsset.boolean, Inherited from ClientMediaClass.boolean.

changeObject(signalId, scalar?): ChangeEditObject

ParameterTypeDescription
signalId`${string}.${string}`
scalar?Scalar

Returns ChangeEditObject. Implementation of ClientRawAsset.changeObject, Inherited from ClientMediaClass.changeObject.

changeScalars(scalars): void

ParameterTypeDescription
scalarsPartial<SignalScalarRecord>

Returns void. Implementation of ClientRawAsset.changeScalars, Inherited from ClientMediaClass.changeScalars.

changesObject(scalars): ChangePropertiesEditObject

ParameterTypeDescription
scalarsPartial<SignalScalarRecord>

Returns ChangePropertiesEditObject. Implementation of ClientRawAsset.changesObject, Inherited from ClientMediaClass.changesObject.

clipObject(object?): ClipObject

ParameterTypeDescription
object?InstanceObject

Returns ClipObject. Implementation of ClientRawAsset.clipObject, Inherited from ClientMediaClass.clipObject.

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

ParameterTypeDescription
argsServerPromiseArgs
commandFileCommandFile

Returns Promise<DataOrError<number>>. Implementation of ClientRawAsset.commandFilePromise, Inherited from ClientMediaClass.commandFilePromise.

constrainedValue(property, value?): undefined | Scalar

ParameterTypeDescription
propertyProperty
value?Scalar

Returns undefined | Scalar. Implementation of ClientRawAsset.constrainedValue, Inherited from ClientMediaClass.constrainedValue.

decodingOfType(…types): undefined | Decoding

ParameterTypeDescription
typesstring[]

Returns undefined | Decoding. Inherited from ClientMediaClass.decodingOfType.

findResource(…typesOrSources): undefined | Resource

ParameterTypeDescription
typesOrSourcesstring[]

Returns undefined | Resource. Implementation of ClientRawAsset.findResource, Inherited from ClientMediaClass.findResource.

imagePromise(resource): Promise<DataOrError<ClientImage>>

ParameterTypeDescription
resourceResource

Returns Promise<DataOrError<ClientImage>>. Implementation of ClientRawAsset.imagePromise, Inherited from ClientMediaClass.imagePromise.

instanceArgs(object?): InstanceArgs

ParameterTypeDescription
object?InstanceObject

Returns InstanceArgs. Implementation of ClientRawAsset.instanceArgs, Inherited from ClientMediaClass.instanceArgs.

instanceFromObject(object?): Instance

ParameterTypeDescription
object?InstanceObject

Returns Instance. Implementation of ClientRawAsset.instanceFromObject, Inherited from ClientMediaClass.instanceFromObject.

number(id): number

ParameterTypeDescription
idstring

Returns number. Implementation of ClientRawAsset.number, Inherited from ClientMediaClass.number.

propertiesOfTarget(targetId): Property[]

ParameterTypeDescription
targetIdstring

Returns Property[]. Implementation of ClientRawAsset.propertiesOfTarget, Inherited from ClientMediaClass.propertiesOfTarget.

propertyFind(name): undefined | Property

ParameterTypeDescription
namestring

Returns undefined | Property. Implementation of ClientRawAsset.propertyFind, Inherited from ClientMediaClass.propertyFind.

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

ParameterTypeDescription
targetIdstring

Returns `${string}.${string}`[]. Implementation of ClientRawAsset.propertyIds, Inherited from ClientMediaClass.propertyIds.

savePromise(progress?): Promise<DataOrError<string>>

ParameterTypeDescription
progress?ServerProgress

Returns Promise<DataOrError<string>>. Implementation of ClientRawAsset.savePromise, Inherited from ClientMediaClass.savePromise.

scalarsRecord(idOrNames): ScalarRecord

ParameterTypeDescription
idOrNamesstring[]

Returns ScalarRecord. Implementation of ClientRawAsset.scalarsRecord, Inherited from ClientMediaClass.scalarsRecord.

setValue(id, value?, dontConstrain?): void

ParameterTypeDescription
idstring
value?Scalar
dontConstrain?boolean

Returns void. Implementation of ClientRawAsset.setValue, Inherited from ClientMediaClass.setValue.

shouldSelectProperty(property): boolean

ParameterTypeDescription
propertyProperty

Returns boolean. Implementation of ClientRawAsset.shouldSelectProperty, Inherited from ClientMediaClass.shouldSelectProperty.

string(id): string

ParameterTypeDescription
idstring

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[]

ParameterTypeDescription
keystring
timeTime
rangeTimeRange

Returns Scalar[]. Implementation of ClientRawAsset.tweenValues, Inherited from ClientMediaClass.tweenValues.

tweens(key): boolean

ParameterTypeDescription
keystring

Returns boolean. Implementation of ClientRawAsset.tweens, Inherited from ClientMediaClass.tweens.

tweensProperty(key): boolean

ParameterTypeDescription
keystring

Returns boolean. Inherited from ClientMediaClass.tweensProperty.

unload(): void

Returns void. Implementation of ClientRawAsset.unload, Inherited from ClientMediaClass.unload.

value(id): undefined | Scalar

ParameterTypeDescription
idstring

Returns undefined | Scalar. Implementation of ClientRawAsset.value, Inherited from ClientMediaClass.value.

RawMediaClass

Extends MediaClass. Implements RawAsset.

new RawMediaClass(object): RawMediaClass

ParameterTypeDescription
objectStorableMedia

Returns RawMediaClass. Inherited from MediaClass.constructor.

PropertyModifierType
asDatapublic readonlyStorableMedia
decodingspublic readonlyDecoding[]
hasIntrinsicSizingpublicundefined | boolean
hasIntrinsicTimingpublicundefined | boolean
idpublicstring
mediaIdspublic readonlystring[]
projectIdpublicundefined | string
propertiespublicProperty[]
resourcespublicResource[]
sourcepublicstring
targetIdpublicstring
typepublicMediaType

Methods

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

ParameterTypeDescription
argsAssetCacheArgs

Returns Promise<DataOrError<number>>. Implementation of RawAsset.assetCachePromise, Inherited from MediaClass.assetCachePromise.

assetFiles(args): AssetFile[]

ParameterTypeDescription
argsCacheArgs

Returns AssetFile[]. Implementation of RawAsset.assetFiles, Inherited from MediaClass.assetFiles.

boolean(key): boolean

ParameterTypeDescription
keystring

Returns boolean. Implementation of RawAsset.boolean, Inherited from MediaClass.boolean.

changeObject(signalId, scalar?): ChangeEditObject

ParameterTypeDescription
signalId`${string}.${string}`
scalar?Scalar

Returns ChangeEditObject. Implementation of RawAsset.changeObject, Inherited from MediaClass.changeObject.

changeScalars(scalars): void

ParameterTypeDescription
scalarsPartial<SignalScalarRecord>

Returns void. Implementation of RawAsset.changeScalars, Inherited from MediaClass.changeScalars.

changesObject(scalars): ChangePropertiesEditObject

ParameterTypeDescription
scalarsPartial<SignalScalarRecord>

Returns ChangePropertiesEditObject. Implementation of RawAsset.changesObject, Inherited from MediaClass.changesObject.

clipObject(object?): ClipObject

ParameterTypeDescription
object?InstanceObject

Returns ClipObject. Implementation of RawAsset.clipObject, Inherited from MediaClass.clipObject.

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

ParameterTypeDescription
argsServerPromiseArgs
commandFileCommandFile

Returns Promise<DataOrError<number>>. Implementation of RawAsset.commandFilePromise, Inherited from MediaClass.commandFilePromise.

constrainedValue(property, value?): undefined | Scalar

ParameterTypeDescription
propertyProperty
value?Scalar

Returns undefined | Scalar. Implementation of RawAsset.constrainedValue, Inherited from MediaClass.constrainedValue.

decodingOfType(…types): undefined | Decoding

ParameterTypeDescription
typesstring[]

Returns undefined | Decoding. Inherited from MediaClass.decodingOfType.

findResource(…typesOrSources): undefined | Resource

ParameterTypeDescription
typesOrSourcesstring[]

Returns undefined | Resource. Implementation of RawAsset.findResource, Inherited from MediaClass.findResource.

instanceArgs(object?): InstanceArgs

ParameterTypeDescription
object?InstanceObject

Returns InstanceArgs. Implementation of RawAsset.instanceArgs, Inherited from MediaClass.instanceArgs.

instanceFromObject(object?): Instance

ParameterTypeDescription
object?InstanceObject

Returns Instance. Implementation of RawAsset.instanceFromObject, Inherited from MediaClass.instanceFromObject.

number(id): number

ParameterTypeDescription
idstring

Returns number. Implementation of RawAsset.number, Inherited from MediaClass.number.

propertiesOfTarget(targetId): Property[]

ParameterTypeDescription
targetIdstring

Returns Property[]. Implementation of RawAsset.propertiesOfTarget, Inherited from MediaClass.propertiesOfTarget.

propertyFind(name): undefined | Property

ParameterTypeDescription
namestring

Returns undefined | Property. Implementation of RawAsset.propertyFind, Inherited from MediaClass.propertyFind.

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

ParameterTypeDescription
targetIdstring

Returns `${string}.${string}`[]. Implementation of RawAsset.propertyIds, Inherited from MediaClass.propertyIds.

scalarsRecord(idOrNames): ScalarRecord

ParameterTypeDescription
idOrNamesstring[]

Returns ScalarRecord. Implementation of RawAsset.scalarsRecord, Inherited from MediaClass.scalarsRecord.

setValue(id, value?, dontConstrain?): void

ParameterTypeDescription
idstring
value?Scalar
dontConstrain?boolean

Returns void. Implementation of RawAsset.setValue, Inherited from MediaClass.setValue.

shouldSelectProperty(property): boolean

ParameterTypeDescription
propertyProperty

Returns boolean. Implementation of RawAsset.shouldSelectProperty, Inherited from MediaClass.shouldSelectProperty.

string(id): string

ParameterTypeDescription
idstring

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[]

ParameterTypeDescription
keystring
timeTime
rangeTimeRange

Returns Scalar[]. Implementation of RawAsset.tweenValues, Inherited from MediaClass.tweenValues.

tweens(key): boolean

ParameterTypeDescription
keystring

Returns boolean. Implementation of RawAsset.tweens, Inherited from MediaClass.tweens.

tweensProperty(key): boolean

ParameterTypeDescription
keystring

Returns boolean. Inherited from MediaClass.tweensProperty.

value(id): undefined | Scalar

ParameterTypeDescription
idstring

Returns undefined | Scalar. Implementation of RawAsset.value, Inherited from MediaClass.value.

Interfaces

ClientRawAsset

Extends ClientAsset.RawAsset. Extended by ClientRawAudio, ClientRawVideo, and ClientRawImage.

PropertyType
asDataStorableMedia
createdAt?string
decodingsDecoding[]
hasIntrinsicSizing?boolean
hasIntrinsicTiming?boolean
idstring
label?string
mediaIdsstring[]
projectId?string
propertiesProperty[]
resourcesResource[]
saveNeededboolean
sourcestring
targetIdstring
typeMediaType
updatedAt?string

Methods

addResource(resource): void

ParameterType
resourceResource

Returns void. Inherited from ClientAsset.addResource.

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

ParameterType
argsAssetCacheArgs

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

assetFiles(args): AssetFile[]

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

Returns AssetFile[]. Inherited from RawAsset.assetFiles.

assetIcon(size, cover?, patch?): Promise<DataOrError<SVGSVGElement>>

ParameterType
sizeSize<number>
cover?boolean
patch?Element

Returns Promise<DataOrError<SVGSVGElement>>. Inherited from ClientAsset.assetIcon.

assetIconPromise(resource, options, cover?, patch?): Promise<DataOrError<SvgItem>>

ParameterType
resourceResource
optionsSize<number> | Rect<number>
cover?boolean
patch?Element

Returns Promise<DataOrError<SvgItem>>. Inherited from ClientAsset.assetIconPromise.

boolean(key): boolean

ParameterType
keystring

Returns boolean. Inherited from RawAsset.boolean.

changeObject(propertyId, scalar?): ChangeEditObject

ParameterType
propertyId`${string}.${string}`
scalar?Scalar

Returns ChangeEditObject. Inherited from RawAsset.changeObject.

changeScalars(scalars): void

ParameterType
scalarsPartial<SignalScalarRecord>

Returns void. Inherited from RawAsset.changeScalars.

changesObject(scalars): ChangePropertiesEditObject

ParameterType
scalarsPartial<SignalScalarRecord>

Returns ChangePropertiesEditObject. Inherited from RawAsset.changesObject.

clipObject(object?): ClipObject

ParameterType
object?InstanceObject

Returns ClipObject. Inherited from RawAsset.clipObject.

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

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

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

constrainedValue(found, value?): undefined | Scalar

ParameterType
foundProperty
value?Scalar

Returns undefined | Scalar. Inherited from RawAsset.constrainedValue.

findResource(…types): undefined | Resource

ParameterType
typesstring[]

Returns undefined | Resource. Inherited from RawAsset.findResource.

imagePromise(resource): Promise<DataOrError<ClientImage>>

ParameterType
resourceResource

Returns Promise<DataOrError<ClientImage>>. Inherited from ClientAsset.imagePromise.

instanceArgs(object?): InstanceArgs

ParameterType
object?InstanceObject

Returns InstanceArgs. Inherited from RawAsset.instanceArgs.

instanceFromObject(object?): Instance

ParameterType
object?InstanceObject

Returns Instance. Inherited from RawAsset.instanceFromObject.

number(key): number

ParameterType
keystring

Returns number. Inherited from RawAsset.number.

propertiesOfTarget(targetId): Property[]

ParameterType
targetIdstring

Returns Property[]. Inherited from RawAsset.propertiesOfTarget.

propertyFind(name): undefined | Property

ParameterType
namestring

Returns undefined | Property. Inherited from RawAsset.propertyFind.

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

ParameterType
targetIdstring

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

savePromise(progress?): Promise<DataOrError<string>>

ParameterType
progress?ServerProgress

Returns Promise<DataOrError<string>>. Inherited from ClientAsset.savePromise.

scalarsRecord(idOrNames): ScalarRecord

ParameterType
idOrNamesstring[]

Returns ScalarRecord. Inherited from RawAsset.scalarsRecord.

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

ParameterType
nameOrIdstring
scalar?Scalar
dontConstrain?boolean

Returns void. Inherited from RawAsset.setValue.

shouldSelectProperty(property): boolean

ParameterType
propertyProperty

Returns boolean. Inherited from RawAsset.shouldSelectProperty.

string(key): string

ParameterType
keystring

Returns string. Inherited from RawAsset.string.

toJSON(): UnknownRecord

Returns UnknownRecord. Inherited from RawAsset.toJSON.

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

ParameterType
keystring
timeTime
rangeTimeRange

Returns Scalar[]. Inherited from RawAsset.tweenValues.

tweens(key): boolean

ParameterType
keystring

Returns boolean. Inherited from RawAsset.tweens.

unload(): void

Returns void. Inherited from ClientAsset.unload.

value(key): undefined | Scalar

ParameterType
keystring

Returns undefined | Scalar. Inherited from RawAsset.value.

RawAsset

Extends Media. Extended by ClientRawAsset.

PropertyType
asDataStorableMedia
createdAt?string
decodingsDecoding[]
hasIntrinsicSizing?boolean
hasIntrinsicTiming?boolean
idstring
label?string
mediaIdsstring[]
projectId?string
propertiesProperty[]
resourcesResource[]
sourcestring
targetIdstring
typeMediaType
updatedAt?string

Methods

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

ParameterType
argsAssetCacheArgs

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

assetFiles(args): AssetFile[]

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

Returns AssetFile[]. Inherited from Media.assetFiles.

boolean(key): boolean

ParameterType
keystring

Returns boolean. Inherited from Media.boolean.

changeObject(propertyId, scalar?): ChangeEditObject

ParameterType
propertyId`${string}.${string}`
scalar?Scalar

Returns ChangeEditObject. Inherited from Media.changeObject.

changeScalars(scalars): void

ParameterType
scalarsPartial<SignalScalarRecord>

Returns void. Inherited from Media.changeScalars.

changesObject(scalars): ChangePropertiesEditObject

ParameterType
scalarsPartial<SignalScalarRecord>

Returns ChangePropertiesEditObject. Inherited from Media.changesObject.

clipObject(object?): ClipObject

ParameterType
object?InstanceObject

Returns ClipObject. Inherited from Media.clipObject.

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

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

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

constrainedValue(found, value?): undefined | Scalar

ParameterType
foundProperty
value?Scalar

Returns undefined | Scalar. Inherited from Media.constrainedValue.

findResource(…types): undefined | Resource

ParameterType
typesstring[]

Returns undefined | Resource. Inherited from Media.findResource.

instanceArgs(object?): InstanceArgs

ParameterType
object?InstanceObject

Returns InstanceArgs. Inherited from Media.instanceArgs.

instanceFromObject(object?): Instance

ParameterType
object?InstanceObject

Returns Instance. Inherited from Media.instanceFromObject.

number(key): number

ParameterType
keystring

Returns number. Inherited from Media.number.

propertiesOfTarget(targetId): Property[]

ParameterType
targetIdstring

Returns Property[]. Inherited from Media.propertiesOfTarget.

propertyFind(name): undefined | Property

ParameterType
namestring

Returns undefined | Property. Inherited from Media.propertyFind.

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

ParameterType
targetIdstring

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

scalarsRecord(idOrNames): ScalarRecord

ParameterType
idOrNamesstring[]

Returns ScalarRecord. Inherited from Media.scalarsRecord.

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

ParameterType
nameOrIdstring
scalar?Scalar
dontConstrain?boolean

Returns void. Inherited from Media.setValue.

shouldSelectProperty(property): boolean

ParameterType
propertyProperty

Returns boolean. Inherited from Media.shouldSelectProperty.

string(key): string

ParameterType
keystring

Returns string. Inherited from Media.string.

toJSON(): UnknownRecord

Returns UnknownRecord. Inherited from Media.toJSON.

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

ParameterType
keystring
timeTime
rangeTimeRange

Returns Scalar[]. Inherited from Media.tweenValues.

tweens(key): boolean

ParameterType
keystring

Returns boolean. Inherited from Media.tweens.

value(key): undefined | Scalar

ParameterType
keystring

Returns undefined | Scalar. Inherited from Media.value.

Type Aliases

RawSource

RawSource: MediaType | _css | _ttf | _woff2 | _otf

Functions

isRawAsset

isRawAsset(value): value is RawAsset

ParameterType
valueany

Returns value is RawAsset.