NAME

HTML::Object::DOM::Element::Media - HTML Object DOM Media Class

SYNOPSIS

use HTML::Object::DOM::Element::Media;
my $media = HTML::Object::DOM::Element::Media->new || 
    die( HTML::Object::DOM::Element::Media->error, "\n" );

VERSION

v0.2.0

DESCRIPTION

This interface adds to HTML::Object::DOM::Element the properties and methods needed to support basic media-related capabilities that are common to audio and video.

INHERITANCE

+-----------------------+     +---------------------------+     +-------------------------+     +----------------------------+     +-----------------------------------+
| HTML::Object::Element | --> | HTML::Object::EventTarget | --> | HTML::Object::DOM::Node | --> | HTML::Object::DOM::Element | --> | HTML::Object::DOM::Element::Media |
+-----------------------+     +---------------------------+     +-------------------------+     +----------------------------+     +-----------------------------------+

PROPERTIES

Inherits properties from its parent HTML::Object::DOM::Element

audioTracks

A AudioTrackList that lists the AudioTrack objects contained in the element.

Example:

my $video = $doc->getElementById("video");

for( my $i = 0; $i < $video->audioTracks->length; $i += 1 )
{
    $video->audioTracks->[$i]->enabled = 0; # false
}

See also Mozilla documentation

autoplay

A boolean value that reflects the autoplay HTML attribute, indicating whether playback should automatically begin as soon as enough media is available to do so without interruption.

Note: Automatically playing audio when the user does not expect or desire it is a poor user experience and should be avoided in most cases, though there are exceptions. See the Mozilla Autoplay guide for media and Web Audio APIs for more information. Keep in mind that browsers may ignore autoplay requests, so you should ensure that your code is not dependent on autoplay working.

Example:

<video id="video" autoplay="" controls>
    <source src="https://player.vimeo.com/external/250688977.sd.mp4?s=d14b1f1a971dde13c79d6e436b88a6a928dfe26b&profile_id=165">
</video>

# *** Disable autoplay (recommended) ***
# false is the default value
$doc->querySelector('#video')->autoplay = 0; # false
# <video id="video" controls>

See also Mozilla documentation

buffered

This returns undef under perl.

Normally, under JavaScript, this returns a TimeRanges object that indicates the ranges of the media source that the browser has buffered (if any) at the moment the buffered property is accessed.

See also Mozilla documentation

controller

This returns undef under perl.

Normally, under JavaScript, this returns a MediaController object that represents the media controller assigned to the element, or undef if none is assigned.

See also Mozilla documentation

controls

Is a boolean that reflects the controls HTML attribute, indicating whether user interface items for controlling the resource should be displayed.

Example:

my $obj = $doc->createElement('video');
$obj->controls = 1; # true

See also Mozilla documentation

controlsList

Returns a HTML::Object::TokenList that helps the user agent select what controls to show on the media element whenever the user agent shows its own set of controls. The HTML::Object::TokenList takes one or more of three possible values: nodownload, nofullscreen, and noremoteplayback.

Example:

To disable the dowload button for HTML5 audio and video player:

<audio controls controlsList="nodownload"><source src="song.mp3" type="audio/mpeg"></audio>

<video controls controlsList="nodownload"><source src="video.mp4" type="video/mp4"></video>

Another example:

<video controls controlsList="nofullscreen nodownload noremoteplayback"></video>

Using code:

my $video = $doc->querySelector('video');
$video->controls; # true
$video->controlsList; # ["nofullscreen", "nodownload", "noremoteplayback"]
$video->controlsList->remove('noremoteplayback');
$video->controlsList; # ["nofullscreen", "nodownload"]
$video->getAttribute('controlsList'); # "nofullscreen nodownload"

# Actually, under perl, 'supports' always returns true
$video->controlsList->supports('foo'); # false
$video->controlsList->supports('noremoteplayback'); # true

crossOrigin

A string indicating the CORS setting for this media element.

See also Mozilla documentation

currentSrc

Returns a string with the absolute URL of the chosen media resource.

Example:

my $obj = $doc->createElement('video');
say($obj->currentSrc); # ""

See also Mozilla documentation

