<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (1.8.0_191) on Wed Oct 31 14:01:54 UTC 2018 --> <title>MediaPlayer.Status (JavaFX 8)</title> <meta name="date" content="2018-10-31"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="MediaPlayer.Status (JavaFX 8)"; } } catch(err) { } //--> var methods = {"i0":9,"i1":9}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/MediaPlayer.Status.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage">JavaFX 8</div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../javafx/scene/media/MediaPlayer.html" title="class in javafx.scene.media"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/media/MediaView.html" title="class in javafx.scene.media"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?javafx/scene/media/MediaPlayer.Status.html" target="_top">Frames</a></li> <li><a href="MediaPlayer.Status.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#enum.constant.summary">Enum Constants</a> | </li> <li>Field | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#enum.constant.detail">Enum Constants</a> | </li> <li>Field | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">javafx.scene.media</div> <h2 title="Enum MediaPlayer.Status" class="title">Enum MediaPlayer.Status</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>java.lang.Enum<<a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a>></li> <li> <ul class="inheritance"> <li>javafx.scene.media.MediaPlayer.Status</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.io.Serializable, java.lang.Comparable<<a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a>></dd> </dl> <dl> <dt>Enclosing class:</dt> <dd><a href="../../../javafx/scene/media/MediaPlayer.html" title="class in javafx.scene.media">MediaPlayer</a></dd> </dl> <hr> <br> <pre>public static enum <span class="typeNameLabel">MediaPlayer.Status</span> extends java.lang.Enum<<a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a>></pre> <div class="block">Enumeration describing the different status values of a <a href="../../../javafx/scene/media/MediaPlayer.html" title="class in javafx.scene.media"><code>MediaPlayer</code></a>. <p> The principal <code>MediaPlayer</code> status transitions are given in the following table: </p> <table border="1"> <caption>MediaPlayer Status Transition Table</caption> <tr> <th scope="col">Current \ Next</th><th scope="col">READY</th><th scope="col">PAUSED</th> <th scope="col">PLAYING</th><th scope="col">STALLED</th><th scope="col">STOPPED</th> <th scope="col">DISPOSED</th> </tr> <tr> <th scope="row"><b>UNKNOWN</b></th><td>pre-roll</td><td></td><td></td><td></td><td></td><td>dispose()</td> </tr> <tr> <th scope="row"><b>READY</b></th><td></td><td></td><td>autoplay; play()</td><td></td><td></td><td>dispose()</td> </tr> <tr> <th scope="row"><b>PAUSED</b></th><td></td><td></td><td>play()</td><td></td><td>stop()</td><td>dispose()</td> </tr> <tr> <th scope="row"><b>PLAYING</b></th><td></td><td>pause()</td><td></td><td>buffering data</td><td>stop()</td><td>dispose()</td> </tr> <tr> <th scope="row"><b>STALLED</b></th><td></td><td>pause()</td><td>data buffered</td><td></td><td>stop()</td><td>dispose()</td> </tr> <tr> <th scope="row"><b>STOPPED</b></th><td></td><td>pause()</td><td>play()</td><td></td><td></td><td>dispose()</td> </tr> <tr> <th scope="row"><b>HALTED</b></th><td></td><td></td><td></td><td></td><td></td><td>dispose()</td> </tr> </table> <p>The table rows represent the current state of the player and the columns the next state of the player. The cell at the intersection of a given row and column lists the events which can cause a transition from the row state to the column state. An empty cell represents an impossible transition. The transitions to <code>UNKNOWN</code> and <code>HALTED</code> and from <code>DISPOSED</code> status are intentionally not tabulated. <code>UNKNOWN</code> is the initial status of the player before the media source is pre-rolled and cannot be entered once exited. <code>DISPOSED</code> is a terminal status entered after dispose() method is invoked and cannot be exited. <code>HALTED</code> status entered when a critical error occurs and may be transitioned into from any other status except <code>DISPOSED</code>. </p> <p> The principal <code>MediaPlayer</code> status values and transitions are depicted in the following diagram: <br><br> <img src="doc-files/mediaplayerstatus.png" alt="MediaPlayer status diagram"> </p> <p> Reaching the end of the media (or the <a href="../../../javafx/scene/media/MediaPlayer.html#stopTimeProperty--"><code>stopTime</code></a> if this is defined) while playing does not cause the status to change from <code>PLAYING</code>. Therefore, for example, if the media is played to its end and then a manual seek to an earlier time within the media is performed, playing will continue from the new media time. </p></div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 2.0</dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== ENUM CONSTANT SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="enum.constant.summary"> <!-- --> </a> <h3>Enum Constant Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Enum Constant and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/media/MediaPlayer.Status.html#DISPOSED">DISPOSED</a></span></code> <div class="block">State of the player after dispose() method is invoked.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/media/MediaPlayer.Status.html#HALTED">HALTED</a></span></code> <div class="block">State of the player when a critical error has occurred.</div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/media/MediaPlayer.Status.html#PAUSED">PAUSED</a></span></code> <div class="block">State of the player when playback is paused.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/media/MediaPlayer.Status.html#PLAYING">PLAYING</a></span></code> <div class="block">State of the player when it is currently playing.</div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/media/MediaPlayer.Status.html#READY">READY</a></span></code> <div class="block">State of the player once it is prepared to play.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/media/MediaPlayer.Status.html#STALLED">STALLED</a></span></code> <div class="block">State of the player when data coming into the buffer has slowed or stopped and the playback buffer does not have enough data to continue playing.</div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/media/MediaPlayer.Status.html#STOPPED">STOPPED</a></span></code> <div class="block">State of the player when playback has stopped.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../javafx/scene/media/MediaPlayer.Status.html#UNKNOWN">UNKNOWN</a></span></code> <div class="block">State of the player immediately after creation.</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>static <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/media/MediaPlayer.Status.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> <div class="block">Returns the enum constant of this type with the specified name.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../javafx/scene/media/MediaPlayer.Status.html#values--">values</a></span>()</code> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> <!-- --> </a> <h3>Methods inherited from class java.lang.Enum</h3> <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>getClass, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ ENUM CONSTANT DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="enum.constant.detail"> <!-- --> </a> <h3>Enum Constant Detail</h3> <a name="UNKNOWN"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>UNKNOWN</h4> <pre>public static final <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a> UNKNOWN</pre> <div class="block">State of the player immediately after creation. While in this state, property values are not reliable and should not be considered. Additionally, commands sent to the player while in this state will be buffered until the media is fully loaded and ready to play.</div> </li> </ul> <a name="READY"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>READY</h4> <pre>public static final <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a> READY</pre> <div class="block">State of the player once it is prepared to play. This state is entered only once when the movie is loaded and pre-rolled.</div> </li> </ul> <a name="PAUSED"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>PAUSED</h4> <pre>public static final <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a> PAUSED</pre> <div class="block">State of the player when playback is paused. Requesting the player to play again will cause it to continue where it left off.</div> </li> </ul> <a name="PLAYING"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>PLAYING</h4> <pre>public static final <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a> PLAYING</pre> <div class="block">State of the player when it is currently playing.</div> </li> </ul> <a name="STOPPED"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>STOPPED</h4> <pre>public static final <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a> STOPPED</pre> <div class="block">State of the player when playback has stopped. Requesting the player to play again will cause it to start playback from the beginning.</div> </li> </ul> <a name="STALLED"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>STALLED</h4> <pre>public static final <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a> STALLED</pre> <div class="block">State of the player when data coming into the buffer has slowed or stopped and the playback buffer does not have enough data to continue playing. Playback will continue automatically when enough data are buffered to resume playback. If paused or stopped in this state, then buffering will continue but playback will not resume automatically when sufficient data are buffered.</div> </li> </ul> <a name="HALTED"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>HALTED</h4> <pre>public static final <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a> HALTED</pre> <div class="block">State of the player when a critical error has occurred. This state indicates playback can never continue again with this player. The player is no longer functional and a new player should be created.</div> </li> </ul> <a name="DISPOSED"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>DISPOSED</h4> <pre>public static final <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a> DISPOSED</pre> <div class="block">State of the player after dispose() method is invoked. This state indicates player is disposed, all resources are free and player SHOULD NOT be used again. <code>Media</code> and <code>MediaView</code> objects associated with disposed player can be reused.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 8.0</dd> </dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="values--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>values</h4> <pre>public static <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a>[] values()</pre> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: <pre> for (MediaPlayer.Status c : MediaPlayer.Status.values()) System.out.println(c); </pre></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>an array containing the constants of this enum type, in the order they are declared</dd> </dl> </li> </ul> <a name="valueOf-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>valueOf</h4> <pre>public static <a href="../../../javafx/scene/media/MediaPlayer.Status.html" title="enum in javafx.scene.media">MediaPlayer.Status</a> valueOf(java.lang.String name)</pre> <div class="block">Returns the enum constant of this type with the specified name. The string must match <i>exactly</i> an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>name</code> - the name of the enum constant to be returned.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the enum constant with the specified name</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> <dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/MediaPlayer.Status.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage">JavaFX 8</div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../javafx/scene/media/MediaPlayer.html" title="class in javafx.scene.media"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../javafx/scene/media/MediaView.html" title="class in javafx.scene.media"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?javafx/scene/media/MediaPlayer.Status.html" target="_top">Frames</a></li> <li><a href="MediaPlayer.Status.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#enum.constant.summary">Enum Constants</a> | </li> <li>Field | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#enum.constant.detail">Enum Constants</a> | </li> <li>Field | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small><font size="-1"><a href="http://bugreport.java.com/bugreport/" target="_blank">Submit a bug or feature</a><br>For further API reference and developer documentation, see <a href="https://docs.oracle.com/javase/8/docs/index.html" target="_blank">Java SE Documentation</a>. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> <a href="https://docs.oracle.com/javase/8/docs/legal/cpyr.html" target="_blank">Copyright</a> © 2008, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to <a href="http://download.oracle.com/otndocs/jcp/java_se-8-mrel-spec/license.html" target="_blank">license terms</a>. Also see the <a target="_blank" href="http://www.oracle.com/technetwork/java/redist-137594.html" target="_blank">documentation redistribution policy</a>.</font></small></p> </body> </html>