uk.co.caprica.vlcj.player.embedded.InputApi 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.player.embedded;

import static uk.co.caprica.vlcj.binding.LibVlc.libvlc_video_set_key_input;
import static uk.co.caprica.vlcj.binding.LibVlc.libvlc_video_set_mouse_input;

/**
 * Behaviour pertaining to keyboard/mouse input-events.
 */
public final class InputApi extends BaseApi {

    InputApi(EmbeddedMediaPlayer mediaPlayer) {
        super(mediaPlayer);
    }

    /**
     * Set whether or not to enable native media player mouse input handling.
     * 
     * It may be necessary on some platforms to invoke this method with a false parameter value for Java
     * mouse and keyboard listeners to work.
     * 

     * Note that clicking the video surface on certain platforms is not guaranteed to capture mouse events - it may be
     * necessary to respond to a mouse pressed event on the video surface and explicitly request the input focus to the
     * video surface.
     *
     * @param enable true to enable, false to disable
     */
    public void enableMouseInputHandling(boolean enable) {
        libvlc_video_set_mouse_input(mediaPlayerInstance, enable ? 1 : 0);
    }

    /**
     * Set whether or not to enable native media player keyboard input handling.
     * 
     * It may be necessary on some platforms to invoke this method with a false parameter value for Java
     * mouse and keyboard listeners to work.
     *
     * @param enable true to enable, false to disable
     */
    public void enableKeyInputHandling(boolean enable) {
        libvlc_video_set_key_input(mediaPlayerInstance, enable ? 1 : 0);
    }

}