currentTime

This returns whatever number you set it to under perl, as a Module::Generic::Number object.

Normally, under JavaScript, this returns a double-precision floating-point value indicating the current playback time in seconds; if the media has not started to play and has not been seeked, this value is the media's initial playback time. Setting this value seeks the media to the new time. The time is specified relative to the media's timeline.

Example:

my $video = $doc->createElement('$video');
say( $video->currentTime );
$vide->currentTime = 35;

See also Mozilla documentation

defaultMuted

A Boolean that reflects the muted HTML attribute, which indicates whether the media element's audio output should be muted by default.

Example:

my $video = $doc->createElement('video');
$video->defaultMuted = 1; # true
say( $video->outerHTML ); # <video muted=""></video>

See also Mozilla documentation

defaultPlaybackRate

This returns whatever number you set it to under perl, as a Module::Generic::Number object.

Normally, under JavaScript, this returns a double indicating the default playback rate for the media.

Example:

my $obj = $doc->createElement('video');
say($obj->defaultPlaybackRate); # 1

See also Mozilla documentation

disableRemotePlayback

A boolean that sets or returns the remote playback state of the HTML attribute, indicating whether the media element is allowed to have a remote playback UI.

Example:

my $obj = $doc->createElement('audio');
# <audio></audio>
$obj->disableRemotePlayback = 1; # true
# <audio disableremoteplayback=""></audio>

See also Mozilla documentation

duration

This returns whatever number you set it to under perl, as a Module::Generic::Number object.

