Correct docstring for seek
This commit is contained in:
parent
6d122e96e1
commit
6d4e870e32
@ -159,8 +159,9 @@ public:
|
|||||||
/// other overload.
|
/// other overload.
|
||||||
///
|
///
|
||||||
/// The sample offset takes the channels into account.
|
/// The sample offset takes the channels into account.
|
||||||
/// Offsets can be calculated like this:
|
/// If you have a time offset instead, you can easily find
|
||||||
/// `sampleNumber * sampleRate * channelCount`
|
/// the corresponding sample offset with the following formula:
|
||||||
|
/// `timeInSeconds * sampleRate * channelCount`
|
||||||
/// If the given offset exceeds to total number of samples,
|
/// If the given offset exceeds to total number of samples,
|
||||||
/// this function jumps to the end of the sound file.
|
/// this function jumps to the end of the sound file.
|
||||||
///
|
///
|
||||||
|
@ -80,8 +80,9 @@ public:
|
|||||||
/// \brief Change the current read position to the given sample offset
|
/// \brief Change the current read position to the given sample offset
|
||||||
///
|
///
|
||||||
/// The sample offset takes the channels into account.
|
/// The sample offset takes the channels into account.
|
||||||
/// Offsets can be calculated like this:
|
/// If you have a time offset instead, you can easily find
|
||||||
/// `sampleNumber * sampleRate * channelCount`
|
/// the corresponding sample offset with the following formula:
|
||||||
|
/// `timeInSeconds * sampleRate * channelCount`
|
||||||
/// If the given offset exceeds to total number of samples,
|
/// If the given offset exceeds to total number of samples,
|
||||||
/// this function must jump to the end of the file.
|
/// this function must jump to the end of the file.
|
||||||
///
|
///
|
||||||
|
@ -83,8 +83,9 @@ public:
|
|||||||
/// \brief Change the current read position to the given sample offset
|
/// \brief Change the current read position to the given sample offset
|
||||||
///
|
///
|
||||||
/// The sample offset takes the channels into account.
|
/// The sample offset takes the channels into account.
|
||||||
/// Offsets can be calculated like this:
|
/// If you have a time offset instead, you can easily find
|
||||||
/// `sampleNumber * sampleRate * channelCount`
|
/// the corresponding sample offset with the following formula:
|
||||||
|
/// `timeInSeconds * sampleRate * channelCount`
|
||||||
/// If the given offset exceeds to total number of samples,
|
/// If the given offset exceeds to total number of samples,
|
||||||
/// this function must jump to the end of the file.
|
/// this function must jump to the end of the file.
|
||||||
///
|
///
|
||||||
|
@ -83,8 +83,9 @@ public:
|
|||||||
/// \brief Change the current read position to the given sample offset
|
/// \brief Change the current read position to the given sample offset
|
||||||
///
|
///
|
||||||
/// The sample offset takes the channels into account.
|
/// The sample offset takes the channels into account.
|
||||||
/// Offsets can be calculated like this:
|
/// If you have a time offset instead, you can easily find
|
||||||
/// `sampleNumber * sampleRate * channelCount`
|
/// the corresponding sample offset with the following formula:
|
||||||
|
/// `timeInSeconds * sampleRate * channelCount`
|
||||||
/// If the given offset exceeds to total number of samples,
|
/// If the given offset exceeds to total number of samples,
|
||||||
/// this function must jump to the end of the file.
|
/// this function must jump to the end of the file.
|
||||||
///
|
///
|
||||||
|
@ -75,8 +75,9 @@ public:
|
|||||||
/// \brief Change the current read position to the given sample offset
|
/// \brief Change the current read position to the given sample offset
|
||||||
///
|
///
|
||||||
/// The sample offset takes the channels into account.
|
/// The sample offset takes the channels into account.
|
||||||
/// Offsets can be calculated like this:
|
/// If you have a time offset instead, you can easily find
|
||||||
/// `sampleNumber * sampleRate * channelCount`
|
/// the corresponding sample offset with the following formula:
|
||||||
|
/// `timeInSeconds * sampleRate * channelCount`
|
||||||
/// If the given offset exceeds to total number of samples,
|
/// If the given offset exceeds to total number of samples,
|
||||||
/// this function must jump to the end of the file.
|
/// this function must jump to the end of the file.
|
||||||
///
|
///
|
||||||
|
Loading…
Reference in New Issue
Block a user