main.includes.JniAlSoundSource.h Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of module-audio-openal Show documentation
OpenAL implementation for the module audio.
The newest version!
/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *
 * Copyright (c) 2019 Grégory Van den Borre
 *
 * More infos available: https://engine.yildiz-games.be
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without
 * limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 * OR COPYRIGHT  HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  SOFTWARE.
 */

#include 

#ifndef _JNI_AL_VORBIS_STREAM_H_
#define _JNI_AL_VORBIS_STREAM_H_

/**
 * JNI interface for a yz::AlSoundSource.
*@author Grégory Van den Borre
*/
#ifdef __cplusplus
extern "C" {
#endif

/**
 * Start playing a sound source.
 * @param env Environment provided by the JVM.
 * @param object Associated object, never used for performance reason.
 * @param pointer Pointer of a yz::AlSoundSource to be used.
 * @throw A NativeException if an error occurred.
 */
JNIEXPORT void JNICALL Java_jni_ALSoundSourceNative_play(JNIEnv* env, jobject object, jlong pointer);

/**
 * Stop playing a sound source.
 * @param env Environment provided by the JVM.
 * @param object Associated object, never used for performance reason.
 * @param pointer Pointer of a yz::AlSoundSource to be used.
 * @throw A NativeException if an error occurred.
 */
JNIEXPORT void JNICALL Java_jni_ALSoundSourceNative_stop(JNIEnv* env, jobject o, jlong pointer);

/**
 * Set a sound source to restart once completed.
 * @param env Environment provided by the JVM.
 * @param object Associated object, never used for performance reason.
 * @param pointer Pointer of a yz::AlSoundSource to be used.
 */
JNIEXPORT void JNICALL Java_jni_ALSoundSourceNative_loop(JNIEnv* env, jobject o, jlong pointer);

/**
 * Set a sound source to restart at the beginning.
 * @param env Environment provided by the JVM.
 * @param object Associated object, never used for performance reason.
 * @param pointer Pointer of a yz::AlSoundSource to be used.
 */
JNIEXPORT void JNICALL Java_jni_ALSoundSourceNative_rewind(JNIEnv* env, jobject o, jlong pointer);

/**
 * Set a sound source position.
 * @param env Environment provided by the JVM.
 * @param object Associated object, never used for performance reason.
 * @param pointer Pointer of a yz::AlSoundSource to be used.
 * @param x Source new X position.
 * @param y Source new Y position.
 * @param z Source new Z position.
 */
JNIEXPORT void JNICALL Java_jni_ALSoundSourceNative_setPosition(
        JNIEnv* env, jobject o, jlong pointer, jfloat x, jfloat y, jfloat z);

/**
 * Check if a sound source is currently playing.
 * @param env Environment provided by the JVM.
 * @param object Associated object, never used for performance reason.
 * @param pointer Pointer of a yz::AlSoundSource to be used.
 * @return True if the sound source is playing, false otherwise.
 */
JNIEXPORT jboolean JNICALL Java_jni_ALSoundSourceNative_isPlaying(JNIEnv* env, jobject o, jlong pointer);

JNIEXPORT void JNICALL Java_jni_ALSoundSourceNative_delete(JNIEnv* env, jobject o, jlong pointer);

JNIEXPORT void JNICALL Java_jni_ALSoundSourceNative_setGain(JNIEnv* env, jobject o, jlong pointer, jfloat gain);

#ifdef __cplusplus
}
#endif
#endif