luasoundapi.h

Go to the documentation of this file.

/*
 * Copyright (c) since 2021 by PopolonY2k and Leidson Campos A. Ferreira
 * 
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#ifndef __LUASOUNDAPI_H__
#define __LUASOUNDAPI_H__
 
extern "C"
{
  #include "lua.h"
}
 
#include "scripting/iscriptlistener.h"
 
 
namespace Scarab  {
    namespace Engine  {
        namespace Lua  {
            class LuaSoundApi  {
 
                static int Load( lua_State *pLuaState );
                static int Unload( lua_State *pLuaState );
                static int Play( lua_State *pLuaState );
                static int Stop( lua_State *pLuaState );
                static int Pause( lua_State *pLuaState );
                static int Resume( lua_State *pLuaState );
                static int IsPlaying( lua_State *pLuaState );
                static int SetVolume( lua_State *pLuaState );
 
                // Direct (non-queued) song commands - reach EngineHost::OnCommand synchronously
                static void CallPlayCommandDirect( lua_State *pLuaState, SunLight :: Scripting :: Commands cmd );
                static int PlaySong( lua_State *pLuaState );
                static int PlaySongLooping( lua_State *pLuaState );
                static int PauseSong( lua_State *pLuaState );
                static int StopSong( lua_State *pLuaState );
                static int ResumeSong( lua_State *pLuaState );
 
                // Queued song commands - paced by the ScriptProcessor like sp_wait/sp_move_sprites_to_screen
                static int QueuePlaySong( lua_State *pLuaState );
                static int QueuePauseSong( lua_State *pLuaState );
                static int QueueStopSong( lua_State *pLuaState );
                static int QueueResumeSong( lua_State *pLuaState );
 
                public:
 
                static void Register( lua_State *pLuaState );
            };
        }
    }
}
 
#endif  /* __LUASOUNDAPI_H__ */