Clips

Clips represent actual video data. A clip must always be part of a playlist, so it cannot be created directly. (We will see about that...)
These are the necessary steps to create a clip with video data:

1. Acquire a playlist ID (by walking the folder tree to find or create one)
2. Create a new playlist item, without passing a clip_id.
3. Acquire the new clip_id from the create action's response
4. The clip is now accessible using the project resource, e.g. /api/projects/{project_id}/clips/{clip_id}
5. (optionally) Set clip attributes using the update action
6. Upload video data using the uploads resource

There is a step-by-step tutorial on how to upload a clip under 10.12 Upload if you need further assistance

Note that there is no destroy action for clips. When the last playlist reference of a clip is removed, the clip is implicitly destroyed as well. (We will also look into that.)

Example with pagination:

GET /api/projects/6/clips?page=1&per_page=20 HTTP/1.1
Authorization: Bearer example-token
Content-Type: application/json

response:

HTTP/1.1 200 OK
Content-Type: application/json
Link: <https://fischerappelt.webgate.io/api/projects/6/clips?page=3&per_page=20>; rel="last", <https://fischerappelt.webgate.io/api/projects/6/clips?page=2&per_page=20>; rel="next"
Per-Page: 1
Total: 5

{
  "status": 200,
  "status_message": "OK",
  "info": "",
  "data": {"array":{...}}
}

You can add multiple filters on the same field by using the array syntax. For example if you want to filter for scene 1 and 2:

?filters[scene][]=1&filters[scene][]=2

List of available filters

Example:

GET /api/projects/6/clips/filter?filters[scene][]=1&filters[scene][]=2&filters[take][]=1
Authorization: Bearer example-token
Content-Type: application/json

response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": 200,
    "status_message": "OK",
    "info": "",
    "data": {
            "hash": {
                    "total_clips_count": 43,
                    "duration": 2049704,
                    "clips": [
                        {
                            "checksum": null,
                            "circled_take": "true",
                            "created_at": "2017-10-13T15:31:25.000+02:00",
                            "download_for_playlist_id": null,
                            "duration": 31510,
                            "episode": "009",
                            "framecount": 787,
                            "framerate": 25,
                            "id": 833887,
                            "name": "rbs-open-pine-30s",
                            "playlist_infos": {
                                "794982": {
                                    "name": "Drehtag 01",
                                    "folder_id": 75590,
                                    "clips_count": 6,
                                    "clip_position": 1
                                }
                            },
                            "poster_image": "template/allgemein/poster_empty.jpg",
                            "project_id": 6083,
                            "reel": "001",
                            "reel_number": null,
                            "rendered_resolutions": {
                                "720p": 11086400,
                                "1080p": 18674364,
                                "270p": 2073424,
                                "540p": 5779713
                            },
                            "scene": "003",
                            "shoot_date": "20171212",
                            "shoot_day": "",
                            "shot": "",
                            "source_file_type": ".mp4",
                            "source_filesize": 6560759,
                            "start_timecode": "00:00:00:00",
                            "take": "006",
                            "thumb_image": "/images/blank.gif",
                            "tray": "",
                            "updated_at": "2018-01-12T17:08:40.000+01:00"
                        }
                    ]
               }
          }
     }
}

Adding the parameter '?mediafiles=heights' to the action, will list all the available videoheights for the particular browser. The browser is being detemined by the header "User-Agent".

This action streams rendered formats for browser view. Usually uploaded film-data is too big to stream over the internet. Therefore several formats are being automatically rendered after uploading a clip. Which formats are being automatically rendered, can be set within projects' configuration. Which format will be streamed, is being determined by which User-Agent is being used, and by setting the parameter videoheight. For example:

GET /api/projects/6/clips/1164.stream?videoheight=720 HTTP/1.1
Authorization: Bearer example-token