Constructor Detail

Method Detail

• getAvailableOfflineRecordingDataTypes

   abstract Single<Set<PolarBleApi.PolarDeviceDataType>> getAvailableOfflineRecordingDataTypes(String identifier)

  Get the data types available in this device for offline recording. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING

  Parameters:

  identifier - Polar device id found printed on the sensor/device or bt address

  Returns:

  Single Produces: <BR></BR> - onSuccess the set of available offline recording data types in this device <BR></BR> - onError status request failed

• requestOfflineRecordingSettings

   abstract Single<PolarSensorSetting> requestOfflineRecordingSettings(String identifier, PolarBleApi.PolarDeviceDataType feature)

  Request the offline recording settings available in current operation mode. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING This request shall be used before the offline recording is started to decide currently available settings. The available settings depend on the state of the device.

  Parameters:

  identifier - polar device id or bt address

  feature - the stream feature of interest

  Returns:

  Single stream

• requestFullOfflineRecordingSettings

   abstract Single<PolarSensorSetting> requestFullOfflineRecordingSettings(String identifier, PolarBleApi.PolarDeviceDataType feature)

  Request all the settings available in the device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.

  Parameters:

  identifier - polar device id or bt address

  feature - the stream feature of interest

  Returns:

  Single stream

• getOfflineRecordingStatus

   abstract Single<List<PolarBleApi.PolarDeviceDataType>> getOfflineRecordingStatus(String identifier)

  Get current offline recording status. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING

  Parameters:

  identifier - polar device id or bt address

  Returns:

  Single Produces: <BR></BR> - onSuccess the list of currently recording offline recordings, if the list is empty no offline recordings currently recorded <BR></BR> - onError status request failed

• listOfflineRecordings

   abstract Flowable<PolarOfflineRecordingEntry> listOfflineRecordings(String identifier)

  List offline recordings stored in the device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING

  Parameters:

  identifier - Polar device id found printed on the sensor/device or bt address

  Returns:

  Flowable stream <BR></BR> - onNext the found offline recording entry in PolarOfflineRecordingEntry <BR></BR> - onComplete the listing completed <BR></BR> - onError listing request failed

• getOfflineRecord

   abstract Single<PolarOfflineRecordingData> getOfflineRecord(String identifier, PolarOfflineRecordingEntry entry, PolarRecordingSecret secret)

  Fetch recording from the Polar device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING

  Note, the fetching of the recording may take several seconds if the recording is big.

  Parameters:

  identifier - Polar device id found printed on the sensor/device or bt address

  entry - The offline recording to be fetched

  secret - If the secret is provided in startOfflineRecording or setOfflineRecordingTrigger then the same secret must be provided when fetching the offline record

  Returns:

  Single Produces: <BR></BR> - onSuccess the offline recording data <BR></BR> - onError fetch recording request failed

• getOfflineRecordWithProgress

   abstract Observable<PolarOfflineRecordingResult> getOfflineRecordWithProgress(String identifier, PolarOfflineRecordingEntry entry, PolarRecordingSecret secret)

  Fetch recording from the Polar device with progress tracking. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING

  Note, the fetching of the recording may take several seconds if the recording is big. This method provides progress updates during the download.

  Parameters:

  identifier - Polar device id found printed on the sensor/device or bt address

  entry - The offline recording to be fetched

  secret - If the secret is provided in startOfflineRecording or setOfflineRecordingTrigger then the same secret must be provided when fetching the offline record

  Returns:

  Observable Produces: <BR></BR> - onNext progress updates with PolarOfflineRecordingProgress containing bytes downloaded <BR></BR> - onComplete when download finishes with final PolarOfflineRecordingResult <BR></BR> - onError fetch recording request failed

