bridges.audio_channel.AudioChannel Class Reference

Inheritance diagram for bridges.audio_channel.AudioChannel:

Detailed Description

This is a class in BRIDGES a channel of audio data.

This class contains one channel of 8, 16, 24, or 32 bit audio samples.

Author

Luke Sloop

Date

2020, 1/31/2020

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)

Constructor & Destructor Documentation

__init__()

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

AudioChannel constructor.

(int) sample_count: The total number of samples in this audio channel

Returns

None

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.

           (int) index: The sample index on this channel to get

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_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.

           (int) index: The index on this channel to set
           (int) value: The signed integer value to set the sample to

Returns

None

---

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

• /home/erik/work/bridges/bridges-python/bridges/audio_channel.py