Skip to content

Commit

Permalink
Add info about async-ness
Browse files Browse the repository at this point in the history
  • Loading branch information
szekelyzol committed Jul 22, 2024
1 parent 44ea05a commit f12fc37
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion live-streaming/working-with-live-streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ You can update live stream details from your dashboard if you don't want to retr

## Complete a live stream

You can request the API to complete a live stream that is currently running.
You can request the API to complete a live stream that is currently running. This operation is asynchronous and the live stream will stop after a few seconds.

The API adds the `EXT-X-ENDLIST` tag to the live stream's HLS manifest. This stops the live stream on the player and also stops the recording of the live stream. The API keeps the incoming connection from the streamer open for at most 1 minute, which can be used to terminate the stream.

Expand Down
2 changes: 1 addition & 1 deletion openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6958,7 +6958,7 @@ paths:
- Live Streams
summary: Complete a live stream
description: |
Request the completion of a live stream that is currently running.
Request the completion of a live stream that is currently running. This operation is asynchronous and the live stream will stop after a few seconds.

The API adds the `EXT-X-ENDLIST` tag to the live stream's HLS manifest. This stops the live stream on the player and also stops the recording of the live stream. The API keeps the incoming connection from the streamer open for at most 1 minute, which can be used to terminate the stream.
operationId: PUT_live-streams-liveStreamId-complete
Expand Down

0 comments on commit f12fc37

Please sign in to comment.