Module ncine.audio_stream_player
The table containing audio stream player related functions.
Inherits from ncine.audio_player.
Functions
| ncine.audio_stream_player.new (filename) | Constructs an audio stream player object from an audio file. |
| ncine.audio_stream_player.delete (player) | Destroys an audio stream player object and releases its memory |
| ncine.audio_stream_player.num_samples_in_stream_buffer (player) | Returns the number of samples in the streaming buffer |
| ncine.audio_stream_player.stream_buffer_size (player) | Returns the size of the streaming buffer in bytes |
| ncine.audio_stream_player.sample_offset_in_stream (player) | Returns the sample offset relative to the whole stream |
Tables
| audiostreamplayerObj | The light user data of an audio stream player object. |
Functions
- ncine.audio_stream_player.new (filename)
-
Constructs an audio stream player object from an audio file.
Don’t forget to call ncine.audio_stream_player.delete when you are done with it!
Parameters:
- filename string The path to an audio file
Returns:
-
audiostreamplayerObj
A new audio stream player object
- ncine.audio_stream_player.delete (player)
-
Destroys an audio stream player object and releases its memory
Parameters:
- player audiostreamplayerObj The audio stream player object to be destroyed
- ncine.audio_stream_player.num_samples_in_stream_buffer (player)
-
Returns the number of samples in the streaming buffer
Parameters:
- player audiostreamplayerObj
Returns:
-
integer
- ncine.audio_stream_player.stream_buffer_size (player)
-
Returns the size of the streaming buffer in bytes
Parameters:
- player audiostreamplayerObj
Returns:
-
integer
- ncine.audio_stream_player.sample_offset_in_stream (player)
-
Returns the sample offset relative to the whole stream
Parameters:
- player audiostreamplayerObj
Returns:
-
integer
Tables
- audiostreamplayerObj
-
The light user data of an audio stream player object.
Inherits from ncine.audio_player.audioplayerObj.