@pbvision/partner-sdk 0.1.10 → 0.1.12

package/README.md

@@ -12,6 +12,7 @@ standard length game, so we'll notify your servers when the results are ready.
   - [Send Videos](#send-videos)
     - [Option 1: PBV downloads your video from a URL](#option-1-pbv-downloads-your-video-from-a-url)
     - [Option 2: Upload your video](#option-2-upload-your-video)
+  - [Video Editors](#video-editors)
 - [After Video Processing is Done](#after-video-processing-is-done)
   - [Callback Data](#callback-data)
 - [Video Guidelines](#video-guidelines)
@@ -21,10 +22,10 @@ standard length game, so we'll notify your servers when the results are ready.
 
 ### Step 1: Get API Access
 
-Email **[dev@pb.vision](mailto:dev@pb.vision)** to request API access for your
+Email **[support@pb.vision](mailto:support@pb.vision)** to request API access for your
 account. Let us know which data you need access to (e.g. insights, stats) which
 is documented below in the [Callback Data](#callback-data) section. We'll send
-you an API Key after discussing your needs more in depth.
+you an API Key after discussing your needs more in depth and laying out our billing options.
 
 ### Step 2: SDK Setup
 
@@ -78,12 +79,11 @@ Next, tell us to download and work on the video. You can do this using our SDK:
 ```javascript
 import { PBVision } from '@pbvision/partner-sdk';
 
-const pbv = new PBVision(YOUR_API_KEY);
+const pbv = new PBVision(YOUR_API_KEY, { useProdServer: true });
 // you can omit this metadata, or provide some or all of this object—whatever you'd like!
 const optionalMetadata = {
-  userEmails: [],
-  name: 'Dink Championship 2024',
-  desc: 'A longer description, if you want',
+  userEmails: [], // these users will have the video in their PB Vision library
+  name: 'Dink Championship 2025',
   gameStartEpoch: 1711393200, // when the game was played
 };
 await pbv.sendVideoUrlToDownload(YOUR_VIDEO_URL, optionalMetadata);
@@ -106,21 +106,31 @@ You can directly upload your video from a file using the SDK too:
 ```javascript
 import { PBVision } from '@pbvision/partner-sdk';
 
-const pbv = new PBVision(YOUR_API_KEY, { useProdServer: false });
+const pbv = new PBVision(YOUR_API_KEY, { useProdServer: true });
 // you can omit this metadata, or provide some or all of this object—whatever you'd like!
 const optionalMetadata = {
-  userEmails: [],
-  name: 'Dink Championship 2024',
-  desc: 'A longer description, if you want',
+  userEmails: [], // these users will have the video in their PB Vision library
+  name: 'Dink Championship 2025',
   gameStartEpoch: 1711393200, // when the game was played
 };
 await pbv.uploadVideo(YOUR_VIDEO_FILENAME, optionalMetadata);
 ```
 
+### Video Editors
+
+Editors can tag themselves and friends in the video. They also have access to
+the video even if the video is private (to make videos uploaded by your partner
+account private by default, please let us know via email).
+
+You can get the current list of editors on a video by using the `getVideoEditors()`
+method. Similarly, the `setVideoEditors()` method can be used to change the
+email addresses which have editor access on your video.
+
 ## After Video Processing is Done
 
 When our AI is done processing your video, we will email the players in the
-game (_if_ their email addresses were provided via `userEmails`).
+game (_if_ their email addresses were provided via `userEmails`). These users
+will be "editors" on the video and be able to tag themselves and their friends.
 
 If you [provided a webhook](#webhook-setup), then we'll send
 an HTTP POST request to your server. Your server should acknowledge this
@@ -133,8 +143,7 @@ data is enabled for your API key, only some of these fields may be present):
 ```json
 {
     "from_url": "https://example.com/my-video.mp4",
-    "webpage": "https://pb.vision/video/tvgz3pqij0ll",
-    "cutVideo": "https://storage.googleapis.com/pbv-pro/xyz/f50272db-69a8-49ed-9d92-3a4d067af87c/rallies.mp4",
+    "webpage": "https://pb.vision/video/83gyqyc10y8f",
     "cv": CV_DATA,
     "insights": INSIGHTS_DATA,
     "stats": STATS_DATA,
@@ -158,7 +167,6 @@ data is enabled for your API key, only some of these fields may be present):
 - `stats` various stats about the game for advanced players
   - Explore the _stats_ schema at <https://pbv-public.github.io/stats?s=~stats~game>
   - Schema changes and diffs are in our [`pbv-public/stats` repo](https://github.com/pbv-public/stats/blob/dev/CHANGELOG.md)
-- `cutVideo` contains a link to the rally-sliced (dead time removed) .mp4.
 - only included if `insights` is included:
   - `vid` - the unique ID of the video in our system
   - `aiEngineVersion` - the version number of our AI used to process the video
@@ -179,7 +187,7 @@ For best results, we also recommend:
 - Audio Encoding: MPEG-4 AAC
 - Resolution: 1080p
 - Frame Rate: 30 FPS
-- Max Bitrate: 2 Mbps
+- Max Bitrate: 4 Mbps
 - Max File Size: 2GB
 
 ## Reference Guide

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pbvision/partner-sdk",
   "description": "SDK for interacting with the PB Vision pickleball AI engine.",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "license": "MIT",
   "type": "module",
   "engines": {

package/src/index.js

@@ -47,6 +47,28 @@ export class PBVision {
     return this.__callAPI('webhook/set', { url: webhookUrl })
   }
 
+  /**
+   * Gets the email addresses (if any) which have editor access to a video your
+   * partner account uploaded.
+   *
+   * @param {string} vid video id
+   */
+  async getVideoEditors (vid) {
+    return this.__callAPI('video/editors/get', { vid })
+  }
+
+  /**
+   * Sets the email addresses (if any) which have editor access to a video your
+   * partner account uploaded.
+   *
+   * @param {string} vid video id
+   * @param {Array<string>} editorEmails a list of 0 to 4 email addresses to
+   *   allow edit access to the video (replaces any previous editors list).
+   */
+  async setVideoEditors (vid, editorEmails) {
+    return this.__callAPI('video/editors/set', { vid, editorEmails })
+  }
+
   /**
    * @typedef {Object} VideoUrlToDownloadResponse
    * @property {string} vid the ID of the new video
@@ -118,7 +140,8 @@ export class PBVision {
   async uploadVideo (mp4Filename, { userEmails = [], name, desc, gameStartEpoch, facility, court, fid } = {}) {
     const pieces = mp4Filename.split('.')
     const ext = pieces[pieces.length - 1]
-    const makeVIDResp = await this.__callAPI('make_video_id', { userEmails, name, desc, gameStartEpoch, facility, court, fid, fileExt: ext })
+    const platform = { name: 'api', version: '0.1.12' }
+    const makeVIDResp = await this.__callAPI('make_video_id', { platform, userEmails, name, desc, gameStartEpoch, facility, court, fid, fileExt: ext })
     const { hasCredits, vid } = JSON.parse(makeVIDResp)
     if (hasCredits === false) {
       return { hasCredits }