media_player

Get the current state of a media player block.

Changed on
get/api/flows/{flow_id}/blocks/{block_id}/player/state

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

flow_idstring required

Flow ID (UUID)

block_idstring required

Block ID

Response

Player state

current_filestring nullable

Current file path/URI

current_file_indexinteger required

Current file index (0-based)

duration_nsinteger required

Total duration in nanoseconds

loop_playlistboolean required

Whether playlist loops

playliststring[] required

Full playlist

position_nsinteger required

Current position in nanoseconds

state'playing' | 'paused' | 'stopped' required

Playback state of a media player.

total_filesinteger required

Total number of files in playlist

Changes

    • warning

      added the new paused enum value to the response property for the response status

    • warning

      added the new playing enum value to the response property for the response status

    • warning

      added the new stopped enum value to the response property for the response status

    • info

      removed the paused enum value from the response property for the response status

    • info

      removed the playing enum value from the response property for the response status

    • info

      removed the stopped enum value from the response property for the response status