Media Capture

Media capture is performed client-side using the following methods:

await skylight.startPhotoCapture()
await skylight.startVideoCapture()

Photo Capture

When calling the startPhotoCapture method, there are several parameters in the configuration object that is passed in. These include:

  • delay: The number of seconds until a photo is automatically captured from when the capture screen launches. This is currently unsupported by the web client preview tool.

  • properties: This is a dictionary of key-value pairs that is added to the captured media object. This is accessible when working with captured media objects from the skylight.session.media array.

  • labels: This is a list of strings that is added to the media object of the photo that is captured by this startPhotoCapture call. This list is used in future startPhotoCapture calls by the galleryFilter parameter, described below.

  • galleryFilter: This is a list of strings used to determine which previously-captured photos are shown in the gallery that appears when this startPhotoCapture is called. Specifically, if any of the strings in this galleryFilter list matches any of the labels of a previously-captured photo, then that photo will appear in the gallery.

As a rule of thumb, it's reasonable to setlabels and galleryFilterto the same list of strings for a given startPhotoCapturecall.

‚Äč

Video Capture

When calling the startVideoCapture method, there are several parameters in the configuration object that is passed in. These include:

  • properties: This is a dictionary of key-value pairs that is added to the captured media object. This is accessible when working with captured media objects from the skylight.session.media array.

  • labels: This is a list of strings that is added to the media object of the video that is captured by this startVideoCapture call. This list is used in future startVideoCapture calls by the galleryFilter parameter, described below.

  • galleryFilter: This is a list of strings used to determine which previously-captured videos are shown in the gallery that appears when this startVideoCapture is called. Specifically, if any of the strings in this galleryFilter list matches any of the labels of a previously-captured video, then that video will appear in the gallery.