bridges.audio_clip.AudioClip Class Reference

Inheritance diagram for bridges.audio_clip.AudioClip:

Detailed Description

This is a class in BRIDGES for multi-channel audio data.

This class contains a list of channels that contain sample data. The samples audio are encoded in 8, 16, 24, or 32 bit integers. All methods use 32 bits when taking and returning samples.

Author

Luke Sloop

Date

2020, 1/31/2020

Public Member Functions
def	__init__
	AudioBase constructor. More...
def	get_num_channels (self)
	Return the number of channels in this AudioClip. More...
def	get_channel
	Get the audio channel at index. More...
def	get_sample_rate (self)
def	get_sample_count (self)
def	get_sample
	Get the sample at the index of the sample data from a specific channel. More...
def	set_sample
	Set the sample at the index of the sample data to value. More...
def	get_sample_bits (self)
	Get the number of bits for the samples in this audio clip. More...
def	get_sample_bytes (self)
	Get the number of bytes for the samples in this audio clip. More...
def	get_data_structure_type (self)
	Get the data structure type. More...
def	get_data_structure_representation (self)
	Return a dictionary of the data in this audio file. More...
def	display (self)
	Print information about this audio file to the console. More...
def	audio_from_json
	Create an AudioClip from a json dictionary created by another AudioClip object. More...

Public Attributes
	sample_count
	sample_rate
	sample_bits
	num_channels
	framebytes

Constructor & Destructor Documentation

__init__()

def bridges.audio_clip.AudioClip.__init__	(		self,
			filepath
	)

AudioBase constructor.

(int) sample_count: The total number of samples in this audio object (int) sample_rate: The number of samples in 1 second of audio default cd quality (44100)

Returns

None

Member Function Documentation

audio_from_json()

def bridges.audio_clip.AudioClip.audio_from_json

(

json_dict

)

Create an AudioClip from a json dictionary created by another AudioClip object.

(dict) json_dict: The json dictionary created by another AudioClip object

display()

def bridges.audio_clip.AudioClip.display	(		self,
			None
	)

Print information about this audio file to the console.

get_channel()

def bridges.audio_clip.AudioClip.get_channel	(		self,
			index
	)

Get the audio channel at index.

The index should be less than get_num_channels().

       (int) index: The index of the channel to get. 0 for front-left, 1 for front-right, etc.

Returns

AudioChannel The audio channel at index

get_data_structure_representation()

def bridges.audio_clip.AudioClip.get_data_structure_representation	(		self,
			dict
	)

Return a dictionary of the data in this audio file.

Returns

dict The data of this audio file

get_data_structure_type()

def bridges.audio_clip.AudioClip.get_data_structure_type	(		self,
			str
	)

Get the data structure type.

Returns

str data structure type

get_num_channels()

def bridges.audio_clip.AudioClip.get_num_channels	(		self,
			int
	)

Return the number of channels in this AudioClip.

1 for mono, 2 for stereo, etc.

Returns

int The number of channels of audio samples this object holds.

get_sample()

def bridges.audio_clip.AudioClip.get_sample	(		self,
			channel
	)

Get the sample at the index of the sample data from a specific channel.

(int) channel: The index of the channel to get. 0 for front-left, 1 for front-right, etc. (int) index: The index of the sample to get. From 0 - get_sample_count()

Returns

int The 32 bit sample

get_sample_bits()

def bridges.audio_clip.AudioClip.get_sample_bits	(		self,
			int
	)

Get the number of bits for the samples in this audio clip.

Will be 8, 16, 24, or 32 bits.

Returns

int The number of bits for each sample

get_sample_bytes()

def bridges.audio_clip.AudioClip.get_sample_bytes	(		self,
			int
	)

Get the number of bytes for the samples in this audio clip.

Will be 1, 2, 3, or 4 bits.

Returns

int The number of bytes for each sample

get_sample_count()

def bridges.audio_clip.AudioClip.get_sample_count	(		self,
			int
	)

get_sample_rate()

def bridges.audio_clip.AudioClip.get_sample_rate	(		self,
			int
	)

set_sample()

def bridges.audio_clip.AudioClip.set_sample	(		self,
			channel
	)

Set the sample at the index of the sample data to value.

(int) channel: The index of the channel to get. 0 for front-left, 1 for front-right, etc. (int) index: The index of sampledata to set which must be less than get_sample_count() (int) value: The value to set the sample to which must be a valid signed integer with bit length get_sample_bits()

Returns

None

Member Data Documentation

framebytes

bridges.audio_clip.AudioClip.framebytes

num_channels

bridges.audio_clip.AudioClip.num_channels

sample_bits

bridges.audio_clip.AudioClip.sample_bits

sample_count

bridges.audio_clip.AudioClip.sample_count

sample_rate

bridges.audio_clip.AudioClip.sample_rate

---

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

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