001/*
002 * Trident - A Multithreaded Server Alternative
003 * Copyright 2014 The TridentSDK Team
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package net.tridentsdk.effect.sound;
018
019import net.tridentsdk.effect.RemoteEffect;
020
021/**
022 * Represents a sound effect
023 *
024 * @author The TridentSDK Team
025 * @since 0.4-alpha
026 */
027public interface SoundEffect extends RemoteEffect<SoundEffectType> {
028    /**
029     * Set the volume of the sound
030     *
031     * @param volume The volume of the sound (1 is 100%, can be higher)
032     */
033    void setVolume(float volume);
034
035    /**
036     * Set the pitch of the sound
037     *
038     * @param pitch The pitch of the sound (63 is 100%, can be higher)
039     */
040    void setPitch(int pitch);
041
042    /**
043     * Returns the volume of the sound
044     *
045     * @return The volume of the sound
046     */
047    float volume();
048
049    /**
050     * Returns the pitch of the sound
051     *
052     * @return The pitch of the sound
053     */
054    int pitch();
055}