Skip to main content
PATCH
/
streaming
/
players
/
{player_id}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
player = client.streaming.players.update(
    player_id=0,
)
print(player.id)
{
  "name": "<string>",
  "id": 123,
  "client_id": 123,
  "framework": "<string>",
  "design": "<string>",
  "custom_css": "<string>",
  "js_url": "<string>",
  "skin_is_url": "<string>",
  "bg_color": "<string>",
  "fg_color": "<string>",
  "text_color": "<string>",
  "hover_color": "<string>",
  "autoplay": true,
  "mute": true,
  "disable_skin": true,
  "save_options_to_cookies": true,
  "show_sharing": true,
  "logo_position": "<string>",
  "speed_control": true,
  "logo": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
player_id
integer
required

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

Body

application/json
​
player
object

Set of properties for displaying videos. All parameters may be blank to inherit their values from default Streaming player.

Response

200 - application/json

Successful

Set of properties for displaying videos. All parameters may be blank to inherit their values from default Streaming player.

​
name
string
required

Player name

​
id
integer

Player ID

​
client_id
integer

Client ID

​
framework
string

Player framework type

​
design
string

String to be rendered as JS parameters to player

​
custom_css
string

Custom CSS to be added to player iframe

​
js_url
string

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

​
skin_is_url
string

URL to custom skin JS file

​
bg_color
string

Color of skin background in format #AAAAAA

​
fg_color
string

Color of skin foreground (elements) in format #AAAAAA

​
text_color
string

Color of skin text elements in format #AAAAAA

​
hover_color
string

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

​
autoplay
boolean

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

​
mute
boolean

Regulates the sound volume:

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

Default is false

​
disable_skin
boolean

Enables/Disables player skin:

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

Default is false

​
save_options_to_cookies
boolean

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_sharing
boolean

Enables/Disables sharing button display:

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

Default is true

​
logo_position
string

Logotype position.
Has four possible values:

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

Default is null

​
speed_control
boolean

Enables/Disables speed control button display:

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

Default is false

URL to logo image