• listSplitOfflineRecordings

  @Deprecated(message = "Use listOfflineRecordings instead") abstract Flowable<PolarOfflineRecordingEntry> listSplitOfflineRecordings(String identifier)

  Lists all parts of all offline recordings (split and non-split) stored in the device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING Use this method to list all parts of a recording when you need to read long offline recordings one file part at a time.

  Parameters:

  identifier - Polar device id found printed on the sensor/device or bt address

  Returns:

  Flowable stream <BR></BR> - onNext the found offline recording entry in PolarOfflineRecordingEntry <BR></BR> - onComplete the listing completed <BR></BR> - onError listing request failed

• getSplitOfflineRecord

  @Deprecated(message = "Use getOfflineRecordWithProgress method instead") abstract Single<PolarOfflineRecordingData> getSplitOfflineRecord(String identifier, PolarOfflineRecordingEntry entry, PolarRecordingSecret secret)

  Fetch split recording from the Polar device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING

  Note, the fetching of the recording may take several seconds if the recording is big.

  Parameters:

  identifier - Polar device id found printed on the sensor/device or bt address

  entry - The offline recording to be fetched

  secret - If the secret is provided in startOfflineRecording or setOfflineRecordingTrigger then the same secret must be provided when fetching the offline record

  Returns:

  Single Produces: <BR></BR> - onSuccess the offline recording data <BR></BR> - onError fetch recording request failed

• removeOfflineRecord

   abstract Completable removeOfflineRecord(String identifier, PolarOfflineRecordingEntry entry)

  Removes offline recording from the device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING

  Parameters:

  identifier - Polar device id found printed on the sensor/device or bt address

  entry - entry to be removed

  Returns:

  Completable Produces: <BR></BR> - onComplete offline record is removed <BR></BR> - onError offline record removal failed

• startOfflineRecording

   abstract Completable startOfflineRecording(String identifier, PolarBleApi.PolarDeviceDataType feature, PolarSensorSetting settings, PolarRecordingSecret secret)

  Start offline recording. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING

  Parameters:

  identifier - Polar device id found printed on the sensor/device or bt address

  feature - the feature to be started

  settings - settings for the started offline recording.

  secret - if the secret is provided the offline recordings are encrypted in device

  Returns:

  Completable Produces: <BR></BR> - onComplete offline recording is started successfully <BR></BR> - onError offline recording start failed.

• stopOfflineRecording

   abstract Completable stopOfflineRecording(String identifier, PolarBleApi.PolarDeviceDataType feature)

  Request to stop offline recording. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING

  Parameters:

  identifier - polar device id

  feature - which is stopped

  Returns:

  Completable Produces: <BR></BR> - onComplete offline recording is stop successfully <BR></BR> - onError offline recording stop failed.

• setOfflineRecordingTrigger

   abstract Completable setOfflineRecordingTrigger(String identifier, PolarOfflineRecordingTrigger trigger, PolarRecordingSecret secret)

  Sets the offline recording triggers for a given Polar device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING The offline recording can be started automatically in the device by setting the triggers. The changes to the trigger settings will take effect on the next device startup.

  Automatically started offline recording can be stopped by stopOfflineRecording. Also if user switches off the device power, the offline recording is stopped but starts again once power is switched on and the trigger event happens.

  Trigger functionality can be disabled by setting PolarOfflineRecordingTriggerMode.TRIGGER_DISABLED, the already running offline recording is not stopped by disable.

  Parameters:

  identifier - Polar device id found printed on the sensor/device or bt address

  trigger - the type of trigger

  secret - if the secret is provided the offline recordings are encrypted in deviceProduces: <BR></BR> - onComplete offline recording trigger set successfully <BR></BR> - onError offline recording trigger set failed.

• getOfflineRecordingTriggerSetup

   abstract Single<PolarOfflineRecordingTrigger> getOfflineRecordingTriggerSetup(String identifier)

  Retrieves the current offline recording trigger setup in the device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_RECORDING

  Parameters:

  identifier - Polar device id found printed on the sensor/device or bt addressProduces: <BR></BR> - onSuccess the offline recording trigger setup in the device <BR></BR> - onError fetch recording request failed