Timeline Studio API Documentation - v0.26.0
Preparing search index...
types/video-compiler
TauriCommands
Interface TauriCommands
interface
TauriCommands
{
cancel_render
(
job_id
:
string
)
:
Promise
<
boolean
>
;
check_ffmpeg_capabilities
()
:
Promise
<
FfmpegCapabilities
>
;
check_hardware_acceleration
()
:
Promise
<
boolean
>
;
clear_cache
()
:
Promise
<
void
>
;
clear_preview_cache
()
:
Promise
<
void
>
;
compile_video
(
project
:
ProjectSchema
,
output_path
:
string
)
:
Promise
<
string
>
;
generate_preview
(
project
:
ProjectSchema
,
timestamp
:
number
,
quality
?:
number
,
)
:
Promise
<
Uint8Array
<
ArrayBufferLike
>
>
;
get_active_jobs
()
:
Promise
<
RenderJob
[]
>
;
get_cache_stats
()
:
Promise
<
CacheStats
>
;
get_compiler_settings
()
:
Promise
<
CompilerSettings
>
;
get_current_gpu_info
()
:
Promise
<
GpuInfo
>
;
get_gpu_capabilities_full
()
:
Promise
<
GpuCapabilities
>
;
get_render_progress
(
job_id
:
string
)
:
Promise
<
RenderProgress
>
;
get_system_info
()
:
Promise
<
SystemInfo
>
;
set_ffmpeg_path
(
path
:
string
)
:
Promise
<
boolean
>
;
update_compiler_settings
(
settings
:
CompilerSettings
)
:
Promise
<
void
>
;
}
Index
Methods
cancel_
render
check_
ffmpeg_
capabilities
check_
hardware_
acceleration
clear_
cache
clear_
preview_
cache
compile_
video
generate_
preview
get_
active_
jobs
get_
cache_
stats
get_
compiler_
settings
get_
current_
gpu_
info
get_
gpu_
capabilities_
full
get_
render_
progress
get_
system_
info
set_
ffmpeg_
path
update_
compiler_
settings
Methods
cancel_
render
cancel_render
(
job_id
:
string
)
:
Promise
<
boolean
>
Parameters
job_id
:
string
Returns
Promise
<
boolean
>
check_
ffmpeg_
capabilities
check_ffmpeg_capabilities
()
:
Promise
<
FfmpegCapabilities
>
Returns
Promise
<
FfmpegCapabilities
>
check_
hardware_
acceleration
check_hardware_acceleration
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
clear_
cache
clear_cache
()
:
Promise
<
void
>
Returns
Promise
<
void
>
clear_
preview_
cache
clear_preview_cache
()
:
Promise
<
void
>
Returns
Promise
<
void
>
compile_
video
compile_video
(
project
:
ProjectSchema
,
output_path
:
string
)
:
Promise
<
string
>
Parameters
project
:
ProjectSchema
output_path
:
string
Returns
Promise
<
string
>
generate_
preview
generate_preview
(
project
:
ProjectSchema
,
timestamp
:
number
,
quality
?:
number
,
)
:
Promise
<
Uint8Array
<
ArrayBufferLike
>
>
Parameters
project
:
ProjectSchema
timestamp
:
number
Optional
quality
:
number
Returns
Promise
<
Uint8Array
<
ArrayBufferLike
>
>
get_
active_
jobs
get_active_jobs
()
:
Promise
<
RenderJob
[]
>
Returns
Promise
<
RenderJob
[]
>
get_
cache_
stats
get_cache_stats
()
:
Promise
<
CacheStats
>
Returns
Promise
<
CacheStats
>
get_
compiler_
settings
get_compiler_settings
()
:
Promise
<
CompilerSettings
>
Returns
Promise
<
CompilerSettings
>
get_
current_
gpu_
info
get_current_gpu_info
()
:
Promise
<
GpuInfo
>
Returns
Promise
<
GpuInfo
>
get_
gpu_
capabilities_
full
get_gpu_capabilities_full
()
:
Promise
<
GpuCapabilities
>
Returns
Promise
<
GpuCapabilities
>
get_
render_
progress
get_render_progress
(
job_id
:
string
)
:
Promise
<
RenderProgress
>
Parameters
job_id
:
string
Returns
Promise
<
RenderProgress
>
get_
system_
info
get_system_info
()
:
Promise
<
SystemInfo
>
Returns
Promise
<
SystemInfo
>
set_
ffmpeg_
path
set_ffmpeg_path
(
path
:
string
)
:
Promise
<
boolean
>
Parameters
path
:
string
Returns
Promise
<
boolean
>
update_
compiler_
settings
update_compiler_settings
(
settings
:
CompilerSettings
)
:
Promise
<
void
>
Parameters
settings
:
CompilerSettings
Returns
Promise
<
void
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Methods
cancel_
render
check_
ffmpeg_
capabilities
check_
hardware_
acceleration
clear_
cache
clear_
preview_
cache
compile_
video
generate_
preview
get_
active_
jobs
get_
cache_
stats
get_
compiler_
settings
get_
current_
gpu_
info
get_
gpu_
capabilities_
full
get_
render_
progress
get_
system_
info
set_
ffmpeg_
path
update_
compiler_
settings
Timeline Studio API Documentation - v0.26.0
Loading...