Struct triseratops::tag::container::TagContainer

pub struct TagContainer { /* private fields */ }

Provides a streamlined interface for retrieving Serato tag data.

If you’re not interested in the low-level format details, just use this instead of the low-level structs (e.g. Markers, Markers2, etc.)

Some of the data in Serato’s tags is redundant and may contradict each other. This class implements the same merge strategies for inconsistent data that Serato uses, too.

Implementations

impl TagContainer

pub const fn new() -> Self

Create an empty Serato tag container.

pub fn parse_autotags( &mut self, input: &[u8], tag_format: TagFormat ) -> Result<(), Error>

Parse the Serato Autotags tag.

pub fn write_autotags( &self, writer: &mut impl Write, tag_format: TagFormat ) -> Result<usize, Error>

Write the Serato Autotags tag.

pub fn parse_beatgrid( &mut self, input: &[u8], tag_format: TagFormat ) -> Result<(), Error>

Parse the Serato BeatGrid tag.

pub fn write_beatgrid( &self, writer: &mut impl Write, tag_format: TagFormat ) -> Result<usize, Error>

Write the Serato BeatGrid tag.

pub fn parse_markers( &mut self, input: &[u8], tag_format: TagFormat ) -> Result<(), Error>

Parse the Serato Markers_ tag.

pub fn write_markers( &self, writer: &mut impl Write, tag_format: TagFormat ) -> Result<usize, Error>

Write the Serato Markers_ tag.

pub fn parse_markers2( &mut self, input: &[u8], tag_format: TagFormat ) -> Result<(), Error>

Parse the Serato Markers2 tag.

pub fn write_markers2( &self, writer: &mut impl Write, tag_format: TagFormat ) -> Result<usize, Error>

Write the Serato Markers2 tag.

pub fn parse_overview( &mut self, input: &[u8], tag_format: TagFormat ) -> Result<(), Error>

Parse the Serato Overview tag.

pub fn write_overview( &self, writer: &mut impl Write, tag_format: TagFormat ) -> Result<usize, Error>

Write the Serato Overview tag.

pub fn auto_gain(&self) -> Option<f64>

Returns the auto_gain value from the Serato Autotags tag.

pub fn gain_db(&self) -> Option<f64>

Returns the gain_db value from the Serato Autotags tag.

pub fn beatgrid(&self) -> Option<(&Vec<NonTerminalMarker>, &TerminalMarker)>

Returns the beatgrid from the Serato BeatGrid tag.

pub fn bpm_locked(&self) -> Option<bool>

Returns BPM lock status from the Serato Markers2 tag.

pub fn cues(&self) -> Vec<Cue>

Returns cues from the Serato Markers_ and Serato Markers2 tags.

This retrieves the Serato Markers2 cues first, then overwrite the values with those from Serato Markers_. This is what Serato does too (i.e. if Serato Markers_ and Serato Markers2 contradict each other, Serato will use the values from Serato Markers_).

pub fn loops(&self) -> Vec<Loop>

Returns loops from the Serato Markers_ and Serato Markers2 tags.

This retrieves the Serato Markers2 loops first, then overwrite the values with those from Serato Markers_. This is what Serato does too (i.e. if Serato Markers_ and Serato Markers2 contradict each other, Serato will use the values from Serato Markers_).

pub fn flips(&self) -> Option<impl Iterator<Item = &Flip>>

Returns flips from the Serato Markers2 tag.

pub fn track_color(&self) -> Option<Color>

Returns the track color from the Serato Markers_ and Serato Markers2 tags.

If present the color in Serato Markers_ takes precedence over that in Serato Markers2. This is what Serato does too, i.e. if Serato Markers_ and Serato Markers2 contradict each other, Serato will use the value from Serato Markers_.

pub fn overview_data(&self) -> Option<&[Vec<u8>]>

Returns the waveform overview data color from the Serato Overview tag.

Trait Implementations

impl Clone for TagContainer

fn clone(&self) -> TagContainer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TagContainer

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

Formats the value using the given formatter.

impl Default for TagContainer

fn default() -> Self

Returns the “default value” for a type.