ChoonMLLib - class library to access and convert ChoonML files

Sample Members

Sample overview

Public Instance Properties

BufferLeft The number of bytes of buffer left to write to. This is updated when AddData is used to write sample data out. When this is zero the whole sample can be persisted by calling WriteSample
BufferLen The length of the buffer. This relates to Length and is calculated by StartWrite (assumes a fixed bitrate)
Codec The codec (data encoding) of the sample
EndPosition The end position (in global units) of the sample, relative to the start of the choon. Note that StartPosition, EndPosition and Length are kept related.
ExtFile The path (absolute or relative) of the external file this sample is persisted to.
Index The index of this sample. This corresponds to the 'sample.index' attribute and is *not* necessarily the index in Samples.
Length The length (in global units) of the sample Note that StartPosition, EndPosition and Length are kept related.
Loop Access the 'sample.loop' attribute. This is the number of times to loop the sample, or zero for no loop.
Mute Access the 'sample.mute' boolean attribute
Name The name of this sample.
Part The index (into Parts of the part this sample is in.
RefOnly True if the sample is just a reference to an earlier sample.
SampleFormat The format of the sample
Section The name of the section this sample is in. Optional. Must match in entry in Sections if present.
Skip Access the 'sample.skip' boolean attribute
StartPosition The start position (in global units) of the sample, relative to the start of the choon.

Public Instance Methods

AddData Add data to a sample
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
StartWrite Start writing a sample. This sets up a data buffer into which sample data gets written A converter typically calls StartWrite, then AddData to add data until the buffer is full, then WriteSample to write the sample data out
ToString (inherited from Object) Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

Sample Class | ChoonML Namespace