G-g-core
Players

Change player

Changed on

Updates player settings

patch/streaming/players/{player_id}

Request

  • Base URL
    https://api.gcore.com
  • URL
    https://api.gcore.com/streaming/players/{player_id}
  • Auth
    HTTP apikey

Path parameters

player_idinteger required

Player ID.
IDs of all created players can be received via Get All Players request

Request body

Response

Successful

idinteger

Player ID

namestring

Player name

client_idinteger

Client ID

frameworkstring

Player framework type

designstring

String to be rendered as JS parameters to player

custom_cssstring

Custom CSS to be added to player iframe

js_urlstring

Player main JS file URL. Leave empty to use JS URL from the default player

skin_is_urlstring

URL to custom skin JS file

bg_colorstring

Color of skin background in format #AAAAAA

fg_colorstring

Color of skin foreground (elements) in format #AAAAAA

text_colorstring

Color of skin text elements in format #AAAAAA

hover_colorstring

Color of foreground elements when mouse is over in format #AAAAAA

autoplayboolean

Enables video playback right after player load:

  • true — video starts playing right after player loads
  • false — video isn’t played automatically. A user must click play to start

Default is false

muteboolean

Regulates the sound volume:

  • true — video starts with volume off
  • false — video starts with volume on

Default is false

disable_skinboolean

Enables/Disables player skin:

  • true — player skin is disabled
  • false — player skin is enabled

Default is false

save_options_to_cookiesboolean

Enables/Disables saving volume and other options in cookies:

  • true — user settings will be saved
  • false — user settings will not be saved

Default is true

show_sharingboolean

Enables/Disables sharing button display:

  • true — sharing button is displayed
  • false — no sharing button is displayed

Default is true

logo_positionstring

Logotype position.
Has four possible values:

  • tl — top left
  • tr — top right
  • bl — bottom left
  • br — bottom right

Default is null

speed_controlboolean

Enables/Disables speed control button display:

  • true — sharing button is displayed
  • false — no sharing button is displayed

Default is false

logostring

URL to logo image

Changes

  • e39aa177017fRevision changes
    • breaking

      the response property became optional for the status

    • info

      the request property / became optional