Samsung Health Data SDK/com.samsung.android.sdk.health.data.data.entries/ExerciseSession

ExerciseSession

Details of a single exercise activity such as running or cycling.

Each exercise session is included in ExerciseType with a list. If the exercise data includes only one exercise activity, one ExerciseSession is included in the list.

Data specifications

The main properties of this entry are as follows.

Property	Description
startTime	[Mandatory] The timestamp representing the start of the measurement in this exercise session, specified as an Instant, in milliseconds.
endTime	[Mandatory] The timestamp representing the end of the measurement in this exercise session, specified as Instant, in milliseconds.
exerciseType	[Mandatory] The exercise type of this exercise session. It indicates the Samsung Health app's predefined exercise type.
duration	[Mandatory] The duration of this exercise session, specified as Duration, in milliseconds.
calories	[Mandatory] The calories burned during this exercise session, in kilocalories.
route	This exercise session's route. It's a list of ExerciseLocation.
log	This exercise session's detailed logs such as heart rate or speed. It's a list of ExerciseLog.
swimmingLog	If the exercise session's exercise type is POOL_SWIMMING or OPEN_WATER_SWIMMING, detailed logs with SwimmingLog.
distance	The distance covered during this exercise session, in meters.
countType	The count type for a countable exercise in this exercise session.
count	The number of counts for a countable exercise in this exercise session.
customTitle	The exercise title of this exercise session.
comment	The comment entered by the user for the session.

Depending on exerciseType, recorded properties may differ.

Since

1.0.0

Types

Builder

class Builder

A builder to create an ExerciseSession instance.

Companion

object Companion

Properties

altitudeGain

val altitudeGain: Float?

The altitude gain during this exercise session, in meters.

altitudeLoss

val altitudeLoss: Float?

The altitude loss during this exercise session, in meters.

calories

val calories: Float

The calories burned during this exercise session, in kilocalories.

comment

val comment: String?

The comment entered by the user for the exercise session.

count

val count: Int?

The number of counts for a countable exercise in this exercise session.

countType

val countType: DataType.ExerciseType.CountType

The count type for a countable exercise in this exercise session.

customTitle

val customTitle: String?

The exercise title of this exercise session.

declineDistance

val declineDistance: Float?

The distance covered on a declined surface during the exercise session, in meters.

distance

val distance: Float?

The distance covered during this exercise session, in meters.

duration

val duration: Duration

The duration of this exercise session, specified as Duration, in milliseconds.

endTime

val endTime: Instant

The timestamp representing the end of the measurement in this exercise session, specified as Instant, in milliseconds.

exerciseType

val exerciseType: DataType.ExerciseType.PredefinedExerciseType

The exercise type of this exercise session. It indicates the Samsung Health app's predefined exercise type.

inclineDistance

val inclineDistance: Float?

The distance covered on an inclined surface during the exercise session, in meters.

log

val log: List<ExerciseLog>?

This exercise session's detailed logs such as heart rate or speed. It's a list of ExerciseLog.

maxAltitude

val maxAltitude: Float?

The highest altitude in this exercise session, in meters.

maxCadence

val maxCadence: Float?

The highest value for the cadence in this exercise session, as either cycles per minute or swings per minute.

maxCalorieBurnRate

val maxCalorieBurnRate: Float?

The highest value for the calorie burn rate in this exercise session.

maxHeartRate

val maxHeartRate: Float?

The highest heart rate in this exercise session, in beats per minute.

maxPower

val maxPower: Float?

The highest power in this exercise session, in Watts.

maxRpm

val maxRpm: Float?

The highest value for revolutions per minute (RPM) in this exercise session.

maxSpeed

val maxSpeed: Float?

The highest speed in this exercise session, in meters per second (m/s).

meanCadence

val meanCadence: Float?

The average value for the cadence in this exercise session, as either cycles per minute or swings per minute.

meanCalorieBurnRate

val meanCalorieBurnRate: Float?

The average calorie burn rate in this exercise session.

meanHeartRate

val meanHeartRate: Float?

The average heart rate in this exercise session, in beats per minute.

meanPower

val meanPower: Float?

The average power in this exercise session, in Watts.

meanRpm

val meanRpm: Float?

The average value for revolutions per minute (RPM) in this exercise session.

meanSpeed

val meanSpeed: Float?

The average speed in this exercise session, in meters per second (m/s).

minAltitude

val minAltitude: Float?

The lowest altitude in this exercise session, in meters.

minHeartRate

val minHeartRate: Float?

The lowest heart rate in this exercise session, in beats per minute.

route

val route: List<ExerciseLocation>?

This exercise session's route. It's a list of ExerciseLocation.

startTime

val startTime: Instant

The timestamp representing the start of the measurement in this exercise session, specified as an Instant, in milliseconds.

swimmingLog

val swimmingLog: SwimmingLog?

If the exercise session's exercise type is POOL_SWIMMING or OPEN_WATER_SWIMMING, detailed logs with SwimmingLog.

vo2Max

val vo2Max: Float? = null

The VO2 max during this exercise session.

Essential Cookies

These cookies are essential as they enable you to move around the website. This category cannot be disabled.

Analytical/Performance Cookies

These cookies collect information about how you use our website. for example which pages you visit most often. All information these cookies collect is used to improve how the website works.

Functionality Cookies

These cookies allow our website to remember choices you make (such as your user name, language or the region your are in) and tailor the website to provide enhanced features and content for you.

Advertising Cookies

These cookies gather information about your browser habits. They remember that you've visited our website and share this information with other organizations such as advertisers.