Skip to main content

AlignedLyrics

Struct AlignedLyrics 

Source
pub struct AlignedLyrics {
    pub words: Vec<AlignedWord>,
    pub lines: Vec<AlignedLine>,
}
Expand description

A clip’s aligned lyrics: the flat word list and the line list.

Both are empty for an instrumental or an un-alignable clip; see is_empty.

Fields§

§words: Vec<AlignedWord>§lines: Vec<AlignedLine>

Implementations§

Source§

impl AlignedLyrics

Source

pub fn from_json(raw: &Value) -> AlignedLyrics

Map the aligned_lyrics/v2 response body, tolerating missing keys.

A non-object body, or one whose arrays are missing, maps to the empty value, so a malformed or instrumental response is simply “no synced lyrics” rather than an error.

Source

pub fn from_bytes(body: &[u8]) -> AlignedLyrics

Parse the aligned_lyrics/v2 response bytes, or the empty value when the body is not valid JSON (defensive: an odd body means “no synced lyrics”).

Source

pub fn is_empty(&self) -> bool

True when the clip carries no aligned lyrics (an instrumental, or a clip Suno could not align). No synced artefact is written for such a clip.

Source

pub fn plain_text(&self) -> String

The plain lyric text, one line per aligned line (falling back to the flat word list when there are no lines), for the unsynced LYRICS/USLT tag.

Returns an empty string when there is nothing to embed.

Source

pub fn lrc_body(&self) -> String

The body of a standard (line-level) .lrc: one [mm:ss.xx] stamp per aligned line, followed by the line text.

Line-level is the universally supported LRC form, so every player syncs and displays it cleanly; the enhanced “A2” per-word <mm:ss.xx> tags are parsed by only a few karaoke players and are shown as literal text by the rest, so they are not emitted here. Word-level timing is carried instead in the MP3 SYLT frame (see sylt_entries). A line with empty text falls back to its nested words joined by spaces. The body is empty when there are no lines; callers treat that as “no .lrc”.

Source

pub fn sylt_entries(&self) -> Vec<(u32, String)>

Word-level SYLT content: (offset_ms, text) pairs in time order.

Each new line’s first word carries a leading newline so a player renders line breaks (the ID3v2 SYLT convention). Uses Suno’s own line grouping; a line with no nested words contributes its whole text as one segment.

Trait Implementations§

Source§

impl Clone for AlignedLyrics

Source§

fn clone(&self) -> AlignedLyrics

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AlignedLyrics

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AlignedLyrics

Source§

fn default() -> AlignedLyrics

Returns the “default value” for a type. Read more
Source§

impl PartialEq for AlignedLyrics

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for AlignedLyrics

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.