Normally, under JavaScript, this returns a read-only double-precision floating-point value indicating the total duration of the media in seconds. If no media data is available, the returned value is NaN. If the media is of indefinite length (such as streamed live media, a WebRTC call's media, or similar), the value is +Infinity.

Example:

my $obj = $doc->createElement('video');
say( $obj->duration ); # NaN

See also Mozilla documentation

ended

Returns a Boolean that indicates whether the media element has finished playing.

Example:

my $obj = $doc->createElement('video');
say($obj->ended); # false

See also Mozilla documentation

error

Read-only.

This returns a HTML::Object::MediaError object for the most recent error, or undef if there has not been an error.

Example:

my $video = $doc->createElement('video');
$video->onerror = sub
{
    say( "Error " . $video->error->code . "; details: " . $video->error->message );
}
$video->src = 'https://example.org/badvideo.mp4';

See also Mozilla documentation

loop

A Boolean that reflects the loop HTML attribute, which indicates whether the media element should start over when it reaches the end.

Example:

my $obj = $doc->createElement('video');
$obj->loop = 1; # true

See also Mozilla documentation

mediaKeys

This always returns undef under perl.

Normally, under JavaScript, this returns a MediaKeys object or undef. MediaKeys is a set of keys that an associated HTML::Object::DOM::Element::Media can use for decryption of media data during playback.

See also Mozilla documentation

muted

Is a boolean that determines whether audio is muted. true if the audio is muted and false otherwise. This does not affect the DOM.

Example:

my $obj = $doc->createElement('video');
say( $obj->muted ); # false

See also Mozilla documentation

networkState

Set or get an integer (enumeration) indicating the current state of fetching the media over the network.

Example:

<audio id="example" preload="auto">
    <source src="sound.ogg" type="audio/ogg" />
</audio>

# Export constants
use HTML::Object::DOM::Element::Media qw( :all );
my $obj = $doc->getElementById('example');
$obj->addEventListener( playing => sub
{
    if( $obj->networkState == NETWORK_LOADING )
    {
        # Still loading...
    }
});

See "CONSTANTS" below for the constants that can be exported and used.

See also Mozilla documentation

paused

Returns a boolean that indicates whether the media element is paused. This is set to true if you use the "pause" method and set to false when you use the "play" method.

Example:

my $obj = $doc->createElement('video');
say( $obj->paused ); # true

See also Mozilla documentation

playbackRate

This only sets or gets a number under perl environment.

Normally, under JavaScript, this is a double that indicates the rate at which the media is being played back.

Example:

my $obj = $doc->createElement('video');
say( $obj->playbackRate ); # Expected Output: 1

See also Mozilla documentation

played

This always returns undef under perl.

Normally, under JavaScript, this returns a TimeRanges object that contains the ranges of the media source that the browser has played, if any.

See also Mozilla documentation

preload

Is a string that reflects the preload HTML attribute, indicating what data should be preloaded, if any. Possible values are: none, metadata, auto.

See also Mozilla documentation

preservesPitch

Under perl environment, this is just a boolean value you can set or get.

Under JavaScript environment, this is a boolean that determines if the pitch of the sound will be preserved. If set to false, the pitch will adjust to the speed of the audio. This is implemented with prefixes in Firefox (mozPreservesPitch) and WebKit (webkitPreservesPitch).

See also Mozilla documentation

readyState

Set or get an integer (enumeration) indicating the readiness state of the media.

Example:

<audio id="example" preload="auto">
    <source src="sound.ogg" type="audio/ogg" />
</audio>

use HTML::Object::DOM::Element::Media qw( :all );
my $obj = $doc->getElementById('example');
$obj->addEventListener( loadeddata => sub
{
    if( $obj->readyState >= NETWORK_LOADING )
    {
        $obj->play();
    }
});

See "CONSTANTS" for the constants that can be exported and used.

See also Mozilla documentation

seekable

This always returns undef under perl.

Normally, under JavaScript, this returns a TimeRanges object that contains the time ranges that the user is able to seek to, if any.

See also Mozilla documentation

seeking

Under perl environment, this is just a boolean value you can set or get.

Under JavaScript environment, this is a boolean that indicates whether the media is in the process of seeking to a new position.

See also Mozilla documentation

sinkId

This returns undef by default under perl. You can set a value using "setSinkId".

Normally, under JavaScript, this returns a string that is the unique ID of the audio device delivering output, or an empty string if it is using the user agent default. This ID should be one of the MediaDeviceInfo.deviceid values returned from MediaDevices.enumerateDevices(), id-multimedia, or id-communications.

See also Mozilla documentation

src

Is a string that reflects the src HTML attribute, which contains the URL of a media resource to use.

Example:

my $obj = $doc->createElement('video');
say( $obj->src ); # ""

See also Mozilla documentation

srcObject

This always returns undef under perl.

Normally, under JavaScript, this is a MediaStream representing the media to play or that has played in the current HTML::Object::DOM::Element::Media, or undef if not assigned.

See also Mozilla documentation

textTracks

Read-only.

Returns the list of TextTrack objects contained in the element.

Example:

<video controls poster="/images/sample.gif">
    <source src="sample.mp4" type="video/mp4">
    <source src="sample.ogv" type="video/ogv">
    <track kind="captions" src="sampleCaptions.vtt" srclang="en">
    <track kind="descriptions" src="sampleDescriptions.vtt" srclang="en">
    <track kind="chapters" src="sampleChapters.vtt" srclang="en">
    <track kind="subtitles" src="sampleSubtitles_de.vtt" srclang="de">
    <track kind="subtitles" src="sampleSubtitles_en.vtt" srclang="en">
    <track kind="subtitles" src="sampleSubtitles_ja.vtt" srclang="ja">
    <track kind="subtitles" src="sampleSubtitles_oz.vtt" srclang="oz">
    <track kind="metadata" src="keyStage1.vtt" srclang="en" label="Key Stage 1">
    <track kind="metadata" src="keyStage2.vtt" srclang="en" label="Key Stage 2">
    <track kind="metadata" src="keyStage3.vtt" srclang="en" label="Key Stage 3">
</video>

my $tracks = $doc->querySelector('video')->textTracks;

# $tracks->length == 10
for( my $i = 0, $L = $tracks->length; $i < $L; $i++ )
{
    if( $tracks->[$i]->language eq 'en' )
    {
        say( $tracks->[$i] );
    }
}

See also Mozilla documentation

videoTracks

Read-only.

Returns the list of VideoTrack objects contained in the element.

See also Mozilla documentation

volume

Is a double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).

See also Mozilla documentation

METHODS

Inherits methods from its parent HTML::Object::DOM::Element

addTextTrack

Adds a text track (such as a track for subtitles) to a media element.

