/*
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.sun.media.jfxmedia.events;

import com.sun.media.jfxmedia.control.VideoDataBuffer;

Event indicating that a new video frame has been decoded.
/**
 * Event indicating that a new video frame has been decoded.
 */
public class NewFrameEvent extends PlayerEvent {

    private VideoDataBuffer frameData;

    
The constructor for the VideoDataBuffer.
Params:
buffer – The video frame.
Throws:
IllegalArgumentException – if buffer is
null./**
     * The constructor for the <code>VideoDataBuffer</code>.
     *
     * @param buffer The video frame.
     * @throws IllegalArgumentException if <code>buffer</code> is
     * <code>null</code>.
     */
    public NewFrameEvent(VideoDataBuffer buffer) {
        if (buffer == null) {
            throw new IllegalArgumentException("buffer == null!");
        }
        frameData = buffer;
    }

    
The video buffer.
Returns:
The event's data./**
     * The video buffer.
     *
     * @return The event's data.
     */
    public VideoDataBuffer getFrameData() {
        return frameData;
    }
}