Module ncine.audio_buffer_player
The table containing audio buffer player related functions.
Inherits from ncine.audio_player.
Functions
ncine.audio_buffer_player.new (buffer) | Constructs an audio buffer player object from an audio buffer. |
ncine.audio_buffer_player.delete (player) | Destroys an audio buffer player object and releases its memory |
ncine.audio_buffer_player.get_audio_buffer (player) | Gets the audio buffer used for playing |
ncine.audio_buffer_player.set_audio_buffer (player, buffer) | Sets the audio buffer used for playing |
Tables
audiobufferplayerObj | The light user data of an audio buffer player object. |
Functions
- ncine.audio_buffer_player.new (buffer)
-
Constructs an audio buffer player object from an audio buffer.
Don’t forget to call ncine.audio_buffer_player.delete when you are done with it!
Parameters:
- buffer ncine.audio_buffer.audiobufferObj
Returns:
-
audiobufferplayerObj
A new audio buffer player object
- ncine.audio_buffer_player.delete (player)
-
Destroys an audio buffer player object and releases its memory
Parameters:
- player audiobufferplayerObj The audio buffer player object to be destroyed
- ncine.audio_buffer_player.get_audio_buffer (player)
-
Gets the audio buffer used for playing
Parameters:
- player audiobufferplayerObj
Returns:
-
audiobufferObj
- ncine.audio_buffer_player.set_audio_buffer (player, buffer)
-
Sets the audio buffer used for playing
Parameters:
- player audiobufferplayerObj
- buffer audiobufferObj
Tables
- audiobufferplayerObj
-
The light user data of an audio buffer player object.
Inherits from ncine.audio_player.audioplayerObj.