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
// Copyright (c) 2024 Melody Madeline Lyons
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
use std::ffi::{c_float, c_int};
use fmod_sys::*;
use lanyard::Utf8CStr;
use crate::studio::{EventInstance, ParameterID};
#[cfg(doc)]
use crate::studio::{ParameterKind, PlaybackState};
use crate::{FmodResultExt, Result};
impl EventInstance {
/// Sets a parameter value by name.
///
/// The value will be set instantly regardless of `ignore_seek_speed` when the Event playback state is [`PlaybackState::Stopped`].
///
/// If the specified parameter is read only, is an automatic parameter or is not of type [`ParameterKind::GameControlled`] then [`FMOD_RESULT::FMOD_ERR_INVALID_PARAM`] is returned.
///
/// If the event has no parameter matching name then [`FMOD_RESULT::FMOD_ERR_EVENT_NOTFOUND`] is returned.
pub fn set_parameter_by_name(
&self,
name: &Utf8CStr,
value: c_float,
ignore_seek_speed: bool,
) -> Result<()> {
unsafe {
FMOD_Studio_EventInstance_SetParameterByName(
self.inner.as_ptr(),
name.as_ptr(),
value,
ignore_seek_speed.into(),
)
.to_result()
}
}
/// Sets a parameter value by name, looking up the value label.
///
/// The label will be set instantly regardless of `ignore_seek_speed` when the Event playback state is [`PlaybackState::Stopped`].
///
/// If the specified parameter is read only, is an automatic parameter or is not of type [`ParameterKind::GameControlled`] then [`FMOD_RESULT::FMOD_ERR_INVALID_PARAM`] is returned.
///
/// If the event has no parameter matching name then [`FMOD_RESULT::FMOD_ERR_EVENT_NOTFOUND`] is returned.
///
/// If the specified label is not found, [`FMOD_RESULT::FMOD_ERR_EVENT_NOTFOUND`] is returned. This lookup is case sensitive.
pub fn set_parameter_by_name_with_label(
&self,
name: &Utf8CStr,
label: &Utf8CStr,
ignore_seek_speed: bool,
) -> Result<()> {
unsafe {
FMOD_Studio_EventInstance_SetParameterByNameWithLabel(
self.inner.as_ptr(),
name.as_ptr(),
label.as_ptr(),
ignore_seek_speed.into(),
)
.to_result()
}
}
/// Retrieves a parameter value by name.
///
/// Automatic parameters always return value as 0 since they can never have their value set from the public API.
///
/// The second returned tuple field is the final value of the parameter after applying adjustments due to automation, modulation, seek speed, and parameter velocity to value.
/// This is calculated asynchronously when the Studio system updates.
pub fn get_parameter_by_name(&self, name: &Utf8CStr) -> Result<(c_float, c_float)> {
let mut value = 0.0;
let mut final_value = 0.0;
unsafe {
FMOD_Studio_EventInstance_GetParameterByName(
self.inner.as_ptr(),
name.as_ptr(),
&raw mut value,
&raw mut final_value,
)
.to_result()?;
}
Ok((value, final_value))
}
/// Sets a parameter value by unique identifier.
///
/// The value will be set instantly regardless of `ignore_seek_speed` when the Event playback state is [`PlaybackState::Stopped`].
///
/// If the specified parameter is read only, is an automatic parameter or is not of type [`ParameterKind::GameControlled`] then [`FMOD_RESULT::FMOD_ERR_INVALID_PARAM`] is returned.
pub fn set_parameter_by_id(
&self,
id: ParameterID,
value: c_float,
ignore_seek_speed: bool,
) -> Result<()> {
unsafe {
FMOD_Studio_EventInstance_SetParameterByID(
self.inner.as_ptr(),
id.into(),
value,
ignore_seek_speed.into(),
)
.to_result()
}
}
/// Sets a parameter value by unique identifier, looking up the value label.
///
/// The label will be set instantly regardless of `ignore_seek_speed` when the Event playback state is [`PlaybackState::Stopped`].
///
/// If the specified parameter is read only, is an automatic parameter or is not of type [`ParameterKind::GameControlled`] then [`FMOD_RESULT::FMOD_ERR_INVALID_PARAM`] is returned.
///
/// If the specified label is not found, [`FMOD_RESULT::FMOD_ERR_EVENT_NOTFOUND`] is returned. This lookup is case sensitive.
pub fn set_parameter_by_id_with_label(
&self,
id: ParameterID,
label: &Utf8CStr,
ignore_seek_speed: bool,
) -> Result<()> {
unsafe {
FMOD_Studio_EventInstance_SetParameterByIDWithLabel(
self.inner.as_ptr(),
id.into(),
label.as_ptr(),
ignore_seek_speed.into(),
)
.to_result()
}
}
/// Retrieves a parameter value by unique identifier.
///
/// Automatic parameters always return value as 0 since they can never have their value set from the public API.
///
/// The second returned tuple field is the final value of the parameter after applying adjustments due to automation, modulation, seek speed, and parameter velocity to value.
/// This is calculated asynchronously when the Studio system updates.
pub fn get_parameter_by_id(&self, id: ParameterID) -> Result<(c_float, c_float)> {
let mut value = 0.0;
let mut final_value = 0.0;
unsafe {
FMOD_Studio_EventInstance_GetParameterByID(
self.inner.as_ptr(),
id.into(),
&raw mut value,
&raw mut final_value,
)
.to_result()?;
}
Ok((value, final_value))
}
/// Sets multiple parameter values by unique identifier.
///
/// All values will be set instantly regardless of `ingore_seek_speed` when the Event playback state is [`PlaybackState::Stopped`].
///
/// If any ID is set to all zeroes then the corresponding value will be ignored.
///
/// # Panics
///
/// This function will panic if `ids.len()` != `values.len()`.
pub fn set_parameters_by_ids(
&self,
ids: &[ParameterID], // TODO fmod says that the size of this must range from 1-32. do we need to enforce this?
values: &mut [c_float], // TODO is this &mut correct? does fmod perform any writes?
ignore_seek_speed: bool,
) -> Result<()> {
// TODO don't panic, return result
assert_eq!(ids.len(), values.len());
unsafe {
FMOD_Studio_EventInstance_SetParametersByIDs(
self.inner.as_ptr(),
ids.as_ptr().cast(),
values.as_mut_ptr(),
ids.len() as c_int,
ignore_seek_speed.into(),
)
.to_result()
}
}
}