CAcamb
Apis
Streaming

Get Stream Status

Retrieve the current status of a stream, including source connection details and the state and URLs of every output.

get/stream/{stream_id}

Request

  • Base URL
    https://client.camb.ai/apis
  • URL
    https://client.camb.ai/apis/stream/{stream_id}
  • Auth
    API key in header x-api-key

Path parameters

stream_idinteger required

Identifier returned when the stream was created.

Response

Current state of the stream.

stream_idinteger
status1 | 2 | 3 | 4 | 5 | 6

Lifecycle status of a stream.

ValueStatusDescription
1ScheduledCreated and waiting for its start time.
2Setting upResources are being provisioned.
3StartedLive and processing.
4EndedCompleted normally.
5InterruptedStopped before its scheduled end.
6ErrorFailed; see the error field.
scheduled_atstring date-time nullable
started_atstring date-time nullable
stopped_atstring date-time nullable
task_idstring nullable

Setup task identifier.

errorstring nullable

Failure description when status is 6 (error).

Changes

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