Skip to content

Stores the FluentPlayer integration settings and returns the normalised result.

Endpoint

  • Method: POST

  • Path: /settings/fluent-player-settings

  • Edition: Core

  • Controller: SettingController@updateFluentPlayerSettings

  • Route source: fluent-community/app/Http/Routes/api.php:168

  • Controller source: fluent-community/app/Http/Controllers/SettingController.php

  • Requires the FluentCommunity community-admin permission (or a WordPress super admin).

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

POST Save Fluent Player Settings

POST
/settings/fluent-player-settings

Stores the FluentPlayer integration settings and returns the normalised result.

Controller: SettingController@updateFluentPlayerSettings
Route source: fluent-community/app/Http/Routes/api.php:168

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Request Body

application/json
JSON
{
  
"settings": {
  
}
}

Responses

Successful response

application/json
JSON
{
  
"message": "string",
  
"settings": {
  
  
"behaviors": {
  
  
  
"hide_bottom_controls": true,
  
  
  
"hide_center_controls": true,
  
  
  
"hide_top_controls": true,
  
  
  
"load_strategy": "string",
  
  
  
"muted_autoplay": true,
  
  
  
"save_play_position": true
  
  
},
  
  
"brandColor": "string",
  
  
"controlBarColor": "string",
  
  
"controls": {
  
  
  
"backward": true,
  
  
  
"captions_toggle": true,
  
  
  
"current_time": true,
  
  
  
"forward": true,
  
  
  
"fullscreen": true,
  
  
  
"pip": true,
  
  
  
"play": true,
  
  
  
"playback_speed": true,
  
  
  
"progress_bar": true,
  
  
  
"settings": true,
  
  
  
"volume": true
  
  
},
  
  
"enable_audio": "string",
  
  
"enable_fluent_player": "string",
  
  
"playButtonBgColor": "string",
  
  
"playButtonColor": "string",
  
  
"play_embedded_videos": "string",
  
  
"skin": "string",
  
  
"video_upload": "string",
  
  
"video_upload_role": "string"
  
}
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation