org.freedesktop.gstreamer.event.CapsEvent Maven / Gradle / Ivy

/*
 * Copyright (c) 2019 Neil C Smith
 * Copyright (c) 2016 Christophe Lafolet
 *
 * This file is part of gstreamer-java.
 *
 * This code is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3 only, as
 * published by the Free Software Foundation.
 *
 * 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 Lesser General Public License
 * version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with this work.  If not, see .
 */
package org.freedesktop.gstreamer.event;

import org.freedesktop.gstreamer.Caps;
import org.freedesktop.gstreamer.glib.Natives;
import static org.freedesktop.gstreamer.lowlevel.GstEventAPI.GSTEVENT_API;

/**
 * A CAPS event for {@link Caps}. The caps event can only travel downstream
 * synchronized with the buffer flow and contains the format of the buffers that
 * will follow after the event.
 * 
 * See upstream documentation at
 * https://gstreamer.freedesktop.org/data/doc/gstreamer/stable/gstreamer/html/GstEvent.html#gst-event-new-caps
 * 
 */
public class CapsEvent extends Event {

    /**
     * This constructor is for internal use only.
     *
     * @param init initialization data.
     */
    CapsEvent(Initializer init) {
        super(init);
    }

    /**
     * Creates a new caps event.
     */
    public CapsEvent(final Caps caps) {
        super(Natives.initializer(GSTEVENT_API.ptr_gst_event_new_caps(caps)));
    }
}