Sports Lib API - v21.3.0
    Preparing search index...

    Module API

    The supported API surface for the generated reference.

    This file is intentionally documentation-only. It does not replace the package entry point; it defines the stable, consumer-oriented view that is published to GitHub Pages.

    Enumerations - Other

    ActivityTypes
    FileType
    Privacy
    RiderPosition
    UnitSystem
    WeightUnits

    Enumerations - Unit settings

    DaysOfTheWeek
    DistanceUnits
    GradeAdjustedPaceUnits
    GradeAdjustedSpeedUnits
    PaceUnits
    SpeedUnits
    SwimPaceUnits
    VerticalSpeedUnits

    Classes - Parsing options

    ActivityParsingOptions

    Classes - Activities and events

    ActivityTypesHelper
    EventUtilities

    Classes - Routes

    Route
    RouteFile
    RouteStream

    Classes - Streams, stats, and data

    DataAltitude
    DataDistance
    DataGroundContactTime
    DataGroundContactTimeAvg
    DataGroundContactTimeBalanceLeft
    DataGroundContactTimeBalanceRight
    DataGroundContactTimeMax
    DataGroundContactTimeMin
    DataHeartRate
    Stream

    Classes - Health and sleep

    DataActiveDuration
    DataActiveEnergy
    DataAltitude
    DataBasalEnergy
    DataBloodOxygenSaturation
    DataBloodPressureDiastolic
    DataBloodPressureSystolic
    DataBodyEnergy
    DataBodyEnergyChange
    DataBodyFat
    DataBodyMassIndex
    DataBodyWater
    DataBoneMass
    DataDistance
    DataFitnessAge
    DataFloorsClimbed
    DataHeartRate
    DataHeartRateVariability
    DataModerateIntensityDuration
    DataMuscleMass
    DataPulseRate
    DataRecoveryScore
    DataRespirationRate
    DataRestingHeartRate
    DataSkinTemperatureDeviation
    DataSleepAwakeDuration
    DataSleepBloodOxygenSaturationMax
    DataSleepDeepDuration
    DataSleepDuration
    DataSleepHeartRateAvg
    DataSleepHeartRateMin
    DataSleepHRVAvg
    DataSleepHRVOvernight
    DataSleepHRVSampleCount
    DataSleepInBedDuration
    DataSleepLightDuration
    DataSleepRemDuration
    DataSleepRespirationRateAvg
    DataSleepRestingHeartRate
    DataSleepScore
    DataSleepUnknownDuration
    DataSleepUnmeasurableDuration
    DataSteps
    DataStressDuration
    DataStressLevel
    DataStressState
    DataTotalEnergy
    DataVigorousIntensityDuration
    DataVO2Max
    DataWeight
    DataWheelchairPushDistance
    DataWheelchairPushes

    Classes - Other

    Data
    DataAirTimeRemaining
    DataArray
    DataBare
    DataBoolean
    DataBottomTime
    DataCadence
    DataCNSLoad
    DataContactTimeToFlightTimeRatio
    DataContactTimeToFlightTimeRatioAvg
    DataContactTimeToFlightTimeRatioMax
    DataContactTimeToFlightTimeRatioMin
    DataDepth
    DataDepthAvg
    DataDepthAvgFeet
    DataDepthFeet
    DataDepthMax
    DataDepthMaxFeet
    DataDiveAscentRate
    DataDiveAscentRateAvg
    DataDiveAscentRateAvgFeetPerSecond
    DataDiveAscentRateFeetPerSecond
    DataDiveAscentRateMax
    DataDiveAscentRateMaxFeetPerSecond
    DataDiveAscentTime
    DataDiveDescentRateAvg
    DataDiveDescentRateAvgFeetPerSecond
    DataDiveDescentRateMax
    DataDiveDescentRateMaxFeetPerSecond
    DataDiveDescentTime
    DataDiveHangTime
    DataDiveNumber
    DataDuration
    DataEndingCNSLoad
    DataEndingN2Load
    DataEnergy
    DataEvent
    DataFITTrainingFileReferences
    DataFITWorkoutDefinitions
    DataGroundContactTimePercentage
    DataGroundContactTimePercentageAvg
    DataGroundContactTimePercentageMax
    DataGroundContactTimePercentageMin
    DataIntensity
    DataMetabolicCalories
    DataMovingTime
    DataN2Load
    DataNextStopDepth
    DataNextStopDepthFeet
    DataNextStopTime
    DataNoDecompressionLimit
    DataNumber
    DataOxygenToxicity
    DataPause
    DataPO2
    DataPower
    DataPowerCurve
    DataPowerWattsPerKg
    DataPressureSAC
    DataPressureSACAvg
    DataRiderPositionChangeEvent
    DataRMV
    DataRMVAvg
    DataRunningFlightTime
    DataRunningFlightTimeAvg
    DataRunningFlightTimeMax
    DataRunningFlightTimeMin
    DataSpeed
    DataStartEvent
    DataStartingCNSLoad
    DataStartingN2Load
    DataStopAllEvent
    DataStopEvent
    DataString
    DataStrokeRate
    DataStrokeRateAvg
    DataStrokeRateMax
    DataStrokeRateMin
    DataSurfaceInterval
    DataSuuntoPlusGuideReferences
    DataThreeDimensionalStrainEvidence
    DataTimerTime
    DataTimeToSurface
    DataVolumeSAC
    DataVolumeSACAvg
    EventExporterGPX
    EventExporterJSON
    LapTypesHelper
    RouteFileUtilities
    RouteParsingOptions
    RoutePreviewUtilities
    RouteUtilities
    SportsLib
    StatsUtilities

    Interfaces - Serialization and supporting contracts

    CreatorInterface
    DeviceInterface
    IntensityZonesInterface
    SerializableClassInterface
    SwimLengthInterface

    Interfaces - Other

    ActivityDurabilityAnalysis
    ActivityInterface
    ActivityJSONInterface
    ActivityParsingOptionsInput
    ActivityParsingStreamOptions
    ActivityParsingTssOptions
    ActivityParsingTssOverridesOptions
    AerobicDurabilityEvidence
    AnalyzeActivityDurabilityOptions
    BuildPowerDurationEnvelopeOptions
    CalculateThreeDimensionalStrainOptions
    CoordinatePairSimplificationOptions
    CoordinatePairSimplificationResult
    CreatorJSONInterface
    CriticalPowerFitCandidate
    DataInterface
    DataJSONInterface
    DataPositionInterface
    DataPowerCurvePoint
    DatedActivityPowerCurve
    DeviceJsonInterface
    DiveGasJSONInterface
    DiveGasRecord
    DiveMessageIndex
    DiveSourceRecords
    DiveSourceRecordsJSONInterface
    DiveTankSummaryJSONInterface
    DiveTankSummaryRecord
    DiveTankUpdateJSONInterface
    DiveTankUpdateRecord
    DurabilityContext
    DurabilityEligibility
    DurabilityEvidenceValue
    DurabilityProtocol
    DurabilityTimelinePoint
    DurationClassInterface
    EventExporter
    EventInterface
    EventJSONInterface
    FitThreeDimensionalImpulseResponseOptions
    FITWorkoutReferenceSession
    FITWorkoutReferencesResult
    IDClassInterface
    ImpulseResponseCalibrationDiagnostics
    ImpulseResponseCalibrationError
    ImpulseResponseComponentCalibration
    ImpulseResponseParameters
    ImpulseResponsePoint
    IntensityZonesJSONInterface
    LapInterface
    LapJSONInterface
    NumericRecordAggregation
    PoolDurabilityEvidence
    PowerCurveSampleLike
    PowerCurveWindowComparison
    PowerDurationEnvelope
    PowerDurationEnvelopePoint
    PrivacyClassInterface
    RouteFileInterface
    RouteFileJSONInterface
    RouteInterface
    RouteJSONInterface
    RouteLinkInterface
    RouteMetadataInterface
    RouteParsingGPXOptions
    RouteParsingOptionsInput
    RouteParsingStreamOptions
    RoutePointInterface
    RoutePreviewBoundsInterface
    RoutePreviewCoordinateInterface
    RoutePreviewJSONInterface
    RoutePreviewOptions
    RoutePreviewRouteFileSourceInterface
    RoutePreviewRouteSourceInterface
    RoutePreviewSegmentJSONInterface
    RouteStreamDataItem
    RouteStreamInterface
    RouteWaypointInterface
    SamplePowerCurveOptions
    StatsClassInterface
    StreamDataItem
    StreamFilterInterface
    StreamInterface
    StreamJSONInterface
    SwimLengthJSONInterface
    ThreeDimensionalCapacityComponent
    ThreeDimensionalCapacityDiagnostics
    ThreeDimensionalCapacityFit
    ThreeDimensionalDailyStrainLoad
    ThreeDimensionalImpulseResponseCalibration
    ThreeDimensionalImpulseResponseParameters
    ThreeDimensionalImpulseResponsePoint
    ThreeDimensionalPerformanceObservation
    ThreeDimensionalPowerContributions
    ThreeDimensionalStrainAnalysis
    ThreeDimensionalStrainEligibility
    ThreeDimensionalStrainEvidence
    ThreeDimensionalStrainEvidenceValueV1
    ThreeDimensionalStrainEvidenceValueV2
    ThreeDimensionalStrainFitDiagnostics
    ThreeDimensionalStrainInputDiagnostics
    ThreeDimensionalStrainLoad
    ThreeDimensionalStrainScores
    ThreeParameterCriticalPowerFit
    ThreeParameterCriticalPowerFitOptions
    ThreeParameterCriticalPowerModel
    UserUnitSettingsInterface

    Type Aliases

    ActivityTypeGroup
    CriticalPowerFitMethod
    DataJSONPrimitive
    DataJSONValue
    DefaultDataClassValue
    DefaultDataValue
    DiveGasMode
    DiveGasStatus
    DiveSourceRecordsInput
    DurabilityDiscipline
    DurabilityEligibilityReason
    DurabilityEvidence
    DurabilityOutputSource
    DurabilityOutputUnit
    FitThreeDimensionalCapacityOptions
    FITTrainingFileReference
    FITTrainingFileReferencesValue
    FITWorkoutDefinition
    FITWorkoutDefinitionsValue
    FITWorkoutReferenceDiagnostic
    ImpulseResponseCalibrationReason
    ImpulseResponseCalibrationStatus
    LapType
    LapTypes
    PowerDurationEnvelopeStatus
    SuuntoPlusGuideExporter
    SuuntoPlusGuideReference
    SuuntoPlusGuideReferencesValue
    ThreeDimensionalCapacityComponentStatus
    ThreeDimensionalCapacityReason
    ThreeDimensionalCapacityStatus
    ThreeDimensionalImpulseResponseCalibrationReason
    ThreeDimensionalImpulseResponseCalibrationStatus
    ThreeDimensionalPowerSample
    ThreeDimensionalStrainDiscipline
    ThreeDimensionalStrainEligibilityReason
    ThreeDimensionalStrainEvidenceValue
    ThreeDimensionalStrainReason
    ThreeDimensionalStrainStatus
    WPrimeBalanceTiming

    Variables - Activities and events

    ActivityTypeGroups

    Variables - Analytics

    DEFAULT_DURABILITY_PROTOCOL

    Variables - Other

    DEFAULT_POWER_CURVE_MAXIMUM_BRACKET_DURATION_RATIO
    LapTypes
    MAXIMUM_ALLOWED_POWER_CURVE_BRACKET_DURATION_RATIO
    ROUTE_PREVIEW_DEFAULT_MAX_POINTS_PER_ROUTE
    ROUTE_PREVIEW_DEFAULT_MAX_POINTS_PER_SEGMENT
    ROUTE_PREVIEW_ENCODING
    ROUTE_PREVIEW_POLYLINE_PRECISION
    ROUTE_PREVIEW_VERSION
    THREE_DIMENSIONAL_CAPACITY_CRITICAL_POWER_ANCHORS_SECONDS
    THREE_DIMENSIONAL_CAPACITY_MAXIMUM_POWER_ANCHORS_SECONDS
    THREE_DIMENSIONAL_STRAIN_LEGACY_PROTOCOL_VERSION
    THREE_DIMENSIONAL_STRAIN_PROTOCOL_VERSION

    Functions - Activities and events

    normalizeActivityMetricSemanticsForStats

    Functions - Analytics

    analyzeActivityDurability
    calculateActivityDurabilitySourceFingerprint
    calculateAerobicEfficiency
    hasActivityDurabilitySourceData

    Functions - FIT workout references

    readFITWorkoutReferences

    Functions - Other

    buildPowerDurationEnvelope
    buildRoutePreviewBounds
    calculateImpulseResponse
    calculateMaximumPowerAvailable
    calculateThreeDimensionalImpulseResponse
    calculateThreeDimensionalStrain
    calculateThreeDimensionalStrainCoefficient
    comparePowerCurveWindows
    decodeRoutePolyline5
    encodeRoutePolyline5
    fitThreeDimensionalCapacityModel
    fitThreeDimensionalImpulseResponseParameters
    fitThreeParameterCriticalPowerModel
    mergeRoutePreviewBounds
    predictThreeParameterCriticalPower
    resolveThreeDimensionalPowerContributions
    samplePowerCurveAtDuration
    simplifyCoordinatePairsVisvalingamWhyatt

    Settings

    Member Visibility

    On This Page

    Enumerations - Other
    Enumerations - Unit settings
    Classes - Parsing options
    Classes - Activities and events
    Classes - Routes
    Classes - Streams, stats, and data
    Classes - Health and sleep
    DataActiveDurationDataActiveEnergyDataAltitudeDataBasalEnergyDataBloodOxygenSaturationDataBloodPressureDiastolicDataBloodPressureSystolicDataBodyEnergyDataBodyEnergyChangeDataBodyFatDataBodyMassIndexDataBodyWaterDataBoneMassDataDistanceDataFitnessAgeDataFloorsClimbedDataHeartRateDataHeartRateVariabilityDataModerateIntensityDurationDataMuscleMassDataPulseRateDataRecoveryScoreDataRespirationRateDataRestingHeartRateDataSkinTemperatureDeviationDataSleepAwakeDurationDataSleepBloodOxygenSaturationMaxDataSleepDeepDurationDataSleepDurationDataSleepHeartRateAvgDataSleepHeartRateMinDataSleepHRVAvgDataSleepHRVOvernightDataSleepHRVSampleCountDataSleepInBedDurationDataSleepLightDurationDataSleepRemDurationDataSleepRespirationRateAvgDataSleepRestingHeartRateDataSleepScoreDataSleepUnknownDurationDataSleepUnmeasurableDurationDataStepsDataStressDurationDataStressLevelDataStressStateDataTotalEnergyDataVigorousIntensityDurationDataVO2MaxDataWeightDataWheelchairPushDistanceDataWheelchairPushes
    Classes - Other
    DataDataAirTimeRemainingDataArrayDataBareDataBooleanDataBottomTimeDataCadenceDataCNSLoadDataContactTimeToFlightTimeRatioDataContactTimeToFlightTimeRatioAvgDataContactTimeToFlightTimeRatioMaxDataContactTimeToFlightTimeRatioMinDataDepthDataDepthAvgDataDepthAvgFeetDataDepthFeetDataDepthMaxDataDepthMaxFeetDataDiveAscentRateDataDiveAscentRateAvgDataDiveAscentRateAvgFeetPerSecondDataDiveAscentRateFeetPerSecondDataDiveAscentRateMaxDataDiveAscentRateMaxFeetPerSecondDataDiveAscentTimeDataDiveDescentRateAvgDataDiveDescentRateAvgFeetPerSecondDataDiveDescentRateMaxDataDiveDescentRateMaxFeetPerSecondDataDiveDescentTimeDataDiveHangTimeDataDiveNumberDataDurationDataEndingCNSLoadDataEndingN2LoadDataEnergyDataEventDataFITTrainingFileReferencesDataFITWorkoutDefinitionsDataGroundContactTimePercentageDataGroundContactTimePercentageAvgDataGroundContactTimePercentageMaxDataGroundContactTimePercentageMinDataIntensityDataMetabolicCaloriesDataMovingTimeDataN2LoadDataNextStopDepthDataNextStopDepthFeetDataNextStopTimeDataNoDecompressionLimitDataNumberDataOxygenToxicityDataPauseDataPO2DataPowerDataPowerCurveDataPowerWattsPerKgDataPressureSACDataPressureSACAvgDataRiderPositionChangeEventDataRMVDataRMVAvgDataRunningFlightTimeDataRunningFlightTimeAvgDataRunningFlightTimeMaxDataRunningFlightTimeMinDataSpeedDataStartEventDataStartingCNSLoadDataStartingN2LoadDataStopAllEventDataStopEventDataStringDataStrokeRateDataStrokeRateAvgDataStrokeRateMaxDataStrokeRateMinDataSurfaceIntervalDataSuuntoPlusGuideReferencesDataThreeDimensionalStrainEvidenceDataTimerTimeDataTimeToSurfaceDataVolumeSACDataVolumeSACAvgEventExporterGPXEventExporterJSONLapTypesHelperRouteFileUtilitiesRouteParsingOptionsRoutePreviewUtilitiesRouteUtilitiesSportsLibStatsUtilities
    Interfaces - Serialization and supporting contracts
    Interfaces - Other
    ActivityDurabilityAnalysisActivityInterfaceActivityJSONInterfaceActivityParsingOptionsInputActivityParsingStreamOptionsActivityParsingTssOptionsActivityParsingTssOverridesOptionsAerobicDurabilityEvidenceAnalyzeActivityDurabilityOptionsBuildPowerDurationEnvelopeOptionsCalculateThreeDimensionalStrainOptionsCoordinatePairSimplificationOptionsCoordinatePairSimplificationResultCreatorJSONInterfaceCriticalPowerFitCandidateDataInterfaceDataJSONInterfaceDataPositionInterfaceDataPowerCurvePointDatedActivityPowerCurveDeviceJsonInterfaceDiveGasJSONInterfaceDiveGasRecordDiveMessageIndexDiveSourceRecordsDiveSourceRecordsJSONInterfaceDiveTankSummaryJSONInterfaceDiveTankSummaryRecordDiveTankUpdateJSONInterfaceDiveTankUpdateRecordDurabilityContextDurabilityEligibilityDurabilityEvidenceValueDurabilityProtocolDurabilityTimelinePointDurationClassInterfaceEventExporterEventInterfaceEventJSONInterfaceFitThreeDimensionalImpulseResponseOptionsFITWorkoutReferenceSessionFITWorkoutReferencesResultIDClassInterfaceImpulseResponseCalibrationDiagnosticsImpulseResponseCalibrationErrorImpulseResponseComponentCalibrationImpulseResponseParametersImpulseResponsePointIntensityZonesJSONInterfaceLapInterfaceLapJSONInterfaceNumericRecordAggregationPoolDurabilityEvidencePowerCurveSampleLikePowerCurveWindowComparisonPowerDurationEnvelopePowerDurationEnvelopePointPrivacyClassInterfaceRouteFileInterfaceRouteFileJSONInterfaceRouteInterfaceRouteJSONInterfaceRouteLinkInterfaceRouteMetadataInterfaceRouteParsingGPXOptionsRouteParsingOptionsInputRouteParsingStreamOptionsRoutePointInterfaceRoutePreviewBoundsInterfaceRoutePreviewCoordinateInterfaceRoutePreviewJSONInterfaceRoutePreviewOptionsRoutePreviewRouteFileSourceInterfaceRoutePreviewRouteSourceInterfaceRoutePreviewSegmentJSONInterfaceRouteStreamDataItemRouteStreamInterfaceRouteWaypointInterfaceSamplePowerCurveOptionsStatsClassInterfaceStreamDataItemStreamFilterInterfaceStreamInterfaceStreamJSONInterfaceSwimLengthJSONInterfaceThreeDimensionalCapacityComponentThreeDimensionalCapacityDiagnosticsThreeDimensionalCapacityFitThreeDimensionalDailyStrainLoadThreeDimensionalImpulseResponseCalibrationThreeDimensionalImpulseResponseParametersThreeDimensionalImpulseResponsePointThreeDimensionalPerformanceObservationThreeDimensionalPowerContributionsThreeDimensionalStrainAnalysisThreeDimensionalStrainEligibilityThreeDimensionalStrainEvidenceThreeDimensionalStrainEvidenceValueV1ThreeDimensionalStrainEvidenceValueV2ThreeDimensionalStrainFitDiagnosticsThreeDimensionalStrainInputDiagnosticsThreeDimensionalStrainLoadThreeDimensionalStrainScoresThreeParameterCriticalPowerFitThreeParameterCriticalPowerFitOptionsThreeParameterCriticalPowerModelUserUnitSettingsInterface
    Type Aliases
    ActivityTypeGroupCriticalPowerFitMethodDataJSONPrimitiveDataJSONValueDefaultDataClassValueDefaultDataValueDiveGasModeDiveGasStatusDiveSourceRecordsInputDurabilityDisciplineDurabilityEligibilityReasonDurabilityEvidenceDurabilityOutputSourceDurabilityOutputUnitFitThreeDimensionalCapacityOptionsFITTrainingFileReferenceFITTrainingFileReferencesValueFITWorkoutDefinitionFITWorkoutDefinitionsValueFITWorkoutReferenceDiagnosticImpulseResponseCalibrationReasonImpulseResponseCalibrationStatusLapTypeLapTypesPowerDurationEnvelopeStatusSuuntoPlusGuideExporterSuuntoPlusGuideReferenceSuuntoPlusGuideReferencesValueThreeDimensionalCapacityComponentStatusThreeDimensionalCapacityReasonThreeDimensionalCapacityStatusThreeDimensionalImpulseResponseCalibrationReasonThreeDimensionalImpulseResponseCalibrationStatusThreeDimensionalPowerSampleThreeDimensionalStrainDisciplineThreeDimensionalStrainEligibilityReasonThreeDimensionalStrainEvidenceValueThreeDimensionalStrainReasonThreeDimensionalStrainStatusWPrimeBalanceTiming
    Variables - Activities and events
    Variables - Analytics
    Variables - Other
    Functions - Activities and events
    Functions - Analytics
    Functions - FIT workout references
    Functions - Other