Bridges-Python  3.2.0
Bridges(PythonAPI)
Public Member Functions | List of all members
bridges.audio_channel.AudioChannel Class Reference
Inheritance diagram for bridges.audio_channel.AudioChannel:

Public Member Functions

def __init__
 AudioChannel constructor. More...
 
def set_sample
 Set the sample at index. More...
 
def get_sample
 Get the sample at index. More...
 
def get_sample_count (self)
 Get the number of samples or length of this channel. More...
 
def get_sample_bits (self)
 Get the number of bits that make the samples in this channel. More...
 

Constructor & Destructor Documentation

◆ __init__()

def bridges.audio_channel.AudioChannel.__init__ (   self,
  sample_count 
)

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()

def bridges.audio_channel.AudioChannel.get_sample (   self,
  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()

def bridges.audio_channel.AudioChannel.get_sample_bits (   self,
  int 
)

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()

def bridges.audio_channel.AudioChannel.get_sample_count (   self,
  int 
)

Get the number of samples or length of this channel.

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

◆ set_sample()

def bridges.audio_channel.AudioChannel.set_sample (   self,
  index 
)

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: