Playback

Stop playback

Stop playback on a layer. Supports video, videoPlaylist, and audioPlaylist layers.

Request Body by Layer Type

Video layers: Use VideoStopRequest schema Playlist layers: Use PlaylistStopRequest schema

Both schemas accept the same resetPosition parameter.

Position Handling

Use resetPosition: true to reset the playback position to the beginning. By default (resetPosition: false), the current position is preserved so playback can resume from where it stopped.

Response

Returns information about what was playing (if anything) and whether the position was reset.

Auto-sync

If the project has auto-sync enabled and is live, the stop is automatically synced to the stream.

post/projects/{id}/layers/{layerId}/stop

Request

  • Base URL: https://api.livereacting.com/v1/external
  • URL: https://api.livereacting.com/v1/external/projects/{id}/layers/{layerId}/stop
  • Auth: HTTP bearer

Path parameters

idstring required

Project ID

layerIdstring required

Layer ID

Request body

resetPositionboolean

Reset playback position to beginning

Response

Playback stopped

layerIdstring

Layer ID

wasPlayingboolean

Whether something was playing

positionResetboolean

Whether position was reset to beginning

syncedboolean

Whether change was synced to live stream

Changes

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