Interface IAimpLyrics

Interface IAimpLyrics Implements the IAimpObject

Namespace: AIMP.SDK.Lyrics

Assembly: AIMP.SDK.dll

Syntax

public interface IAimpLyrics : IAimpObject

Properties

Album

Get or sets the album. Optional.

Declaration

string Album { get; set; }

Application

Gets or sets the application which was used. Optional.

Declaration

string Application { get; set; }

ApplicationVersion

Gets or sets the application version.

Declaration

string ApplicationVersion { get; set; }

Author

Gets or sets the text author. Optional.

Declaration

string Author { get; set; }

Creator

Gets or sets the creator. Optional.

Declaration

string Creator { get; set; }

Offset

Gets or sets common offset in milliseconds.

Declaration

int Offset { get; set; }

Text

Gets or sets the song text without tags.

Declaration

string Text { get; set; }

Title

Gets or sets the song title. Optional.

Declaration

string Title { get; set; }

Type

Gets or sets the lyrics type.

Declaration

LyricsType Type { get; set; }

Methods

Add(Int32, Int32, String)

Adds time interval.

Declaration

AimpActionResult Add(int timeStart, int timeFinish, string text)

Parameters

Type	Name	Description
System.Int32	timeStart	In milliseconds.
System.Int32	timeFinish	In milliseconds.
System.String	text	The text.

Assign(IAimpLyrics)

Copy values from source.

Declaration

AimpActionResult Assign(IAimpLyrics source)

Parameters

Type	Name	Description
IAimpLyrics	source	The source lyrics.

Clone()

Creates a copy of current instance.

Declaration

AimpActionResult<IAimpLyrics> Clone()

Delete(Int32)

Deletes the specified index.

Declaration

AimpActionResult Delete(int index)

Parameters

Type	Name	Description
System.Int32	index	The index.

Find(Int32, Int32)

Finds the specified time.

Declaration

AimpActionResult<string> Find(int time, int index)

Parameters

Type	Name	Description
System.Int32	time	The time.
System.Int32	index	The index.

Get(Int32, Int32, Int32)

Gets the specified index.

Declaration

AimpActionResult<string> Get(int index, int timeStart, int timeFinish)

Parameters

Type	Name	Description
System.Int32	index	The index.
System.Int32	timeStart	The time start.
System.Int32	timeFinish	The time finish.

GetCount()

Gets the count.

Declaration

AimpActionResult<int> GetCount()

LoadFromFile(String)

Loads lyrics from file.

Declaration

AimpActionResult LoadFromFile(string virtualFileName)

Parameters

Type	Name	Description
System.String	virtualFileName	Virtual file name.

LoadFromStream(IAimpStream, LyricsFormat)

Loads lyrics from stream.

Declaration

AimpActionResult LoadFromStream(IAimpStream stream, LyricsFormat format)

Parameters

Type	Name	Description
IAimpStream	stream	File stream.
LyricsFormat	format	Lyrics format LyricsFormat.

LoadFromString(String, LyricsFormat)

Loads lyrics from string.

Declaration

AimpActionResult LoadFromString(string lyrics, LyricsFormat format)

Parameters

Type	Name	Description
System.String	lyrics	String with lyrics.
LyricsFormat	format	Lyrics format LyricsFormat.

SaveToFile(String)

Saves lyrics to file.

Declaration

AimpActionResult SaveToFile(string fileUri)

Parameters

Type	Name	Description
System.String	fileUri	File.

SaveToStream(IAimpStream, LyricsFormat)

Saves lyrics to stream.

Declaration

AimpActionResult SaveToStream(IAimpStream stream, LyricsFormat format)

Parameters

Type	Name	Description
IAimpStream	stream	The stream.
LyricsFormat	format	Lyrics format LyricsFormat.

SaveToString(LyricsFormat)

Saves lyrics to string.

Declaration

AimpActionResult<string> SaveToString(LyricsFormat format)

Parameters

Type	Name	Description
LyricsFormat	format	Lyrics format LyricsFormat.

See Also

IAimpObject