VidStudio SDK reference
Preparing search index...
@vidstudio/engine
ProjectRepository
Interface ProjectRepository
interface
ProjectRepository
{
create
(
name
:
string
,
options
?:
CreateProjectOptions
)
:
Promise
<
Project
>
;
delete
(
id
:
string
)
:
Promise
<
void
>
;
getAll
()
:
Promise
<
Project
[]
>
;
getById
(
id
:
string
)
:
Promise
<
Project
|
undefined
>
;
update
(
id
:
string
,
changes
:
Partial
<
Pick
<
Project
,
|
"name"
|
"canvas_width"
|
"canvas_height"
|
"frame_rate"
|
"work_area"
|
"loop_playback"
|
"stacking_version"
,
>
,
>
,
)
:
Promise
<
Project
>
;
}
Index
Methods
create
delete
get
All
get
By
Id
update
Methods
create
create
(
name
:
string
,
options
?:
CreateProjectOptions
)
:
Promise
<
Project
>
Parameters
name
:
string
options
:
CreateProjectOptions
= {}
Returns
Promise
<
Project
>
delete
delete
(
id
:
string
)
:
Promise
<
void
>
Parameters
id
:
string
Returns
Promise
<
void
>
get
All
getAll
()
:
Promise
<
Project
[]
>
Returns
Promise
<
Project
[]
>
get
By
Id
getById
(
id
:
string
)
:
Promise
<
Project
|
undefined
>
Parameters
id
:
string
Returns
Promise
<
Project
|
undefined
>
update
update
(
id
:
string
,
changes
:
Partial
<
Pick
<
Project
,
|
"name"
|
"canvas_width"
|
"canvas_height"
|
"frame_rate"
|
"work_area"
|
"loop_playback"
|
"stacking_version"
,
>
,
>
,
)
:
Promise
<
Project
>
Parameters
id
:
string
changes
:
Partial
<
Pick
<
Project
,
|
"name"
|
"canvas_width"
|
"canvas_height"
|
"frame_rate"
|
"work_area"
|
"loop_playback"
|
"stacking_version"
,
>
,
>
Returns
Promise
<
Project
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
create
delete
get
All
get
By
Id
update
VidStudio SDK reference
Loading...