Class FileSegment

Represents a segment of a target file. It can also store the parent file that a new segment has been derived from. A segment is just a stored start and end for a target file - it represents a future, or a request. Other functions can take the segment request, cut out the selected range, and return a new file segment. New file segments, or segments that represent a whole file, will not have the segment properties set because they do not represent a request anymore.

Inheritance
Object
FileSegment
Inherited Members
Namespace: AnalysisBase
Assembly: AnalysisBase.dll
Syntax
public class FileSegment : ICloneable, ISegment<FileInfo>, IEquatable<ISegment<FileInfo>>

Constructors

| Improve this Doc View Source

FileSegment(FileInfo, TimeAlignment)

Initializes a new instance of the FileSegment class. Allow specifying an absolutely aligned (to the nearest minute) file segment. Implies FileDateBehavior.Required. NOTE: Start offset will be set to start of file, and end offset set to the end of the file.

Declaration
public FileSegment(FileInfo source, TimeAlignment alignment)
Parameters
Type Name Description
FileInfo source
TimeAlignment alignment
| Improve this Doc View Source

FileSegment(FileInfo, TimeAlignment, IAudioUtility, FileSegment.FileDateBehavior)

Initializes a new instance of the FileSegment class. Allow specifying an absolutely aligned (to the nearest minute) file segment. Implies FileDateBehavior.Required. NOTE: Start offset will be set to start of file, and end offset set to the end of the file.

Declaration
public FileSegment(FileInfo source, TimeAlignment alignment, IAudioUtility utility = null, FileSegment.FileDateBehavior dateBehavior = FileSegment.FileDateBehavior.Try)
Parameters
Type Name Description
FileInfo source
TimeAlignment alignment
IAudioUtility utility
FileSegment.FileDateBehavior dateBehavior
| Improve this Doc View Source

FileSegment(FileInfo, DateTimeOffset, IAudioUtility)

Declaration
public FileSegment(FileInfo source, DateTimeOffset startDate, IAudioUtility utility = null)
Parameters
Type Name Description
FileInfo source
DateTimeOffset startDate
IAudioUtility utility
| Improve this Doc View Source

FileSegment(FileInfo, Int32, TimeSpan, FileSegment.FileDateBehavior)

Initializes a new instance of the FileSegment class. Use this constructor if you know all the information about a segment beforehand (except for the date it was created).

Declaration
public FileSegment(FileInfo source, int sampleRate, TimeSpan duration, FileSegment.FileDateBehavior dateBehavior)
Parameters
Type Name Description
FileInfo source
Int32 sampleRate
TimeSpan duration
FileSegment.FileDateBehavior dateBehavior
| Improve this Doc View Source

FileSegment(FileInfo, Int32, TimeSpan, Nullable<DateTimeOffset>)

Initializes a new instance of the FileSegment class. Use this constructor if you know all the information about a segment beforehand.

Declaration
public FileSegment(FileInfo source, int sampleRate, TimeSpan duration, DateTimeOffset? suppliedDate = default(DateTimeOffset? ))
Parameters
Type Name Description
FileInfo source
Int32 sampleRate
TimeSpan duration
Nullable<DateTimeOffset> suppliedDate

Properties

| Improve this Doc View Source

Alignment

Gets the style of alignment padding to use - indicates that bad start dates should be shifted to the nearest minute.

Declaration
public TimeAlignment Alignment { get; }
Property Value
Type Description
TimeAlignment
| Improve this Doc View Source

EndOffsetSeconds

Declaration
public double EndOffsetSeconds { get; }
Property Value
Type Description
Double
| Improve this Doc View Source

IsSegmentSet

Gets a value indicating whether gets ISegmentSet - whether or not either of the segment properties have been set.

Declaration
public bool IsSegmentSet { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

SegmentEndOffset

Gets or sets SegmentEndOffset - the value that represents what ending point of the target file should be used.

Declaration
public TimeSpan? SegmentEndOffset { get; set; }
Property Value
Type Description
Nullable<TimeSpan>
Remarks

These properties are the source for EndOffsetSeconds and are maintained as nullables for backwards compatibility. However as far as ISegment<TSource> is concerned null is not a valid value.

| Improve this Doc View Source

SegmentStartOffset

Gets or sets SegmentStartOffset - the value that represents what starting point of the target file should be used.

Declaration
public TimeSpan? SegmentStartOffset { get; set; }
Property Value
Type Description
Nullable<TimeSpan>
Remarks

These properties are the source for StartOffsetSeconds and are maintained as nullables for backwards compatibility. However as far as ISegment<TSource> is concerned null is not a valid value.

| Improve this Doc View Source

Source

Gets the target file for this file segment.

Declaration
public FileInfo Source { get; }
Property Value
Type Description
FileInfo
| Improve this Doc View Source

SourceMetadata

Declaration
public SourceMetadata SourceMetadata { get; }
Property Value
Type Description
SourceMetadata
| Improve this Doc View Source

StartOffsetSeconds

Declaration
public double StartOffsetSeconds { get; }
Property Value
Type Description
Double
| Improve this Doc View Source

TargetFileDuration

Gets the entire audio file duration FOR THE TARGET FILE.

Declaration
public TimeSpan? TargetFileDuration { get; }
Property Value
Type Description
Nullable<TimeSpan>
| Improve this Doc View Source

TargetFileSampleRate

Gets the TARGET FILE'S audio file Sample rate. May be required when doing analysis.

Declaration
public int? TargetFileSampleRate { get; }
Property Value
Type Description
Nullable<Int32>
| Improve this Doc View Source

TargetFileStartDate

Gets the TargetFileStartDate.

Declaration
public DateTimeOffset? TargetFileStartDate { get; }
Property Value
Type Description
Nullable<DateTimeOffset>

Methods

| Improve this Doc View Source

Clone()

Declaration
public object Clone()
Returns
Type Description
Object
Remarks

Constructs a new instance of this FileSegment by copying important attributes.

| Improve this Doc View Source

Equals(ISegment<FileInfo>)

Determines if two FileSegments represent the same part of a source file. It compares Source, StartOffsetSeconds, and EndOffsetSeconds.

Declaration
public bool Equals(ISegment<FileInfo> other)
Parameters
Type Name Description
ISegment<FileInfo> other

The other file segment to compare with.
Returns
Type Description
Boolean

True if the segments are considered equal.
| Improve this Doc View Source

SplitSegment(Double, Double)

Declaration
public ISegment<FileInfo> SplitSegment(double newStart, double newEnd)
Parameters
Type Name Description
Double newStart
Double newEnd
Returns
Type Description
ISegment<FileInfo>
| Improve this Doc View Source

ToString()

Returns a friendly string representation of this object.

Declaration
public override string ToString()
Returns
Type Description
String
Overrides
| Improve this Doc View Source

Validate()

Validate the FileSegment properties.

Declaration
public bool Validate()
Returns
Type Description
Boolean

True if properties are valid, otherwise false.

Implements

Extension Methods