org.freedesktop.gstreamer.controller.ProxyControlBinding Maven / Gradle / Ivy

/* 
 * Copyright (c) 2019 Neil C Smith
 * 
 * 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.controller;

import org.freedesktop.gstreamer.ControlBinding;
import org.freedesktop.gstreamer.Gst;
import org.freedesktop.gstreamer.GstObject;
import org.freedesktop.gstreamer.glib.Natives;

import static org.freedesktop.gstreamer.lowlevel.GstControllerAPI.GSTCONTROLLER_API;
import org.freedesktop.gstreamer.lowlevel.GstObjectPtr;
import org.freedesktop.gstreamer.lowlevel.GstProxyControlBindingPtr;

/**
 * Attachment for forwarding control sources
 * 
 * See upstream documentation at
 * https://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/gstreamer-libs-GstProxyControlBinding.html
 * 
 */
@Gst.Since(minor = 12)
public class ProxyControlBinding extends ControlBinding {
    
    public static final String GTYPE_NAME = "GstProxyControlBinding";

    ProxyControlBinding(Initializer init) {
        this(new Handle(
                init.ptr.as(GstProxyControlBindingPtr.class, GstProxyControlBindingPtr::new),
                init.ownsHandle),
                init.needRef);
    }

    private ProxyControlBinding(Handle handle, boolean needRef) {
        super(handle, needRef);
    }

    /**
     * Create a ProxyControlBinding that forwards all access to data or
     * syncValues() requests from propertyName on object to the control
     * binding at refPropertyName on refObject .
     *
     * @param object the object of the property
     * @param propertyName the property-name to attach the control source
     * @param refObject a GstObject to forward all ControlBinding requests to
     * @param refPropertyName the property name in refObject to control
     * @return new ProxyControlBinding
     */
    @Gst.Since(minor = 12)
    public static ProxyControlBinding create(GstObject object, String propertyName,
            GstObject refObject, String refPropertyName) {
        GstProxyControlBindingPtr ptr = GSTCONTROLLER_API.gst_proxy_control_binding_new(
                Natives.getPointer(object).as(GstObjectPtr.class, GstObjectPtr::new),
                propertyName,
                Natives.getPointer(refObject).as(GstObjectPtr.class, GstObjectPtr::new),
                refPropertyName);
        return new ProxyControlBinding(new Handle(ptr, true), false);
    }
    
}