An annotation. More...

Inherits Component.

Public Member Functions
	Annotation ()
	Default constructor. More...

	Annotation (IContainer container)
	Constructor. More...

void	AlignSelectedLayers (int maxDistance)
	Align segments on selected layers. First layer is pattern for others. More...

void	AudioEmbedToExternal (AudioFileObject audioFile)
	Remove audio file from ANT file and link to external audio file. More...

void	AudioExternalToEmbed (AudioFileObject audioFile)
	Import external audio file to ANT file. More...

string	AudioFileToPath (AudioFileObject audioFile)
	Retrieve audio file path from AudioFileObject. If extrnal returns FileName otherwise returns combination DataFolder and FileName. More...

void	AutoGroup (LayerCollection layerCollection)
	Automatic group. More...

void	ClearParameters (LayerCollection selectedLayers)
	Clears the parameters described by selectedLayers. More...

void	ClearParameters (LayerCollection selectedLayers, bool onlySelectedSegments)
	Clears the parameters described by selectedLayers. More...

void	ClearSelection ()
	Clears the selection. More...

void	ClearSelection (bool clearLayers, bool clearSegments)
	Clears the selection. More...

void	ClearVideoIndex (int videoIndex, bool changeIsModified)
	Clears given video index in all layers. More...

void	Consolidate (LayerCollection layerCollection, string label)
	Consolidates. More...

void	Consolidate (LayerObject layer, string label)
	Consolidates. More...

void	CopyToClipboard ()
	Copies to clipboard. More...

void	Crop (float start, float end)
	Crops annotation to given start and end. More...

void	CutToClipboard ()
	Cuts to clipboard. More...

void	DeleteSegment (SegmentObject segment)
	Deletes the segment described by segment. More...

string	ExportLayerToCSVString (LayerObject layer)
	Exports layer to CSV string. More...

void	ExportLayerToTextGrid (LayerObject layer, string fileName, float lengthInSamples, int threshold)
	Exports layer to TextGrid file. More...

string	ExportLayerToTextGridString (LayerObject layer, int layerIndex, float lengthInSamples, int threshold)
	Exports layer to TextGrid string. More...

string	ExportSegmentToTextGridString (SegmentObject segment, int index)
	Exports segment to TextGrid string. More...

string	ExportTextGridHeader (float lengthInSamples, int layersCount)
	Creates TextGrid header string. More...

void	ExportToCSV (bool open)
	Export to CSV. More...

void	ExportToEAF (bool open)
	Export annotation to EAF file (ELAN). More...

void	ExportToTextGrid (bool open, float lengthInSamples, int threshold)
	Export all layers to TextGrid file. More...

void	ExportToTextGrid (string fileName, bool open, float lengthInSamples, int threshold)
	Exports annotation to TextGrid. More...

void	ExportToXRA (bool open)
	Export annotation to XRA file (Sppas). More...

void	FillPauses (LayerCollection layerCollection, string pauseLabel, float rangeStart, float rangeEnd, float minimumSpace, float maximumSpace)
	Fill pauses. More...

void	FillPauses (LayerObject layer, string pauseLabel, float rangeStart, float rangeEnd, float minimumSpace, float maximumSpace)
	Fill pauses. More...

void	Find (string findText)
	Searches for the first match for the given string. More...

void	Find (string findText, FindReplaceOptions options)
	Searches for the first match for the given string. More...

void	FindAll (string findText)
	Searches for the first all. More...

void	FindAll (string findText, FindReplaceOptions options)
	Searches for the first all. More...

string	FindAudioInFolder ()
	Find wave file in folder annotation file folder. More...

SegmentObject	FindLeftMostSegment ()
	Find most left segment in whole annotation. More...

SegmentObject	FindRightMostSegment ()
	Find most right segment in whole annotation. More...

string	GetContentCSVString ()
	Gets content CSV string. More...

string	GetContentHeaderCSVString ()
	Gets content header CSV string. More...

KeyValuePair< string, string >	GetTextGridPairFromLine (string line)
	Gets text grid pair from line. More...

void	GroupSelectedSegments ()
	Group selected segments. More...

LayerObject	ImportLayerFromBLF (string fileName)
	Import layer from blf. More...

LayerObject	ImportLayerFromCSVLabelStartStop (string fileName, int samplerate)
	Import layer from CSV label start stop. More...

LayerObject	ImportLayerFromText (int startInSamples, string text)
	Import layer from text. More...

LayerObject	ImportLayerFromText (int startInSamples, int lineDurationInSamples, string text)
	Imports layer from text, converts lines into segments. Each segment has given line duration. More...

LayerObject	ImportLayerFromTRS (string fileName, int samplerate)
	Import layer from trs. More...

LayerCollection	ImportLayersFromPraatF0 (string fileName, int samplerate)
	Import layers from Praat F0 file. More...

LayerCollection	ImportLayersFromPraatFormants (string fileName, int samplerate)
	Import layers from Praat formants file. More...

LayerCollection	ImportLayersFromTextGrid (string fileName, int samplerate)
	Import layers from text grid. More...

AudioFileObject	InsertAudioFile (string sourceFile, bool external)
	Inserts an audio file described by sourceFile. More...

void	InsertVideoFile (string sourceFile, double duration)
	Inserts video file into annotation. More...

void	InvertSegmentSelection ()
	Inverts segment selection. More...

bool	New ()
	Creates new annotation. More...

bool	Open ()
	Opens annotation. More...

bool	Open (string fileName)
	Opens annotation. More...

void	PasteFromClipboard (LayerObject destinationLayer, float startPosition, float maxPosition)
	Pastes from clipboard. More...

void	RemoveAudioFile (AudioFileObject audioFile)
	Removes audio file from data. More...

void	RemoveVideoFile (VideoFileObject videoFile)
	Removes given video file from annotation. More...

void	Replace (string findText, string replaceText)
	Replaces. More...

void	Replace (string findText, string replaceText, FindReplaceOptions options)
	Replaces. More...

void	ReplaceAll (string findText, string replaceText)
	Replace all. More...

void	ReplaceAll (string findText, string replaceText, FindReplaceOptions options)
	Replace all. More...

bool	Save ()
	Saves this object. More...

bool	Save (string filePath)
	Saves this object. More...

bool	SaveAs ()
	Saves annotation as. More...

void	SaveSubAnnotation (string annotationFilePath, float start, float end, bool withAudioFiles)
	Saves a sub annotation. More...

void	SelectGroup (SegmentObject segment)
	Selects group. More...

void	SelectSegmentRange (SegmentObject segmentFrom, SegmentObject segmentTo)
	Select segment range. More...

void	SendSelectionChanged (object sender, EventArgs e)
	Sends a selection changed. More...

bool	SpaceSegmentsEqually (LayerObject layer, float samplesCount)
	Spaces segment equally on selected layer. More...

List< SegmentCollection >	Split (LayerObject layer, string label)
	Splits. More...

List< SegmentCollection >	SplitByCount (LayerObject layer, int count)
	Splits by count. More...

List< SegmentCollection >	SplitByPauses (LayerObject layer)
	Splits by pauses. More...

void	UngroupSelectedSegments ()
	Ungroup selected segments. More...

Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used. More...

Properties
string	AnnotationFileName `[get]`
	Annotation file name build in application, normally "annotation.xml" when use with DataFolder gets access to annotation XML. More...

AudioFileCollection	AudioFiles = new LayerCollection() `[get, set]`
	Gets or sets the audio files. More...

string	Author = string.Empty `[get, set]`
	Gets or sets author of the annotation. More...

ConfigurationCollection	Configuration = new SpeakerCollection() `[get, set]`
	Gets or sets the configuration. More...

string	DataFolder = new ConfigurationCollection() `[get, set]`
	Gets the pathname of the data folder. More...

string	FilePath = string.Empty `[get, set]`
	Gets the full pathname of the file. More...

bool	InSessionMode = string.Empty `[get, set]`
	Gets or sets a value indicating whether the in session mode. More...

bool	IsModified `[get, set]`
	Gets or sets a value indicating whether this object is modified. More...

bool	IsPlainXmlFormat = "New Annotation" `[get, set]`
	If true annotation is saved in plain ANTX (xml) file instead of boxing annotation.xml in ANT (zip) file. More...

LayerCollection	Layers `[get, set]`
	Gets or sets the layers. More...

float	Length `[get]`
	Get annotation length in seconds, last segment end position determines length of annotation. More...

bool	LockExistingLayersInSession = false `[get, set]`
	Gets or sets a value indicating whether the existing layers in session is locked. More...

string	ProjectCollection = string.Empty `[get, set]`
	Gets or sets a collection of projects. More...

string	ProjectCorpusOwner = string.Empty `[get, set]`
	Gets or sets the project corpus that owns this item. More...

string	ProjectCorpusType = string.Empty `[get, set]`
	Gets or sets the type of the project corpus. More...

string	ProjectDescription = string.Empty `[get, set]`
	Gets or sets information describing the project. More...

string	ProjectEnvironment = string.Empty `[get, set]`
	Gets or sets the project environment. More...

string	ProjectLicense = string.Empty `[get, set]`
	Gets or sets the project license. More...

string	ProjectNoises = string.Empty `[get, set]`
	Gets or sets the project noises. More...

string	ProjectTitle `[get, set]`
	Gets or sets the project title. More...

int	Samplerate `[get, set]`
	Gets or sets the samplerate. More...

LayerObject	SelectedLayer = false `[get]`
	Gets the selected layer. More...

LayerCollection	SelectedLayers `[get]`
	Gets the selected layers. More...

SegmentObject	SelectedSegment `[get]`
	Gets the selected segment. More...

SegmentCollection	SelectedSegments `[get]`
	Gets the selected segments. More...

SettingsCollection	Settings = new VideoFileCollection() `[get, set]`
	Gets or sets options for controlling the operation. More...

SpeakerCollection	Speakers = new SettingsCollection() `[get, set]`
	Gets or sets speaker for annotation. More...

string	SuggestedFileName = "annotation.xml" `[get, set]`
	Suggested name in SaveFileDialog More...

VideoFileCollection	VideoFiles = new AudioFileCollection() `[get, set]`
	Gets or sets video files. More...

Events
ChangedHandler	Changed
	Event queue for all listeners interested in Changed events. More...

ChangedHandler	Modified
	Event queue for all listeners interested in Modified events. More...

SelectionChangedHandler	SelectionChanged
	Event queue for all listeners interested in SelectionChanged events. More...

Detailed Description

An annotation.

Constructor & Destructor Documentation

◆ Annotation() [1/2]

Annotation ( )

inline

Default constructor.

◆ Annotation() [2/2]

Annotation ( IContainer container )

inline

Constructor.

Parameters

container The container.

Member Function Documentation

◆ AlignSelectedLayers()

void AlignSelectedLayers ( int maxDistance )

inline

Align segments on selected layers. First layer is pattern for others.

Parameters

maxDistance select only borders less than maxDistance

◆ AudioEmbedToExternal()

void AudioEmbedToExternal ( AudioFileObject audioFile )

inline

Remove audio file from ANT file and link to external audio file.

Parameters

audioFile Audio file information

◆ AudioExternalToEmbed()

void AudioExternalToEmbed ( AudioFileObject audioFile )

inline

Import external audio file to ANT file.

Parameters

audioFile Audio file with information

◆ AudioFileToPath()

string AudioFileToPath ( AudioFileObject audioFile )

inline

Retrieve audio file path from AudioFileObject. If extrnal returns FileName otherwise returns combination DataFolder and FileName.

Parameters

audioFile audio file object

Returns

◆ AutoGroup()

void AutoGroup ( LayerCollection layerCollection )

inline

Automatic group.

Parameters

layerCollection Collection of layers.

◆ ClearParameters() [1/2]

void ClearParameters ( LayerCollection selectedLayers )

inline

Clears the parameters described by selectedLayers.

Parameters

selectedLayers The selected layers.

◆ ClearParameters() [2/2]

void ClearParameters	(	LayerCollection	selectedLayers,
		bool	onlySelectedSegments
	)

inline

Clears the parameters described by selectedLayers.

Parameters

selectedLayers	The selected layers.
onlySelectedSegments	true to only selected segments.

◆ ClearSelection() [1/2]

void ClearSelection ( )

inline

Clears the selection.

◆ ClearSelection() [2/2]

void ClearSelection	(	bool	clearLayers,
		bool	clearSegments
	)

inline

Clears the selection.

Parameters

clearLayers	true to clear layers.
clearSegments	true to clear segments.

◆ ClearVideoIndex()

void ClearVideoIndex	(	int	videoIndex,
		bool	changeIsModified
	)

inline

Clears given video index in all layers.

Parameters

videoIndex	Video index to clear
changeIsModified	If true changes IsModified flag

◆ Consolidate() [1/2]

void Consolidate	(	LayerCollection	layerCollection,
		string	label
	)

inline

Consolidates.

Parameters

layerCollection	Collection of layers.
label	The label.

◆ Consolidate() [2/2]

void Consolidate	(	LayerObject	layer,
		string	label
	)

inline

Consolidates.

Parameters

layer	The layer.
label	The label.

◆ CopyToClipboard()

void CopyToClipboard ( )

inline

Copies to clipboard.

◆ Crop()

void Crop	(	float	start,
		float	end
	)

inline

Crops annotation to given start and end.

Parameters

start	cropping start position in samples
end	cropping end position in samples

◆ CutToClipboard()

void CutToClipboard ( )

inline

Cuts to clipboard.

◆ DeleteSegment()

void DeleteSegment ( SegmentObject segment )

inline

Deletes the segment described by segment.

Parameters

segment The segment.

◆ Dispose()

override void Dispose ( bool disposing )

inlineprotected

Clean up any resources being used.

Parameters

disposing true if managed resources should be disposed; otherwise, false.

◆ ExportLayerToCSVString()

string ExportLayerToCSVString ( LayerObject layer )

inline

Exports layer to CSV string.

Parameters

layer Layer to export

Returns: CSV contents

◆ ExportLayerToTextGrid()

void ExportLayerToTextGrid	(	LayerObject	layer,
		string	fileName,
		float	lengthInSamples,
		int	threshold
	)

inline

Exports layer to TextGrid file.

Parameters

layer	Source layer to export
fileName	Destination TextGrid file name
lengthInSamples	Full length in samples
threshold	Threshold to decide whether move to border or fill in the gap

◆ ExportLayerToTextGridString()

string ExportLayerToTextGridString	(	LayerObject	layer,
		int	layerIndex,
		float	lengthInSamples,
		int	threshold
	)

inline

Exports layer to TextGrid string.

Parameters

layer	Layer to export
layerIndex	Layer index (starts from 1)
lengthInSamples	Full length in samples
threshold	Threshold to decide whether move to border or fill in the gap

Returns: String represents layer in TextGrid format

◆ ExportSegmentToTextGridString()

string ExportSegmentToTextGridString	(	SegmentObject	segment,
		int	index
	)

inline

Exports segment to TextGrid string.

Parameters

segment	Source segment
index	Index of the segment

Returns: A string.

◆ ExportTextGridHeader()

string ExportTextGridHeader	(	float	lengthInSamples,
		int	layersCount
	)

inline

Creates TextGrid header string.

Parameters

lengthInSamples	Full length in samples
layersCount	Layers count

Returns: Header string

◆ ExportToCSV()

void ExportToCSV ( bool open )

inline

Export to CSV.

Parameters

open	true to open.

◆ ExportToEAF()

void ExportToEAF ( bool open )

inline

Export annotation to EAF file (ELAN).

Parameters

open	Open file after export if true

◆ ExportToTextGrid() [1/2]

void ExportToTextGrid	(	bool	open,
		float	lengthInSamples,
		int	threshold
	)

inline

Export all layers to TextGrid file.

Parameters

open	Open after export
lengthInSamples	Full length in samples
threshold	Threshold param

◆ ExportToTextGrid() [2/2]

void ExportToTextGrid	(	string	fileName,
		bool	open,
		float	lengthInSamples,
		int	threshold
	)

inline

Exports annotation to TextGrid.

Parameters

fileName	Destination file name
open	Open in default application after export
lengthInSamples	Full length in samples
threshold	Threshold to decide whether move to border or fill in the gap

◆ ExportToXRA()

void ExportToXRA ( bool open )

inline

Export annotation to XRA file (Sppas).

Parameters

open	Open file after export if true

◆ FillPauses() [1/2]

void FillPauses	(	LayerCollection	layerCollection,
		string	pauseLabel,
		float	rangeStart,
		float	rangeEnd,
		float	minimumSpace,
		float	maximumSpace
	)

inline

Fill pauses.

Parameters

layerCollection	Collection of layers.
pauseLabel	The pause label.
rangeStart	Start position
rangeEnd	End position
minimumSpace	Minimum size of space to fill pause
maximumSpace	Maximum size of space to fill pause

◆ FillPauses() [2/2]

void FillPauses	(	LayerObject	layer,
		string	pauseLabel,
		float	rangeStart,
		float	rangeEnd,
		float	minimumSpace,
		float	maximumSpace
	)

inline

Fill pauses.

Parameters

layer	The layer.
pauseLabel	The pause label.
rangeStart	Start position
rangeEnd	End position
minimumSpace	Minimum size of space to fill pause
maximumSpace	Maximum size of space to fill pause

◆ Find() [1/2]

void Find ( string findText )

inline

Searches for the first match for the given string.

Parameters

findText The find text.

◆ Find() [2/2]

void Find	(	string	findText,
		FindReplaceOptions	options
	)

inline

Searches for the first match for the given string.

Parameters

findText	The find text.
options	Options for controlling the operation.

◆ FindAll() [1/2]

void FindAll ( string findText )

inline

Searches for the first all.

Parameters

findText The find text.

◆ FindAll() [2/2]

void FindAll	(	string	findText,
		FindReplaceOptions	options
	)

inline

Searches for the first all.

Parameters

findText	The find text.
options	Options for controlling the operation.

◆ FindAudioInFolder()

string FindAudioInFolder ( )

inline

Find wave file in folder annotation file folder.

Returns

◆ FindLeftMostSegment()

SegmentObject FindLeftMostSegment ( )

inline

Find most left segment in whole annotation.

Returns: Most left segment or null if there is no segments.

◆ FindRightMostSegment()

SegmentObject FindRightMostSegment ( )

inline

Find most right segment in whole annotation.

Returns: Most right segment or null if there is no segments.

◆ GetContentCSVString()

string GetContentCSVString ( )

inline

Gets content CSV string.

Returns: The content CSV string.

◆ GetContentHeaderCSVString()

string GetContentHeaderCSVString ( )

inline

Gets content header CSV string.

Returns: The content header CSV string.

◆ GetTextGridPairFromLine()

KeyValuePair<string, string> GetTextGridPairFromLine ( string line )

inline

Gets text grid pair from line.

Parameters

line The line.

Returns: The text grid pair from line.

◆ GroupSelectedSegments()

void GroupSelectedSegments ( )

inline

Group selected segments.

◆ ImportLayerFromBLF()

LayerObject ImportLayerFromBLF ( string fileName )

inline

Import layer from blf.

Parameters

fileName Filename of the file.

Returns: A LayerObject.

◆ ImportLayerFromCSVLabelStartStop()

LayerObject ImportLayerFromCSVLabelStartStop	(	string	fileName,
		int	samplerate
	)

inline

Import layer from CSV label start stop.

Parameters

fileName	Filename of the file.
samplerate	The samplerate.

Returns: A LayerObject.

◆ ImportLayerFromText() [1/2]

LayerObject ImportLayerFromText	(	int	startInSamples,
		string	text
	)

inline

Import layer from text.

Parameters

startInSamples	The start in samples.
text	The text.

Returns: A LayerObject.

◆ ImportLayerFromText() [2/2]

LayerObject ImportLayerFromText	(	int	startInSamples,
		int	lineDurationInSamples,
		string	text
	)

inline

Imports layer from text, converts lines into segments. Each segment has given line duration.

Parameters

startInSamples	Where to put first segment
lineDurationInSamples	Each segment duration
text	Text to convert into segments.

Returns

◆ ImportLayerFromTRS()

LayerObject ImportLayerFromTRS	(	string	fileName,
		int	samplerate
	)

inline

Import layer from trs.

Parameters

fileName	Filename of the file.
samplerate	The samplerate.

Returns: A LayerObject.

◆ ImportLayersFromPraatF0()

LayerCollection ImportLayersFromPraatF0	(	string	fileName,
		int	samplerate
	)

