Timeline Studio API Documentation - v0.26.0
Preparing search index...
features/media/hooks/use-media-preview
useMediaPreview
Function useMediaPreview
useMediaPreview
(
options
?:
UseMediaPreviewOptions
,
)
:
{
clearPreviewData
:
(
fileId
:
string
)
=>
Promise
<
boolean
>
;
error
:
string
;
generateThumbnail
:
(
fileId
:
string
,
filePath
:
string
,
width
:
number
,
height
:
number
,
timestamp
?:
number
,
)
=>
Promise
<
ThumbnailData
>
;
getAllFilesWithPreviews
:
()
=>
Promise
<
string
[]
>
;
getFilesWithPreviews
:
()
=>
Promise
<
string
[]
>
;
getPreviewData
:
(
fileId
:
string
)
=>
Promise
<
MediaPreviewData
>
;
getTimelineFrames
:
(
fileId
:
string
,
)
=>
Promise
<
{
base64_data
:
string
;
is_keyframe
:
boolean
;
timestamp
:
number
}
[]
,
>
;
isGenerating
:
boolean
;
loadPreviewData
:
(
path
:
string
)
=>
Promise
<
boolean
>
;
savePreviewData
:
(
path
:
string
)
=>
Promise
<
boolean
>
;
saveTimelineFrames
:
(
fileId
:
string
,
frames
:
{
base64_data
:
string
;
is_keyframe
:
boolean
;
timestamp
:
number
}
[]
,
)
=>
Promise
<
boolean
>
;
}
Parameters
options
:
UseMediaPreviewOptions
= {}
Returns
{
clearPreviewData
:
(
fileId
:
string
)
=>
Promise
<
boolean
>
;
error
:
string
;
generateThumbnail
:
(
fileId
:
string
,
filePath
:
string
,
width
:
number
,
height
:
number
,
timestamp
?:
number
,
)
=>
Promise
<
ThumbnailData
>
;
getAllFilesWithPreviews
:
()
=>
Promise
<
string
[]
>
;
getFilesWithPreviews
:
()
=>
Promise
<
string
[]
>
;
getPreviewData
:
(
fileId
:
string
)
=>
Promise
<
MediaPreviewData
>
;
getTimelineFrames
:
(
fileId
:
string
,
)
=>
Promise
<
{
base64_data
:
string
;
is_keyframe
:
boolean
;
timestamp
:
number
}
[]
,
>
;
isGenerating
:
boolean
;
loadPreviewData
:
(
path
:
string
)
=>
Promise
<
boolean
>
;
savePreviewData
:
(
path
:
string
)
=>
Promise
<
boolean
>
;
saveTimelineFrames
:
(
fileId
:
string
,
frames
:
{
base64_data
:
string
;
is_keyframe
:
boolean
;
timestamp
:
number
}
[]
,
)
=>
Promise
<
boolean
>
;
}
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
Timeline Studio API Documentation - v0.26.0
Loading...