Hiyve Components - v1.0.0
Preparing search index...
@hiyve/react-media-player
useMediaPlayer
Function useMediaPlayer
useMediaPlayer
(
options
:
UseMediaPlayerOptions
,
)
:
{
audioContextRef
:
MutableRefObject
<
AudioContext
|
null
>
;
destinationStreamRef
:
MutableRefObject
<
MediaStreamAudioDestinationNode
|
null
,
>
;
detectedMediaType
:
"audio"
|
"video"
|
null
;
disableWebAudio
:
boolean
;
gainNodeRef
:
MutableRefObject
<
GainNode
|
null
>
;
isMuted
:
boolean
;
isPlaying
:
boolean
;
loaded
:
boolean
;
mediaRef
:
MutableRefObject
<
HTMLMediaElement
|
null
>
;
pause
:
()
=>
void
;
play
:
()
=>
Promise
<
void
>
;
playbackLength
:
number
;
playbackRate
:
number
;
playbackTime
:
number
;
playerId
:
string
;
rewind
:
()
=>
void
;
seek
:
(
time
:
number
)
=>
void
;
setIsPlaying
:
Dispatch
<
SetStateAction
<
boolean
>
>
;
setLoaded
:
Dispatch
<
SetStateAction
<
boolean
>
>
;
setPlaybackLength
:
Dispatch
<
SetStateAction
<
number
>
>
;
setPlaybackTime
:
Dispatch
<
SetStateAction
<
number
>
>
;
setRate
:
(
rate
:
number
)
=>
void
;
setSkipWaveform
:
Dispatch
<
SetStateAction
<
boolean
>
>
;
skipWaveform
:
boolean
;
toggleMute
:
()
=>
void
;
togglePlayPause
:
()
=>
void
;
}
Parameters
options
:
UseMediaPlayerOptions
Returns
{
audioContextRef
:
MutableRefObject
<
AudioContext
|
null
>
;
destinationStreamRef
:
MutableRefObject
<
MediaStreamAudioDestinationNode
|
null
,
>
;
detectedMediaType
:
"audio"
|
"video"
|
null
;
disableWebAudio
:
boolean
;
gainNodeRef
:
MutableRefObject
<
GainNode
|
null
>
;
isMuted
:
boolean
;
isPlaying
:
boolean
;
loaded
:
boolean
;
mediaRef
:
MutableRefObject
<
HTMLMediaElement
|
null
>
;
pause
:
()
=>
void
;
play
:
()
=>
Promise
<
void
>
;
playbackLength
:
number
;
playbackRate
:
number
;
playbackTime
:
number
;
playerId
:
string
;
rewind
:
()
=>
void
;
seek
:
(
time
:
number
)
=>
void
;
setIsPlaying
:
Dispatch
<
SetStateAction
<
boolean
>
>
;
setLoaded
:
Dispatch
<
SetStateAction
<
boolean
>
>
;
setPlaybackLength
:
Dispatch
<
SetStateAction
<
number
>
>
;
setPlaybackTime
:
Dispatch
<
SetStateAction
<
number
>
>
;
setRate
:
(
rate
:
number
)
=>
void
;
setSkipWaveform
:
Dispatch
<
SetStateAction
<
boolean
>
>
;
skipWaveform
:
boolean
;
toggleMute
:
()
=>
void
;
togglePlayPause
:
()
=>
void
;
}
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
Hiyve Components - v1.0.0
Loading...