KalturaAPI:updatekshow
From Devwiki
Part of the KalturaAPI
Contents |
Description
Updates an existing Collaborative Video. Can modify itsname and summary.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| kshow_id | integer | always | The id of the Collaborative Video. |
| kshow_name | string | no | The new name of the Collaborative Video. This string should be unique per partner. The name is displayed on the widget at play time. |
| kshow_description | string | no | The new description of the Collaborative Video. The description is displayed on the widget at play time. |
| kshow_tags | string | no | A new set of tags separated by ',' that help describe the Collaborative Video. These strings help find the Collaborative Video during search. |
| detailed | 0 or 1 | no | affects the amount of info returned for the updated Collaborative Video. detailed=1 will present more info such as the name of the producer and not only his ID. |
Results
| Name | Type | Description |
|---|---|---|
| old_kshow | kshow object | An object with info about the Collaborative Video prior to the changes. |
| kshow | kshow object | An object with info about the updated Collaborative Video. If detailed=1 was used, many extra parameters are returned. |
Error Codes
| Code | Description |
|---|---|
| ? | kshow [<kshow_id>] does not exist |
| -1 | Kshow with name '<kshow_name>' already exists in system. This happens if the name exists for some existing Collaborative Video other than the one reffered by the kshow_id. |