This takes a track kind, label and language and returns a new HTML::Object::DOM::TextTrack object.

Possible values for kind are:

caption
chapters
descriptions
metadata
subtitles

label is a string specifying the label for the text track. Is used to identify the text track for the users.

language in iso 639 format (e.g. en-US or ja-JP).

See also Mozilla documentation

canPlayType

This always returns undef under perl.

Normally, under JavaScript, given a string specifying a MIME media type (potentially with the codecs parameter included), canPlayType() returns the string probably if the media should be playable, maybe if there's not enough information to determine whether the media will play or not, or an empty string if the media cannot be played.

Example:

my $obj = $doc->createElement('video');
say( $obj->canPlayType('video/mp4') ); # "maybe"

See also Mozilla documentation

captureStream

This always returns undef under perl.

Normally, under JavaScript, this returns MediaStream, captures a stream of the media content.

Example:

$doc->querySelector('.playAndRecord')->addEventListener( click => sub
{
    my $playbackElement = $doc->getElementById("playback");
    my $captureStream = $playbackElement->captureStream();
    $playbackElement->play();
});

See also Mozilla documentation

fastSeek

This always returns undef under perl.

Normally, under JavaScript, this quickly seeks to the given time with low precision.

Example:

my $myVideo = $doc->getElementById("myVideoElement");

$myVideo->fastSeek(20);

See also Mozilla documentation

load

This always returns undef under perl.

Normally, under JavaScript, this resets the media to the beginning and selects the best available source from the sources provided using the src attribute or the <source> element.

Example:

my $mediaElem = $doc->querySelector("video");
$mediaElem->load();

See also Mozilla documentation

pause

Under perl, this does not do anything particular except setting the "paused" boolean value to true.

Pauses the media playback.

See also Mozilla documentation

play

This does not do anything in particular under perl, except setting the paused boolean value to false.

Normally, under JavaScript, this begins playback of the media.

Example:

use Nice::Try;
my $videoElem = $doc->getElementById( 'video' );
my $playButton = $doc->getElementById( 'playbutton' );

$playButton->addEventListener( 'click', \&handlePlayButton, { capture => 0 });
playVideo();

sub playVideo
{
    try
    {
        $videoElem->play();
        $playButton->classList->add( 'playing' );
    }
    catch($err)
    {
        $playButton->classList->remove( 'playing' );
    }
}

sub handlePlayButton
{
    if( $videoElem->paused )
    {
        playVideo();
    }
    else
    {
        $videoElem->pause();
        $playButton->classList->remove( 'playing' );
    }
}

See also Mozilla documentation

removeTextTrack

Provided with a HTML::Object::DOM::TextTrack object and this will remove it.

It returns the HTML::Object::DOM::TextTrack object upon success, or if it cannot be found, it returns undef

seekToNextFrame

This always returns undef under perl.

Normally, under JavaScript, this seeks to the next frame in the media. This non-standard, experimental method makes it possible to manually drive reading and rendering of media at a custom speed, or to move through the media frame-by-frame to perform filtering or other operations.

See also Mozilla documentation

setMediaKeys

This always returns undef under perl.

Normally, under JavaScript, this returns Promise. Sets the MediaKeys keys to use when decrypting media during playback.

See also Mozilla documentation

setSinkId

This does not do anything particular under perl, except setting the value of "sinkid".

Normally, under JavaScript, this sets the ID of the audio device to use for output and returns a Promise. This only works when the application is authorized to use the specified device.

See also Mozilla documentation

EVENTS

abort

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when the resource was not fully loaded, but not as the result of an error.

Example:

my $video = $doc->querySelector('video');
my $videoSrc = 'https://example.org/path/to/video.webm';

$video->addEventListener( abort => sub
{
    say( "Abort loading: ", $videoSrc );
});

my $source = $doc->createElement('source');
$source->setAttribute( src => $videoSrc );
$source->setAttribute( type => 'video/webm' );

$video->appendChild( $source );

See also Mozilla documentation

canplay

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when the user agent can play the media, but estimates that not enough data has been loaded to play the media up to its end without having to stop for further buffering of content

Example:

my $video = $doc->querySelector( 'video' );

