Timeline Studio API Documentation - v0.26.0
Preparing search index...
features/media/hooks/use-media-processor
useMediaProcessor
Function useMediaProcessor
useMediaProcessor
(
options
?:
UseMediaProcessorOptions
,
)
:
{
cancelProcessing
:
()
=>
Promise
<
void
>
;
clearErrors
:
()
=>
void
;
errors
:
Map
<
string
,
string
>
;
isProcessing
:
boolean
;
processFiles
:
(
filePaths
:
string
[]
)
=>
Promise
<
MediaFile
[]
>
;
processFilesWithThumbnails
:
(
filePaths
:
string
[]
,
width
?:
number
,
height
?:
number
,
)
=>
Promise
<
MediaFile
[]
>
;
progress
:
{
current
:
number
;
total
:
number
}
;
scanFolder
:
(
folderPath
:
string
)
=>
Promise
<
MediaFile
[]
>
;
scanFolderWithThumbnails
:
(
folderPath
:
string
,
width
?:
number
,
height
?:
number
,
)
=>
Promise
<
MediaFile
[]
>
;
}
Parameters
options
:
UseMediaProcessorOptions
= {}
Returns
{
cancelProcessing
:
()
=>
Promise
<
void
>
;
clearErrors
:
()
=>
void
;
errors
:
Map
<
string
,
string
>
;
isProcessing
:
boolean
;
processFiles
:
(
filePaths
:
string
[]
)
=>
Promise
<
MediaFile
[]
>
;
processFilesWithThumbnails
:
(
filePaths
:
string
[]
,
width
?:
number
,
height
?:
number
,
)
=>
Promise
<
MediaFile
[]
>
;
progress
:
{
current
:
number
;
total
:
number
}
;
scanFolder
:
(
folderPath
:
string
)
=>
Promise
<
MediaFile
[]
>
;
scanFolderWithThumbnails
:
(
folderPath
:
string
,
width
?:
number
,
height
?:
number
,
)
=>
Promise
<
MediaFile
[]
>
;
}
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
Timeline Studio API Documentation - v0.26.0
Loading...