name (str) – Audio file or resource name. Multiple calls with the same name +
name (str) – Audio file or resource name. Multiple calls with the same name
will return the same buffer.
context (Optional[Context], optional) – The context from which the buffer is to be created and cached. +
context (Optional[Context], optional) – The context from which the buffer is to be created and cached.
By default current_context() is used.
str
+str
decoder (Decoder) – The decoder from which the buffer is to be cached.
name (str) – The name to give to the buffer. It may alias an audio file, +
decoder (Decoder) – The decoder from which the buffer is to be cached.
name (str) – The name to give to the buffer. It may alias an audio file,
but it must not currently exist in the buffer cache.
context (Optional[Context], optional) – The context from which the buffer is to be created. +
context (Optional[Context], optional) – The context from which the buffer is to be created.
By default current_context() is used.
loop_points¶
Loop points for looping sources.
-If the AL_SOFT_loop_points extension is not supported by the +
If AL_SOFT_loop_points extension is not supported by the current context, start = 0 and end = length respectively. Otherwise, start < end <= length.
start (int) – Starting point, in sample frames (inclusive).
end (int) – Ending point, in sample frames (exclusive).
start (int) – Starting point, in sample frames (inclusive).
end (int) – Ending point, in sample frames (exclusive).
Notes
@@ -335,7 +336,7 @@available_resamplers¶
The list of resamplers supported by the context.
-If the AL_SOFT_source_resampler extension is unsupported -this will be an empty list, otherwise there would be +
If AL_SOFT_source_resampler extension is unsupported, +this will be an empty list. Otherwise there would be at least one entry.
This method require the context to be current.
default_resampler_index¶
The context’s default resampler index.
-If the AL_SOFT_source_resampler extension is unsupported -the resampler list will be empty and this will return 0.
+If AL_SOFT_source_resampler extension is unsupported, +this will return 0.
If you try to access the resampler list with this index without extension, undefined behavior will occur (accessing an out of bounds array index).
@@ -292,7 +292,7 @@context (Optional[Context], optional) – The context on which the listener instance is to be created. +
context (Optional[Context], optional) – The context on which the listener instance is to be created.
By default current_context() is used.
at (Tuple[float, float, float]) – Relative position.
up (Tuple[float, float, float]) – Relative direction.
at (Tuple[float, float, float]) – Relative position.
up (Tuple[float, float, float]) – Relative direction.
name (str) – Resource name passed to Buffer.
channel_config (str) – Channel configuration of the given audio data.
sample_type (str) – Sample type of the given audio data.
sample_rate (int) – Sample rate of the given audio data.
data (MutableSequence[int]) –
The audio data that is about to be fed to the OpenAL buffer.
+name (str) – Resource name passed to Buffer.
channel_config (str) – Channel configuration of the given audio data.
sample_type (str) – Sample type of the given audio data.
sample_rate (int) – Sample rate of the given audio data.
data (MutableSequence[int]) –
The audio data that is about to be fed to the OpenAL buffer.
It is a mutable memory array of signed 8-bit integers, following Python buffer protocol.
Handle disconnected device messages.
This is called when the given device has been disconnected and -is no longer usable for output. As per the ALC_EXT_disconnect +is no longer usable for output. As per ALC_EXT_disconnect specification, disconnected devices remain valid, however all playing sources are automatically stopped, any sources that are attempted to play will immediately stop, and new contexts may @@ -392,7 +392,7 @@
palace.thread_local(state: bool) → Iterator[None]¶palace.thread_local(state: bool) → Iterator[None]¶
Return a context manager controlling preference of local thread.
-Effectively, it sets the fallback value for the thread argument +
Effectively, it sets fallback value for thread argument for current_context and use_context.
Initially, globally current Context is preferred.
palace.distance_models: Tuple[str, …]¶palace.distance_models: Tuple[str, …]¶
Names of available distance models.
name (str) – Audio file or resource name.
context (Optional[Context], optional) – The context from which the decoder is to be created. +
name (str) – Audio file or resource name.
context (Optional[Context], optional) – The context from which the decoder is to be created.
By default current_context() is used.
loop_points¶
Loop points in sample frames.
start (int) – Inclusive starting loop point.
end (int) – Exclusive starting loop point.
start (int) – Inclusive starting loop point.
end (int) – Exclusive starting loop point.
Notes
@@ -197,13 +198,13 @@chunk_len (int) – The number of sample frames to read for each chunk update. +
chunk_len (int) – The number of sample frames to read for each chunk update.
Smaller values will require more frequent updates and
larger values will handle more data with each chunk.
queue_size (int) – The number of chunks to keep queued during playback. +
queue_size (int) – The number of chunks to keep queued during playback.
Smaller values use less memory while larger values
improve protection against underruns.
source (Optional[Source], optional) – The source object to play audio. If None is given, +
source (Optional[Source], optional) – The source object to play audio. If None is given,
a new one will be created from the current context.
seek(pos: int) → bool¶Seek to pos, specified in sample frames.
+Seek to pos, specified in sample frames.
Return if the seek was successful.
loop_points¶
Loop points in sample frames.
start (int) – Inclusive starting loop point.
end (int) – Exclusive starting loop point.
start (int) – Inclusive starting loop point.
end (int) – Exclusive starting loop point.
Notes
@@ -350,13 +352,13 @@palace.sample_types: Tuple[str, …]¶palace.sample_types: Tuple[str, …]¶
Names of available sample types.
palace.channel_configs: Tuple[str, …]¶palace.channel_configs: Tuple[str, …]¶
Names of available channel configurations.
name (str, optional) – The name of the playback device.
fallback (Iterable[str], optional) – Device names to fallback to, default to an empty tuple.
name (str, optional) – The name of the playback device.
fallback (Iterable[str], optional) – Device names to fallback to, default to an empty tuple.
efx_version¶
EFX version supported by this device.
-If the ALC_EXT_EFX extension is unsupported, -this will be (0, 0).
+If ALC_EXT_EFX extension is unsupported, this will be (0, 0).
hrtf_enabled¶
Whether HRTF is enabled on the device.
-If the ALC_SOFT_HRTF extension is unavailable, +
If ALC_SOFT_HRTF extension is unavailable, this will return False although there could still be HRTF applied at a lower hardware level.
reset(attrs: Dict[int, int]) → None¶
Reset the device, using the specified attributes.
-If the ALC_SOFT_HRTF extension is unavailable, +
If ALC_SOFT_HRTF extension is unavailable, this will be a no-op.
context (Optional[Context], optional) – The context from which the effect is to be created. +
context (Optional[Context], optional) – The context from which the effect is to be created.
By default current_context() is used.
See also
ReverbEffectEAXReverb effect
+ReverbEffectEnvironmental reverberation effect
ChorusEffectChorus effect
palace.ChorusEffect¶
Chorus effect.
+The chorus effect essentially replays the input audio accompanied +by another slightly delayed version of the signal, creating +a “doubling” effect. This was originally intended to emulate +the effect of several musicians playing the same notes +simultaneously, to create a thicker, more satisfying sound.
waveform (str) – Either ‘sine’ or ‘triangle’.
phase (int) – From -180 to 180.
depth (float) – From 0.0 to 1.0.
feedback (float) – From -1.0 to 1.0.
delay (float) – From 0.0 to 0.016.
context (Optional[Context], optional) – The context from which the effect is to be created. +
waveform (str) – Either ‘sine’ or ‘triangle’.
phase (int) – From -180 to 180.
depth (float) – From 0.0 to 1.0.
feedback (float) – From -1.0 to 1.0.
delay (float) – From 0.0 to 0.016.
context (Optional[Context], optional) – The context from which the effect is to be created.
By default current_context() is used.
palace.reverb_preset_names: Tuple[str, …]¶palace.reverb_preset_names: Tuple[str, …]¶
Names of predefined reverb effect presets in lexicographical order.
palace.ReverbEffect¶EAXReverb effect.
-It will automatically downgrade to the Standard Reverb effect -if EAXReverb effect is not supported.
+Environmental reverberation effect.
preset (str, optional) – The initial preset to start with, falling back to GENERIC.
context (Optional[Context], optional) – The context from which the effect is to be created. +
preset (str, optional) – The initial preset to start with, falling back to GENERIC.
context (Optional[Context], optional) – The context from which the effect is to be created.
By default current_context() is used.
decay_hf_limit¶High frequency decay limit.
+Whether to limit high frequency decay.
palace.use_fileio(factory: Optional[Callable[[str], FileIO]], buffer_size: int = 8192) → None¶palace.use_fileio(factory: Optional[Callable[[str], FileIO]], buffer_size: int = 8192) → None¶
Set the file I/O factory instance to be used by audio decoders.
If factory=None is provided, revert to the default.
offset (int) – A byte count.
whence (int, optional) – Either 0 (default, move relative to start of file), +
offset (int) – A byte count.
whence (int, optional) – Either 0 (default, move relative to start of file),
1 (move relative to current position)
or 2 (move relative to end of file).
context (Optional[Context], optional) – The context from which the source is to be created. +
context (Optional[Context], optional) – The context from which the source is to be created.
By default current_context() is used.
Cone inner and outer angles in degrees.
inner (float) – The area within which the listener will hear the source +
inner (float) – The area within which the listener will hear the source
without extra attenuation, default to 360.
outer (float) – The area outside of which the listener will hear the source +
outer (float) – The area outside of which the listener will hear the source
attenuated according to outer_cone_gains, default to 360.
ValueError – If set to a value where inner is greater than outer @@ -178,15 +179,16 @@
refdist (float) – The distance at which the source’s volume will not have +
refdist (float) – The distance at which the source’s volume will not have
any extra attenuation (an effective gain multiplier of 1),
default to 0.
maxdist (float) – The maximum distance, default to FLT_MAX, which is the +
maxdist (float) – The maximum distance, default to FLT_MAX, which is the
maximum value of a single-precision floating-point variable
(2**128 - 2**104).
ValueError – If set to a value where refdist is greater than maxdist @@ -231,9 +233,9 @@
gain (float) – Linear gain applying to all frequencies, default to 1.
gain_hf (float) – Linear gain applying to high frequencies, default to 1.
gain_lf (float) – Linear gain applying to low frequencies, default to 1.
gain (float) – Linear gain applying to all frequencies, default to 1.
gain_hf (float) – Linear gain applying to high frequencies, default to 1.
gain_lf (float) – Linear gain applying to low frequencies, default to 1.
gain_auto¶
Whether automatically adjust gains.
-Respectively for direct path’s high frequency gain, -send paths’ gain and send paths’ high-frequency gain are -automatically adjusted. The default is True for all.
+direct_hf (bool) – Direct path’s high frequency gain, default to True.
send (bool) – Send paths’ gain, default to True.
send_hf (bool) – Send paths’ high-frequency, default to True.
mingain (float) – Minimum gain, default to 0.
maxgain (float) – Maximum gain, default to 1.
mingain (float) – Minimum gain, default to 0.
maxgain (float) – Maximum gain, default to 1.
ValueError – If set to a value where mingain is greater than maxgain @@ -302,16 +312,16 @@
latency¶
Source latency in nanoseconds.
-If the AL_SOFT_source_latency extension is unsupported, -the latency will be 0.
+If AL_SOFT_source_latency extension is unsupported, +this will be 0.
latency_seconds¶Source latency in seconds.
-If the AL_SOFT_source_latency extension is unsupported, -the latency will be 0.
+If AL_SOFT_source_latency extension is unsupported, +this will be 0.
offset¶Source offset in sample frames. For streaming sources -this will be the offset based on the decoder’s read position.
+Source offset in sample frames.
+For streaming sources, this will be +based on decoder’s read position.
offset_seconds¶Source offset in seconds.
-For streaming sources this will be the offset based on +
For streaming sources, this will be based on the decoder’s read position.
3D orientation of the source.
at (Tuple[float, float, float]) – Relative position.
up (Tuple[float, float, float]) – Relative direction.
at (Tuple[float, float, float]) – Relative position.
up (Tuple[float, float, float]) – Relative direction.
Notes
-Unlike the AL_EXT_BFORMAT extension this property +
Unlike AL_EXT_BFORMAT extension this property comes from, this also affects the facing direction.
Gain when listener is out of the source’s outer cone area.
gain (float) – Linear gain applying to all frequencies, default to 1.
gain_hf (float) – Linear gain applying extra attenuation to high frequencies +
gain (float) – Linear gain applying to all frequencies, default to 1.
gain_hf (float) – Linear gain applying extra attenuation to high frequencies
creating a low-pass effect, default to 1. It has no effect
without the ALC_EXT_EFX extension.
ValueError – If either of the gains is set to a value @@ -421,7 +434,7 @@
radius¶
Radius of the source, as if it is a sound-emitting sphere.
-This has no effect without the AL_EXT_SOURCE_RADIUS extension.
+This has no effect without AL_EXT_SOURCE_RADIUS extension.
ValueError – If set to a negative value.
@@ -455,19 +468,24 @@rolloff_factors¶Rolloff factor and room factor for the direct and send paths.
+Rolloff factors for the direct and send paths.
This is effectively a distance scaling relative to the reference distance.
ValueError – If either of rolloff factors is set to a negative value.
+factor (float) – Rolloff factor.
room_factor (float) – Room rolloff factor, default to 0 which disables
+distance attenuation for send paths. This is because
+the reverb engine will, by default, apply a more realistic
+room decay based on the reverb decay time and distance.
ValueError – If either of rolloff factors is set to a negative value.
Notes
-To disable distance attenuation for send paths, -set room factor to 0. The reverb engine will, by default, -apply a more realistic room decay based on the reverb decay -time and distance.
context (Optional[Context], optional) – The context from which the source group is to be created. +
context (Optional[Context], optional) – The context from which the source group is to be created.
By default current_context() is used.
parent_group¶The source group this source group is a child of.
+The parent source group of this source group.
RuntimeException – If this group is being added to its sub-group @@ -640,7 +658,7 @@