asrun

Changed on

A historic log over what was sent through playout.

post/api/asrun

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie sessionid

Request body

videointeger nullable

Points to the Video which was played if there is one. Can be empty if something other than a video was played. The field is mutually exclusive with programName.

programNamestring

A free form text input saying what was played. If video is set, this field should not be set. Examples of where you'd use this field is e.g. when broadcasting live. Defaults to the empty string.

playoutstring

The playout this entry corresponds with. This will almost always be 'main' which it defaults to.

playedAtstring date-time

Time when the playout started. Defaults to now.

inMsinteger

The inpoint where the video/stream was started at. In milliseconds. Normally 0 which it defaults to.

outMsinteger nullable

The outpoint where the video/stream stopped. This would often be the duration of the video, or how long we live streamed a particular URL. Can be null (None) if this is 'currently happening'.

Response

idinteger required
videointeger nullable

Points to the Video which was played if there is one. Can be empty if something other than a video was played. The field is mutually exclusive with programName.

programNamestring

A free form text input saying what was played. If video is set, this field should not be set. Examples of where you'd use this field is e.g. when broadcasting live. Defaults to the empty string.

playoutstring

The playout this entry corresponds with. This will almost always be 'main' which it defaults to.

playedAtstring date-time

Time when the playout started. Defaults to now.

inMsinteger

The inpoint where the video/stream was started at. In milliseconds. Normally 0 which it defaults to.

outMsinteger nullable

The outpoint where the video/stream stopped. This would often be the duration of the video, or how long we live streamed a particular URL. Can be null (None) if this is 'currently happening'.

Changes