Bridges-Python  3.4.4
Bridges(Python API)
Public Member Functions | List of all members
bridges.audio_channel.AudioChannel Class Reference

Public Member Functions

None __init__ (self, int sample_count=0, int sample_bits=32)
 AudioChannel constructor. More...
 
None set_sample (self, int index, int value)
 Set the sample at index. More...
 
int get_sample (self, int index)
 Get the sample at index. More...
 
int get_sample_count (self)
 Get the number of samples or length of this channel. More...
 
int get_sample_bits (self)
 Get the number of bits that make the samples in this channel. More...
 

Constructor & Destructor Documentation

◆ __init__()

None bridges.audio_channel.AudioChannel.__init__ (   self,
int  sample_count = 0,
int  sample_bits = 32 
)

AudioChannel constructor.

Parameters
sample_countThe total number of samples in this audio channel
sample_bitsnumber of bits per sample (8, 16, 24, 32)

Member Function Documentation

◆ get_sample()

int bridges.audio_channel.AudioChannel.get_sample (   self,
int  index 
)

Get the sample at index.

The sample will be a signed integer with get_sample_bits() number of bits.

Parameters
indexThe sample index on this channel to get (int)
Returns
(int) The sample at index that is an integer within the range of an integer of get_sample_bits() number of bits.

◆ get_sample_bits()

int bridges.audio_channel.AudioChannel.get_sample_bits (   self)

Get the number of bits that make the samples in this channel.

   Will be 8, 16, 24, or 32.
Returns
(int) The number of bits that make the samples in this channel.

◆ get_sample_count()

int bridges.audio_channel.AudioChannel.get_sample_count (   self)

Get the number of samples or length of this channel.

Returns
(int) The number of samples in this channel.

◆ set_sample()

None bridges.audio_channel.AudioChannel.set_sample (   self,
int  index,
int  value 
)

Set the sample at index.

The sample value should be a valid signed integer with get_sample_bits() number of bits.

Parameters
indexThe index on this channel to set (int)
valueThe signed integer value to set the sample to (int)

The documentation for this class was generated from the following file: