Annotation Pro API
Public Member Functions | Static Public Member Functions | Properties | List of all members
SegmentObject Class Reference

A segment object. More...

Inherits IComparable< SegmentObject >.

Public Member Functions

 SegmentObject ()
 Default constructor. More...
 
 SegmentObject (float start, float duration, string label)
 Constructor. More...
 
SegmentObject Copy ()
 Copies this object. More...
 
string GetCSVRow (string fileName, int samplerate, string fieldSeparator)
 Gets CSV row. More...
 
bool InRange (float rangeStart, float rangeEnd)
 Checking whether the segment is included within the given range. More...
 

Static Public Member Functions

static string GetHeaderRow (string fieldSeparator)
 Gets header row. More...
 

Properties

Color BackColor = Color.Black [get, set]
 Gets or sets the color of the back. More...
 
Color BorderColor = Color.White [get, set]
 Gets or sets the color of the border. More...
 
Rectangle ControlRectangle = string.Empty [get, set]
 Gets or sets the control rectangle. More...
 
float Duration [get, set]
 Gets or sets the duration. More...
 
float End [get, set]
 Gets or sets the end. More...
 
string Feature = false [get, set]
 Gets or sets the feature. More...
 
Color ForeColor = SnappingSide.None [get, set]
 Gets or sets the color of the foreground. More...
 
string Group = new object() [get, set]
 Gets or sets the group. More...
 
bool HasVideo = new Guid() [get]
 Gets true if segment has set video More...
 
Guid Id [get, set]
 Gets or sets the identifier. More...
 
Guid IdLayer = Guid.NewGuid() [get, set]
 Gets or sets the identifier layer. More...
 
Guid IdVideoFile = 0 [get, set]
 Id of video file assigned to segment More...
 
bool IsDragging = false [get, set]
 Gets or sets a value indicating whether this object is dragging. More...
 
bool IsDraggingEnd = 0 [get, set]
 Gets or sets a value indicating whether this object is dragging end. More...
 
bool IsDraggingStart [get, set]
 Gets or sets a value indicating whether this object is dragging start. More...
 
bool IsMarker = string.Empty [get, set]
 Gets or sets a value indicating whether this object is marker. More...
 
bool IsSelected = null [get, set]
 Gets or sets a value indicating whether this object is selected. More...
 
string Label = new Guid() [get, set]
 Gets or sets the label. More...
 
string Language = string.Empty [get, set]
 Gets or sets the language. More...
 
string Marker = false [get, set]
 Gets or sets the marker. More...
 
string Name = string.Empty [get, set]
 Gets or sets the name. More...
 
string Parameter1 = string.Empty [get, set]
 Gets or sets the parameter 1. More...
 
string Parameter2 = string.Empty [get, set]
 Gets or sets the parameter 2. More...
 
string Parameter3 = string.Empty [get, set]
 Gets or sets the parameter 3. More...
 
string RScript = string.Empty [get, set]
 Gets or sets the script. More...
 
float Start [get, set]
 Gets or sets the start. More...
 
object Tag = new Rectangle() [get, set]
 Gets or sets the tag. More...
 

Detailed Description

A segment object.

Constructor & Destructor Documentation

◆ SegmentObject() [1/2]

SegmentObject ( )
inline

Default constructor.

◆ SegmentObject() [2/2]

SegmentObject ( float  start,
float  duration,
string  label 
)
inline

Constructor.

Parameters
startThe start.
durationThe duration.
labelThe label.

Member Function Documentation

◆ Copy()

SegmentObject Copy ( )
inline

Copies this object.

Returns
A SegmentObject.

◆ GetCSVRow()

string GetCSVRow ( string  fileName,
int  samplerate,
string  fieldSeparator 
)
inline

Gets CSV row.

Parameters
fileNameFilename of the file.
samplerateThe samplerate.
fieldSeparatorThe field separator.
Returns
The CSV row.

◆ GetHeaderRow()

static string GetHeaderRow ( string  fieldSeparator)
inlinestatic

Gets header row.

Parameters
fieldSeparatorThe field separator.
Returns
The header row.

◆ InRange()

bool InRange ( float  rangeStart,
float  rangeEnd 
)
inline

Checking whether the segment is included within the given range.

Parameters
rangeStartRange start
rangeEndRange end
Returns
True if segment is in range otherwise false. If start is larger or equal end returns false

Property Documentation

◆ BackColor

Color BackColor = Color.Black
getset

Gets or sets the color of the back.

The color of the back.

◆ BorderColor

Color BorderColor = Color.White
getset

Gets or sets the color of the border.

The color of the border.

◆ ControlRectangle

Rectangle ControlRectangle = string.Empty
getset

Gets or sets the control rectangle.

The control rectangle.

◆ Duration

float Duration
getset

Gets or sets the duration.

The duration.

◆ End

float End
getset

Gets or sets the end.

The end.

◆ Feature

string Feature = false
getset

Gets or sets the feature.

The feature.

◆ ForeColor

Color ForeColor = SnappingSide.None
getset

Gets or sets the color of the foreground.

The color of the foreground.

◆ Group

string Group = new object()
getset

Gets or sets the group.

The group.

◆ HasVideo

bool HasVideo = new Guid()
get

Gets true if segment has set video

◆ Id

Guid Id
getset

Gets or sets the identifier.

The identifier.

◆ IdLayer

Guid IdLayer = Guid.NewGuid()
getset

Gets or sets the identifier layer.

The identifier layer.

◆ IdVideoFile

Guid IdVideoFile = 0
getset

Id of video file assigned to segment

◆ IsDragging

bool IsDragging = false
getset

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

true if this object is dragging, false if not.

◆ IsDraggingEnd

bool IsDraggingEnd = 0
getset

Gets or sets a value indicating whether this object is dragging end.

true if this object is dragging end, false if not.

◆ IsDraggingStart

bool IsDraggingStart
getset

Gets or sets a value indicating whether this object is dragging start.

true if this object is dragging start, false if not.

◆ IsMarker

bool IsMarker = string.Empty
getset

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

true if this object is marker, false if not.

◆ IsSelected

bool IsSelected = null
getset

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

true if this object is selected, false if not.

◆ Label

string Label = new Guid()
getset

Gets or sets the label.

The label.

◆ Language

string Language = string.Empty
getset

Gets or sets the language.

The language.

◆ Marker

string Marker = false
getset

Gets or sets the marker.

The marker.

◆ Name

string Name = string.Empty
getset

Gets or sets the name.

The name.

◆ Parameter1

string Parameter1 = string.Empty
getset

Gets or sets the parameter 1.

The parameter 1.

◆ Parameter2

string Parameter2 = string.Empty
getset

Gets or sets the parameter 2.

The parameter 2.

◆ Parameter3

string Parameter3 = string.Empty
getset

Gets or sets the parameter 3.

The parameter 3.

◆ RScript

string RScript = string.Empty
getset

Gets or sets the script.

The r script.

◆ Start

float Start
getset

Gets or sets the start.

The start.

◆ Tag

object Tag = new Rectangle()
getset

Gets or sets the tag.

The tag.


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