@rtorcato/browser-common / htmlmedia
htmlmedia
Functions
playMedia()
playMedia(
media):Promise<void>
Defined in: htmlmedia/index.ts:11
Plays a given HTMLMediaElement (audio or video).
Example
import { playMedia } from '@rtorcato/browser-common/htmlmedia'
await playMedia(audio)
Parameters
media
HTMLMediaElement
The media element to play.
Returns
Promise<void>
A promise that resolves when playback starts.
pauseMedia()
pauseMedia(
media):void
Defined in: htmlmedia/index.ts:24
Pauses a given HTMLMediaElement (audio or video).
Example
import { pauseMedia } from '@rtorcato/browser-common/htmlmedia'
pauseMedia(video)
Parameters
media
HTMLMediaElement
The media element to pause.
Returns
void
setCurrentTime()
setCurrentTime(
media,time):void
Defined in: htmlmedia/index.ts:38
Sets the current playback time of a media element.
Example
import { setCurrentTime } from '@rtorcato/browser-common/htmlmedia'
setCurrentTime(video, 30)
Parameters
media
HTMLMediaElement
The media element.
time
number
The time in seconds to set.
Returns
void
setVolume()
setVolume(
media,volume):void
Defined in: htmlmedia/index.ts:52
Sets the volume of a media element (0.0 to 1.0).
Example
import { setVolume } from '@rtorcato/browser-common/htmlmedia'
setVolume(audio, 0.5)
Parameters
media
HTMLMediaElement
The media element.
volume
number
The volume level.
Returns
void
setMuted()
setMuted(
media,muted):void
Defined in: htmlmedia/index.ts:66
Mutes or unmutes a media element.
Example
import { setMuted } from '@rtorcato/browser-common/htmlmedia'
setMuted(video, true)
Parameters
media
HTMLMediaElement
The media element.
muted
boolean
True to mute, false to unmute.
Returns
void
loadMediaSource()
loadMediaSource(
media,src,autoplay?):void|Promise<void>
Defined in: htmlmedia/index.ts:82
Loads a new source into a media element and optionally plays it.
Example
import { loadMediaSource } from '@rtorcato/browser-common/htmlmedia'
await loadMediaSource(audio, '/song.mp3', true)
Parameters
media
HTMLMediaElement
The media element.
src
string
The source URL.
autoplay?
boolean = false
Whether to play after loading (default: false).
Returns
void | Promise<void>
A promise if autoplay, otherwise void.
onMediaEvent()
onMediaEvent<
K>(media,event,handler): () =>void
Defined in: htmlmedia/index.ts:107
Adds an event listener to a media element and returns a cleanup function.
Example
import { onMediaEvent } from '@rtorcato/browser-common/htmlmedia'
const off = onMediaEvent(video, 'ended', () => console.log('done'))
off()
Type Parameters
K
K extends keyof HTMLMediaElementEventMap
Parameters
media
HTMLMediaElement
The media element.
event
K
The event name.
handler
(this, ev) => unknown
The event handler.
Returns
Cleanup function to remove the listener.
() => void