video object

This topic has not yet been rated - Rate this topic

Specifies the video content to be played in a document.

HTML5 A vocabulary and associated APIs for HTML and XHTML, Section 4.8.6

DOM Information

Inheritance Hierarchy

 Node
  Element
   HTMLElement
    HTMLMediaElement
      video

Members

The video object has these types of members:

Events

The video object has these events.

EventDescription
canplay

Occurs when playback is possible, but would require further buffering.

canplaythrough

Occurs when playback to end is possible without requiring a stop for further buffering.

durationchange

Occurs when the duration attribute is updated.

emptied

Occurs when the media element is reset to its initial state.

ended

Occurs when the end of playback is reached.

loadeddata

Occurs when media data is loaded at the current playback position.

loadedmetadata

Occurs when the duration and dimensions of the media have been determined.

loadstart

Occurs when Internet Explorer begins looking for media data.

pause

Occurs when playback is paused.

play

Occurs when the play method is requested.

playing

Occurs when the audio or video has started playing.

progress

Occurs to indicate progress while downloading media data.

ratechange

Occurs when the playback rate is increased or decreased.

seeked

Occurs when the seek operation ends.

seeking

Occurs when the current playback position is moved.

stalled

Occurs when the download has stopped.

suspend

Occurs if the load operation has been intentionally halted.

timeupdate

Occurs to indicate the current playback position.

volumechange

Occurs when the volume is changed, or playback is muted or unmuted.

waiting

Occurs when playback stops because the next frame of a video resource is not available.

 

Properties

The video object has these properties.

PropertyDescription

autoplay

Gets or sets a value that indicates whether to start playing the media automatically.

buffered

Gets a collection of buffered time ranges.

controls

Gets or sets a flag that indicates whether the client provides a set of controls for the media (in case the developer does not include controls for the player).

currentSrc

Gets the address or URL of the current media resource (video,audio) that is selected by IHTMLMediaElement.

currentTime

Gets or sets the current playback position, in seconds.

defaultPlaybackRate

Gets or sets the default playback rate when the user is not using fast foward or reverse for a video or audio resource.

duration

Gets the duration, in seconds, of the current media resource, a NaN value if duration is not available, or Infinity if the media resource is streaming.

ended

Gets information about whether the playback has ended or not.

error

Gets an IHTMLMediaError object representing the current error state of the media element.

height

Gets or sets the height of the video element.

initialTime

Gets the earliest possible position, in seconds, that the playback can begin.

loop

Gets or sets a flag that specifies whether playback should restart after it completes.

muted

Gets or sets a flag that indicates whether the audio (either audio or the audio track on video media) is muted.

networkState

Gets the current network activity for the element.

paused

Gets a flag that specifies whether playback is paused.

playbackRate

Gets or sets the current speed for the media resource to play. This speed is expressed as a multiple of the normal speed of the media resource.

played

Gets TimeRanges for the current media resource that has been played.

poster

Gets or sets a URL of an image to display, for example, like a movie poster. This can be a still frame from the video, or another image if no video data is available.

preload

Gets or sets a hint to how much buffering is advisable for a media resource, even if autoplay is not specified.

seekable

Returns a TimeRanges object that represents the ranges of the current media resource that can be seeked.

seeking

Gets a flag that indicates whether the the client is currently moving to a new playback position in the media resource.

src

The address or URL of the a media resource (videoaudio) that is to be considered.

textTracks

Returns a list of TextTrack objects from a video object.

videoHeight

Gets the intrinsic height of a video in CSS pixels, or zero if the dimensions are not known.

videoWidth

Gets the intrinsic width of a video in CSS pixels, or zero if the dimensions are not known.

volume

Gets or sets the volume level for audio portions of the media element.

width

Gets or sets the width of the video element.

 

Standards information

Remarks

Beginning with a Windows Store app using JavaScript, any audio or video content needs the correct mime type set on the server, or the files won't play. a Windows Store app using JavaScript supports MP3 audio, and MP4 audio and video. WebM audio and video files can be supported by installing the WebM components from The WebM project. The following table shows the required settings for your web server to host these files correctly.

Media file to serveExtension settingMime type setting
Audio mp3mp3audio/mpeg
Audio mp4 m4aaudio/mp4
Audio WebMwebmaudio/webm
Video mp4mp4video/mp4
Video webmwebmvideo/webm

 

The following extensions are available to the Video object when used in a Windows Store app built for Windows using JavaScript.

Microsoft ExtensionDescription
msClearEffects Clears all effects from the media pipeline.
msFrameStep Steps the video by one frame forward or one frame backward. Only available on the video object.
msInsertAudioEffect Inserts the specified audio effect into media pipeline.
msInsertVideoEffect Inserts the specified video effect into media pipeline.
msSetMediaProtectionManager Specifies the media protection manager for a given media pipeline.
msSetVideoRectangle Sets the dimensions of a sub-rectangle within a video. Only available on the video object.
msAudioCategory Specifies the purpose the audio or video media, such as background audio or alerts.
msAudioDeviceType Specifies the output devices that the audio will be sent to.
msHorizontalMirror Sets or gets whether a video element is flipped horizontally in the display. Only available on the video object.
msIsLayoutOptimalForPlayback Indicates whether the video can be rendered more efficiently.
msIsStereo3D Determines whether the system considers the video source that is loaded to be stereo 3-D or not. Only available on the video object.
msPlayToDisabled Gets or sets whether the PlayTo device is available.
msPlayToPrimary Gets or sets the primary PlayTo device.
msPlayToSource Gets the source associated with the media element for use by the PlayToManager.
msRealTime Specifies whether or not to enable low-latency playback on the media element.
msStereo3DPackingMode Gets or sets the frame-packing mode for stereo 3-D video content. Only available on the video object.
msStereo3DRenderMode Gets or sets whether the system display is set to stereo display (if stereo-capable). Only available on the video object.
msZoom Gets or sets whether the video frame is trimmed, on the top and bottom or left and right, to fit the video display. Only available on the video object.
onMSVideoFormatChanged Occurs when the video format changes. Only available on the video object.
onMSVideoFrameStepCompleted Occurs when the video frame has been stepped forward or backward one frame. Only available on the video object.
onMSVideoOptimalLayoutChanged Occurs when the msIsLayoutOptimalForPlayback state changes.

 

For information on video formats supported on the Video tag when used in a Windows Store app using JavaScript, see Supported audio and video formats.

To prevent the display from be deactivating when user action is no longer detected, such as when an app is playing video, you can call DisplayRequest.RequestActive. To conserve power and battery life, you should call DisplayRequest.RequestRelease to release the display request when it is no longer required. See the Display power state sample for more info.

For an example of audio and video playback in a Windows Store app using JavaScript, see the HTML media playback sample.

For additional information on creating Windows Store apps using JavaScript, see Roadmap for Windows Store apps using JavaScript.

For additional information on playing audio and video in a Windows Store app using JavaScript, see Adding multimedia. For information on audio and video performance, see Audio and video performance.

See also

How to use HTML5 to play video files on your webpage
HTMLVideoElement

 

 

Build date: 11/28/2012

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.