inline

Import layers from Praat F0 file.

Parameters

fileName	Filename of the file.
samplerate	The samplerate.

Returns: A LayerCollection.

◆ ImportLayersFromPraatFormants()

LayerCollection ImportLayersFromPraatFormants	(	string	fileName,
		int	samplerate
	)

inline

Import layers from Praat formants file.

Parameters

fileName	Filename of the file.
samplerate	The samplerate.

Returns: A LayerCollection.

◆ ImportLayersFromTextGrid()

LayerCollection ImportLayersFromTextGrid	(	string	fileName,
		int	samplerate
	)

inline

Import layers from text grid.

Parameters

fileName	Filename of the file.
samplerate	The samplerate.

Returns: A LayerCollection.

◆ InsertAudioFile()

AudioFileObject InsertAudioFile	(	string	sourceFile,
		bool	external
	)

inline

Inserts an audio file described by sourceFile.

Parameters

sourceFile	Audio source file path.
external	If false saves audio in ANT file.

Returns: If SaveInANT enabled returns internal audio file path otherwise returns original sourcePath.

◆ InsertVideoFile()

void InsertVideoFile	(	string	sourceFile,
		double	duration
	)

inline

Inserts video file into annotation.

Parameters

sourceFile	File path with video source
duration	Duration of video file in samples

◆ InvertSegmentSelection()

void InvertSegmentSelection ( )

inline

Inverts segment selection.

◆ New()

bool New ( )

inline

Creates new annotation.

Returns: true if it succeeds, false if it fails.

◆ Open() [1/2]

bool Open ( )

inline

Opens annotation.

Returns: true if it succeeds, false if it fails.

◆ Open() [2/2]

bool Open ( string fileName )

inline

Opens annotation.

Parameters

fileName Filename of the file.

Returns: true if it succeeds, false if it fails.

◆ PasteFromClipboard()

void PasteFromClipboard	(	LayerObject	destinationLayer,
		float	startPosition,
		float	maxPosition
	)

inline

Pastes from clipboard.

Parameters

destinationLayer	Destination layer.
startPosition	The start position.
maxPosition	The maximum position.

◆ RemoveAudioFile()

void RemoveAudioFile ( AudioFileObject audioFile )

inline

Removes audio file from data.

Parameters

audioFile Audio file to remove

◆ RemoveVideoFile()

void RemoveVideoFile ( VideoFileObject videoFile )

inline

Removes given video file from annotation.

Parameters

videoFile Video file to delete

◆ Replace() [1/2]

void Replace	(	string	findText,
		string	replaceText
	)

inline

Replaces.

Parameters

findText	The find text.
replaceText	The replace text.

◆ Replace() [2/2]

void Replace	(	string	findText,
		string	replaceText,
		FindReplaceOptions	options
	)

inline

Replaces.

Parameters

findText	The find text.
replaceText	The replace text.
options	Options for controlling the operation.

◆ ReplaceAll() [1/2]

void ReplaceAll	(	string	findText,
		string	replaceText
	)

inline

Replace all.

Parameters

findText	The find text.
replaceText	The replace text.

◆ ReplaceAll() [2/2]

void ReplaceAll	(	string	findText,
		string	replaceText,
		FindReplaceOptions	options
	)

inline

Replace all.

Parameters

findText	The find text.
replaceText	The replace text.
options	Options for controlling the operation.

◆ Save() [1/2]

bool Save ( )

inline

Saves this object.

Returns: true if it succeeds, false if it fails.

◆ Save() [2/2]

bool Save ( string filePath )

inline

Saves this object.

Parameters

filePath The full pathname of the file.

Returns: true if it succeeds, false if it fails.

◆ SaveAs()

bool SaveAs ( )

inline

Saves annotation as.

Returns: true if it succeeds, false if it fails.

◆ SaveSubAnnotation()

void SaveSubAnnotation	(	string	annotationFilePath,
		float	start,
		float	end,
		bool	withAudioFiles
	)

inline

Saves a sub annotation.

Parameters

annotationFilePath	Full pathname of the annotation file.
start	Start subannotation
end	End subannotation
withAudioFiles	If true save subannotation with Audio File section

◆ SelectGroup()

