Buffer

class supriya.tools.nonrealtimetools.Buffer(session, session_id, buffer_group=None, channel_count=None, frame_count=1, duration=None, start_offset=None, file_path=None, starting_frame=None)[source]

A non-realtime buffer.

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=1, group=0, label=object, shape=box]; } subgraph cluster_nonrealtimetools { graph [label=nonrealtimetools]; "supriya.tools.nonrealtimetools.Buffer.Buffer" [color=black, fontcolor=white, group=1, label=<<B>Buffer</B>>, shape=box, style="filled, rounded"]; "supriya.tools.nonrealtimetools.SessionObject.SessionObject" [color=2, group=1, label=SessionObject, shape=oval, style=bold]; "supriya.tools.nonrealtimetools.SessionObject.SessionObject" -> "supriya.tools.nonrealtimetools.Buffer.Buffer"; } subgraph cluster_systemtools { graph [label=systemtools]; "supriya.tools.systemtools.SupriyaObject.AbstractBase" [color=3, group=2, label=AbstractBase, shape=box]; "supriya.tools.systemtools.SupriyaObject.SupriyaObject" [color=3, group=2, label=SupriyaObject, shape=box]; "supriya.tools.systemtools.SupriyaObject.AbstractBase" -> "supriya.tools.systemtools.SupriyaObject.SupriyaObject"; } "builtins.object" -> "supriya.tools.systemtools.SupriyaObject.AbstractBase"; "supriya.tools.systemtools.SupriyaObject.SupriyaObject" -> "supriya.tools.nonrealtimetools.SessionObject.SessionObject"; }

Bases

Attribute summary

buffer_group
channel_count
close([offset])
copy_from(source_buffer_id[, frame_count, ...])
copy_to(target_buffer_id[, frame_count, ...])
duration
file_path
fill([index_count_value_triples, offset])
fill_via_chebyshev(amplitudes[, ...])
fill_via_sine_1(amplitudes[, as_wavetable, ...])
fill_via_sine_2(amplitudes, frequencies[, ...])
fill_via_sine_3(amplitudes, frequencies, phases)
frame_count
read(file_path[, channel_indices, ...])
require_offset(function)
session
session_id
set([index_value_pairs, offset])
set_contiguous([index_values_pairs, offset])
start_offset
starting_frame
stop_offset
write(file_path[, frame_count, ...])
zero([offset])
__eq__(expr) Is true when ID of expr equals ID of Supriya object.
__format__([format_specification]) Formats Supriya object.
__hash__() Hashes Supriya object.
__repr__() Gets interpreter representation of Supriya object.

Read-only properties

Buffer.buffer_group
Buffer.channel_count
Buffer.duration
Buffer.file_path
Buffer.frame_count
(SessionObject).session
Buffer.session_id
Buffer.start_offset
Buffer.starting_frame
Buffer.stop_offset

Methods

Buffer.close(offset=None)[source]
Buffer.copy_from(source_buffer_id, frame_count=None, source_starting_frame=None, target_starting_frame=None, offset=None)[source]
Buffer.copy_to(target_buffer_id, frame_count=None, source_starting_frame=None, target_starting_frame=None, offset=None)[source]
Buffer.fill(index_count_value_triples=None, offset=None)[source]
Buffer.fill_via_chebyshev(amplitudes, as_wavetable=True, should_normalize=True, should_clear_first=True, offset=None)[source]
Buffer.fill_via_sine_1(amplitudes, as_wavetable=True, should_clear_first=True, should_normalize=True, offset=None)[source]
Buffer.fill_via_sine_2(amplitudes, frequencies, as_wavetable=True, should_clear_first=True, should_normalize=True, offset=None)[source]
Buffer.fill_via_sine_3(amplitudes, frequencies, phases, as_wavetable=True, should_clear_first=True, should_normalize=True, offset=None)[source]
Buffer.read(file_path, channel_indices=None, frame_count=None, leave_open=None, starting_frame_in_buffer=None, starting_frame_in_file=None, offset=None)[source]
Buffer.set(index_value_pairs=None, offset=None)[source]
Buffer.set_contiguous(index_values_pairs=None, offset=None)[source]
Buffer.write(file_path, frame_count=None, header_format='aiff', leave_open=False, sample_format='int24', starting_frame=None, offset=None)[source]
Buffer.zero(offset=None)[source]

Class & static methods

(SessionObject).require_offset(function)

Special methods

(SupriyaObject).__eq__(expr)

Is true when ID of expr equals ID of Supriya object. Otherwise false.

Returns boolean.

(SupriyaObject).__format__(format_specification='')

Formats Supriya object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(SupriyaObject).__hash__()

Hashes Supriya object.

Required to be explicitely re-defined on Python 3 if __eq__ changes.

Returns integer.

(SupriyaObject).__repr__()

Gets interpreter representation of Supriya object.

Returns string.