$video->addEventListener( canplay => sub
{
    my $event = shift( @_ );
    say( 'Video can start, but not sure it will play through.' );
});

my $video = $doc->querySelector( 'video' );
$video->oncanplay = sub
{
    my $event = shift( @_ );
    say( 'Video can start, but not sure it will play through.' );
};

See also Mozilla documentation

canplaythrough

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when the user agent can play the media, and estimates that enough data has been loaded to play the media up to its end without having to stop for further buffering of content.

Example:

my $video = $doc->querySelector( 'video' );

$video->addEventListener( canplaythrough => sub
{
    my $event = shift( @_ );
    say( "I think I can play through the entire video without ever having to stop to buffer." );
});

my $video = $doc->querySelector( 'video' );

$video->oncanplaythrough = sub
{
    my $event = shift( @_ );
    say( "I think I can play through the entire video without ever having to stop to buffer." );
};

See also Mozilla documentation

durationchange

This is fired when the duration property has been updated.

Example:

my $video = $doc->querySelector('video');
$video->addEventListener( durationchange => sub
{
    say( 'Not sure why, but the duration of the $video has changed.' );
});

my $video = $doc->querySelector('video');

$video->ondurationchange = sub
{
    say( 'Not sure why, but the duration of the video has changed.' );
};

See also Mozilla documentation

emptied

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when the media has become empty; for example, when the media has already been loaded (or partially loaded), and the "load" in HTML::Object::DOM::Element::Media method is called to reload it.

Example:

my $video = $doc->querySelector('video');

$video->addEventListener( emptied => sub
{
    say( 'Uh oh. The media is empty. Did you call load()?' );
});

my $video = $doc->querySelector('video');

$video->onemptied = sub
{
    say( 'Uh oh. The media is empty. Did you call load()?' );
};

See also Mozilla documentation

ended

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when playback stops when end of the media (<audio> or <video>) is reached or because no further data is available.

Example:

my $obj = $doc->createElement('video');
say( $obj->ended ); # false

See also Mozilla documentation

error

Fired when the resource could not be loaded due to an error.

Example:

my $videoElement = $doc->createElement( 'video' );
$videoElement->onerror = sub
{
    say( "Error " . $videoElement->error->code . "; details: " . $videoElement->error->message );
}
$videoElement->src = "https://example.org/bogusvideo.mp4";

See also Mozilla documentation

loadeddata

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when the first frame of the media has finished loading.

Example:

my $video = $doc->querySelector('video');

$video->addEventListener( loadeddata => sub
{
    say( 'Yay! The readyState just increased to HAVE_CURRENT_DATA or greater for the first time.' );
});

my $video = $doc->querySelector('video');

$video->onloadeddata = sub
{
    say( 'Yay! The readyState just increased to HAVE_CURRENT_DATA or greater for the first time.' );
};

See also Mozilla documentation

loadedmetadata

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when the metadata has been loaded

Example:

my $video = $doc->querySelector('video');

$video->addEventListener( loadedmetadata => sub
{
    say( 'The duration and dimensions of the media and tracks are now known.' );
});

my $video = $doc->querySelector('video');

$video->onloadedmetadata = sub
{
    say( 'The duration and dimensions of the media and tracks are now known.' );
};

See also Mozilla documentation

loadstart

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when the browser has started to load a resource.

Example:

<div class="example">
    <button type="button">Load video</button>
    <video controls width="250"></video>

    <div class="event-log">
        <label>Event log:</label>
        <textarea readonly class="event-log-contents"></textarea>
    </div>
</div>

use feature 'signatures';
my $loadVideo = $doc->querySelector('button');
my $video = $doc->querySelector('video');
my $eventLog = $doc->querySelector('.event-log-contents');
my $source;

sub handleEvent( $event )
{
    $eventLog->textContent = $eventLog->textContent . $event->type . "\n";
}

$video->addEventListener( 'loadstart', \&handleEvent);
$video->addEventListener( 'progress', \&handleEvent);
$video->addEventListener( 'canplay', \&handleEvent);
$video->addEventListener( 'canplaythrough', \&handleEvent);

