Change broadcast

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
)
broadcast = client.streaming.broadcasts.update(
    broadcast_id=0,
)
print(broadcast.id)

package main

import (
	"context"
	"fmt"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/option"
	"github.com/G-Core/gcore-go/streaming"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	broadcast, err := client.Streaming.Broadcasts.Update(
		context.TODO(),
		0,
		streaming.BroadcastUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", broadcast.ID)
}

curl --request PATCH \
  --url https://api.gcore.com/streaming/broadcasts/{broadcast_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "broadcast": {
    "name": "Broadcast",
    "status": "live",
    "share_url": "",
    "custom_iframe_url": "",
    "show_dvr_after_finish": true,
    "ad_id": 1,
    "player_id": 14,
    "stream_ids": [
      10
    ]
  }
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    broadcast: {
      name: 'Broadcast',
      status: 'live',
      share_url: '',
      custom_iframe_url: '',
      show_dvr_after_finish: true,
      ad_id: 1,
      player_id: 14,
      stream_ids: [10]
    }
  })
};

fetch('https://api.gcore.com/streaming/broadcasts/{broadcast_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/streaming/broadcasts/{broadcast_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'broadcast' => [
        'name' => 'Broadcast',
        'status' => 'live',
        'share_url' => '',
        'custom_iframe_url' => '',
        'show_dvr_after_finish' => true,
        'ad_id' => 1,
        'player_id' => 14,
        'stream_ids' => [
                10
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://api.gcore.com/streaming/broadcasts/{broadcast_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"broadcast\": {\n    \"name\": \"Broadcast\",\n    \"status\": \"live\",\n    \"share_url\": \"\",\n    \"custom_iframe_url\": \"\",\n    \"show_dvr_after_finish\": true,\n    \"ad_id\": 1,\n    \"player_id\": 14,\n    \"stream_ids\": [\n      10\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/streaming/broadcasts/{broadcast_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"broadcast\": {\n    \"name\": \"Broadcast\",\n    \"status\": \"live\",\n    \"share_url\": \"\",\n    \"custom_iframe_url\": \"\",\n    \"show_dvr_after_finish\": true,\n    \"ad_id\": 1,\n    \"player_id\": 14,\n    \"stream_ids\": [\n      10\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "name": "Player",
  "status": "paused",
  "share_url": null,
  "custom_iframe_url": null,
  "show_dvr_after_finish": true,
  "ad_id": null,
  "player_id": null,
  "stream_ids": [],
  "id": 3111719,
  "client_id": 102748,
  "iframe_embed_code": "<iframe width=\"560\" height=\"315\" src=\"https://player.gvideo.co/broadcasts/2675_21606?no_low_latency\" frameborder=\"0\" allowfullscreen></iframe>",
  "iframe_url": "https://player.gvideo.co/broadcasts/2675_21606?no_low_latency",
  "pending_message": null,
  "custom_messages": null,
  "client_user_id": null,
  "poster_thumb": null,
  "poster": null
}

This response has no body data.

PATCH

streaming

broadcasts

{broadcast_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
)
broadcast = client.streaming.broadcasts.update(
    broadcast_id=0,
)
print(broadcast.id)

package main

import (
	"context"
	"fmt"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/option"
	"github.com/G-Core/gcore-go/streaming"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	broadcast, err := client.Streaming.Broadcasts.Update(
		context.TODO(),
		0,
		streaming.BroadcastUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", broadcast.ID)
}

curl --request PATCH \
  --url https://api.gcore.com/streaming/broadcasts/{broadcast_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "broadcast": {
    "name": "Broadcast",
    "status": "live",
    "share_url": "",
    "custom_iframe_url": "",
    "show_dvr_after_finish": true,
    "ad_id": 1,
    "player_id": 14,
    "stream_ids": [
      10
    ]
  }
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    broadcast: {
      name: 'Broadcast',
      status: 'live',
      share_url: '',
      custom_iframe_url: '',
      show_dvr_after_finish: true,
      ad_id: 1,
      player_id: 14,
      stream_ids: [10]
    }
  })
};

fetch('https://api.gcore.com/streaming/broadcasts/{broadcast_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/streaming/broadcasts/{broadcast_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'broadcast' => [
        'name' => 'Broadcast',
        'status' => 'live',
        'share_url' => '',
        'custom_iframe_url' => '',
        'show_dvr_after_finish' => true,
        'ad_id' => 1,
        'player_id' => 14,
        'stream_ids' => [
                10
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://api.gcore.com/streaming/broadcasts/{broadcast_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"broadcast\": {\n    \"name\": \"Broadcast\",\n    \"status\": \"live\",\n    \"share_url\": \"\",\n    \"custom_iframe_url\": \"\",\n    \"show_dvr_after_finish\": true,\n    \"ad_id\": 1,\n    \"player_id\": 14,\n    \"stream_ids\": [\n      10\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/streaming/broadcasts/{broadcast_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"broadcast\": {\n    \"name\": \"Broadcast\",\n    \"status\": \"live\",\n    \"share_url\": \"\",\n    \"custom_iframe_url\": \"\",\n    \"show_dvr_after_finish\": true,\n    \"ad_id\": 1,\n    \"player_id\": 14,\n    \"stream_ids\": [\n      10\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "name": "Player",
  "status": "paused",
  "share_url": null,
  "custom_iframe_url": null,
  "show_dvr_after_finish": true,
  "ad_id": null,
  "player_id": null,
  "stream_ids": [],
  "id": 3111719,
  "client_id": 102748,
  "iframe_embed_code": "<iframe width=\"560\" height=\"315\" src=\"https://player.gvideo.co/broadcasts/2675_21606?no_low_latency\" frameborder=\"0\" allowfullscreen></iframe>",
  "iframe_url": "https://player.gvideo.co/broadcasts/2675_21606?no_low_latency",
  "pending_message": null,
  "custom_messages": null,
  "client_user_id": null,
  "poster_thumb": null,
  "poster": null
}

This response has no body data.

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

broadcast_id

integer

required

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

Body

application/json

broadcast

object

Show child attributes

Example:

{
  "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

name

string

required

Broadcast name

status

string

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

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_url

string

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_finish

boolean

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_message

string

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

ad_id

integer

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_id

integer

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

stream_ids

integer[]

IDs of streams used in a broadcast

poster

string

Uploaded poster file

integer

Broadcast ID

client_id

integer

Client ID

client_user_id

integer

Custom field where you can specify user ID in your system

iframe_url

string

URL to the broadcast player, can be embedded via iframe

iframe_embed_code

string

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

custom_messages

object | null

Custom status messages configuration for the broadcast, if configured

poster_thumb

string | null

URL of the poster image thumbnail

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

Edge Proxy

FastEdge

WAAP

Streaming

Object Storage

Resellers

Authorizations

Path Parameters

Body

Response