Skip to main content

Camera Module Documentation

The Camera Module provides comprehensive camera functionality for MentraOS apps, including photo capture and video streaming capabilities.

📸 Available Features​

Photo Capture​

Take high-quality photos from smart glasses with options for gallery saving and raw buffer access.

Key capabilities:

  • Request individual photos on demand
  • Save to device gallery
  • Access raw photo data for processing
  • Handle timeouts and errors gracefully

RTMP Streaming​

Stream live video from smart glasses to custom RTMP endpoints:

Key capabilities:

  • Full control over RTMP endpoints
  • Exclusive camera access for your app
  • Custom server integration
  • Low latency streaming options
  • Detailed stream status monitoring

🎯 Quick Start​

Taking a Photo​

const photo = await session.camera.requestPhoto({ saveToGallery: true });
console.log(`Photo captured: ${photo.mimeType}, ${photo.size} bytes`);

Starting an RTMP Stream​

await session.camera.startStream({
  rtmpUrl: 'rtmp://your-server.com/live/stream-key'
});

📚 Documentation Structure​

🎬 Common Use Cases​

Live Streaming​

Stream to platforms like YouTube Live, X (Twitter), and TikTok using their RTMP endpoints:

await session.camera.startStream({
  rtmpUrl: 'rtmp://a.rtmp.youtube.com/live2/your-stream-key'
});

Security Camera App​

Stream to local RTMP servers for security monitoring:

await session.camera.startStream({
  rtmpUrl: 'rtmp://192.168.1.100/security/cam1'
});

Photo Documentation App​

Capture and save photos for documentation:

const photo = await session.camera.requestPhoto({
  saveToGallery: true
});
await uploadToCloudStorage(photo.buffer);

🚨 Important Notes​

  • Permissions: Camera access requires the camera permission in your app manifest
  • Hardware: Only available on camera-equipped glasses (e.g., Mentra Live)
  • Battery: Extended streaming can drain battery quickly
  • Privacy: Always notify users when camera is active

📖 See Also​