TagMessage.java

/* 
 * Copyright (C) 2008 Wayne Meissner
 * Copyright (C) 2004 Wim Taymans <wim@fluendo.com>
 *
 * 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 <http://www.gnu.org/licenses/>.
 */

package org.gstreamer.message;

import org.gstreamer.GstObject;
import org.gstreamer.Message;
import org.gstreamer.TagList;
import org.gstreamer.lowlevel.GstMessageAPI;
import org.gstreamer.lowlevel.GstNative;
import org.gstreamer.lowlevel.annotations.Invalidate;

import com.sun.jna.Pointer;
import com.sun.jna.ptr.PointerByReference;

/**
 * This message is posted by elements that have discovered new tags.
 */
public class TagMessage extends Message {
    private static interface API extends GstMessageAPI {
        Pointer ptr_gst_message_new_tag(GstObject src, @Invalidate TagList tag_list);
    }
    private static final API gst = GstNative.load(API.class);
    
    /**
     * Creates a new Buffering message.
     * @param init internal initialization data.
     */
    public TagMessage(Initializer init) {
        super(init);
    }
    
    /**
     * Creates a new Buffering message.
     * @param src The object originating the message.
     * @param tagList the tag list for this message.
     * <p>
     * <b> Note: </b> the message takes ownership of the taglist, so do not use
     * it again after adding it to this message.
     */
    public TagMessage(GstObject src, TagList tagList) {
        this(initializer(gst.ptr_gst_message_new_tag(src, tagList)));
    }
    
    /**
     * Gets the list of tags contained in this message.
     * 
     * @return the list of tags in this message.
     */
    public TagList getTagList() {
        PointerByReference list = new PointerByReference();
        gst.gst_message_parse_tag(this, list);
        return objectFor(list.getValue(), TagList.class, false, true);
    }
}