Enum TimeUnit

#[repr(u32)]
pub enum TimeUnit {
    MS = 1,
    PCM = 2,
    PCMBytes = 4,
    RawBytes = 8,
    PCMFraction = 16,
    ModOrder = 256,
    ModRow = 512,
    ModPattern = 1_024,
}

Time types used for position or length.

Variants

MS = 1

Milliseconds.

PCM = 2

PCM samples, related to milliseconds * samplerate / 1000.

PCMBytes = 4

Bytes, related to PCM samples * channels * datawidth (ie 16bit = 2 bytes).

RawBytes = 8

Raw file bytes of (compressed) sound data (does not include headers).

Only used by Sound::get_length and Channel::get_position.

PCMFraction = 16

Fractions of 1 PCM sample. Unsigned int range 0 to 0xFFFFFFFF.

Used for sub-sample granularity for DSP purposes.

ModOrder = 256

MOD/S3M/XM/IT. Order in a sequenced module format.

Use Sound::get_format to determine the PCM format being decoded to.

ModRow = 512

MOD/S3M/XM/IT. Current row in a sequenced module format.

Cannot use with Channel::set_position. Sound::get_length will return the number of rows in the currently playing or seeked to pattern.

ModPattern = 1_024

MOD/S3M/XM/IT. Current pattern in a sequenced module format.

Cannot use with Channel::set_position. Sound::get_length will return the number of patterns in the song and Channel::get_position will return the currently playing pattern.

Trait Implementations

impl Clone for TimeUnit

fn clone(&self) -> TimeUnit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TimeUnit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<TimeUnit> for u32

fn from(enum_value: TimeUnit) -> Self

Converts to this type from the input type.

impl PartialEq for TimeUnit

fn eq(&self, other: &TimeUnit) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<u32> for TimeUnit

type Error = TryFromPrimitiveError<TimeUnit>

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for TimeUnit

const NAME: &'static str = "TimeUnit"

type Primitive = u32

type Error = TryFromPrimitiveError<TimeUnit>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl UnsafeFromPrimitive for TimeUnit

type Primitive = u32

unsafe fn unchecked_transmute_from(number: Self::Primitive) -> Self

Transmutes into an enum from its primitive.

unsafe fn from_unchecked(number: Self::Primitive) -> Self

👎Deprecated since 0.6.0: Prefer to use unchecked_transmute_from, from_unchecked will be removed in a future release.

Transmutes into an enum from its primitive.

impl Copy for TimeUnit

impl Eq for TimeUnit

impl StructuralPartialEq for TimeUnit