1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
use std::sync::Arc;
use ringbuf::HeapProducer;
use crate::{
sound::{IntoOptionalRegion, PlaybackRate, PlaybackState, Region},
tween::{Tween, Value},
CommandError, Volume,
};
use super::{sound::Shared, Command};
/// Controls a static sound.
pub struct StaticSoundHandle {
pub(super) command_producer: HeapProducer<Command>,
pub(super) shared: Arc<Shared>,
}
impl StaticSoundHandle {
/// Returns the current playback state of the sound.
pub fn state(&self) -> PlaybackState {
self.shared.state()
}
/// Returns the current playback position of the sound (in seconds).
pub fn position(&self) -> f64 {
self.shared.position()
}
/**
Sets the volume of the sound.
# Examples
Set the volume of the sound as a factor immediately:
```no_run
# use kira::{
# manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
# sound::static_sound::{StaticSoundData, StaticSoundSettings},
# };
# let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
# let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
use kira::tween::Tween;
sound.set_volume(0.5, Tween::default())?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
Smoothly transition the volume to a target value in decibels:
```no_run
# use kira::{
# manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
# sound::static_sound::{StaticSoundData, StaticSoundSettings},
# };
# let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
# let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
use kira::tween::Tween;
use std::time::Duration;
sound.set_volume(kira::Volume::Decibels(-6.0), Tween {
duration: Duration::from_secs(3),
..Default::default()
})?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
Link the volume to a modulator, smoothly transitioning from the current value:
```no_run
use kira::{
manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
sound::static_sound::{StaticSoundData, StaticSoundSettings},
modulator::tweener::TweenerBuilder,
tween::Tween,
};
use std::time::Duration;
let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
let tweener = manager.add_modulator(TweenerBuilder {
initial_value: 0.5,
})?;
let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
sound.set_volume(&tweener, Tween {
duration: Duration::from_secs(3),
..Default::default()
})?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
*/
pub fn set_volume(
&mut self,
volume: impl Into<Value<Volume>>,
tween: Tween,
) -> Result<(), CommandError> {
self.command_producer
.push(Command::SetVolume(volume.into(), tween))
.map_err(|_| CommandError::CommandQueueFull)
}
/**
Sets the playback rate of the sound.
Changing the playback rate will change both the speed
and pitch of the sound.
# Examples
Set the playback rate of the sound as a factor immediately:
```no_run
# use kira::{
# manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
# sound::static_sound::{StaticSoundData, StaticSoundSettings},
# };
# let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
# let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
use kira::tween::Tween;
sound.set_playback_rate(0.5, Tween::default())?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
Smoothly transition the playback rate to a target value in semitones:
```no_run
# use kira::{
# manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
# sound::static_sound::{StaticSoundData, StaticSoundSettings},
# };
# let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
# let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
use kira::{
tween::Tween,
sound::PlaybackRate,
};
use std::time::Duration;
sound.set_playback_rate(PlaybackRate::Semitones(-2.0), Tween {
duration: Duration::from_secs(3),
..Default::default()
})?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
Link the playback rate to a modulator, smoothly transitioning from the current value:
```no_run
use kira::{
manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
sound::static_sound::{StaticSoundData, StaticSoundSettings},
modulator::tweener::TweenerBuilder,
tween::Tween,
};
use std::time::Duration;
let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
let tweener = manager.add_modulator(TweenerBuilder {
initial_value: 0.5,
})?;
let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
sound.set_playback_rate(&tweener, Tween {
duration: Duration::from_secs(3),
..Default::default()
})?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
*/
pub fn set_playback_rate(
&mut self,
playback_rate: impl Into<Value<PlaybackRate>>,
tween: Tween,
) -> Result<(), CommandError> {
self.command_producer
.push(Command::SetPlaybackRate(playback_rate.into(), tween))
.map_err(|_| CommandError::CommandQueueFull)
}
/**
Sets the panning of the sound, where `0.0` is hard left,
`0.5` is center, and `1.0` is hard right.
# Examples
Smoothly transition the panning to a target value:
```no_run
# use kira::{
# manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
# sound::static_sound::{StaticSoundData, StaticSoundSettings},
# };
# let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
# let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
use kira::tween::Tween;
use std::time::Duration;
sound.set_panning(0.25, Tween {
duration: Duration::from_secs(3),
..Default::default()
})?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
Link the panning to a modulator, smoothly transitioning from the current value:
```no_run
use kira::{
manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
sound::static_sound::{StaticSoundData, StaticSoundSettings},
modulator::tweener::TweenerBuilder,
tween::Tween,
};
use std::time::Duration;
let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
let tweener = manager.add_modulator(TweenerBuilder {
initial_value: 0.25,
})?;
let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
sound.set_panning(&tweener, Tween {
duration: Duration::from_secs(3),
..Default::default()
})?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
*/
pub fn set_panning(
&mut self,
panning: impl Into<Value<f64>>,
tween: Tween,
) -> Result<(), CommandError> {
self.command_producer
.push(Command::SetPanning(panning.into(), tween))
.map_err(|_| CommandError::CommandQueueFull)
}
/**
Sets the portion of the sound that should be played.
# Examples
Set the sound to play from 3 seconds in to the end:
```no_run
# use kira::{
# manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
# sound::static_sound::{StaticSoundData, StaticSoundSettings},
# };
# let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
# let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
sound.set_playback_region(3.0..)?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
Set the sound to play from 2 to 4 seconds:
```no_run
# use kira::{
# manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
# sound::static_sound::{StaticSoundData, StaticSoundSettings},
# };
# let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
# let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
sound.set_playback_region(2.0..4.0)?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
*/
pub fn set_playback_region(
&mut self,
playback_region: impl Into<Region>,
) -> Result<(), CommandError> {
self.command_producer
.push(Command::SetPlaybackRegion(playback_region.into()))
.map_err(|_| CommandError::CommandQueueFull)
}
/**
Sets the portion of the sound that will play in a loop.
# Examples
Set the sound to loop the portion from 3 seconds in to the end:
```no_run
# use kira::{
# manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
# sound::static_sound::{StaticSoundData, StaticSoundSettings},
# };
# let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
# let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
sound.set_loop_region(3.0..)?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
Set the sound to loop the portion from 2 to 4 seconds:
```no_run
# use kira::{
# manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
# sound::static_sound::{StaticSoundData, StaticSoundSettings},
# };
# let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
# let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
sound.set_loop_region(2.0..4.0)?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
Set a sound that was previously looping to stop looping:
```no_run
# use kira::{
# manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
# sound::static_sound::{StaticSoundData, StaticSoundSettings},
# };
# let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
# let mut sound = manager.play(StaticSoundData::from_file("sound.ogg", StaticSoundSettings::default())?)?;
sound.set_loop_region(None)?;
# Result::<(), Box<dyn std::error::Error>>::Ok(())
```
*/
pub fn set_loop_region(
&mut self,
loop_region: impl IntoOptionalRegion,
) -> Result<(), CommandError> {
self.command_producer
.push(Command::SetLoopRegion(
loop_region.into_optional_loop_region(),
))
.map_err(|_| CommandError::CommandQueueFull)
}
/// Fades out the sound to silence with the given tween and then
/// pauses playback.
pub fn pause(&mut self, tween: Tween) -> Result<(), CommandError> {
self.command_producer
.push(Command::Pause(tween))
.map_err(|_| CommandError::CommandQueueFull)
}
/// Resumes playback and fades in the sound from silence
/// with the given tween.
pub fn resume(&mut self, tween: Tween) -> Result<(), CommandError> {
self.command_producer
.push(Command::Resume(tween))
.map_err(|_| CommandError::CommandQueueFull)
}
/// Fades out the sound to silence with the given tween and then
/// stops playback.
///
/// Once the sound is stopped, it cannot be restarted.
pub fn stop(&mut self, tween: Tween) -> Result<(), CommandError> {
self.command_producer
.push(Command::Stop(tween))
.map_err(|_| CommandError::CommandQueueFull)
}
/// Sets the playback position to the specified time in seconds.
pub fn seek_to(&mut self, position: f64) -> Result<(), CommandError> {
self.command_producer
.push(Command::SeekTo(position))
.map_err(|_| CommandError::CommandQueueFull)
}
/// Moves the playback position by the specified amount of time in seconds.
pub fn seek_by(&mut self, amount: f64) -> Result<(), CommandError> {
self.command_producer
.push(Command::SeekBy(amount))
.map_err(|_| CommandError::CommandQueueFull)
}
}