@rendley/sdk - v1.12.6
Preparing search index...
SubtitlesManager
Class SubtitlesManager
Index
Constructors
constructor
Methods
convert
SRT
To
Subtitles
destroy
extract
Subtitles
From
Video
get
Display
Container
get
Highlight
Animation
get
Highlight
Text
Style
get
Main
Text
Container
get
Main
Text
Style
get
Position
get
Scale
get
Text
Mode
hit
Test
init
on
View
Resize
serialize
set
Highlight
Animation
set
Highlighted
Text
Style
set
Main
Text
Style
set
Position
set
Scale
set
Text
Mode
update
update
Subtitles
Clips
deserialize
Constructors
constructor
new
SubtitlesManager
()
:
SubtitlesManager
Returns
SubtitlesManager
Methods
convert
SRT
To
Subtitles
convertSRTToSubtitles
(
srt
:
string
)
:
Subtitles
Parameters
srt
:
string
Returns
Subtitles
destroy
destroy
()
:
void
Returns
void
extract
Subtitles
From
Video
extractSubtitlesFromVideo
(
mediaDataId
:
string
)
:
Promise
<
string
>
|
""
Parameters
mediaDataId
:
string
Returns
Promise
<
string
>
|
""
get
Display
Container
getDisplayContainer
()
:
Container
<
DisplayObject
>
Returns
Container
<
DisplayObject
>
get
Highlight
Animation
getHighlightAnimation
()
:
HighlightAnimationEnum
Returns
HighlightAnimationEnum
get
Highlight
Text
Style
getHighlightTextStyle
()
:
{
backgroundColor
:
string
;
backgroundCornerRadius
:
number
;
backgroundPadding
:
number
;
color
:
string
;
fontFamily
:
string
;
fontSize
:
number
;
fontStyle
:
"normal"
|
"italic"
|
"oblique"
;
fontWeight
:
|
"normal"
|
"bold"
|
"bolder"
|
"lighter"
|
"100"
|
"200"
|
"300"
|
"400"
|
"500"
|
"600"
|
"700"
|
"800"
|
"900"
;
padding
:
number
;
strokeColor
:
string
;
strokeThickness
:
number
;
}
Returns
{
backgroundColor
:
string
;
backgroundCornerRadius
:
number
;
backgroundPadding
:
number
;
color
:
string
;
fontFamily
:
string
;
fontSize
:
number
;
fontStyle
:
"normal"
|
"italic"
|
"oblique"
;
fontWeight
:
|
"normal"
|
"bold"
|
"bolder"
|
"lighter"
|
"100"
|
"200"
|
"300"
|
"400"
|
"500"
|
"600"
|
"700"
|
"800"
|
"900"
;
padding
:
number
;
strokeColor
:
string
;
strokeThickness
:
number
;
}
get
Main
Text
Container
getMainTextContainer
()
:
Text
Returns
Text
get
Main
Text
Style
getMainTextStyle
()
:
{
backgroundColor
:
string
;
backgroundCornerRadius
:
number
;
backgroundPadding
:
number
;
color
:
string
;
fontFamily
:
string
;
fontSize
:
number
;
fontStyle
:
"normal"
|
"italic"
|
"oblique"
;
fontWeight
:
|
"normal"
|
"bold"
|
"bolder"
|
"lighter"
|
"100"
|
"200"
|
"300"
|
"400"
|
"500"
|
"600"
|
"700"
|
"800"
|
"900"
;
leading
:
number
;
padding
:
number
;
strokeColor
:
string
;
strokeThickness
:
number
;
wordWrap
:
boolean
;
wordWrapWidth
:
number
;
}
Returns
{
backgroundColor
:
string
;
backgroundCornerRadius
:
number
;
backgroundPadding
:
number
;
color
:
string
;
fontFamily
:
string
;
fontSize
:
number
;
fontStyle
:
"normal"
|
"italic"
|
"oblique"
;
fontWeight
:
|
"normal"
|
"bold"
|
"bolder"
|
"lighter"
|
"100"
|
"200"
|
"300"
|
"400"
|
"500"
|
"600"
|
"700"
|
"800"
|
"900"
;
leading
:
number
;
padding
:
number
;
strokeColor
:
string
;
strokeThickness
:
number
;
wordWrap
:
boolean
;
wordWrapWidth
:
number
;
}
get
Position
getPosition
()
:
number
[]
Returns
number
[]
get
Scale
getScale
()
:
number
Returns
number
get
Text
Mode
getTextMode
()
:
"partial"
|
"full"
Returns
"partial"
|
"full"
hit
Test
hitTest
(
point
:
{
cursorX
:
number
;
cursorY
:
number
}
)
:
boolean
Parameters
point
:
{
cursorX
:
number
;
cursorY
:
number
}
Returns
boolean
init
init
()
:
void
Returns
void
on
View
Resize
onViewResize
(
oldWidth
:
number
,
oldHeight
:
number
,
newWidth
:
number
,
newHeight
:
number
,
)
:
void
Parameters
oldWidth
:
number
oldHeight
:
number
newWidth
:
number
newHeight
:
number
Returns
void
serialize
serialize
()
:
{
highlightAnimation
:
HighlightAnimationEnum
;
highlightAnimationSpeed
:
number
;
highlightTextStyle
:
{
backgroundColor
:
string
;
backgroundCornerRadius
:
number
;
backgroundPadding
:
number
;
color
:
string
;
fontFamily
:
string
;
fontSize
:
number
;
fontStyle
:
"normal"
|
"italic"
|
"oblique"
;
fontWeight
:
|
"normal"
|
"bold"
|
"bolder"
|
"lighter"
|
"100"
|
"200"
|
"300"
|
"400"
|
"500"
|
"600"
|
"700"
|
"800"
|
"900"
;
padding
:
number
;
strokeColor
:
string
;
strokeThickness
:
number
;
}
;
mainTextStyle
:
{
backgroundColor
:
string
;
backgroundCornerRadius
:
number
;
backgroundPadding
:
number
;
color
:
string
;
fontFamily
:
string
;
fontSize
:
number
;
fontStyle
:
"normal"
|
"italic"
|
"oblique"
;
fontWeight
:
|
"normal"
|
"bold"
|
"bolder"
|
"lighter"
|
"100"
|
"200"
|
"300"
|
"400"
|
"500"
|
"600"
|
"700"
|
"800"
|
"900"
;
leading
:
number
;
padding
:
number
;
strokeColor
:
string
;
strokeThickness
:
number
;
wordWrap
:
boolean
;
wordWrapWidth
:
number
;
}
;
position
?:
[
number
,
number
]
;
scale
:
number
;
textMode
:
"partial"
|
"full"
;
}
Returns
{
highlightAnimation
:
HighlightAnimationEnum
;
highlightAnimationSpeed
:
number
;
highlightTextStyle
:
{
backgroundColor
:
string
;
backgroundCornerRadius
:
number
;
backgroundPadding
:
number
;
color
:
string
;
fontFamily
:
string
;
fontSize
:
number
;
fontStyle
:
"normal"
|
"italic"
|
"oblique"
;
fontWeight
:
|
"normal"
|
"bold"
|
"bolder"
|
"lighter"
|
"100"
|
"200"
|
"300"
|
"400"
|
"500"
|
"600"
|
"700"
|
"800"
|
"900"
;
padding
:
number
;
strokeColor
:
string
;
strokeThickness
:
number
;
}
;
mainTextStyle
:
{
backgroundColor
:
string
;
backgroundCornerRadius
:
number
;
backgroundPadding
:
number
;
color
:
string
;
fontFamily
:
string
;
fontSize
:
number
;
fontStyle
:
"normal"
|
"italic"
|
"oblique"
;
fontWeight
:
|
"normal"
|
"bold"
|
"bolder"
|
"lighter"
|
"100"
|
"200"
|
"300"
|
"400"
|
"500"
|
"600"
|
"700"
|
"800"
|
"900"
;
leading
:
number
;
padding
:
number
;
strokeColor
:
string
;
strokeThickness
:
number
;
wordWrap
:
boolean
;
wordWrapWidth
:
number
;
}
;
position
?:
[
number
,
number
]
;
scale
:
number
;
textMode
:
"partial"
|
"full"
;
}
set
Highlight
Animation
setHighlightAnimation
(
animation
:
HighlightAnimationEnum
,
speedMultiplier
?:
number
,
)
:
void
Parameters
animation
:
HighlightAnimationEnum
speedMultiplier
:
number
= 1
Returns
void
set
Highlighted
Text
Style
setHighlightedTextStyle
(
style
:
Partial
<
HighlightTextStyle
>
,
reset
?:
boolean
,
)
:
void
Parameters
style
:
Partial
<
HighlightTextStyle
>
reset
:
boolean
= false
Returns
void
set
Main
Text
Style
setMainTextStyle
(
style
:
Partial
<
MainTextStyle
>
,
reset
?:
boolean
)
:
void
Parameters
style
:
Partial
<
MainTextStyle
>
reset
:
boolean
= false
Returns
void
set
Position
setPosition
(
x
:
number
,
y
:
number
)
:
void
Parameters
x
:
number
y
:
number
Returns
void
set
Scale
setScale
(
scale
:
number
)
:
void
Parameters
scale
:
number
Returns
void
set
Text
Mode
setTextMode
(
mode
:
"partial"
|
"full"
)
:
void
Parameters
mode
:
"partial"
|
"full"
Returns
void
update
update
(
currentTime
:
number
)
:
void
Parameters
currentTime
:
number
Returns
void
update
Subtitles
Clips
updateSubtitlesClips
(
subtitleId
:
string
)
:
void
Parameters
subtitleId
:
string
Returns
void
Static
deserialize
deserialize
(
data
:
object
)
:
SubtitlesManager
Parameters
data
:
object
Returns
SubtitlesManager
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
convert
SRT
To
Subtitles
destroy
extract
Subtitles
From
Video
get
Display
Container
get
Highlight
Animation
get
Highlight
Text
Style
get
Main
Text
Container
get
Main
Text
Style
get
Position
get
Scale
get
Text
Mode
hit
Test
init
on
View
Resize
serialize
set
Highlight
Animation
set
Highlighted
Text
Style
set
Main
Text
Style
set
Position
set
Scale
set
Text
Mode
update
update
Subtitles
Clips
deserialize
@rendley/sdk - v1.12.6
Loading...