uk.co.caprica.vlcj.media.SlaveApi Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of vlcj Show documentation
Java Framework for the vlc Media Player.
There is a newer version: 5.0.0-M1
/*
 * 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 .
 *
 * Copyright 2009-2019 Caprica Software Limited.
 */

package uk.co.caprica.vlcj.media;

import java.io.File;
import java.util.List;

import static uk.co.caprica.vlcj.binding.LibVlc.libvlc_media_slaves_add;
import static uk.co.caprica.vlcj.binding.LibVlc.libvlc_media_slaves_clear;

/**
 * Behaviour pertaining to media slaves, enabling subtitle and audio tracks to be added to the media.
 */
public final class SlaveApi extends BaseApi {

    SlaveApi(Media media) {
        super(media);
    }

    /**
     * Add an input slave to the current media.
     * 
     * The success of this call does not indicate that the slave being added is actually valid or not, it simply
     * associates a slave URI with the current media player (for example, a sub-title file will not be parsed and
     * checked for validity during this call).
     * 

     * If the URI represents a local file, it must be of the form "file://" otherwise it will not work, so this
     * will work:
     * 
     *     file:///home/movies/movie.srt
     * 
     * This will not work:
     *      *     file:/home/movies/movie.srt
     * 
     * 
     * If you are using {@link File#toURI()} to generate your URI, this will not work as that method will most likely
     * return the latter from the two above.
     *
     * @param type type of slave to add
     * @param uri URI of the slave to add
     * @return true on success; false otherwise
     */
    public boolean add(MediaSlaveType type, MediaSlavePriority priority, String uri) {
        return libvlc_media_slaves_add(mediaInstance, type.intValue(), priority.intValue(), uri) == 0;
    }

    /**
     * Remove all media slaves from the current media.
     */
    public void clear() {
        libvlc_media_slaves_clear(mediaInstance);
    }

    /**
     * Get the list of media slaves added to the current media.
     *
     * @return media slaves
     */
    public List get() {
        return MediaSlaves.getMediaSlaves(mediaInstance);
    }

}