ProjectBuilder
此内容尚不支持你的语言。
Defined in: packages/sdk/src/project-builder.ts:347
Create a validated Project v1 document through small, type-safe operations.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ProjectBuilder(
options):ProjectBuilder
Defined in: packages/sdk/src/project-builder.ts:355
Parameters
Section titled “Parameters”options
Section titled “options”CreateProjectOptions = {}
Returns
Section titled “Returns”ProjectBuilder
Accessors
Section titled “Accessors”projectId
Section titled “projectId”Get Signature
Section titled “Get Signature”get projectId():
string
Defined in: packages/sdk/src/project-builder.ts:437
Returns
Section titled “Returns”string
sequenceId
Section titled “sequenceId”Get Signature
Section titled “Get Signature”get sequenceId():
string
Defined in: packages/sdk/src/project-builder.ts:441
Returns
Section titled “Returns”string
Methods
Section titled “Methods”addAsset()
Section titled “addAsset()”addAsset(
options):string
Defined in: packages/sdk/src/project-builder.ts:466
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
addCaptionClip()
Section titled “addCaptionClip()”addCaptionClip(
options):string
Defined in: packages/sdk/src/project-builder.ts:802
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
addImageClip()
Section titled “addImageClip()”addImageClip(
options):string
Defined in: packages/sdk/src/project-builder.ts:629
Add a first-class still image Clip backed by an image Asset.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
addImageSequenceClip()
Section titled “addImageSequenceClip()”addImageSequenceClip(
options):string
Defined in: packages/sdk/src/project-builder.ts:673
Add an image-sequence Clip: registers an image-sequence Asset whose frame
manifest references existing image Assets, then adds an image Clip that
samples the sequence deterministically through the frame mapping.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
addMarker()
Section titled “addMarker()”addMarker(
options):string
Defined in: packages/sdk/src/project-builder.ts:1234
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
addMaterialInstance()
Section titled “addMaterialInstance()”addMaterialInstance(
options):string
Defined in: packages/sdk/src/project-builder.ts:898
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
addMediaClip()
Section titled “addMediaClip()”addMediaClip(
options):string
Defined in: packages/sdk/src/project-builder.ts:502
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
addShapeClip()
Section titled “addShapeClip()”addShapeClip(
options):string
Defined in: packages/sdk/src/project-builder.ts:853
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
addTextClip()
Section titled “addTextClip()”addTextClip(
options):string
Defined in: packages/sdk/src/project-builder.ts:730
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
addTrack()
Section titled “addTrack()”addTrack(
options):string
Defined in: packages/sdk/src/project-builder.ts:445
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
addTransition()
Section titled “addTransition()”addTransition(
options):string
Defined in: packages/sdk/src/project-builder.ts:959
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”string
attachEffect()
Section titled “attachEffect()”attachEffect(
itemId,materialInstanceId):this
Defined in: packages/sdk/src/project-builder.ts:947
Parameters
Section titled “Parameters”itemId
Section titled “itemId”string
materialInstanceId
Section titled “materialInstanceId”string
Returns
Section titled “Returns”this
build()
Section titled “build()”build():
Readonly<AelionProject>
Defined in: packages/sdk/src/project-builder.ts:1263
Returns
Section titled “Returns”Readonly<AelionProject>
importMedia()
Section titled “importMedia()”importMedia(
options):Promise<ImportedMedia>
Defined in: packages/sdk/src/project-builder.ts:1118
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<ImportedMedia>
setBackgroundColor()
Section titled “setBackgroundColor()”setBackgroundColor(
value):this
Defined in: packages/sdk/src/project-builder.ts:595
Parameters
Section titled “Parameters”string | readonly [number, number, number, number]
Returns
Section titled “Returns”this
setItemMetadata()
Section titled “setItemMetadata()”setItemMetadata(
itemId,metadata):this
Defined in: packages/sdk/src/project-builder.ts:621
Parameters
Section titled “Parameters”itemId
Section titled “itemId”string
metadata
Section titled “metadata”Returns
Section titled “Returns”this
setKeyframes()
Section titled “setKeyframes()”setKeyframes(
itemId,property,keyframes):this
Defined in: packages/sdk/src/project-builder.ts:1057
Parameters
Section titled “Parameters”itemId
Section titled “itemId”string
property
Section titled “property”keyframes
Section titled “keyframes”readonly Keyframe<JsonValue>[]
Returns
Section titled “Returns”this
setMask()
Section titled “setMask()”setMask(
itemId,options):this
Defined in: packages/sdk/src/project-builder.ts:989
Parameters
Section titled “Parameters”itemId
Section titled “itemId”string
options
Section titled “options”Returns
Section titled “Returns”this
setProjectExtension()
Section titled “setProjectExtension()”setProjectExtension(
namespace,value):this
Defined in: packages/sdk/src/project-builder.ts:600
Parameters
Section titled “Parameters”namespace
Section titled “namespace”string
Returns
Section titled “Returns”this
setTrackExtension()
Section titled “setTrackExtension()”setTrackExtension(
trackId,namespace,value):this
Defined in: packages/sdk/src/project-builder.ts:605
Parameters
Section titled “Parameters”trackId
Section titled “trackId”string
namespace
Section titled “namespace”string
Returns
Section titled “Returns”this
setVisual()
Section titled “setVisual()”setVisual(
itemId,options):this
Defined in: packages/sdk/src/project-builder.ts:1014
Parameters
Section titled “Parameters”itemId
Section titled “itemId”string
options
Section titled “options”Returns
Section titled “Returns”this