The properties of the Sample class are listed below. For a complete list of Sample class members, see the Sample Members topic.
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. |
Sample Class | ChoonML Namespace