$loadVideo->addEventListener( click => sub
{
    if( $source )
    {
        $doc->location->reload();
    }
    else
    {
        $loadVideo->textContent = "Reset example";
        $source = $doc->createElement( 'source' );
        $source->setAttribute( 'src', 'https://example.org/some/where/media/examples/video.webm' );
        $source->setAttribute( 'type', 'video/webm' );
        $video->appendChild( $source );
    }
});

See also Mozilla documentation

pause

Fired when a request to pause play is handled and the activity has entered its paused state, most commonly occurring when the media's "pause" in HTML::Object::DOM::Element::Media method is called.

See also Mozilla documentation

play

Fired when the paused property is changed from true to false, as a result of the "play" in HTML::Object::DOM::Element::Media method, or the autoplay attribute

Example:

use Nice::Try; # for the try{}catch block
my $videoElem = $doc->getElementById( 'video' );
my $playButton = $doc->getElementById( 'playbutton' );

$playButton->addEventListener( click => \&handlePlayButton, { capture => 0 });
playVideo();

sub playVideo
{
    try {
        $videoElem->play();
        $playButton->classList->add( 'playing' );
    } catch( $err ) {
        $playButton->classList->remove( 'playing' );
    }
}

sub handlePlayButton
{
    if( $videoElem->paused )
    {
        playVideo();
    }
    else
    {
        $videoElem->pause();
        $playButton->classList->remove( 'playing' );
    }
}

See also Mozilla documentation

playing

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when playback is ready to start after having been paused or delayed due to lack of data

Example:

my $video = $doc->querySelector('video');

$video->addEventListener( playing =>sub
{
    say( 'Video is no longer paused' );
});

my $video = $doc->querySelector('video');

$video->onplaying = sub
{
    say( 'Video is no longer paused.' );
};

See also Mozilla documentation

progress

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired periodically as the browser loads a resource.

Example:

<div class="example">
    <button type="button">Load video</button>
    <video controls width="250"></video>

    <div class="event-log">
        <label>Event log:</label>
        <textarea readonly class="event-log-contents"></textarea>
    </div>
</div>

use feature 'signatures';
my $loadVideo = $doc->querySelector('button');
my $video = $doc->querySelector('video');
my $eventLog = $doc->querySelector('.event-log-contents');
my $source;

sub handleEvent( $event )
{
    $eventLog->textContent = $eventLog->textContent . $event->type . "\n";
}

$video->addEventListener( 'loadstart', \&handleEvent );
$video->addEventListener( 'progress', \&handleEvent );
$video->addEventListener( 'canplay', \&handleEvent );
$video->addEventListener( 'canplaythrough', \&handleEvent );

$loadVideo->addEventListener( click => sub
{
    if( $source )
    {
        $doc->location->reload();
    }
    else
    {
        $loadVideo->textContent = "Reset example";
        $source = $doc->createElement('source');
        $source->setAttribute( 'src', 'https://example.org/some/where/video.mp4' );
        $source->setAttribute( 'type', 'video/mp4' );
        $video->appendChild( $source );
    }
});

See also Mozilla documentation

ratechange

This is fired when the playback rate has changed, i.e. when the property "playbackRate" is changed.

Example:

my $video = $doc->querySelector( 'video' );

$video->addEventListener( 'ratechange' => sub
{
    say( 'The playback rate changed.' );
});

my $video = $doc->querySelector('video');

$video->onratechange = sub
{
    say( 'The playback rate changed.' );
};

See also Mozilla documentation

seeked

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when a seek operation completes

Example:

my $video = $doc->querySelector('video');
$video->addEventListener( seeked => sub
{
    say( 'Video found the playback position it was looking for.' );
});
my $video = $doc->querySelector( 'video' );
$video->onseeked = sub
{
    say( 'Video found the playback position it was looking for.' );
};

See also Mozilla documentation

seeking

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when a seek operation begins

Example:

my $video = $doc->querySelector( 'video' );
$video->addEventListener( seeking => sub
{
    say( 'Video is seeking a new position.' );
});
my $video = $doc->querySelector( 'video' );
$video->onseeking = sub
{
    say( 'Video is seeking a new position.' );
};

