MqttCamera

MqttCamera connects to one device, peer to peer, through an MQTT broker. It is the only connection with snapshots, recording, files and camera controls.

It is a connection: connect(), disconnect(), onStatus, onStream, onMessage, sendText(), gamepad() and the rest work as described there.

import { MqttCamera } from '@mazupo/client';

const camera = new MqttCamera({
  deviceId: 'your-device-id',
  host: 'your.mqtt.cloud',
  port: 8084,
  username: 'hakunamatata',
  password: 'Wonderful',
  stunUrls: ['stun:stun1.l.google.com:19302'],
});
camera.onStream = (stream) => { video.srcObject = stream; };
camera.connect();

Options複製段落連結

Next to the options of every connection.

Your microphone goes to the device, and the device's audio comes to you, unless datachannelOnly is set.

Events複製段落連結

Next to the events of every connection.

onDatachannel複製段落連結

= (role: ChannelRole) => {}

Called when a DataChannel opens. See DataChannels.

onSnapshot複製段落連結

= (base64: string) => {}

Called after snapshot(), with the image as a data URL, once every part of it has arrived.

onRecording複製段落連結

= (res: RecordingResponse) => {}

Called when the device answers startRecording() or stopRecording().

• res.isRecording: true if recording started, false if it stopped.
• res.filepath: the path of the file being recorded.

onVideoListLoaded複製段落連結

= (res: QueryFileResponse) => {}

Called with the details of the recorded files, after fetchVideoList().

onVideoDownloaded複製段落連結

= (file: Uint8Array) => {}

Called when a file has downloaded, after downloadVideoFile().

onProgress複製段落連結

= (received: number, total: number, type: RequestType, requestId?: string) => {}

Called during a transfer, with the bytes received so far and the total. requestId tells transfers apart when they overlap.

Methods複製段落連結

Next to the methods of every connection.

deviceId複製段落連結

.deviceId: string

The device's --uid.

snapshot複製段落連結

.snapshot(quality?: number)

Asks the device for a still image. The image arrives in onSnapshot.

• quality: the JPEG quality, from 0 to 100. The default is 30.

startRecording複製段落連結

.startRecording()

Starts the device's recorder. The answer arrives in onRecording.

stopRecording複製段落連結

.stopRecording()

Stops the device's recorder. The answer arrives in onRecording.

fetchVideoList複製段落連結

.fetchVideoList(options?: { param?: string | Date, mode?: VideoMode })

Gets the details of recorded files. The answer arrives in onVideoListLoaded. Set onVideoListLoaded first: without it, nothing is asked.

• With no arguments, it returns the newest recorded file.
• If param is a file path (a string), it returns up to 8 recordings older than that file.
• If param is a Date, it returns the recorded file closest to that time.
• mode (optional) selects the set of files, as a VideoMode.

downloadVideoFile複製段落連結

.downloadVideoFile(path: string)

Downloads a file from the device. The file arrives in onVideoDownloaded. Set onVideoDownloaded first: without it, nothing is asked.

setCameraControl複製段落連結

.setCameraControl(key: CameraControlId, value: CameraControlValue)

Changes a camera control, such as brightness or white balance. See Camera controls.