Skip to main content
Version: ACAP version 13 Alpha

Recording Notify API

The Recording Notify application API makes it possible to receive notifications about recordings and their recording spans and segments.

Overview​

Identification​

gdbus introspect --system
                 --dest=com.axis.RecordingNotify1
                 --object-path /com/axis/RecordingNotify1

Check that the root node of the returned introspection data contains the interface com.axis.RecordingNotify1.Notify1.

The D-Bus error org.freedesktop.DBus.Error.ServiceUnknown will be returned if the service is not available.

D-Bus Names​

D-Bus Service: com.axis.RecordingNotify1

Main D-Bus object: /com/axis/RecordingNotify1

D-Bus interface: com.axis.RecordingNotify1.Notify1

Use Cases​

Monitor recordings​

A client wants to monitor when recordings are started and completed.

Use Notify interface for monitoring when recordings are started and completed​

  1. The application connects to the following two signals of /com/axis/RecordingNotify1:
    • com.axis.RecordingNotify1.Notify1.RecordingStarted
    • com.axis.RecordingNotify1.Notify1.RecordingCompleted
  2. Signals will be emitted when recordings are started and completed.

Monitor new recording spans and segments​

A client wants to monitor new recording spans and segments of an ongoing recording.

Use Notify interface for monitoring new spans and segments of a recording group​

  1. The application connects to the following signal of /com/axis/RecordingNotify1:
    • com.axis.RecordingNotify1.Notify1.SpanStarted
    • com.axis.RecordingNotify1.Notify1.SegmentCompleted
  2. Signals will be emitted when new recording spans are started and recording segments are completed.

API Definition​

com.axis.RecordingNotify1.Notify1​

This interface provides signals to notify about new recording spans and segments.

The SegmentCompleted signal​

SegmentCompleted (s storage_id,
                  s span_id,
                  s group_id,
                  s container_id,
                  s start_time,
                  s stop_time,
                  t size);

Emitted when a new recording segment is completed. All times are in ISO 8601 format.

Parameters:

  • storage_id: The storage the recording segment is stored on.
  • span_id: The ID of the recording span.
  • group_id: The ID of the recording group.
  • container_id: The ID of the container.
  • start_time: The start time of the segment.
  • stop_time: The stop time of the segment.
  • size: The size of the segment in bytes.

The SpanStarted signal​

SpanStarted (s storage_id,
             s span_id,
             s group_id,
             s start_time,
             u count,
             s trigger_time);

Emitted when a new recording span is started. All times are in ISO 8601 format.

Parameters:

  • storage_id: The storage the recording span is stored on.
  • span_id: The ID of the recording span.
  • group_id: The ID of the recording group.
  • start_time: The start time of the span.
  • count: The count within a sequence of contiguous spans, starting at 0.
  • trigger_time: The trigger time of the recording.

The RecordingStarted signal​

RecordingStarted (s storage_id,
                  s group_id,
                  s start_time,
                  s trigger_time);

Emitted when a recording is started. All times are in ISO 8601 format.

Parameters:

  • storage_id: The storage the recording span is stored on.
  • group_id: The ID of the recording group.
  • start_time: The start time of the recording.
  • trigger_time: The trigger time of the recording.

The RecordingCompleted signal​

RecordingCompleted (s storage_id,
                    s group_id,
                    s start_time,
                    s stop_time,
                    s trigger_time);

Emitted when a recording is completed. All times are in ISO 8601 format.

Parameters:

  • storage_id: The storage the recording is stored on.
  • group_id: The ID of the recording group.
  • start_time: The start time of the recording.
  • stop_time: The stop time of the recording.
  • trigger_time: The trigger time of the recording.