Interface StreamService
-
- All Implemented Interfaces:
public interface StreamServiceIngest and monitor livestream content.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceStreamService.WithRawResponseA view of StreamService that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract StreamService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract StreamService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
add
StreamAddResponse add(String namespace, StreamAddParams params)
Monitor the livestream at the given stream URL. This method returns immediately.
-
add
StreamAddResponse add(String namespace, StreamAddParams params, RequestOptions requestOptions)
-
add
StreamAddResponse add(StreamAddParams params)
-
add
abstract StreamAddResponse add(StreamAddParams params, RequestOptions requestOptions)
-
addFrame
StreamAddFrameResponse addFrame(String namespace, StreamAddFrameParams params)
Ingest a single livestream frame as an image data URI plus relative timestamp in milliseconds. The stream does not need to be created beforehand. Only image/jpeg, image/png, and image/webp are accepted. The decoded bytes must match the declared mime type, decode as a valid image, stay within 5 MB, and stay within 4096x4096 / 16,000,000 total pixels. Timestamps are relative milliseconds from stream start and must be unique and strictly increasing within a stream. Duplicate or out-of-order frame timestamps are accepted at the API boundary but ignored by downstream processing. This method returns immediately after the frame has been accepted for processing.
-
addFrame
StreamAddFrameResponse addFrame(String namespace, StreamAddFrameParams params, RequestOptions requestOptions)
-
addFrame
StreamAddFrameResponse addFrame(StreamAddFrameParams params)
-
addFrame
abstract StreamAddFrameResponse addFrame(StreamAddFrameParams params, RequestOptions requestOptions)
-
addTranscript
StreamAddTranscriptResponse addTranscript(String namespace, StreamAddTranscriptParams params)
Ingest a single transcript segment for a livestream using a relative timestamp in milliseconds. The stream does not need to be created beforehand. Transcript timestamps are relative milliseconds from stream start and should be monotonically increasing within a stream so transcript context lines up correctly with later frames. This method returns immediately after the transcript has been accepted for processing.
-
addTranscript
StreamAddTranscriptResponse addTranscript(String namespace, StreamAddTranscriptParams params, RequestOptions requestOptions)
-
addTranscript
StreamAddTranscriptResponse addTranscript(StreamAddTranscriptParams params)
-
addTranscript
abstract StreamAddTranscriptResponse addTranscript(StreamAddTranscriptParams params, RequestOptions requestOptions)
-
-
-
-