Create ingress stream

Preview

Creates a video ingress stream, returning metadata that you can use to stream live video to Lattice. Exactly one of rtsp or srt must be set on the request.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
ingressIdstringOptional

Caller-supplied identifier for the new stream. If omitted, the service generates a GUID. If supplied, a consistent and recognizable pattern is recommended. A common convention is a group prefix (organization, platform, or asset) followed by a specific identifier using underscore or dot as a separator, for example, drone_1, vessel_2, or teamalpha.drone1.

When supplied, an ingress_id must be between 4 and 36 characters long and use only printable ASCII characters with no spaces; the 36-character ceiling leaves room for a full GUID. A value outside that length range, or one containing spaces, control characters, or non-ASCII characters, is rejected, as is an ingress_id that another ingress stream is already using.

titlestringOptional

Human-readable title for the stream. A title is required: surrounding whitespace is trimmed before it is stored, and what remains must be non-empty, valid UTF-8, and no longer than 64 characters. Otherwise the request is rejected.

mpegTsobjectOptional

Receive an MPEG-TS push from the producer. The service allocates a UDP port and returns the URL the producer must push to in CreateIngressStreamResponse.

MPEG-TS ingress may be disabled per deployment. When it is disabled, a request that selects mpeg_ts is rejected with a gRPC error rather than accepted, so callers should be prepared to fall back to another protocol.

rtspobjectOptional

Pull from a caller-supplied RTSP URL.

srtobjectOptional

Receive an SRT push from the producer. The service returns a URL and session_id in CreateIngressStreamResponse.

Response

OK
ingressIdstringOptional

Identifier of the newly created ingress stream. Echoes the caller-supplied ingress_id if one was provided, otherwise a service-generated GUID.

mpegTsobjectOptional

Connection details for an MPEG-TS push. Only returned when MPEG-TS ingress is enabled for the deployment and the request selected mpeg_ts.

srtobjectOptional
SRT ingress connection details. Returned to the producer so it knows where to push the stream.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
503
Service Unavailable Error