diff --git a/include/SFML/Audio/InputSoundFile.hpp b/include/SFML/Audio/InputSoundFile.hpp index d50e76ec2..8c51db858 100644 --- a/include/SFML/Audio/InputSoundFile.hpp +++ b/include/SFML/Audio/InputSoundFile.hpp @@ -159,8 +159,9 @@ public: /// other overload. /// /// The sample offset takes the channels into account. - /// Offsets can be calculated like this: - /// `sampleNumber * sampleRate * channelCount` + /// If you have a time offset instead, you can easily find + /// the corresponding sample offset with the following formula: + /// `timeInSeconds * sampleRate * channelCount` /// If the given offset exceeds to total number of samples, /// this function jumps to the end of the sound file. /// diff --git a/include/SFML/Audio/SoundFileReader.hpp b/include/SFML/Audio/SoundFileReader.hpp index 006ce6542..e06230103 100644 --- a/include/SFML/Audio/SoundFileReader.hpp +++ b/include/SFML/Audio/SoundFileReader.hpp @@ -80,8 +80,9 @@ public: /// \brief Change the current read position to the given sample offset /// /// The sample offset takes the channels into account. - /// Offsets can be calculated like this: - /// `sampleNumber * sampleRate * channelCount` + /// If you have a time offset instead, you can easily find + /// the corresponding sample offset with the following formula: + /// `timeInSeconds * sampleRate * channelCount` /// If the given offset exceeds to total number of samples, /// this function must jump to the end of the file. /// diff --git a/src/SFML/Audio/SoundFileReaderFlac.hpp b/src/SFML/Audio/SoundFileReaderFlac.hpp index bde8a197b..5b53a7dd4 100644 --- a/src/SFML/Audio/SoundFileReaderFlac.hpp +++ b/src/SFML/Audio/SoundFileReaderFlac.hpp @@ -83,8 +83,9 @@ public: /// \brief Change the current read position to the given sample offset /// /// The sample offset takes the channels into account. - /// Offsets can be calculated like this: - /// `sampleNumber * sampleRate * channelCount` + /// If you have a time offset instead, you can easily find + /// the corresponding sample offset with the following formula: + /// `timeInSeconds * sampleRate * channelCount` /// If the given offset exceeds to total number of samples, /// this function must jump to the end of the file. /// diff --git a/src/SFML/Audio/SoundFileReaderOgg.hpp b/src/SFML/Audio/SoundFileReaderOgg.hpp index b1bf2529c..5da56f417 100644 --- a/src/SFML/Audio/SoundFileReaderOgg.hpp +++ b/src/SFML/Audio/SoundFileReaderOgg.hpp @@ -83,8 +83,9 @@ public: /// \brief Change the current read position to the given sample offset /// /// The sample offset takes the channels into account. - /// Offsets can be calculated like this: - /// `sampleNumber * sampleRate * channelCount` + /// If you have a time offset instead, you can easily find + /// the corresponding sample offset with the following formula: + /// `timeInSeconds * sampleRate * channelCount` /// If the given offset exceeds to total number of samples, /// this function must jump to the end of the file. /// diff --git a/src/SFML/Audio/SoundFileReaderWav.hpp b/src/SFML/Audio/SoundFileReaderWav.hpp index 904408b29..89144a19e 100644 --- a/src/SFML/Audio/SoundFileReaderWav.hpp +++ b/src/SFML/Audio/SoundFileReaderWav.hpp @@ -75,8 +75,9 @@ public: /// \brief Change the current read position to the given sample offset /// /// The sample offset takes the channels into account. - /// Offsets can be calculated like this: - /// `sampleNumber * sampleRate * channelCount` + /// If you have a time offset instead, you can easily find + /// the corresponding sample offset with the following formula: + /// `timeInSeconds * sampleRate * channelCount` /// If the given offset exceeds to total number of samples, /// this function must jump to the end of the file. ///