Exports related to raw audio files.
Classes
ClientRawAudioClass
Extends ClientRawAudioClass_base. Implements ClientRawAudio.
new ClientRawAudioClass(
object):ClientRawAudioClass
| Parameter | Type | Description |
|---|---|---|
object | StorableMedia |
Returns ClientRawAudioClass. Inherited from ClientRawAudioClass_base.constructor.
| Property | Modifier | Type |
|---|---|---|
asData | public | StorableMedia |
canBeMuted | public | undefined | boolean |
createdAt? | public | string |
decodings | public | Decoding[] |
duration | public | number |
hasIntrinsicSizing | public | undefined | boolean |
hasIntrinsicTiming | public | undefined | boolean |
id | public | string |
label? | public | string |
mediaIds | public | string[] |
projectId | public | undefined | string |
properties | public | Property[] |
resources | public | Resource[] |
saveNeeded | public | boolean |
source | public | string |
targetId | public | string |
type | public | MediaType |
unsavedResources | public readonly | Resource[] |
updatedAt? | public | string |
Methods
addResource(
resource):void
| Parameter | Type | Description |
|---|---|---|
resource | Resource |
Returns void. Implementation of ClientRawAudio.addResource, Inherited from ClientRawAudioClass_base.addResource.
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClientRawAudio.assetCachePromise, Overrides ClientRawAudioClass_base.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of ClientRawAudio.assetFiles, Inherited from ClientRawAudioClass_base.assetFiles.
assetIcon(
size,cover?,patch?):Promise<DataOrError<SVGSVGElement>>
| Parameter | Type | Description |
|---|---|---|
size | Size<number> | |
cover? | boolean | |
patch? | Element |
Returns Promise<DataOrError<SVGSVGElement>>. Implementation of ClientRawAudio.assetIcon, Overrides ClientRawAudioClass_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 ClientRawAudio.assetIconPromise, Inherited from ClientRawAudioClass_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 ClientRawAudio.assetIconPromise, Inherited from ClientRawAudioClass_base.assetIconPromise.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClientRawAudio.boolean, Inherited from ClientRawAudioClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClientRawAudio.changeObject, Inherited from ClientRawAudioClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClientRawAudio.changeScalars, Inherited from ClientRawAudioClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClientRawAudio.changesObject, Inherited from ClientRawAudioClass_base.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of ClientRawAudio.clipObject, Inherited from ClientRawAudioClass_base.clipObject.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of ClientRawAudio.commandFilePromise, Inherited from ClientRawAudioClass_base.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClientRawAudio.constrainedValue, Inherited from ClientRawAudioClass_base.constrainedValue.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from ClientRawAudioClass_base.decodingOfType.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of ClientRawAudio.findResource, Inherited from ClientRawAudioClass_base.findResource.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Implementation of ClientRawAudio.frames, Inherited from ClientRawAudioClass_base.frames.
imagePromise(
resource):Promise<DataOrError<ClientImage>>
| Parameter | Type | Description |
|---|---|---|
resource | Resource |
Returns Promise<DataOrError<ClientImage>>. Implementation of ClientRawAudio.imagePromise, Inherited from ClientRawAudioClass_base.imagePromise.
instanceArgs(
object?):ClippedRawAudioArgs
| Parameter | Type | Description |
|---|---|---|
object? | ClippedRawAudioObject |
Returns ClippedRawAudioArgs. Implementation of ClientRawAudio.instanceArgs, Overrides ClientRawAudioClass_base.instanceArgs.
instanceFromObject(
object?):ClippedAudio
| Parameter | Type | Description |
|---|---|---|
object? | ClippedRawAudioObject |
Returns ClippedAudio. Implementation of ClientRawAudio.instanceFromObject, Overrides ClientRawAudioClass_base.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClientRawAudio.number, Inherited from ClientRawAudioClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClientRawAudio.propertiesOfTarget, Inherited from ClientRawAudioClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClientRawAudio.propertyFind, Inherited from ClientRawAudioClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClientRawAudio.propertyIds, Inherited from ClientRawAudioClass_base.propertyIds.
savePromise(
progress?):Promise<DataOrError<string>>
| Parameter | Type | Description |
|---|---|---|
progress? | ServerProgress |
Returns Promise<DataOrError<string>>. Implementation of ClientRawAudio.savePromise, Inherited from ClientRawAudioClass_base.savePromise.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClientRawAudio.scalarsRecord, Inherited from ClientRawAudioClass_base.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClientRawAudio.setValue, Inherited from ClientRawAudioClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClientRawAudio.shouldSelectProperty, Inherited from ClientRawAudioClass_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 ClientRawAudio.string, Inherited from ClientRawAudioClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClientRawAudio.toJSON, Inherited from ClientRawAudioClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClientRawAudio.tweenValues, Inherited from ClientRawAudioClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClientRawAudio.tweens, Inherited from ClientRawAudioClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClientRawAudioClass_base.tweensProperty.
unload():
void
Returns void. Implementation of ClientRawAudio.unload, Inherited from ClientRawAudioClass_base.unload.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClientRawAudio.value, Inherited from ClientRawAudioClass_base.value.
ClippedClientRawAudioClass
Extends ClippedClientRawAudioClass_base. Implements ClippedClientRawAudio.
new ClippedClientRawAudioClass(
object):ClippedClientRawAudioClass
| Parameter | Type | Description |
|---|---|---|
object | InstanceArgs |
Returns ClippedClientRawAudioClass. Inherited from ClippedClientRawAudioClass_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 |
hasIntrinsicTiming | public | boolean |
id | public | string |
instanceObject | public | InstanceObject |
isDefault | public | boolean |
mediaIds | public | string[] |
muted | public | boolean |
properties | public | Property[] |
targetId | public | string |
Methods
assetFrames(
quantize):number[]
| Parameter | Type |
|---|---|
quantize | number |
Returns number[] containing duration, start trim, and end trim in frames.. Implementation of ClippedClientRawAudio.assetFrames, Inherited from ClippedClientRawAudioClass_base.assetFrames.
assetTime(
mashTime):Time
| Parameter | Type | Description |
|---|---|---|
mashTime | Time |
Returns Time. Implementation of ClippedClientRawAudio.assetTime, Inherited from ClippedClientRawAudioClass_base.assetTime.
audibleCommandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | AudioCommandFileArgs |
Returns CommandFile[]. Implementation of ClippedClientRawAudio.audibleCommandFiles, Inherited from ClippedClientRawAudioClass_base.audibleCommandFiles.
audiblePreviewPromise(
outputSize,scale?):Promise<DataOrError<SvgItem>>
| Parameter | Type |
|---|---|
outputSize | Size<number> |
scale? | number |
Returns Promise<DataOrError<SvgItem>>. Inherited from ClippedClientRawAudioClass_base.audiblePreviewPromise.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedClientRawAudio.boolean, Inherited from ClippedClientRawAudioClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClippedClientRawAudio.changeObject, Inherited from ClippedClientRawAudioClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClippedClientRawAudio.changeScalars, Inherited from ClippedClientRawAudioClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClippedClientRawAudio.changesObject, Inherited from ClippedClientRawAudioClass_base.changesObject.
commandFiles(
cacheArgs):CommandFile[]
| Parameter | Type | Description |
|---|---|---|
cacheArgs | CommandFileArgs |
Returns CommandFile[]. Implementation of ClippedClientRawAudio.commandFiles, Inherited from ClippedClientRawAudioClass_base.commandFiles.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClippedClientRawAudio.constrainedValue, Inherited from ClippedClientRawAudioClass_base.constrainedValue.
frames(
quantize):number
| Parameter | Type | Description |
|---|---|---|
quantize | number |
Returns number. Implementation of ClippedClientRawAudio.frames, Inherited from ClippedClientRawAudioClass_base.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClippedClientRawAudio.instanceCachePromise, Inherited from ClippedClientRawAudioClass_base.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type | Description |
|---|---|---|
options | IntrinsicOptions |
Returns boolean. Implementation of ClippedClientRawAudio.intrinsicsKnown, Inherited from ClippedClientRawAudioClass_base.intrinsicsKnown.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClippedClientRawAudio.number, Inherited from ClippedClientRawAudioClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClippedClientRawAudio.propertiesOfTarget, Inherited from ClippedClientRawAudioClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClippedClientRawAudio.propertyFind, Inherited from ClippedClientRawAudioClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClippedClientRawAudio.propertyIds, Inherited from ClippedClientRawAudioClass_base.propertyIds.
scalarsById(targetId, time, timeIsStart)
scalarsById(
targetId,time?,timeIsStart?):SignalScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
time? | Time | |
timeIsStart? | boolean |
Returns SignalScalarRecord. Implementation of ClippedClientRawAudio.scalarsById, Inherited from ClippedClientRawAudioClass_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 ClippedClientRawAudio.scalarsById, Inherited from ClippedClientRawAudioClass_base.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClippedClientRawAudio.scalarsRecord, Inherited from ClippedClientRawAudioClass_base.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClippedClientRawAudio.setValue, Inherited from ClippedClientRawAudioClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClippedClientRawAudio.shouldSelectProperty, Inherited from ClippedClientRawAudioClass_base.shouldSelectProperty.
splitObject(
targetId,frame?,frameIsStart?):Partial<SignalScalarRecord>
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
frame? | number | |
frameIsStart? | boolean |
Returns Partial<SignalScalarRecord>. Inherited from ClippedClientRawAudioClass_base.splitObject.
splitScalars(
targetId,frame?):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
frame? | number |
Returns ScalarRecord. Inherited from ClippedClientRawAudioClass_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 ClippedClientRawAudio.string, Inherited from ClippedClientRawAudioClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClippedClientRawAudio.toJSON, Inherited from ClippedClientRawAudioClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClippedClientRawAudio.tweenValues, Inherited from ClippedClientRawAudioClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedClientRawAudio.tweens, Inherited from ClippedClientRawAudioClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClippedClientRawAudioClass_base.tweensProperty.
unload():
void
Returns void. Inherited from ClippedClientRawAudioClass_base.unload.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClippedClientRawAudio.value, Inherited from ClippedClientRawAudioClass_base.value.
ClippedRawAudioClass
Extends ClippedRawAudioClass_base. Implements ClippedRawAudio.
new ClippedRawAudioClass(
object):ClippedRawAudioClass
| Parameter | Type | Description |
|---|---|---|
object | InstanceArgs |
Returns ClippedRawAudioClass. Inherited from ClippedRawAudioClass_base.constructor.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
audibleAsset | AudibleAsset |
canBeMuted | boolean |
clip | Clip |
hasIntrinsicTiming | boolean |
id | string |
instanceObject | InstanceObject |
isDefault | boolean |
mediaIds | string[] |
muted | boolean |
properties | Property[] |
targetId | string |
Methods
assetFrames(
quantize):number[]
| Parameter | Type |
|---|---|
quantize | number |
Returns number[] containing duration, start trim, and end trim in frames.. Implementation of ClippedRawAudio.assetFrames, Inherited from ClippedRawAudioClass_base.assetFrames.
assetTime(
mashTime):Time
| Parameter | Type | Description |
|---|---|---|
mashTime | Time |
Returns Time. Implementation of ClippedRawAudio.assetTime, Inherited from ClippedRawAudioClass_base.assetTime.
audibleCommandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | AudioCommandFileArgs |
Returns CommandFile[]. Implementation of ClippedRawAudio.audibleCommandFiles, Inherited from ClippedRawAudioClass_base.audibleCommandFiles.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedRawAudio.boolean, Inherited from ClippedRawAudioClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of ClippedRawAudio.changeObject, Inherited from ClippedRawAudioClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of ClippedRawAudio.changeScalars, Inherited from ClippedRawAudioClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of ClippedRawAudio.changesObject, Inherited from ClippedRawAudioClass_base.changesObject.
commandFiles(
cacheArgs):CommandFile[]
| Parameter | Type | Description |
|---|---|---|
cacheArgs | CommandFileArgs |
Returns CommandFile[]. Implementation of ClippedRawAudio.commandFiles, Inherited from ClippedRawAudioClass_base.commandFiles.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of ClippedRawAudio.constrainedValue, Inherited from ClippedRawAudioClass_base.constrainedValue.
frames(
quantize):number
| Parameter | Type | Description |
|---|---|---|
quantize | number |
Returns number. Implementation of ClippedRawAudio.frames, Inherited from ClippedRawAudioClass_base.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of ClippedRawAudio.instanceCachePromise, Inherited from ClippedRawAudioClass_base.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type | Description |
|---|---|---|
options | IntrinsicOptions |
Returns boolean. Implementation of ClippedRawAudio.intrinsicsKnown, Inherited from ClippedRawAudioClass_base.intrinsicsKnown.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of ClippedRawAudio.number, Inherited from ClippedRawAudioClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of ClippedRawAudio.propertiesOfTarget, Inherited from ClippedRawAudioClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of ClippedRawAudio.propertyFind, Inherited from ClippedRawAudioClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of ClippedRawAudio.propertyIds, Inherited from ClippedRawAudioClass_base.propertyIds.
scalarsById(targetId, time, timeIsStart)
scalarsById(
targetId,time?,timeIsStart?):SignalScalarRecord
| Parameter | Type | Description |
|---|---|---|
targetId | string | |
time? | Time | |
timeIsStart? | boolean |
Returns SignalScalarRecord. Implementation of ClippedRawAudio.scalarsById, Inherited from ClippedRawAudioClass_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 ClippedRawAudio.scalarsById, Inherited from ClippedRawAudioClass_base.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of ClippedRawAudio.scalarsRecord, Inherited from ClippedRawAudioClass_base.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of ClippedRawAudio.setValue, Inherited from ClippedRawAudioClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of ClippedRawAudio.shouldSelectProperty, Inherited from ClippedRawAudioClass_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 ClippedRawAudio.string, Inherited from ClippedRawAudioClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of ClippedRawAudio.toJSON, Inherited from ClippedRawAudioClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of ClippedRawAudio.tweenValues, Inherited from ClippedRawAudioClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of ClippedRawAudio.tweens, Inherited from ClippedRawAudioClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from ClippedRawAudioClass_base.tweensProperty.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of ClippedRawAudio.value, Inherited from ClippedRawAudioClass_base.value.
RawAudioClass
Extends RawAudioClass_base. Implements RawAudio.
new RawAudioClass(
object):RawAudioClass
| Parameter | Type | Description |
|---|---|---|
object | StorableMedia |
Returns RawAudioClass. Inherited from RawAudioClass_base.constructor.
| Property | Type |
|---|---|
asData | StorableMedia |
canBeMuted? | boolean |
createdAt? | string |
decodings | Decoding[] |
duration | number |
hasIntrinsicSizing | undefined | boolean |
hasIntrinsicTiming | undefined | boolean |
id | string |
label? | string |
mediaIds | string[] |
projectId | undefined | string |
properties | Property[] |
resources | Resource[] |
source | string |
targetId | string |
type | MediaType |
updatedAt? | string |
Methods
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Implementation of RawAudio.assetCachePromise, Inherited from RawAudioClass_base.assetCachePromise.
assetFiles(
args):AssetFile[]
| Parameter | Type | Description |
|---|---|---|
args | CacheArgs |
Returns AssetFile[]. Implementation of RawAudio.assetFiles, Overrides RawAudioClass_base.assetFiles.
boolean(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of RawAudio.boolean, Inherited from RawAudioClass_base.boolean.
changeObject(
signalId,scalar?):ChangeEditObject
| Parameter | Type | Description |
|---|---|---|
signalId | `${string}.${string}` | |
scalar? | Scalar |
Returns ChangeEditObject. Implementation of RawAudio.changeObject, Inherited from RawAudioClass_base.changeObject.
changeScalars(
scalars):void
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Implementation of RawAudio.changeScalars, Inherited from RawAudioClass_base.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type | Description |
|---|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Implementation of RawAudio.changesObject, Inherited from RawAudioClass_base.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns ClipObject. Implementation of RawAudio.clipObject, Inherited from RawAudioClass_base.clipObject.
commandFilePromise(
args,commandFile):Promise<DataOrError<number>>
| Parameter | Type | Description |
|---|---|---|
args | ServerPromiseArgs | |
commandFile | CommandFile |
Returns Promise<DataOrError<number>>. Implementation of RawAudio.commandFilePromise, Inherited from RawAudioClass_base.commandFilePromise.
constrainedValue(
property,value?):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
property | Property | |
value? | Scalar |
Returns undefined | Scalar. Implementation of RawAudio.constrainedValue, Inherited from RawAudioClass_base.constrainedValue.
decodingOfType(…
types):undefined|Decoding
| Parameter | Type | Description |
|---|---|---|
…types | string[] |
Returns undefined | Decoding. Inherited from RawAudioClass_base.decodingOfType.
findResource(…
typesOrSources):undefined|Resource
| Parameter | Type | Description |
|---|---|---|
…typesOrSources | string[] |
Returns undefined | Resource. Implementation of RawAudio.findResource, Inherited from RawAudioClass_base.findResource.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Implementation of RawAudio.frames, Inherited from RawAudioClass_base.frames.
instanceArgs(
object?):InstanceArgs
| Parameter | Type | Description |
|---|---|---|
object? | InstanceObject |
Returns InstanceArgs. Implementation of RawAudio.instanceArgs, Inherited from RawAudioClass_base.instanceArgs.
instanceFromObject(
object):ClippedRawAudio
| Parameter | Type | Description |
|---|---|---|
object | undefined | ClippedRawAudioObject |
Returns ClippedRawAudio. Implementation of RawAudio.instanceFromObject, Overrides RawAudioClass_base.instanceFromObject.
number(
id):number
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns number. Implementation of RawAudio.number, Inherited from RawAudioClass_base.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns Property[]. Implementation of RawAudio.propertiesOfTarget, Inherited from RawAudioClass_base.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type | Description |
|---|---|---|
name | string |
Returns undefined | Property. Implementation of RawAudio.propertyFind, Inherited from RawAudioClass_base.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type | Description |
|---|---|---|
targetId | string |
Returns `${string}.${string}`[]. Implementation of RawAudio.propertyIds, Inherited from RawAudioClass_base.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type | Description |
|---|---|---|
idOrNames | string[] |
Returns ScalarRecord. Implementation of RawAudio.scalarsRecord, Inherited from RawAudioClass_base.scalarsRecord.
setValue(
id,value?,dontConstrain?):void
| Parameter | Type | Description |
|---|---|---|
id | string | |
value? | Scalar | |
dontConstrain? | boolean |
Returns void. Implementation of RawAudio.setValue, Inherited from RawAudioClass_base.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type | Description |
|---|---|---|
property | Property |
Returns boolean. Implementation of RawAudio.shouldSelectProperty, Inherited from RawAudioClass_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 RawAudio.string, Inherited from RawAudioClass_base.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Implementation of RawAudio.toJSON, Inherited from RawAudioClass_base.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type | Description |
|---|---|---|
key | string | |
time | Time | |
range | TimeRange |
Returns Scalar[]. Implementation of RawAudio.tweenValues, Inherited from RawAudioClass_base.tweenValues.
tweens(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Implementation of RawAudio.tweens, Inherited from RawAudioClass_base.tweens.
tweensProperty(
key):boolean
| Parameter | Type | Description |
|---|---|---|
key | string |
Returns boolean. Inherited from RawAudioClass_base.tweensProperty.
value(
id):undefined|Scalar
| Parameter | Type | Description |
|---|---|---|
id | string |
Returns undefined | Scalar. Implementation of RawAudio.value, Inherited from RawAudioClass_base.value.
Interfaces
ClientRawAudio
Extends AudioMedia.ClientRawAsset.
| Property | Type |
|---|---|
asData | StorableMedia |
canBeMuted? | boolean |
createdAt? | string |
decodings | Decoding[] |
duration | number |
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 ClientRawAsset.addResource.
assetCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | AssetCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from ClientRawAsset.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from ClientRawAsset.assetFiles.
assetIcon(
size,cover?,patch?):Promise<DataOrError<SVGSVGElement>>
| Parameter | Type |
|---|---|
size | Size<number> |
cover? | boolean |
patch? | Element |
Returns Promise<DataOrError<SVGSVGElement>>. Inherited from ClientRawAsset.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 ClientRawAsset.assetIconPromise.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClientRawAsset.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ClientRawAsset.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ClientRawAsset.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ClientRawAsset.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from ClientRawAsset.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 ClientRawAsset.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ClientRawAsset.constrainedValue.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from ClientRawAsset.findResource.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from AudioMedia.frames.
imagePromise(
resource):Promise<DataOrError<ClientImage>>
| Parameter | Type |
|---|---|
resource | Resource |
Returns Promise<DataOrError<ClientImage>>. Inherited from ClientRawAsset.imagePromise.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from ClientRawAsset.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from ClientRawAsset.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ClientRawAsset.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ClientRawAsset.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ClientRawAsset.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ClientRawAsset.propertyIds.
savePromise(
progress?):Promise<DataOrError<string>>
| Parameter | Type |
|---|---|
progress? | ServerProgress |
Returns Promise<DataOrError<string>>. Inherited from ClientRawAsset.savePromise.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ClientRawAsset.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ClientRawAsset.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ClientRawAsset.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ClientRawAsset.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ClientRawAsset.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ClientRawAsset.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClientRawAsset.tweens.
unload():
void
Returns void. Inherited from ClientRawAsset.unload.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ClientRawAsset.value.
ClippedClientRawAudio
Extends ClippedAudio.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
audibleAsset | AudibleAsset |
canBeMuted | boolean |
clip | Clip |
id | string |
instanceObject | InstanceObject |
isDefault | boolean |
mediaIds | string[] |
muted | boolean |
properties | Property[] |
targetId | string |
Methods
assetFrames(
quantize):number[]
| Parameter | Type |
|---|---|
quantize | number |
Returns number[] containing duration, start trim, and end trim in frames.. Inherited from ClippedAudio.assetFrames.
assetTime(
masherTime):Time
| Parameter | Type |
|---|---|
masherTime | Time |
Returns Time. Inherited from ClippedAudio.assetTime.
audibleCommandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | AudioCommandFileArgs |
Returns CommandFile[]. Inherited from ClippedAudio.audibleCommandFiles.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClippedAudio.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ClippedAudio.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ClippedAudio.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ClippedAudio.changesObject.
commandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | CommandFileArgs |
Returns CommandFile[]. Inherited from ClippedAudio.commandFiles.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ClippedAudio.constrainedValue.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from ClippedAudio.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from ClippedAudio.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type |
|---|---|
options | IntrinsicOptions |
Returns boolean. Inherited from ClippedAudio.intrinsicsKnown.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ClippedAudio.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ClippedAudio.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ClippedAudio.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ClippedAudio.propertyIds.
scalarsById(
targetId,time?,timeIsStart?,useNames?):SignalScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
time? | Time |
timeIsStart? | boolean |
useNames? | boolean |
Returns SignalScalarRecord. Inherited from ClippedAudio.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ClippedAudio.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ClippedAudio.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ClippedAudio.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ClippedAudio.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ClippedAudio.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ClippedAudio.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClippedAudio.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ClippedAudio.value.
ClippedRawAudio
Extends ClippedAudio.
| Property | Type |
|---|---|
asset | Media |
assetId | string |
audibleAsset | AudibleAsset |
canBeMuted | boolean |
clip | Clip |
id | string |
instanceObject | InstanceObject |
isDefault | boolean |
mediaIds | string[] |
muted | boolean |
properties | Property[] |
targetId | string |
Methods
assetFrames(
quantize):number[]
| Parameter | Type |
|---|---|
quantize | number |
Returns number[] containing duration, start trim, and end trim in frames.. Inherited from ClippedAudio.assetFrames.
assetTime(
masherTime):Time
| Parameter | Type |
|---|---|
masherTime | Time |
Returns Time. Inherited from ClippedAudio.assetTime.
audibleCommandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | AudioCommandFileArgs |
Returns CommandFile[]. Inherited from ClippedAudio.audibleCommandFiles.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClippedAudio.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from ClippedAudio.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from ClippedAudio.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from ClippedAudio.changesObject.
commandFiles(
args):CommandFile[]
| Parameter | Type |
|---|---|
args | CommandFileArgs |
Returns CommandFile[]. Inherited from ClippedAudio.commandFiles.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from ClippedAudio.constrainedValue.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from ClippedAudio.frames.
instanceCachePromise(
args):Promise<DataOrError<number>>
| Parameter | Type |
|---|---|
args | InstanceCacheArgs |
Returns Promise<DataOrError<number>>. Inherited from ClippedAudio.instanceCachePromise.
intrinsicsKnown(
options):boolean
| Parameter | Type |
|---|---|
options | IntrinsicOptions |
Returns boolean. Inherited from ClippedAudio.intrinsicsKnown.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from ClippedAudio.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from ClippedAudio.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from ClippedAudio.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from ClippedAudio.propertyIds.
scalarsById(
targetId,time?,timeIsStart?,useNames?):SignalScalarRecord
| Parameter | Type |
|---|---|
targetId | string |
time? | Time |
timeIsStart? | boolean |
useNames? | boolean |
Returns SignalScalarRecord. Inherited from ClippedAudio.scalarsById.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from ClippedAudio.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from ClippedAudio.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from ClippedAudio.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from ClippedAudio.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from ClippedAudio.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from ClippedAudio.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from ClippedAudio.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from ClippedAudio.value.
ClippedRawAudioArgs
Extends InstanceArgs.ClippedRawAudioObject.
| Property | Type |
|---|---|
asset | Media |
endTrim? | number |
gain? | number |
loops? | number |
muted? | boolean |
speed? | number |
startTrim? | number |
ClippedRawAudioObject
Extends AudibleInstanceObject. Extended by ClippedRawAudioArgs.
| Property | Type |
|---|---|
endTrim? | number |
gain? | number |
loops? | number |
muted? | boolean |
speed? | number |
startTrim? | number |
RawAudio
Extends AudioMedia.AudibleAsset.
| Property | Type |
|---|---|
asData | StorableMedia |
canBeMuted? | boolean |
createdAt? | string |
decodings | Decoding[] |
duration | number |
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 AudibleAsset.assetCachePromise.
All files needed for audible and/or visible encode commands.assetFiles(
args):AssetFile[]
| Parameter | Type |
|---|---|
args | CacheArgs |
Returns AssetFile[]. Inherited from AudibleAsset.assetFiles.
boolean(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from AudibleAsset.boolean.
changeObject(
propertyId,scalar?):ChangeEditObject
| Parameter | Type |
|---|---|
propertyId | `${string}.${string}` |
scalar? | Scalar |
Returns ChangeEditObject. Inherited from AudibleAsset.changeObject.
changeScalars(
scalars):void
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns void. Inherited from AudibleAsset.changeScalars.
changesObject(
scalars):ChangePropertiesEditObject
| Parameter | Type |
|---|---|
scalars | Partial<SignalScalarRecord> |
Returns ChangePropertiesEditObject. Inherited from AudibleAsset.changesObject.
clipObject(
object?):ClipObject
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns ClipObject. Inherited from AudibleAsset.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 AudibleAsset.commandFilePromise.
constrainedValue(
found,value?):undefined|Scalar
| Parameter | Type |
|---|---|
found | Property |
value? | Scalar |
Returns undefined | Scalar. Inherited from AudibleAsset.constrainedValue.
findResource(…
types):undefined|Resource
| Parameter | Type |
|---|---|
…types | string[] |
Returns undefined | Resource. Inherited from AudibleAsset.findResource.
frames(
quantize):number
| Parameter | Type |
|---|---|
quantize | number |
Returns number. Inherited from AudibleAsset.frames.
instanceArgs(
object?):InstanceArgs
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns InstanceArgs. Inherited from AudibleAsset.instanceArgs.
instanceFromObject(
object?):Instance
| Parameter | Type |
|---|---|
object? | InstanceObject |
Returns Instance. Inherited from AudibleAsset.instanceFromObject.
number(
key):number
| Parameter | Type |
|---|---|
key | string |
Returns number. Inherited from AudibleAsset.number.
propertiesOfTarget(
targetId):Property[]
| Parameter | Type |
|---|---|
targetId | string |
Returns Property[]. Inherited from AudibleAsset.propertiesOfTarget.
propertyFind(
name):undefined|Property
| Parameter | Type |
|---|---|
name | string |
Returns undefined | Property. Inherited from AudibleAsset.propertyFind.
propertyIds(
targetId): `${string}.${string}`[]
| Parameter | Type |
|---|---|
targetId | string |
Returns `${string}.${string}`[]. Inherited from AudibleAsset.propertyIds.
scalarsRecord(
idOrNames):ScalarRecord
| Parameter | Type |
|---|---|
idOrNames | string[] |
Returns ScalarRecord. Inherited from AudibleAsset.scalarsRecord.
setValue(
nameOrId,scalar?,dontConstrain?):void
| Parameter | Type |
|---|---|
nameOrId | string |
scalar? | Scalar |
dontConstrain? | boolean |
Returns void. Inherited from AudibleAsset.setValue.
shouldSelectProperty(
property):boolean
| Parameter | Type |
|---|---|
property | Property |
Returns boolean. Inherited from AudibleAsset.shouldSelectProperty.
string(
key):string
| Parameter | Type |
|---|---|
key | string |
Returns string. Inherited from AudibleAsset.string.
toJSON():
UnknownRecord
Returns UnknownRecord. Inherited from AudibleAsset.toJSON.
tweenValues(
key,time,range):Scalar[]
| Parameter | Type |
|---|---|
key | string |
time | Time |
range | TimeRange |
Returns Scalar[]. Inherited from AudibleAsset.tweenValues.
tweens(
key):boolean
| Parameter | Type |
|---|---|
key | string |
Returns boolean. Inherited from AudibleAsset.tweens.
value(
key):undefined|Scalar
| Parameter | Type |
|---|---|
key | string |
Returns undefined | Scalar. Inherited from AudibleAsset.value.
StorableRawAudio
Extends StorableMedia.AudioProperties.
| Property | Type |
|---|---|
createdAt? | string |
id? | string |
label? | string |
projectId? | string |
resources? | StorableResource[] |
source | string |
type | MediaType |
updatedAt? | string |
StoredRawAudio
Extends StoredAudio.
| Property | Type |
|---|---|
createdAt? | string |
id | string |
label? | string |
projectId? | string |
resources? | StoredResource[] |
source | "raw" |
type | "audio" |
updatedAt? | string |