Interface ITimeline

Namespace

SunSharp

Assembly

SunSharp.dll

Project timeline, containing all the existing patterns.

public interface ITimeline

Properties

Slot

Gets the slot this timeline belongs to.

ISlot Slot { get; }

Property Value

ISlot

Methods

ClonePattern(IPatternHandle, int, int)

Clones a pattern and returns a handle to the new pattern.

IPatternHandle ClonePattern(IPatternHandle original, int x, int y)

Parameters

original IPatternHandle

x int

y int

Returns

IPatternHandle

ClonePattern(int, int, int)

Clone a pattern.

int ClonePattern(int patternId, int x, int y)

Parameters

patternId int

x int

Line number on which the pattern starts (horizontal).

y int

Vertical position on the timeline.

Returns

int

The number of the newly created pattern.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_new_pattern(int, int, int, int, int, int, int, IntPtr).

Exceptions

SunVoxException

Thrown when the operation fails.

CreatePattern(int, int, int, int, int, string?)

Create a new pattern.

IPatternHandle CreatePattern(int lines, int tracks, int x, int y, int iconSeed = 0, string? name = null)

Parameters

lines int

Number of lines.

tracks int

Number of tracks.

x int

Line number on which the pattern starts.

y int

Y coordinate on timeline.

iconSeed int

Icon seed for pattern appearance.

name string

Pattern name.

Returns

IPatternHandle

The number of the newly created pattern.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_new_pattern(int, int, int, int, int, int, int, IntPtr).

Exceptions

SunVoxException

Thrown when the operation fails.

GetPattern(int)

IPatternHandle GetPattern(int patternId)

Parameters

patternId int

Returns

IPatternHandle

GetPatternExists(int)

Check if a pattern exists.

bool GetPatternExists(int patternId)

Parameters

patternId int

Pattern number.

Returns

bool

true if pattern exists; false otherwise.

Remarks

Calls sv_get_pattern_lines(int, int).

GetUpperPatternCount()

Get the upper limit of pattern count (one more than the highest pattern number).

int GetUpperPatternCount()

Returns

int

Upper limit of pattern count.

Remarks

Calls sv_get_number_of_patterns(int).

Exceptions

SunVoxException

Thrown when the operation fails.

TryGetPattern(int, out IPatternHandle?)

Tries to get a pattern by ID.

bool TryGetPattern(int patternId, out IPatternHandle? pattern)

Parameters

patternId int

pattern IPatternHandle

Returns

bool

TryGetPattern(string, out IPatternHandle?)

Tries to get a pattern by name.

bool TryGetPattern(string name, out IPatternHandle? pattern)

Parameters

name string

pattern IPatternHandle

Returns

bool