1 /*
   2  * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javafx.scene.media;
  27 
  28 import javafx.event.ActionEvent;
  29 import javafx.util.Duration;
  30 import javafx.util.Pair;
  31 
  32 /**
  33  * An {@link ActionEvent} representing a media marker. A marker is added to a
  34  * {@link Media} which is then played by a {@link MediaPlayer}. The event
  35  * is fired when the playback position reaches the position of the marker.
  36  *
  37  * @see MediaPlayer#onMarker
  38  * @since JavaFX 2.0
  39  */
  40 public class MediaMarkerEvent extends ActionEvent {
  41 
  42     private static final long serialVersionUID = 20121107L;
  43 
  44     private Pair<String,Duration> marker;
  45 
  46     MediaMarkerEvent(Pair<String,Duration> marker) {
  47         super();
  48         this.marker = marker;
  49     }
  50 
  51     /**
  52      * Retrieves the marker the event represents.
  53      *
  54      * @return the value of the marker.
  55      */
  56     public Pair<String,Duration> getMarker() {
  57         return marker;
  58     }
  59 }