PolarOfflineRecordingApi Protocol Reference


                    
                    
                    getAvailableOfflineRecordingDataTypes(_:)

Asynchronous

Get the data types available in this device for offline recording

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func getAvailableOfflineRecordingDataTypes(_ identifier: String) async throws -> Set<PolarDeviceDataType>

Return Value

set of available offline recording data types in this device


                    
                    
                    requestOfflineRecordingSettings(_:feature:)

Asynchronous

Request the offline recording settings available in current operation mode. 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.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func requestOfflineRecordingSettings(_ identifier: String, feature: PolarDeviceDataType) async throws -> PolarSensorSetting

Return Value

PolarSensorSetting with the available settings received from the device


                    
                    
                    requestFullOfflineRecordingSettings(_:feature:)

Asynchronous

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

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func requestFullOfflineRecordingSettings(_ identifier: String, feature: PolarDeviceDataType) async throws -> PolarSensorSetting

Return Value

PolarSensorSetting with all available settings received from the device


                    
                    
                    getOfflineRecordingStatus(_:)

Asynchronous

Get status of offline recordings.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func getOfflineRecordingStatus(_ identifier: String) async throws -> [PolarDeviceDataType : Bool]

Parameters


                                identifier

polar device id

Return Value

dictionary mapping each PolarDeviceDataType to a Bool indicating whether offline recording is currently active for that type


                    
                    
                    listOfflineRecordings(_:)

List offline recordings stored in the device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Declaration

Swift

func listOfflineRecordings(_ identifier: String) -> AsyncThrowingStream<PolarOfflineRecordingEntry, Error>

Parameters


                                identifier

polar device id

Return Value

AsyncThrowingStream emitting PolarOfflineRecordingEntry values as they are found, or throwing an error


                    
                    
                    getOfflineRecord(_:entry:secret:)

Asynchronous

Fetch recjiöording from the device.

Note, the fetching of the recording may take several seconds if the recording is big. Note, if a faulty data block is encountered while parsing offline data from device that particular data block will be discarded. This will lead to gaps in the data.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func getOfflineRecord(_ identifier: String, entry: PolarOfflineRecordingEntry, secret: PolarRecordingSecret?) async throws -> PolarOfflineRecordingData

Parameters

`identifier`	polar device id
`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

Return Value

PolarOfflineRecordingData containing the fetched offline recording data


                    
                    
                    getOfflineRecordWithProgress(_:entry:secret:)

Fetch recording from the device with progress updates.

Note, the fetching of the recording may take several seconds if the recording is big. Note, if a faulty data block is encountered while parsing offline data from device that particular data block will be discarded. This will lead to gaps in the data.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Declaration

Swift

func getOfflineRecordWithProgress(_ identifier: String, entry: PolarOfflineRecordingEntry, secret: PolarRecordingSecret?) -> AsyncThrowingStream<PolarOfflineRecordingResult, Error>

Parameters

`identifier`	polar device id
`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

Return Value

AsyncThrowingStream emitting PolarOfflineRecordingResult values containing either progress updates or the complete recording data, or throwing an error


                    
                    
                    getSubRecordingCount(identifier:entry:)

Asynchronous

Fetch number of sub recordings in recording from the device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

@available(*, deprecated, message: "Getting subrecordings has been deprecated. Use getOfflineRecord to get full recording instead.")
func getSubRecordingCount(identifier: String, entry: PolarOfflineRecordingEntry) async throws -> Int

Parameters

`identifier`	polar device id
`entry`	the offline recording whose subrecording count will be checked

Return Value

the number of sub recordings in the offline recording


                    
                    
                    listSplitOfflineRecordings(_:)

List split offline recordings stored in the device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Declaration

Swift

@available(*, deprecated, message: "Listing split offline recordings has been deprecated. Use getOfflineRecord to get full recording instead.")
func listSplitOfflineRecordings(_ identifier: String) -> AsyncThrowingStream<PolarOfflineRecordingEntry, Error>

Parameters


                                identifier

polar device id

Return Value

AsyncThrowingStream emitting PolarOfflineRecordingEntry values as they are found, or throwing an error


                    
                    
                    getSplitOfflineRecord(_:entry:secret:)

Asynchronous

Fetch split recording from the device.

Note, the fetching of the recording may take several seconds if the recording is big. Note, if a faulty data block is encountered while parsing offline data from device that particular data block will be discarded. This will lead to gaps in the data.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

@available(*, deprecated, message: "Getting split offline records has been deprecated. Use getOfflineRecord to get full recording instead.")
func getSplitOfflineRecord(_ identifier: String, entry: PolarOfflineRecordingEntry, secret: PolarRecordingSecret?) async throws -> PolarOfflineRecordingData

Parameters

`identifier`	polar device id
`entry`	the split 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

Return Value

PolarOfflineRecordingData containing the fetched offline recording data


                    
                    
                    removeOfflineRecord(_:entry:)

Asynchronous

Removes offline recording from the device. Empty parent directories are removed up to day directory.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func removeOfflineRecord(_ identifier: String, entry: PolarOfflineRecordingEntry) async throws

Parameters

`identifier`	polar device id
`entry`	entry to be removed


                    
                    
                    removeOfflineRecords(_:entry:)

Asynchronous

Removes offline recording with all the subrecordings from the device. Empty parent directories are removed up to day directory.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

@available(*, deprecated, message: "Use removeOfflineRecord to remove recording including subrecords instead.")
func removeOfflineRecords(_ identifier: String, entry: PolarOfflineRecordingEntry) async throws -> Bool

Parameters

`identifier`	polar device id
`entry`	entry with the path to the offline recording

Return Value

true if the offline record and its subrecords were successfully removed


                    
                    
                    startOfflineRecording(_:feature:settings:secret:)

Asynchronous

Start offline recording.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func startOfflineRecording(_ identifier: String, feature: PolarDeviceDataType, settings: PolarSensorSetting?, secret: PolarRecordingSecret?) async throws

Parameters

`identifier`	polar device id
`feature`	the feature to be started
`settings`	optional settings used for offline recording. `PolarDeviceDataType.hr` and `PolarDeviceDataType.ppi` do not require settings
`secret`	if the secret is provided the offline recordings are encrypted in device


                    
                    
                    stopOfflineRecording(_:feature:)

Asynchronous

Request to stop offline recording.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func stopOfflineRecording(_ identifier: String, feature: PolarDeviceDataType) async throws

Parameters

`identifier`	polar device id
`feature`	the feature to be stopped


                    
                    
                    setOfflineRecordingTrigger(_:trigger:secret:)

Asynchronous

Sets the offline recording triggers for a given Polar device. 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.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func setOfflineRecordingTrigger(
    _ identifier: String,
    trigger: PolarOfflineRecordingTrigger,
    secret: PolarRecordingSecret?
) async throws

Parameters

`identifier`	Polar device ID
`trigger`	type of trigger to set
`secret`	optional secret; if provided, the offline recordings are encrypted in the device


                    
                    
                    getOfflineRecordingTriggerSetup(_:)

Asynchronous

Retrieves the current offline recording trigger setup in the device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_offline_recording

Throws

PolarErrors for possible errors invoked

Declaration

Swift

func getOfflineRecordingTriggerSetup(_ identifier: String) async throws -> PolarOfflineRecordingTrigger

Parameters


                                identifier

polar device id

Return Value

PolarOfflineRecordingTrigger describing the current trigger setup in the device