Update the settings used to provision a live stream.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "air_date": "2016-03-15T04:57:35+00:00",
  "email": "g.raymond@bigdata.com",
  "segment_length": 10,
  "has_redundant_streams": true,
}

RESPONSE
201 (Created)
{
  "id": 1
  "video_id": 9692308,
  "air_date": "2015-12-03 20:45:23",
  "ingest_url": "rtmp://live.vidyard.io:1935/live",
  "stream_key": "f437732710546d1f22a939e12d4a950b",
  "email": "g.raymond@bigdata.com",
  "segment_length": 10,
  "start_time": 0,
  "end_time": 0,
  "has_redundant_streams": null,
  "backup_url": null,
  "backup_key": null,
  "channel_style": true,
  "has_captions": null,
  "status": "offline"
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

video_name
optional

Video name

Validations:

  • Must be a String

air_date
optional

The date/time the stream is set to air. This changes credential generation time.

Validations:

  • Parameter has to be DateTime.

email
optional , nil allowed

Email address to receive stream credentials.

Validations:

  • Must be a String

segment_length
optional

Duration of segment files in seconds. Smaller number will be more live, but will cause more viewer buffering.

Validations:

  • Must be one of: 4, 10, 4, 10.

has_redundant_streams
optional

Determines whether backup ingestion credentials are created. Must have feature enabled for your organization for this parameter.

Validations:

  • Parameter has to be Boolean.

trim_black_start
optional

Trim the first section of black frames from the encoded livestream.

Validations:

  • Parameter has to be Boolean.

disable_notifications
optional

Should email notifications be enabled for this stream?

Validations:

  • Parameter has to be Boolean.