Manage recordings

Recording management related API functions.

GHS.ghs_get_storage_location() → tuple[str, str | None][source]

Retrieve the storage location.

Returns

  • GHSReturnValue - API return status

  • GHSStorageLocation - The storage location

GHS.ghs_set_storage_location(storage_location: str | int) → str[source]

Set the storage location.

The system needs to be idle before calling this function.

Parameters

storage_location – The desired storage location.

Returns

  • GHSReturnValue - API return status

GHS.ghs_get_recording_name() → tuple[str, str | None, int | None][source]

Retrieve the recording base name and recording index of the last recording file.

The recording base name parameter is UTF-8 encoded.

Returns

  • GHSReturnValue - API return status

  • recording_base_name - The base name of the recording file

  • recording_index - The index of the recording file

GHS.ghs_set_recording_name(recording_name: str, recording_index: int) → str[source]

Set the recording base name and recording index for the next recording file.

The system needs to be idle before calling this function. The recording base name parameter must be UTF-8 encoded.

Parameters

  • recording_name – The desired base name of the recording file

  • recording_index – The desired index of the recording file

Returns

  • GHSReturnValue - API return status

GHS.ghs_delete_last_recording() → str[source]

Deletes the most recent recording from local mainframe storage.

Recordings are deleted asynchronously.

Returns

  • GHSReturnValue - API return status

GHS.ghs_delete_all_recordings() → str[source]

Deletes all recordings from local mainframe storage.

Recordings are deleted asynchronously.

Returns

  • GHSReturnValue - API return status

GHS.ghs_get_high_low_rate_storage_enabled(source: str | int, slot_id: str) → tuple[str, str | None, str | None][source]

Retrieve storage enabled status of high and low rate data for the specified recording data source.

Parameters

  • source – The recording data source

  • slot_id – The slot containing the recorder

Returns

  • GHSReturnValue - API return status

  • GHSEnableDisable - Flag to indicate if high rate data is stored

  • GHSEnableDisable - Flag to indicate if low rate data is stored

GHS.ghs_set_high_low_rate_storage_enabled(source: str | int, slot_id: str, high_rate_enabled: str | int, low_rate_enabled: str | int) → str[source]

Enable/disable storage of high and low rate data for the specified recording data source.

Parameters

  • source – The recording data source

  • slot_id – The slot containing the recorder

  • high_rate_enabled – Enable/disable storage of high rate data

  • low_rate_enabled – Enable/disable storage of low rate data.

Returns

  • GHSReturnValue - API return status

Accepted values:

  • storage_location - “Remote”, “Local1”, “Local2”, “iSCSI1”, “iSCSI2” (Mainframe should support mentioned storage location)

  • source - “SyncChannels”, “SyncRealTimeFormulas”

  • slot_id - e.g. ‘A’ for the first slot

  • high_rate_enabled/low_rate_enabled - “Enable”, “Disable”