void SelectGroup ( SegmentObject segment )

inline

Selects group.

Parameters

segment The segment.

◆ SelectSegmentRange()

void SelectSegmentRange	(	SegmentObject	segmentFrom,
		SegmentObject	segmentTo
	)

inline

Select segment range.

Parameters

segmentFrom	The segment from.
segmentTo	The segment to.

◆ SendSelectionChanged()

void SendSelectionChanged	(	object	sender,
		EventArgs	e
	)

inline

Sends a selection changed.

Parameters

sender	Source of the event.
e	Event information.

◆ SpaceSegmentsEqually()

bool SpaceSegmentsEqually	(	LayerObject	layer,
		float	samplesCount
	)

inline

Spaces segment equally on selected layer.

Parameters

layer	Layer to space segments.
samplesCount	samples count

Returns

◆ Split()

List<SegmentCollection> Split	(	LayerObject	layer,
		string	label
	)

inline

Splits.

Parameters

layer	The layer.
label	The label.

Returns: A list of.

◆ SplitByCount()

List<SegmentCollection> SplitByCount	(	LayerObject	layer,
		int	count
	)

inline

Splits by count.

Parameters

layer	The layer.
count	Number of.

Returns: A list of.

◆ SplitByPauses()

List<SegmentCollection> SplitByPauses ( LayerObject layer )

inline

Splits by pauses.

Parameters

layer The layer.

Returns: A list of.

◆ UngroupSelectedSegments()

void UngroupSelectedSegments ( )

inline

Ungroup selected segments.

Property Documentation

◆ AnnotationFileName

string AnnotationFileName

get

Annotation file name build in application, normally "annotation.xml" when use with DataFolder gets access to annotation XML.

◆ AudioFiles

AudioFileCollection AudioFiles = new LayerCollection()

getset

Gets or sets the audio files.

The audio files.

◆ Author

string Author = string.Empty

getset

Gets or sets author of the annotation.

◆ Configuration

ConfigurationCollection Configuration = new SpeakerCollection()

getset

Gets or sets the configuration.

The configuration.

◆ DataFolder

string DataFolder = new ConfigurationCollection()

getset

Gets the pathname of the data folder.

The pathname of the data folder.

◆ FilePath

string FilePath = string.Empty

getset

Gets the full pathname of the file.

The full pathname of the file.

◆ InSessionMode

bool InSessionMode = string.Empty

getset

Gets or sets a value indicating whether the in session mode.

true if in session mode, false if not.

◆ IsModified

bool IsModified

getset

Gets or sets a value indicating whether this object is modified.

true if this object is modified, false if not.

◆ IsPlainXmlFormat

bool IsPlainXmlFormat = "New Annotation"

getset

If true annotation is saved in plain ANTX (xml) file instead of boxing annotation.xml in ANT (zip) file.

◆ Layers

LayerCollection Layers

getset

Gets or sets the layers.

The layers.

◆ Length

float Length

get

Get annotation length in seconds, last segment end position determines length of annotation.

◆ LockExistingLayersInSession

bool LockExistingLayersInSession = false

getset

Gets or sets a value indicating whether the existing layers in session is locked.

true if lock existing layers in session, false if not.

◆ ProjectCollection

string ProjectCollection = string.Empty

getset

Gets or sets a collection of projects.

A Collection of projects.

◆ ProjectCorpusOwner

string ProjectCorpusOwner = string.Empty

getset

Gets or sets the project corpus that owns this item.

The project corpus owner.

◆ ProjectCorpusType

string ProjectCorpusType = string.Empty

getset

Gets or sets the type of the project corpus.

The type of the project corpus.

◆ ProjectDescription

string ProjectDescription = string.Empty

getset

Gets or sets information describing the project.

Information describing the project.

◆ ProjectEnvironment

string ProjectEnvironment = string.Empty

getset

Gets or sets the project environment.

The project environment.

◆ ProjectLicense

string ProjectLicense = string.Empty

getset

Gets or sets the project license.

The project license.

◆ ProjectNoises

string ProjectNoises = string.Empty

getset

Gets or sets the project noises.

The project noises.

◆ ProjectTitle

string ProjectTitle

getset

Gets or sets the project title.

The project title.

◆ Samplerate

int Samplerate

getset

Gets or sets the samplerate.

The samplerate.

◆ SelectedLayer

LayerObject SelectedLayer = false

get

Gets the selected layer.

The selected layer.

◆ SelectedLayers

LayerCollection SelectedLayers

get

Gets the selected layers.

The selected layers.

◆ SelectedSegment

SegmentObject SelectedSegment

get

Gets the selected segment.

The selected segment.

◆ SelectedSegments

SegmentCollection SelectedSegments

get

Gets the selected segments.

The selected segments.

◆ Settings

SettingsCollection Settings = new VideoFileCollection()

getset

Gets or sets options for controlling the operation.

The settings.

◆ Speakers

SpeakerCollection Speakers = new SettingsCollection()

getset

Gets or sets speaker for annotation.

The speakers.

◆ SuggestedFileName

string SuggestedFileName = "annotation.xml"

getset

Suggested name in SaveFileDialog

◆ VideoFiles

VideoFileCollection VideoFiles = new AudioFileCollection()

getset

Gets or sets video files.

Video files.

Event Documentation

◆ Changed

ChangedHandler Changed

Event queue for all listeners interested in Changed events.

◆ Modified

ChangedHandler Modified

Event queue for all listeners interested in Modified events.

◆ SelectionChanged

SelectionChangedHandler SelectionChanged

Event queue for all listeners interested in SelectionChanged events.

The documentation for this class was generated from the following files:

AnnotationPro.Logic/Annotation.cs
AnnotationPro.Logic/Annotation.Designer.cs

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ Annotation() [1/2]

◆ Annotation() [2/2]

Member Function Documentation

◆ AlignSelectedLayers()

◆ AudioEmbedToExternal()

◆ AudioExternalToEmbed()

◆ AudioFileToPath()

◆ AutoGroup()

◆ ClearParameters() [1/2]

◆ ClearParameters() [2/2]

◆ ClearSelection() [1/2]

◆ ClearSelection() [2/2]

◆ ClearVideoIndex()

◆ Consolidate() [1/2]

◆ Consolidate() [2/2]

◆ CopyToClipboard()

◆ Crop()

◆ CutToClipboard()

◆ DeleteSegment()

◆ Dispose()

◆ ExportLayerToCSVString()

◆ ExportLayerToTextGrid()

◆ ExportLayerToTextGridString()

◆ ExportSegmentToTextGridString()

◆ ExportTextGridHeader()

◆ ExportToCSV()

◆ ExportToEAF()

◆ ExportToTextGrid() [1/2]

◆ ExportToTextGrid() [2/2]

◆ ExportToXRA()

◆ FillPauses() [1/2]

◆ FillPauses() [2/2]

◆ Find() [1/2]

◆ Find() [2/2]

◆ FindAll() [1/2]

◆ FindAll() [2/2]

◆ FindAudioInFolder()

◆ FindLeftMostSegment()

◆ FindRightMostSegment()

◆ GetContentCSVString()

◆ GetContentHeaderCSVString()

◆ GetTextGridPairFromLine()

◆ GroupSelectedSegments()

◆ ImportLayerFromBLF()

◆ ImportLayerFromCSVLabelStartStop()

◆ ImportLayerFromText() [1/2]

◆ ImportLayerFromText() [2/2]

◆ ImportLayerFromTRS()

◆ ImportLayersFromPraatF0()

◆ ImportLayersFromPraatFormants()

◆ ImportLayersFromTextGrid()

◆ InsertAudioFile()

◆ InsertVideoFile()

◆ InvertSegmentSelection()

◆ New()

◆ Open() [1/2]

◆ Open() [2/2]

◆ PasteFromClipboard()

◆ RemoveAudioFile()

◆ RemoveVideoFile()

◆ Replace() [1/2]

◆ Replace() [2/2]

◆ ReplaceAll() [1/2]

◆ ReplaceAll() [2/2]

◆ Save() [1/2]

◆ Save() [2/2]

◆ SaveAs()

◆ SaveSubAnnotation()

◆ SelectGroup()

◆ SelectSegmentRange()

◆ SendSelectionChanged()

◆ SpaceSegmentsEqually()

◆ Split()

◆ SplitByCount()