ndspy.soundStreamPlayer: Sound Stream Players

The ndspy.soundStreamPlayer module provides a class that represents a stream player.

A “stream player” plays STRM streamed audio files. The stream player data in an SDAT file defines the channels allotted to it. This lets games use stream players and sequence players simultaneously while minimizing conflicts between them.

See also

If you aren’t familiar with how SDAT files are structured, consider reading the appendix explaining this.

class ndspy.soundStreamPlayer.StreamPlayer([channels])

A stream player.

Parameters:

channels – The initial value for the channels attribute.

channels

The hardware channels that this stream player will be allowed to use. All numbers in this list should be between 0 and 15 inclusive.

Note

This is a list rather than a set because – unlike with ndspy.soundSequencePlayer.SequencePlayer – the order of the values is actually preserved in the SDAT file.

Type:

list of int

Default:

[]

save()

Return this sequence player’s channels attribute. This matches the parameter of the default class constructor.

Yes, this is a bit of a pointless function. No, I’m not getting rid of it. :)

Returns:

channels.

Return type:

list of int