G-g-core
Broadcasts

Change broadcast

Changed on

Updates broadcast settings

patch/streaming/broadcasts/{broadcast_id}

Request

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

Path parameters

broadcast_idinteger required

Broadcast ID.
IDs of all created broadcasts can be received via Get All Broadcasts request

Request body

Example request

{
  "broadcast": {
    "name": "Broadcast",
    "status": "live",
    "share_url": "",
    "custom_iframe_url": "",
    "show_dvr_after_finish": true,
    "ad_id": 1,
    "player_id": 14,
    "stream_ids": [
      10
    ]
  }
}

Response

Successful

namestring required

Broadcast name

statusstring

Broadcast statuses:
Pending — default “Broadcast isn’t started yet” or custom message (see pending_message parameter) is shown, users don't see the live stream
Live — broadcast is live, and viewers can see it
Paused — “Broadcast is paused” message is shown, users don't see the live stream
Finished — “Broadcast is finished” message is shown, users don't see the live stream
The users' browsers start displaying the message/stream immediately after you change the broadcast status

share_urlstring

Custom URL or iframe displayed in the link field when a user clicks on a sharing button in player. If empty, the link field and social network sharing is disabled

custom_iframe_urlstring

Custom URL of iframe for video player to be shared via sharing button in player. Auto generated iframe URL is provided by default

show_dvr_after_finishboolean

Regulates if a DVR record is shown once a broadcast is finished. Has two possible values:

  • true — record is shown
  • false — record isn't shown

Default is false

pending_messagestring

A custom message that is shown if broadcast status is set to pending. If empty, a default message is shown

ad_idinteger

ID of ad to be displayed in a live stream. If empty the default ad is show. If there is no default ad, no ad is shown

player_idinteger

ID of player to be used with a broadcast. If empty the default player is used

stream_idsinteger[]

IDs of streams used in a broadcast

posterstring

Uploaded poster file

idinteger

Broadcast ID

client_idinteger

Client ID

client_user_idinteger

Custom field where you can specify user ID in your system

iframe_urlstring

URL to the broadcast player, can be embedded via iframe

iframe_embed_codestring

Ready-to-use HTML <iframe> snippet embedding the broadcast player

custom_messagesobject nullable

Custom status messages configuration for the broadcast, if configured

poster_thumbstring nullable

URL of the poster image thumbnail

Example response

{
  "name": "Broadcast",
  "status": "live",
  "share_url": "",
  "custom_iframe_url": "",
  "show_dvr_after_finish": true,
  "ad_id": 1,
  "player_id": 14,
  "stream_ids": [
    10
  ]
}

Changes