stateString Property
This topic documents a feature of HTML+TIME 2.0, which is obsolete as of Windows Internet Explorer 9.
Gets the current state of the element timeline.
Syntax
[ sState = ] currTimeState.stateString
Possible Values
sState String that receives one of the following values.
unknown
- Timeline is in an unknown state.
active
- Timeline is active.
cueing
- Timeline is cueing the media file.
holding
- Timeline is holding on the current element, waiting for the parent element timeline to end.
inactive
- Timeline is inactive.
The property is read-only. The property has no default value.
Remarks
An element is active when it is in a cueing state or a seeking state. Note that these two states apply only to elements containing media that can be played, such as an audio file or a video file.
Elements with the fill attribute set to
hold
orfreeze
will wait to synchronize with other elements on the page. An element is inactive when it is in a holding state. When an element is inactive, it cannot generate events or respond to events.To get the stateString value as an integer, use the state property.
Example
This example uses the stateString property to get the current state of the element timeline as a string.
<HTML XMLNS:t ="urn:schemas-microsoft-com:time"> <HEAD> <TITLE>stateString Property</TITLE> <?IMPORT namespace="t" implementation="#default#time2"> <SCRIPT> // Update each button based on the current timeline state function updateBtns() { switch (m1.currTimeState.stateString) { case "active": if (m1.currTimeState.isPaused == true) { playBtn.disabled = true; stopBtn.disabled = false; pauseBtn.disabled = true; resumeBtn.disabled = false; } else { playBtn.disabled = true; stopBtn.disabled = false; pauseBtn.disabled = false; resumeBtn.disabled = true; } break; case "inactive": playBtn.disabled = false; stopBtn.disabled = true; pauseBtn.disabled = true; resumeBtn.disabled = true; break; case "holding": playBtn.disabled = false; stopBtn.disabled = true; pauseBtn.disabled = true; resumeBtn.disabled = true; break; } } </SCRIPT> <SCRIPT FOR="document" EVENT="onclick" LANGUAGE="JScript"> updateBtns(); </SCRIPT> <STYLE> .time{ behavior: url(#default#time2);} </STYLE> </HEAD> <BODY onload="updateBtns()"> Click the Current State button at any time to retrieve the string value of the element's current state. To start the movie clip, click the Begin button. <BR><BR> <t:video class="time" id="m1" begin="indefinite" style="position:absolute;top:90px;height:150px;" src="/workshop/samples/author/behaviors/media/movie.avi" fill="remove"/> <SPAN id="stateString1" style="position:absolute;top:255px;"> State: inactive</SPAN> <P style="position:absolute;top:280px;"> <BUTTON id="b1" onclick="stateString1.innerText='State: '+m1.currTimeState.stateString"> Current state </BUTTON> <BUTTON id="playBtn" onclick="m1.beginElement();">Begin</BUTTON> <BUTTON id="pauseBtn" onclick="m1.pauseElement();">Pause</BUTTON> <BUTTON id="resumeBtn" onclick="m1.resumeElement();">Resume</BUTTON> <BUTTON id="stopBtn" onclick="m1.endElement();stateString1.innerText='State: inactive'">Stop </BUTTON> </P> </BODY> </HTML>
Code example: http://samples.msdn.microsoft.com/workshop/samples/author/behaviors/statestring.htm
Applies To
currTimeState
See Also
Introduction to HTML+TIME, activeElements, isActive, isOn, isPaused