Video Handover

getAvailability([, propertyNames])

Declaration

hmkit.commands.VideoHandover.getAvailability()

Parameters

propertyNames

(optional) Array of names of the properties you want returned.

Example

// Get availability for all properties
hmkit.telematics.sendCommand(
  hmkit.commands.VideoHandover.getAvailability(),
  accessCertificate
);
// Get availability for specific properties
hmkit.telematics.sendCommand(
  hmkit.commands.VideoHandover.getAvailability(['status']),
  accessCertificate
);

Response

Parameters

availability(Object)
updateRate.value

(String) enum

rateLimit.value

(Number)

rateLimit.unit

(String)

appliesPer.value

(String)

Discussion

The response contains an availability object for each property, as shown in the example

Example

{
  "status": {
    "availability": {
      "updateRate": {
        "value": "trip_high"
      },
      "rateLimit": {
        "value": 64,
        "unit": "hertz"
      },
      "appliesPer": {
        "value": "vehicle"
      }
    }
  }
}

videoHandover({ url, startingTime, screen })

Parameters

url

(String) URL string

startingTime

(Number) (duration) Start the video from the given time

screen

(String) (enum)

Example

hmkit.telematics.sendCommand(
  hmkit.commands.VideoHandover.videoHandover({
    "url": "https://bit.ly/2obY7G5",
    "startingTime": {
      "seconds": 2.5
    },
    "screen": "rear"
  }),
  accessCertificate
);