Esquema de CameraClipPreview

Nest Doorbell (com bateria) Nest Doorbell (com fio) 

sdm.devices.traits.CameraClipPreview

Essa característica pertence a qualquer dispositivo compatível com o download de uma prévia de clipe.

Campos

Não há campos disponíveis para essa característica.

Comandos

Não há comandos disponíveis para essa característica.

Eventos

ClipPreview

Um videoclipe está disponível para visualização.

A visualização de clipe é um arquivo de vídeo de 10 frames no formato MP4. Você pode mostrar o arquivo de vídeo mp4 ou fazer a transcodificação para outro formato (por exemplo, um GIF animado) para mostrar uma sequência completa de 10 frames. Os recursos do cliente do dispositivo precisam ser considerados ao selecionar um método de visualização de clipe.

Esse evento é compatível com os seguintes eventos:

Tipo Elemento Descrição
Evento Evento Motion do atributo CameraMotion A câmera detectou movimento.
Evento Evento Pessoa da característica "CameraPerson" Uma pessoa foi detectada pela câmera.
Evento Evento Chime do recurso DoorbellChime A campainha foi tocada.
Use o eventSessionId para associar esse evento e o previewUrl relacionado a um ou mais eventos com suporte.

Evento ClipPreview

Payload

{
  "eventId" : "fe2e82ff-0dca-49f1-9c06-c75186a35947",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.CameraClipPreview.ClipPreview" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "previewUrl" : "https://previewUrl/..."
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Campos de evento de ClipPreview

Campo Descrição Tipo de dados
eventSessionId Um ID atribuído a eventos que ocorrem como parte de uma única sessão de eventos relacionados. Pode ser usado para consolidar eventos. string
Exemplo: "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
previewUrl O URL para visualizar o videoclipe. O codec de vídeo padrão é H264. string
Exemplo: "https://previewUrl/…"

Campos de payload do evento

Campo Descrição Tipo de dados
eventId O identificador exclusivo do evento. string
Exemplo: "fe2e82ff-0dca-49f1-9c06-c75186a35947"
timestamp O horário em que o evento ocorreu. string
Exemplo: "2019-01-01T00:00:01Z"
resourceUpdate Um objeto que detalha informações sobre a atualização do recurso. object
userId Um identificador exclusivo e ofuscado que representa o usuário. string
Exemplo: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
resourceGroup Um objeto que indica recursos que podem ter atualizações semelhantes a esse evento. O recurso do próprio evento (do objeto resourceUpdate) sempre estará presente nesse objeto. object

Consulte Eventos para mais informações sobre os diferentes tipos de eventos e como eles funcionam.

Visualizar o clipe

Para visualizar o clipe, faça uma chamada GET para o previewUrl usando o token de acesso OAuth no cabeçalho de autorização HTTP:

Visualizar

curl -H 'Authorization: Bearer access-token' \
  https://previewUrl/...

Erros

Consulte a Referência de códigos de erro da API para conferir a lista completa de códigos de erro da API.