API Method: /api/live/update
Update the meta data about a live stream.
Parameters
| Parameter | Description |
|---|---|
| live_id (required) | The ID for the live stream you're updating. |
| name | The name of the live stream. All HTML tags will be stripped away from the name. |
| description | Description of the live stream. The value can include save HTML tags such as <b> or <p>; however, if any disallowed tags are included, all html with be stripped from the description. |
| album_id | An ID for the ID associated with recordings of the live stream. |
| live_format | The format of the live event to be created. Valid options are available through the /api/live/list-formats method. |
| streaming_method | The streaming method for this live event. Valid options are: webcam, iphone, android, mobile, hardware and software. |
| private_p | Specify if the live event is private or visible to users on your site. Allowed values: 0 or 1 |
| promoted_p | Promote this live stream. Allowed values: 0 or 1 |
| allow_dvr_p | Allow viewers to step back in time using the DVR feature? Allowed values: 0 or 1 |
| auto_promote_p | Automatically promote the live stream when it goes live. Allowed values: 0 or 1 |
| auto_record_p | Automatically record streams to the site's video archive. Allowed values: 0 or 1 |
| publish_recordings_p | Publish recordings to the site immediately. Allowed values: 0 or 1 |
| broadcasting_p | Mark whether the stream is live broadcasting or not. Allowed values: 0 or 1 |
Permission level
The minimum required permission level is:
writeExample XML Response
<pre><code><response status="ok" permission_level="write" message="The live steram was updated" cached="0"></code></pre>
Example JSON Response
{ "status": "ok", "message":"The live stream was updated", "permission_level":"write", "cached":"0", "p": "1", "size": "1", "site": { ...}, "endpoint": "/api/live/update"}