DEPRECATED
Update live stream provisioning data.
DEPRECATED
Create a new live stream and provision using the provided settings.
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 POST /v1/organizations/15/live Content-Type: application/json { "stream_options": { "recurring": false, }, "video_options": { "video_name": "Recounting VBot's Birthday Bash", "description": "Join us for a live recounting of VBot's birthday bash!", "air_date": "2021-03-27T09:57:35+00:00", "segment_length": 4, "has_redundant_streams": true, "disable_notifications": false, "stream_tags": ["BirthdayTag", "VBot"], "dvr_enabled": true, }, } RESPONSE 201 (Created) { "stream_instance_id": 153 }
Param name | Description |
---|---|
auth_token optional |
API token needed to authorize requests Validations:
|
recurring optional |
Validations:
|
video_name required |
Stream name Validations:
|
description required |
Stream description Validations:
|
air_date optional |
The date/time the stream is set to air. 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:
|
stream_tags required |
Tags to describe video/stream Validations:
|
dvr_enabled optional |
Whether viewers can pause and rewind streamed video during the live broadcast Validations:
|
DEPRECATED
Get live stream library for organization
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 GET /v1/organizations/15/live?page=1&per_page=50&states[]=finished Content-Type: application/json RESPONSE 200 { "summary":{ "page":1, "per_page":50, "count":1 }, "stream_instances":[ { "id":202, "player_id":11, "player_uuid":"FDcPaMBEPpKs3A9mjfDAxx", "name":"Live Stream 2", "status":"processing", "recurring":false, "air_date":0, "start_time":1614820644, "vod_created_at":1614575068, "created_at":1614575068, "updated_at":1614575068 }, { "id":203, "player_id":12, "player_uuid":"3gNuotBz2ZPVrSGw2b1yxx", "name":"Live Stream 3", "status":"unaired", "recurring":false, "air_date":0, "start_time":0, "vod_created_at":1615320459, "created_at":1615720460, "updated_at":1615720460 }, ] } REQUEST GET /v1/organizations/15/live?page=1&per_page=50&states[]=upcoming,ongoing Content-Type: application/json RESPONSE 200 { "summary":{ "page":1, "per_page":50, "count":1 }, "stream_instances":[ { "id":201, "player_id":10, "player_uuid":"XQifG3tEE6P3gozEhsCKxx", "name":"Live Stream 1", "status":"ready", "recurring":false, "air_date":0, "start_time":1613575168, "vod_created_at":1613575068, "created_at":1613575068, "updated_at":1613575068 } ] }
Param name | Description |
---|---|
auth_token optional |
API token needed to authorize requests Validations:
|
per_page optional |
The number of items to show per page Validations:
|
page optional |
The page number to include in the response Validations:
|
query optional |
A string used to search for a set a stream instances by name as well as all associated tags Validations:
|
states optional |
Filter streams to the given states. Validations:
|
order_by optional |
Only works if ‘per_page’ or ‘page’ parameters are also set. Validations:
|
direction optional |
Only works if ‘per_page’ or ‘page’ parameters are also set. Validations:
|
DEPRECATED
Get the details for a specific live stream instance
Code | Description |
---|---|
400 | Bad Request: body has wrong syntax or unable to handle request |
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 |
404 | Not Found: The requested resource could not be found |
REQUEST GET /v1/organizations/15/live/153 Content-Type: application/json RESPONSE 200 { "stream_details":{ "stream_id":101, "recurring":true, "created_at":1616772268, "updated_at":1616772268 }, "instance_details":{ "stream_instance_id":153, "dvr_enabled":true, "ingest_url":"rtmp://guzzler.vidyard.com:1935/live", "stream_key":"fccc320ee3da4exxee5495ba60460ba3", "email":null, "segment_length":1, "has_redundant_streams":true, "backup_url":"rtmp://guzzler.vidyard.com:1935/live", "backup_key":"159396036xx1c2af70fc53831139bf33", "air_date":1616772226, "start_time":0, "end_time":0, "vod_created_at":1616772268, "created_at":1616772268, "updated_at":1616772268, "name":"Recounting VBot's Birthday Bash", "description":"Join us for a live recounting of VBot's birthday bash!", "tags":[ ["BirthdayTag", "VBot"], ], "video_id":350, "status":"unaired", "player_uuid":"yNpg4xEhtqcrfb3GSBHfxx" } }
Param name | Description |
---|---|
auth_token optional |
API token needed to authorize requests Validations:
|
DEPRECATED
Update stream instance options
Code | Description |
---|---|
400 | Bad Request: body has wrong syntax or unable to handle request |
401 | Unauthorized: auth_token omitted or authentication failed |
403 | Forbidden: This action cannot be performed |
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 |
REQUEST PATCH /v1/organizations/15/live/153 Content-Type: application/json { "description":"New Stream Description" } RESPONSE 200 { success: true }
Param name | Description |
---|---|
auth_token optional |
API token needed to authorize requests Validations:
|
name optional |
Stream name Validations:
|
description optional |
Stream description Validations:
|
dvr_enabled optional |
Whether the player controls are enabled for viewers Validations:
|
air_date optional |
The date/time the stream is set to air. Validations:
|
stream_tags optional |
Tags to describe video/stream Validations:
|
DEPRECATED
Delete a live stream instance
Code | Description |
---|---|
400 | Bad Request: body has wrong syntax or unable to handle request |
401 | Unauthorized: auth_token omitted or authentication failed |
403 | Forbidden: This action cannot be performed |
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 |
REQUEST DELETE /v1/organizations/15/live/153 Content-Type: application/json RESPONSE 200 { success: true }
Param name | Description |
---|---|
auth_token optional |
API token needed to authorize requests Validations:
|
DEPRECATED
Retrieve health stats for a live stream instance
Code | Description |
---|---|
400 | Bad Request: body has wrong syntax or unable to handle request |
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 |
404 | Not Found: The requested resource could not be found |
REQUEST GET /api/v1/organizations/15/live/153/health Content-Type: application/json RESPONSE 200 { "primary":{ "video_codec_name":"h264", "video_width":1920, "video_height":1080, "video_r_frame_rate":30, "video_bit_rate":3072000, "audio_codec_name":"aac", "audio_sample_rate":48000, "audio_bit_rate":147456, "created_at":"2021-03-14T11:14:20.000Z" }, "backup":null }
Param name | Description |
---|---|
auth_token optional |
API token needed to authorize requests Validations:
|