uk.co.caprica.vlcj.media.MediaRef Maven / Gradle / Ivy
Show all versions of vlcj Show documentation
/*
* This file is part of VLCJ.
*
* VLCJ is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* VLCJ 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 for more details.
*
* You should have received a copy of the GNU General Public License
* along with VLCJ. If not, see
* This is used to pass around media references without requiring the full-blown {@link Media} component.
*/
public final class MediaRef {
/**
* Native library.
*/
private final LibVlc libvlc;
/**
* Native library instance.
*/
private final libvlc_instance_t libvlcInstance;
/**
* Native media instance.
*/
private final libvlc_media_t mediaInstance;
/**
* Create a new media reference.
*
* @param libvlc native library
* @param libvlcInstance native library instance
* @param mediaInstance native media instance
*/
public MediaRef(LibVlc libvlc, libvlc_instance_t libvlcInstance, libvlc_media_t mediaInstance) {
this.libvlc = libvlc;
this.libvlcInstance = libvlcInstance;
this.mediaInstance = mediaInstance;
}
/**
* Return a new {@link Media} component for this {@link MediaRef}.
*
* The returned media component shares the native media instance with any others that may be created subsequently.
*
* The caller must release the returned media when it is of no further use.
*
* @return media
*/
public Media newMedia() {
libvlc.libvlc_media_retain(mediaInstance);
return new Media(libvlc, libvlcInstance, mediaInstance);
}
/**
* Return a new {@link MediaRef} for this {@link MediaRef}.
*
* The returned media reference shares the native media instance with any others that may be created subsequently.
*
* The caller must release the returned media reference when it is of no further use.
*
* @return media reference
*/
public MediaRef newMediaRef() {
libvlc.libvlc_media_retain(mediaInstance);
return new MediaRef(libvlc, libvlcInstance, mediaInstance);
}
/**
* Return a duplicate {@link Media} component for this {@link MediaRef}.
*
* Unlike {@link #newMedia()}, this function will duplicate the native media instance, meaning it is separate from
* the native media instance in this component and any changes made to it (such as adding new media options) will
* not be reflected on the original media.
*
* The caller must release the returned media when it is of no further use.
*
* @return duplicated media
*/
public Media duplicateMedia() {
return new Media(libvlc, libvlcInstance, libvlc.libvlc_media_duplicate(mediaInstance));
}
/**
* Return a duplicate {@link MediaRef} for this {@link MediaRef}.
*
* Unlike {@link #newMediaRef()}, this function will duplicate the native media instance, meaning it is separate
* from the native media instance in this component and any changes made to it (such as adding new media options)
* will not be reflected on the original media.
*
* The caller must release the returned {@link Media} when it has no further use for it.
*
* @return duplicated media reference
*/
public MediaRef duplicateMediaRef() {
return new MediaRef(libvlc, libvlcInstance, libvlc.libvlc_media_duplicate(mediaInstance));
}
/**
* Release this component and the associated native resources.
*
* The component must no longer be used.
*/
public void release() {
libvlc.libvlc_media_release(mediaInstance);
}
/**
* Get the native media instance.
*
* @return media instance
*/
public libvlc_media_t mediaInstance() {
return mediaInstance;
}
}