DEPRECATED
Update the settings used to provision a live stream.
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 |
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, "status": "offline" }
Param name | Description |
---|---|
auth_token optional |
API token needed to authorize requests Validations:
|
video_name optional |
Video name Validations:
|
air_date optional |
The date/time the stream is set to air. This changes credential generation time. Validations:
|
email optional , nil allowed |
Email address to receive stream credentials. Validations:
|
segment_length optional |
Duration of segment files in seconds. Smaller number will be more live, but will cause more viewer buffering. Validations:
|
has_redundant_streams optional |
Determines whether backup ingestion credentials are created. Must have feature enabled for your organization for this parameter. Validations:
|
disable_notifications optional |
Should email notifications be enabled for this stream? Validations:
|