ANangelcam
recording

Start recording

Event recording

If you only wish to record events instead of 24/7 coverage, you can use a combination of the start_from and stop_at or duration parameters. Setting start_from a few seconds before now will ensure that any buffered media starting from the given timestamp will be recorded. Note that this means that Angelcam Cloud is already connected to the media source (e.g. IP camera) or that the media source itself is able to hold media in an internal buffer for some amount of time (RTSP/2.0 media source with Time-Duration media property is required).

The stop_at or duration parameters can be used then to stop the recording automatically at some point. To extend a recording, call this endpoint repeatedly with the same duration parameter or with an increased stop_at parameter. For example, let's assume that the current time is 2024-07-10 10:00:00.000Z. Calling this endpoint with start_from=2024-07-10T09:59:30.000Z and duration=60 will tell Angelcam Cloud to record all available media starting from 30 seconds ago and to keep recording until 60 seconds from now. Calling this endpoint again after 30 seconds with the same parameters will extend the recording duration to 90 seconds from now.

post/recording/{recording_id}/start/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesrecording_start_stop
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

recording_idstring uuid required

Recording UUID

Query parameters

start_fromstring date-time

All available media starting from a given timestamp will be recorded. This also includes any media buffered by Angelcam Cloud infrastructure and the media source itself (e.g. IP camera). This parameter becomes handy in situations when you only want to record certain events but you need the recording to start a few seconds before the event itself. If this endpoint is called without this parameter, only media generated after the recording start command are recorded.

stop_atstring date-time

Time at which the recording will be stopped. In case multiple auto-stop recording requests are received on the same recording, the one which ends later will be applied. If this endpoint is called without this parameter, the recording will not be stopped automatically, and if there's a scheduled auto stop, it will be canceled. This parameter is mutually exclusive with the duration parameter.

durationinteger

Time in seconds after which the recording will be stopped (counting from the moment the request is received by Angelcam API). In case multiple auto-stop recording requests are received on the same recording, the one that ends later will be applied. If this endpoint is called without this parameter, the recording will not be stopped automatically, and if there's a scheduled auto stop, it will be canceled. This parameter is mutually exclusive with the stop_at parameter.

Response

Empty response.

Changes

No recorded changes to this operation across all 1 revision of this API.