See also Mozilla documentation

stalled

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when the user agent is trying to fetch media data, but data is unexpectedly not forthcoming.

Example:

my $video = $doc->querySelector('video');

$video->addEventListener( stalled => sub
{
    say( 'Failed to fetch data, but trying.' );
});

my $video = $doc->querySelector('video');

$video->onstalled = sub
{
    say( 'Failed to fetch data, but trying.' );
};

See also Mozilla documentation

suspend

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when the media data loading has been suspended.

Example:

my $video = $doc->querySelector('video');

$video->addEventListener( suspend => sub
{
    say( 'Data loading has been suspended.' );
});

my $video = $doc->querySelector( 'video' );

$video->onsuspend = sub
{
    say( 'Data loading has been suspended.' );
};

See also Mozilla documentation

timeupdate

Fired when the time indicated by the "currentTime" property has been updated.

Example:

my $video = $doc->querySelector('video');

$video->addEventListener( timeupdate => sub
{
    say( 'The currentTime attribute has been updated. Again.' );
});

my $video = $doc->querySelector('video');

$video->ontimeupdate = sub
{
    say( 'The currentTime attribute has been updated. Again.' );
};

See also Mozilla documentation

volumechange

Fired when the volume has changed, i.e. when the value for the "volume" property has changed.

Example:

my $video = $doc->querySelector('video');

$video->addEventListener( volumechange => sub
{
    say( 'The volume changed.' );
});

my $video = $doc->querySelector('video');
$video->onvolumechange = sub
{
    say( 'The volume changed.' );
};

See also Mozilla documentation

waiting

This is not used under perl, but you can trigger that event yourself.

Under JavaScript, this is fired when playback has stopped because of a temporary lack of data.

Example:

my $video = $doc->querySelector('video');

$video->addEventListener( waiting => sub
{
    say( 'Video is waiting for more data.' );
});

my $video = $doc->querySelector('video');
$video->onwaiting = sub
{
    say( 'Video is waiting for more data.' );
};

See also Mozilla documentation

EVENT HANDLERS

onencrypted

Sets the event handler called when the media is encrypted.

See also Mozilla documentation

onwaitingforkey

Sets the event handler called when playback is blocked while waiting for an encryption key.

See also Mozilla documentation

CONSTANTS

The following constants can be exported and used, such as:

use HTML::Object::DOM::Element::Media qw( :all );
# or directly from HTML::Object::DOM
use HTML::Object::DOM qw( :media );

NETWORK_EMPTY (0): There is no data yet. Also, readyState is HAVE_NOTHING.
NETWORK_IDLE (1): Media element is active and has selected a resource, but is not using the network.
NETWORK_LOADING (2): The browser is downloading HTML::Object::DOM::Element::Media data.
NETWORK_NO_SOURCE (3): No HTML::Object::DOM::Element::Media src found.

AUTHOR

Jacques Deguest <jack@deguest.jp>

COPYRIGHT & LICENSE

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

To install HTML::Object, copy and paste the appropriate command in to your terminal.

cpanm

cpanm HTML::Object

CPAN shell

perl -MCPAN -e shell
install HTML::Object

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

VERSION

DESCRIPTION

INHERITANCE

PROPERTIES

audioTracks

autoplay

buffered

controller

controls

controlsList

crossOrigin

currentSrc

currentTime

defaultMuted

defaultPlaybackRate

disableRemotePlayback

duration

ended

error

loop

mediaKeys

muted

networkState

paused

playbackRate

played

preload

preservesPitch

readyState

seekable

seeking

sinkId

src

srcObject

textTracks

videoTracks

volume

METHODS

addTextTrack

canPlayType

captureStream

fastSeek

load

pause

play

removeTextTrack

seekToNextFrame

setMediaKeys

setSinkId

EVENTS

abort

canplay

canplaythrough

durationchange

emptied

ended

error

loadeddata

loadedmetadata

loadstart

pause

play

playing

progress

ratechange

seeked

seeking

stalled

suspend

timeupdate

volumechange

waiting

EVENT HANDLERS

onencrypted

onwaitingforkey

CONSTANTS

AUTHOR

SEE ALSO