Create ingress stream
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
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
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.
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.
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 is supported only at the edge, in closed networks. When Lattice runs in a cloud environment reached over the public internet, 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 RTSP or SRT. An MPEG-TS stream created at the edge can still be listed and inspected on the IngressStream read model even when cloud ingress is disabled.
Pull from a caller-supplied RTSP URL.
Receive an SRT push from the producer. The service returns a URL and session_id in CreateIngressStreamResponse.
Response
Identifier of the newly created ingress stream. Echoes the caller-supplied
ingress_id if one was provided, otherwise a service-generated GUID.
Connection details for an MPEG-TS push. Only returned when the request selected mpeg_ts and MPEG-TS ingress is enabled for the deployment. MPEG-TS ingress is supported only at the edge, in closed networks; in a cloud environment reached over the public internet it may be disabled per deployment, in which case the create request is rejected and this field is never populated.